Class RememberMeAuthenticationToken

  extended by
      extended by
All Implemented Interfaces:
Serializable, Principal, Authentication, CredentialsContainer

public class RememberMeAuthenticationToken
extends AbstractAuthenticationToken

Represents a remembered Authentication.

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

See Also:
Serialized Form

Constructor Summary
RememberMeAuthenticationToken(String key, Object principal, Collection<? extends GrantedAuthority> authorities)
Method Summary
 boolean equals(Object obj)
 Object getCredentials()
          Always returns an empty String
 int getKeyHash()
 Object getPrincipal()
          The identity of the principal being authenticated.
Methods inherited from class
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


public RememberMeAuthenticationToken(String key,
                                     Object principal,
                                     Collection<? extends GrantedAuthority> authorities)

key - to identify if this object made by an authorised client
principal - the principal (typically a UserDetails)
authorities - the authorities granted to the principal
IllegalArgumentException - if a null was passed
Method Detail


public Object getCredentials()
Always returns an empty String

an empty String


public int getKeyHash()


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.

the Principal being authenticated or the authenticated principal after authentication.


public boolean equals(Object obj)
Specified by:
equals in interface Principal
equals in class AbstractAuthenticationToken