View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  package org.apache.http.auth;
28  
29  import java.io.Serializable;
30  import java.security.Principal;
31  
32  import org.apache.http.annotation.Immutable;
33  import org.apache.http.util.Args;
34  import org.apache.http.util.LangUtils;
35  
36  /**
37   * Simple {@link Credentials} implementation based on a user name / password
38   * pair.
39   *
40   * @since 4.0
41   */
42  @Immutable
43  public class UsernamePasswordCredentials implements Credentials, Serializable {
44  
45      private static final long serialVersionUID = 243343858802739403L;
46  
47      private final BasicUserPrincipal principal;
48      private final String password;
49  
50      /**
51       * The constructor with the username and password combined string argument.
52       *
53       * @param usernamePassword the username:password formed string
54       * @see #toString
55       * @deprecated (4.5) will be replaced with {@code String}, {@code char[]} in 5.0
56       */
57      @Deprecated
58      public UsernamePasswordCredentials(final String usernamePassword) {
59          super();
60          Args.notNull(usernamePassword, "Username:password string");
61          final int atColon = usernamePassword.indexOf(':');
62          if (atColon >= 0) {
63              this.principal = new BasicUserPrincipal(usernamePassword.substring(0, atColon));
64              this.password = usernamePassword.substring(atColon + 1);
65          } else {
66              this.principal = new BasicUserPrincipal(usernamePassword);
67              this.password = null;
68          }
69      }
70  
71  
72      /**
73       * The constructor with the username and password arguments.
74       *
75       * @param userName the user name
76       * @param password the password
77       */
78      public UsernamePasswordCredentials(final String userName, final String password) {
79          super();
80          Args.notNull(userName, "Username");
81          this.principal = new BasicUserPrincipal(userName);
82          this.password = password;
83      }
84  
85      @Override
86      public Principal getUserPrincipal() {
87          return this.principal;
88      }
89  
90      public String getUserName() {
91          return this.principal.getName();
92      }
93  
94      @Override
95      public String getPassword() {
96          return password;
97      }
98  
99      @Override
100     public int hashCode() {
101         return this.principal.hashCode();
102     }
103 
104     @Override
105     public boolean equals(final Object o) {
106         if (this == o) {
107             return true;
108         }
109         if (o instanceof UsernamePasswordCredentials) {
110             final UsernamePasswordCredentials that = (UsernamePasswordCredentials) o;
111             if (LangUtils.equals(this.principal, that.principal)) {
112                 return true;
113             }
114         }
115         return false;
116     }
117 
118     @Override
119     public String toString() {
120         return this.principal.toString();
121     }
122 
123 }
124