View Javadoc

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