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.hc.client5.http.auth;
28
29 import java.io.Serializable;
30 import java.security.Principal;
31
32 import org.apache.hc.core5.annotation.Contract;
33 import org.apache.hc.core5.annotation.ThreadingBehavior;
34 import org.apache.hc.core5.util.Args;
35 import org.apache.hc.core5.util.LangUtils;
36
37 /**
38 * Simple {@link Credentials} representation based on a user name / password
39 * pair.
40 *
41 * @since 4.0
42 */
43 @Contract(threading = ThreadingBehavior.IMMUTABLE)
44 public class UsernamePasswordCredentials implements Credentials, Serializable {
45
46 private static final long serialVersionUID = 243343858802739403L;
47
48 private final BasicUserPrincipal principal;
49 private final char[] password;
50
51 /**
52 * The constructor with the username and password arguments.
53 *
54 * @param userName the user name
55 * @param password the password
56 */
57 public UsernamePasswordCredentials(final String userName, final char[] password) {
58 super();
59 Args.notNull(userName, "Username");
60 this.principal = new BasicUserPrincipal(userName);
61 this.password = password;
62 }
63
64 @Override
65 public Principal getUserPrincipal() {
66 return this.principal;
67 }
68
69 public String getUserName() {
70 return this.principal.getName();
71 }
72
73 @Override
74 public char[] getPassword() {
75 return password;
76 }
77
78 @Override
79 public int hashCode() {
80 return this.principal.hashCode();
81 }
82
83 @Override
84 public boolean equals(final Object o) {
85 if (this == o) {
86 return true;
87 }
88 if (o instanceof UsernamePasswordCredentials) {
89 final UsernamePasswordCredentials that = (UsernamePasswordCredentials) o;
90 return LangUtils.equals(this.principal, that.principal);
91 }
92 return false;
93 }
94
95 @Override
96 public String toString() {
97 return this.principal.toString();
98 }
99
100 }
101