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 import org.apache.hc.core5.util.LangUtils;
37
38 /**
39 * Basic username based principal representation.
40 *
41 * @since 4.0
42 */
43 @Contract(threading = ThreadingBehavior.IMMUTABLE)
44 public final class BasicUserPrincipal implements Principal, Serializable {
45
46 private static final long serialVersionUID = -2266305184969850467L;
47
48 private final String username;
49
50 public BasicUserPrincipal(final String username) {
51 super();
52 Args.notNull(username, "User name");
53 this.username = username;
54 }
55
56 @Override
57 public String getName() {
58 return this.username;
59 }
60
61 @Override
62 public int hashCode() {
63 int hash = LangUtils.HASH_SEED;
64 hash = LangUtils.hashCode(hash, this.username);
65 return hash;
66 }
67
68 @Override
69 public boolean equals(final Object o) {
70 if (this == o) {
71 return true;
72 }
73 if (o instanceof BasicUserPrincipal) {
74 final BasicUserPrincipal that = (BasicUserPrincipal) o;
75 return Objects.equals(this.username, that.username);
76 }
77 return false;
78 }
79
80 @Override
81 public String toString() {
82 final StringBuilder buffer = new StringBuilder();
83 buffer.append("[principal: ");
84 buffer.append(this.username);
85 buffer.append("]");
86 return buffer.toString();
87 }
88
89 }
90