org.springframework.security.adapters

Class PrincipalSpringSecurityUserToken

java.lang.Object

org.springframework.security.providers.AbstractAuthenticationToken

org.springframework.security.adapters.AbstractAdapterAuthenticationToken

org.springframework.security.adapters.PrincipalSpringSecurityUserToken

All Implemented Interfaces:

java.io.Serializable, java.security.Principal, AuthByAdapter, Authentication

public class PrincipalSpringSecurityUserToken
extends AbstractAdapterAuthenticationToken
implements java.security.Principal

A Principal compatible Authentication object.

Version:

$Id$

Author:

Ben Alex

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PrincipalSpringSecurityUserToken(java.lang.String key, java.lang.String username, java.lang.String password, GrantedAuthority[] authorities, java.lang.Object principal)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getCredentials() The credentials that prove the principal is correct.
java.lang.String	getName()
java.lang.Object	getPrincipal() The identity of the principal being authenticated.

Methods inherited from class org.springframework.security.adapters.AbstractAdapterAuthenticationToken

equals, getKeyHash, isAuthenticated, isUserInRole, setAuthenticated

Methods inherited from class org.springframework.security.providers.AbstractAuthenticationToken

getAuthorities, getDetails, hashCode, setDetails, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

equals, hashCode, toString

Methods inherited from interface org.springframework.security.Authentication

getAuthorities, getDetails

Constructor Detail

PrincipalSpringSecurityUserToken

public PrincipalSpringSecurityUserToken(java.lang.String key,
                                java.lang.String username,
                                java.lang.String password,
                                GrantedAuthority[] authorities,
                                java.lang.Object principal)

Method Detail

getCredentials

public java.lang.Object getCredentials()

Description copied from interface: Authentication

The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the AuthenticationManager. Callers are expected to populate the credentials.

Specified by:

getCredentials in interface Authentication

Returns:

the credentials that prove the identity of the Principal

getName

public java.lang.String getName()

Specified by:

getName in interface java.security.Principal

Overrides:

getName in class AbstractAuthenticationToken

getPrincipal

public java.lang.Object getPrincipal()

Description copied from interface: Authentication

The identity of the principal being authenticated. This is usually a username. Callers are expected to populate the principal.

Specified by:

getPrincipal in interface Authentication

Returns:

the Principal being authenticated