View Javadoc

1   /*
2    * Copyright 2008 University Corporation for Advanced Internet Development, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package edu.internet2.middleware.shibboleth.idp.authn;
18  
19  import java.security.Principal;
20  
21  import org.opensaml.xml.util.DatatypeHelper;
22  
23  /** A basic implementation of {@link Principal}. */
24  public class UsernamePrincipal implements Principal {
25  
26      /** Name of the principal. */
27      private String name;
28  
29      /**
30       * Constructor.
31       * 
32       * @param principalName name of the principal
33       */
34      public UsernamePrincipal(String principalName) {
35          name = DatatypeHelper.safeTrimOrNullString(principalName);
36      }
37  
38      /** {@inheritDoc} */
39      public String getName() {
40          return name;
41      }
42  
43      /** {@inheritDoc} */
44      public String toString() {
45          return "{BasicPrincipal}" + getName();
46      }
47  
48      /** {@inheritDoc} */
49      public int hashCode() {
50          return name.hashCode();
51      }
52  
53      /** {@inheritDoc} */
54      public boolean equals(Object obj) {
55          if (obj == this) {
56              return true;
57          }
58  
59          if (obj instanceof UsernamePrincipal) {
60              return DatatypeHelper.safeEquals(getName(), ((UsernamePrincipal) obj).getName());
61          }
62  
63          return false;
64      }
65  }