Class RememberMeAuthenticationToken
- All Implemented Interfaces:
Serializable
,Principal
,Authentication
,CredentialsContainer
Authentication
.
A remembered Authentication
must provide a fully valid
Authentication
, including the GrantedAuthority
s that apply.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A builder ofRememberMeAuthenticationToken
instancesNested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>
-
Constructor Summary
ConstructorsModifierConstructorDescriptionRememberMeAuthenticationToken
(String key, Object principal, Collection<? extends GrantedAuthority> authorities) Constructor.protected
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Always returns an emptyString
int
The identity of the principal being authenticated.int
hashCode()
Return anAuthentication.Builder
based on this instance.Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken
eraseCredentials, getAuthorities, getDetails, getName, isAuthenticated, setAuthenticated, setDetails, toString
-
Constructor Details
-
RememberMeAuthenticationToken
public RememberMeAuthenticationToken(String key, Object principal, Collection<? extends GrantedAuthority> authorities) Constructor.- Parameters:
key
- to identify if this object made by an authorised clientprincipal
- the principal (typically aUserDetails
)authorities
- the authorities granted to the principal- Throws:
IllegalArgumentException
- if anull
was passed
-
RememberMeAuthenticationToken
-
-
Method Details
-
getCredentials
Always returns an emptyString
- Returns:
- an empty String
-
getKeyHash
public int getKeyHash() -
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.
-
toBuilder
Description copied from interface:Authentication
Return anAuthentication.Builder
based on this instance. By default, returns a builder that builds aSimpleAuthentication
.Although a
default
method, allAuthentication
implementations should implement this. The reason is to ensure that theAuthentication
type is preserved whenAuthentication.Builder.build()
is invoked. This is especially important in the event that your authentication implementation contains custom fields.This isn't strictly necessary since it is recommended that applications code to the
Authentication
interface and that custom information is often contained in theAuthentication.getPrincipal()
value.- Returns:
- an
Authentication.Builder
for building a newAuthentication
based on this instance
-
equals
- Specified by:
equals
in interfacePrincipal
- Overrides:
equals
in classAbstractAuthenticationToken
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacePrincipal
- Overrides:
hashCode
in classAbstractAuthenticationToken
-