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

public class RememberMeAuthenticationToken
extends AbstractAuthenticationToken
implements Serializable

Represents a remembered Authentication.

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

Version:

$Id: RememberMeAuthenticationToken.java 3925 2009-10-05 19:28:53Z ltaylor $

Author:

Ben Alex

See Also:

Serialized Form

Constructor Summary

RememberMeAuthenticationToken(String key, Object principal, Collection<GrantedAuthority> authorities)
Constructor.

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 org.springframework.security.authentication.AbstractAuthenticationToken

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

RememberMeAuthenticationToken

public RememberMeAuthenticationToken(String key,
                                     Object principal,
                                     Collection<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

Method Detail

equals

public boolean equals(Object obj)

Specified by:

equals in interface Principal

Overrides:

equals in class AbstractAuthenticationToken

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.