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 */
56 public UsernamePasswordCredentials(final String usernamePassword) {
57 super();
58 Args.notNull(usernamePassword, "Username:password string");
59 final int atColon = usernamePassword.indexOf(':');
60 if (atColon >= 0) {
61 this.principal = new BasicUserPrincipal(usernamePassword.substring(0, atColon));
62 this.password = usernamePassword.substring(atColon + 1);
63 } else {
64 this.principal = new BasicUserPrincipal(usernamePassword);
65 this.password = null;
66 }
67 }
68
69
70 /**
71 * The constructor with the username and password arguments.
72 *
73 * @param userName the user name
74 * @param password the password
75 */
76 public UsernamePasswordCredentials(final String userName, final String password) {
77 super();
78 Args.notNull(userName, "Username");
79 this.principal = new BasicUserPrincipal(userName);
80 this.password = password;
81 }
82
83 public Principal getUserPrincipal() {
84 return this.principal;
85 }
86
87 public String getUserName() {
88 return this.principal.getName();
89 }
90
91 public String getPassword() {
92 return password;
93 }
94
95 @Override
96 public int hashCode() {
97 return this.principal.hashCode();
98 }
99
100 @Override
101 public boolean equals(final Object o) {
102 if (this == o) {
103 return true;
104 }
105 if (o instanceof UsernamePasswordCredentials) {
106 final UsernamePasswordCredentials that = (UsernamePasswordCredentials) o;
107 if (LangUtils.equals(this.principal, that.principal)) {
108 return true;
109 }
110 }
111 return false;
112 }
113
114 @Override
115 public String toString() {
116 return this.principal.toString();
117 }
118
119 }
120