Package org.springframework.security.web.authentication.preauth

Class PreAuthenticatedAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class PreAuthenticatedAuthenticationToken
extends AbstractAuthenticationToken

Authentication implementation for pre-authenticated authentication.

Since:

2.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PreAuthenticatedAuthenticationToken(Object aPrincipal, Object aCredentials)	Constructor used for an authentication request.
PreAuthenticatedAuthenticationToken(Object aPrincipal, Object aCredentials, Collection<? extends GrantedAuthority> anAuthorities)	Constructor used for an authentication response.

Method Summary

Modifier and Type	Method	Description
Object	getCredentials()	Get the credentials
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

Methods inherited from interface java.security.Principal

implies

Constructor Details

PreAuthenticatedAuthenticationToken

public PreAuthenticatedAuthenticationToken(Object aPrincipal,
 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(Object aPrincipal,
 Object aCredentials,
 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 Details

getCredentials

public Object getCredentials()

Get the credentials

Returns:

the credentials that prove the identity of the Principal

getPrincipal

public Object getPrincipal()

Get the principal

Returns:

the Principal being authenticated or the authenticated principal after authentication.