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 import java.util.Objects;
32
33 import org.apache.hc.core5.annotation.Contract;
34 import org.apache.hc.core5.annotation.ThreadingBehavior;
35 import org.apache.hc.core5.util.Args;
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 Principal principal;
49 private final char[] password;
50
51 /**
52 * The constructor with the username and password arguments.
53 *
54 * @param principal the user principal
55 * @param password the password
56 *
57 * @since 5.3
58 *
59 * @see BasicUserPrincipal
60 * @see NTUserPrincipal
61 */
62 public UsernamePasswordCredentials(final Principal principal, final char[] password) {
63 super();
64 this.principal = Args.notNull(principal, "User principal");
65 this.password = password;
66 }
67
68 /**
69 * The constructor with the username and password arguments.
70 *
71 * @param username the user name
72 * @param password the password
73 */
74 public UsernamePasswordCredentials(final String username, final char[] password) {
75 this(new BasicUserPrincipal(username), password);
76 }
77
78 @Override
79 public Principal getUserPrincipal() {
80 return this.principal;
81 }
82
83 public String getUserName() {
84 return this.principal.getName();
85 }
86
87 /**
88 * @since 5.3
89 */
90 public char[] getUserPassword() {
91 return password;
92 }
93
94 /**
95 * @deprecated Use {@link #getUserPassword()}.
96 */
97 @Deprecated
98 @Override
99 public char[] getPassword() {
100 return password;
101 }
102
103 @Override
104 public int hashCode() {
105 return this.principal.hashCode();
106 }
107
108 @Override
109 public boolean equals(final Object o) {
110 if (this == o) {
111 return true;
112 }
113 if (o instanceof UsernamePasswordCredentials) {
114 final UsernamePasswordCredentials that = (UsernamePasswordCredentials) o;
115 return Objects.equals(this.principal, that.principal);
116 }
117 return false;
118 }
119
120 @Override
121 public String toString() {
122 return this.principal.toString();
123 }
124
125 }
126