View Javadoc

1   /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
2    *
3    * Licensed under the Apache License, Version 2.0 (the "License");
4    * you may not use this file except in compliance with the License.
5    * You may obtain a copy of the License at
6    *
7    *     http://www.apache.org/licenses/LICENSE-2.0
8    *
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed under the License is distributed on an "AS IS" BASIS,
11   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12   * See the License for the specific language governing permissions and
13   * limitations under the License.
14   */
15  
16  package org.springframework.security.adapters;
17  
18  import org.springframework.security.GrantedAuthority;
19  
20  import java.security.Principal;
21  
22  
23  /**
24   * A {@link Principal} compatible  {@link org.springframework.security.Authentication} object.
25   *
26   * @author Ben Alex
27   * @version $Id: PrincipalSpringSecurityUserToken.java 2217 2007-10-27 00:45:30Z luke_t $
28   */
29  public class PrincipalSpringSecurityUserToken extends AbstractAdapterAuthenticationToken implements Principal {
30      //~ Instance fields ================================================================================================
31  
32      private static final long serialVersionUID = 1L;
33      private Object principal;
34      private String password;
35      private String username;
36  
37      //~ Constructors ===================================================================================================
38  
39      public PrincipalSpringSecurityUserToken(String key, String username, String password, GrantedAuthority[] authorities,
40          Object principal) {
41          super(key, authorities);
42          this.username = username;
43          this.password = password;
44          this.principal = principal;
45      }
46  
47      //~ Methods ========================================================================================================
48  
49      public Object getCredentials() {
50          return this.password;
51      }
52  
53      public String getName() {
54          return this.username;
55      }
56  
57      public Object getPrincipal() {
58          if (this.principal == null) {
59              return this.username;
60          }
61  
62          return this.principal;
63      }
64  }