Package org.springframework.security.authentication

Class RememberMeAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.authentication.RememberMeAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, Authentication, BuildableAuthentication, CredentialsContainer

public class RememberMeAuthenticationToken
extends AbstractAuthenticationToken
implements BuildableAuthentication

Represents a remembered Authentication.

A remembered Authentication must provide a fully valid Authentication, including the GrantedAuthoritys that apply.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RememberMeAuthenticationToken.Builder<B extends RememberMeAuthenticationToken.Builder<B>>	A builder of RememberMeAuthenticationToken instances

Nested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
	RememberMeAuthenticationToken(String key, Object principal, Collection<? extends GrantedAuthority> authorities)	Constructor.
protected	RememberMeAuthenticationToken(RememberMeAuthenticationToken.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Object	getCredentials()	Always returns an empty String
int	getKeyHash()
Object	getPrincipal()	The identity of the principal being authenticated.
int	hashCode()
RememberMeAuthenticationToken.Builder<?>	toBuilder()	Return an Authentication.Builder based on this instance.

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

eraseCredentials, getAuthorities, getDetails, getName, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.security.core.Authentication

getAuthorities, getDetails, isAuthenticated, setAuthenticated

Methods inherited from interface java.security.Principal

getName, implies, 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 client

principal - the principal (typically a UserDetails)

authorities - the authorities granted to the principal

Throws:

IllegalArgumentException - if a null was passed

RememberMeAuthenticationToken

protected RememberMeAuthenticationToken(RememberMeAuthenticationToken.Builder<?> builder)

Method Details

getCredentials

public Object getCredentials()

Always returns an empty String

Specified by:

getCredentials in interface Authentication

Returns:

an empty String

getKeyHash

public int getKeyHash()

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.

Specified by:

getPrincipal in interface Authentication

Returns:

the Principal being authenticated or the authenticated principal after authentication.

toBuilder

public RememberMeAuthenticationToken.Builder<?> toBuilder()

Description copied from interface: BuildableAuthentication

Return an Authentication.Builder based on this instance.

Although a default method, all BuildableAuthentication implementations should implement this. The reason is to ensure that the BuildableAuthentication type is preserved when Authentication.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 the Authentication.getPrincipal() value.

Specified by:

toBuilder in interface BuildableAuthentication

Returns:

an Authentication.Builder for building a new Authentication based on this instance

equals

public boolean equals(Object obj)

Specified by:

equals in interface Principal

Overrides:

equals in class AbstractAuthenticationToken

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class AbstractAuthenticationToken