Class OneTimeTokenAuthenticationProvider

java.lang.Object

org.springframework.security.authentication.ott.OneTimeTokenAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public final class OneTimeTokenAuthenticationProvider
extends Object
implements AuthenticationProvider

An AuthenticationProvider responsible for authenticating users based on one-time tokens. It uses an OneTimeTokenService to consume tokens and an UserDetailsService to fetch user authorities.

Since:

6.4

Constructor Summary

Constructors

Constructor	Description
OneTimeTokenAuthenticationProvider(OneTimeTokenService oneTimeTokenService, UserDetailsService userDetailsService)

Method Summary

Modifier and Type	Method	Description
Authentication	authenticate(Authentication authentication)	Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication) .
void	setUserDetailsChecker(UserDetailsChecker userDetailsChecker)	Use this UserDetailsChecker to verify the status of the loaded UserDetails after authentication.
boolean	supports(Class<?> authentication)	Returns true if this AuthenticationProvider supports the indicated Authentication object.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OneTimeTokenAuthenticationProvider

public OneTimeTokenAuthenticationProvider(OneTimeTokenService oneTimeTokenService,
 UserDetailsService userDetailsService)

Method Details

authenticate

public Authentication authenticate(Authentication authentication)
                            throws AuthenticationException

Description copied from interface: AuthenticationProvider

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

Specified by:

authenticate in interface AuthenticationProvider

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 - if authentication fails.

supports

public boolean supports(Class<?> authentication)

Description copied from interface: AuthenticationProvider

Returns true if this AuthenticationProvider supports the indicated Authentication object.

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

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

Specified by:

supports in interface AuthenticationProvider

Parameters:

authentication -

Returns:

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

setUserDetailsChecker

public void setUserDetailsChecker(UserDetailsChecker userDetailsChecker)

Use this UserDetailsChecker to verify the status of the loaded UserDetails after authentication.

By default, no checks are performed, keeping this provider's behavior consistent with earlier versions of Spring Security. To reject authentication for accounts that are locked, disabled, or expired, provide a AccountStatusUserDetailsChecker.

Parameters:

userDetailsChecker - the UserDetailsChecker to use

Since:

7.2