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