org.springframework.security.web.authentication.preauth
Class PreAuthenticatedAuthenticationToken

java.lang.Object
  extended by org.springframework.security.authentication.AbstractAuthenticationToken
      extended by org.springframework.security.web.authentication.preauth.PreAuthenticatedAuthenticationToken
All Implemented Interfaces:
java.io.Serializable, java.security.Principal, Authentication, CredentialsContainer

public class PreAuthenticatedAuthenticationToken
extends AbstractAuthenticationToken

Authentication implementation for pre-authenticated authentication.

Since:
2.0
See Also:
Serialized Form

Constructor Summary
PreAuthenticatedAuthenticationToken(java.lang.Object aPrincipal, java.lang.Object aCredentials)
          Constructor used for an authentication request.
PreAuthenticatedAuthenticationToken(java.lang.Object aPrincipal, java.lang.Object aCredentials, java.util.Collection<? extends GrantedAuthority> anAuthorities)
          Constructor used for an authentication response.
 
Method Summary
 java.lang.Object getCredentials()
          Get the credentials
 java.lang.Object getPrincipal()
          Get the principal
 
Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PreAuthenticatedAuthenticationToken

public PreAuthenticatedAuthenticationToken(java.lang.Object aPrincipal,
                                           java.lang.Object aCredentials)
Constructor used for an authentication request. The Authentication.isAuthenticated() will return false.

Parameters:
aPrincipal - The pre-authenticated principal
aCredentials - The pre-authenticated credentials

PreAuthenticatedAuthenticationToken

public PreAuthenticatedAuthenticationToken(java.lang.Object aPrincipal,
                                           java.lang.Object aCredentials,
                                           java.util.Collection<? extends GrantedAuthority> anAuthorities)
Constructor used for an authentication response. The Authentication.isAuthenticated() will return true.

Parameters:
aPrincipal - The authenticated principal
anAuthorities - The granted authorities
Method Detail

getCredentials

public java.lang.Object getCredentials()
Get the credentials

Returns:
the credentials that prove the identity of the Principal

getPrincipal

public java.lang.Object getPrincipal()
Get the principal

Returns:
the Principal being authenticated or the authenticated principal after authentication.