public class

RememberMeAuthenticationProvider

extends Object
implements InitializingBean MessageSourceAware AuthenticationProvider
java.lang.Object
   ↳ org.springframework.security.authentication.RememberMeAuthenticationProvider

Class Overview

An AuthenticationProvider implementation that validates RememberMeAuthenticationTokens.

To be successfully validated, the getKeyHash() must match this class' getKey().

Summary

Fields
protected MessageSourceAccessor messages
Public Constructors
RememberMeAuthenticationProvider()
This constructor is deprecated. Use constructor injection
RememberMeAuthenticationProvider(String key)
Public Methods
void afterPropertiesSet()
Authentication authenticate(Authentication authentication)
Performs authentication with the same contract as authenticate(Authentication).
String getKey()
void setKey(String key)
This method is deprecated. Use constructor injection
void setMessageSource(MessageSource messageSource)
boolean supports(Class<?> authentication)
Returns true if this AuthenticationProvider supports the indicated Authentication object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.context.MessageSourceAware
From interface org.springframework.security.authentication.AuthenticationProvider

Fields

protected MessageSourceAccessor messages

Public Constructors

public RememberMeAuthenticationProvider ()

This constructor is deprecated.
Use constructor injection

public RememberMeAuthenticationProvider (String key)

Public Methods

public void afterPropertiesSet ()

Throws
Exception

public Authentication authenticate (Authentication authentication)

Performs authentication with the same contract as authenticate(Authentication).

Parameters
authentication the authentication request object.
Returns
  • a fully authenticated object including credentials. May return null if the AuthenticationProvider is unable to support authentication of the passed Authentication object. In such a case, the next AuthenticationProvider that supports the presented Authentication class will be tried.
Throws
AuthenticationException

public String getKey ()

public void setKey (String key)

This method is deprecated.
Use constructor injection

public void setMessageSource (MessageSource messageSource)

public boolean supports (Class<?> authentication)

Returns true if this AuthenticationProvider supports the indicated Authentication object.

Returning true does not guarantee an AuthenticationProvider will be able to authenticate the presented instance of the Authentication class. It simply indicates it can support closer evaluation of it. An AuthenticationProvider can still return null from the authenticate(Authentication) method to indicate another AuthenticationProvider should be tried.

Selection of an AuthenticationProvider capable of performing authentication is conducted at runtime the ProviderManager.

Returns
  • true if the implementation can more closely evaluate the Authentication class presented