org.springframework.security.access.intercept
Class RunAsUserToken

java.lang.Object
  org.springframework.security.authentication.AbstractAuthenticationToken
      org.springframework.security.access.intercept.RunAsUserToken

All Implemented Interfaces:

Serializable, Principal, Authentication

public class RunAsUserToken
extends AbstractAuthenticationToken

An immutable Authentication implementation that supports RunAsManagerImpl.

Version:

$Id: RunAsUserToken.java 4075 2009-12-18 18:44:42Z ltaylor $

Author:

Ben Alex

See Also:

Serialized Form

Constructor Summary

RunAsUserToken(String key, Object principal, Object credentials, Collection<GrantedAuthority> authorities, Class<? extends Authentication> originalAuthentication)

RunAsUserToken(String key, Object principal, Object credentials, GrantedAuthority[] authorities, Class<? extends Authentication> originalAuthentication)

Method Summary

Object	getCredentials() The credentials that prove the principal is correct.
int	getKeyHash()
Class<? extends Authentication>	getOriginalAuthentication()
Object	getPrincipal() The identity of the principal being authenticated.
String	toString()

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

equals, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails

Methods inherited from class java.lang.Object

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

Constructor Detail

RunAsUserToken

public RunAsUserToken(String key,
                      Object principal,
                      Object credentials,
                      GrantedAuthority[] authorities,
                      Class<? extends Authentication> originalAuthentication)

RunAsUserToken

public RunAsUserToken(String key,
                      Object principal,
                      Object credentials,
                      Collection<GrantedAuthority> authorities,
                      Class<? extends Authentication> originalAuthentication)

Method Detail

getCredentials

public 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.

Returns:

the credentials that prove the identity of the Principal

getKeyHash

public int getKeyHash()

getOriginalAuthentication

public Class<? extends Authentication> getOriginalAuthentication()

getPrincipal

public Object getPrincipal()

Description copied from interface: Authentication

The identity of the principal being authenticated. In the case of an authentication request with username and password, this would be the username. Callers are expected to populate the principal for an authentication request.

The AuthenticationManager implementation will often return an Authentication containing richer information as the principal for use by the application. Many of the authentication providers will create a UserDetails object as the principal.

Returns:

the Principal being authenticated or the authenticated principal after authentication.

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class AbstractAuthenticationToken