public abstract class AbstractAuthenticationToken extends Object implements Authentication
Authentication objects.Implementations which use this class should be immutable.
| Constructor and Description |
|---|
AbstractAuthenticationToken()
Deprecated.
in favour of the constructor which takes a
GrantedAuthority[] argument. |
AbstractAuthenticationToken(GrantedAuthority[] authorities)
Creates a token with the supplied array of authorities.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
GrantedAuthority[] |
getAuthorities()
Set by an
AuthenticationManager to indicate the authorities that the principal has been
granted. |
Object |
getDetails()
Stores additional details about the authentication request.
|
String |
getName() |
int |
hashCode() |
boolean |
isAuthenticated()
Used to indicate to
AbstractSecurityInterceptor whether it should present the
authentication token to the AuthenticationManager. |
void |
setAuthenticated(boolean authenticated)
See
Authentication.isAuthenticated() for a full description. |
void |
setDetails(Object details) |
String |
toString() |
clone, finalize, getClass, notify, notifyAll, wait, wait, waitgetCredentials, getPrincipalpublic AbstractAuthenticationToken()
GrantedAuthority[] argument.public AbstractAuthenticationToken(GrantedAuthority[] authorities)
authorities - the list of GrantedAuthoritys for the
principal represented by this authentication object. A
null value indicates that no authorities have been
granted (pursuant to the interface contract specified by Authentication.getAuthorities()null should only be
presented if the principal has not been authenticated).public boolean equals(Object obj)
public GrantedAuthority[] getAuthorities()
AuthenticationAuthenticationManager to indicate the authorities that the principal has been
granted. Note that classes should not rely on this value as being valid unless it has been set by a trusted
AuthenticationManager.Implementations should ensure that modifications to the returned array do not affect the state of the Authentication object (e.g. by returning an array copy).
getAuthorities in interface Authenticationnull if authentication has not been completedpublic Object getDetails()
AuthenticationgetDetails in interface Authenticationnull if not usedpublic int hashCode()
public boolean isAuthenticated()
AuthenticationAbstractSecurityInterceptor whether it should present the
authentication token to the AuthenticationManager. Typically an AuthenticationManager
(or, more often, one of its AuthenticationProviders) will return an immutable authentication token
after successful authentication, in which case that token can safely return true to this method.
Returning true will improve performance, as calling the AuthenticationManager for
every request will no longer be necessary.For security reasons, implementations of this interface
should be very careful about returning true to this method unless they are either immutable, or
have some way of ensuring the properties have not been changed since original creation.
isAuthenticated in interface AuthenticationAbstractSecurityInterceptor does not need
to represent the token for re-authentication to the AuthenticationManagerpublic void setAuthenticated(boolean authenticated)
AuthenticationAuthentication.isAuthenticated() for a full description.Implementations should always allow this
method to be called with a false parameter, as this is used by various classes to specify the
authentication token should not be trusted. If an implementation wishes to reject an invocation with a
true parameter (which would indicate the authentication token is trusted - a potential security
risk) the implementation should throw an IllegalArgumentException.
setAuthenticated in interface Authenticationauthenticated - true if the token should be trusted (which may result in an exception) or
false if the token should not be trustedpublic void setDetails(Object details)
Copyright © 2024. All rights reserved.