Class OAuth2DeviceAuthorizationRequestAuthenticationProvider

java.lang.Object

org.springframework.security.oauth2.server.authorization.authentication.OAuth2DeviceAuthorizationRequestAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public final class OAuth2DeviceAuthorizationRequestAuthenticationProvider
extends Object
implements AuthenticationProvider

An AuthenticationProvider implementation for the Device Authorization Request used in the OAuth 2.0 Device Authorization Grant.

Since:

7.0

See Also:

• OAuth2DeviceAuthorizationRequestAuthenticationToken
• OAuth2DeviceVerificationAuthenticationProvider
• OAuth2DeviceAuthorizationConsentAuthenticationProvider
• OAuth2DeviceCodeAuthenticationProvider
• OAuth2AuthorizationService
• OAuth2TokenGenerator
• OAuth 2.0 Device Authorization Grant
• Section 3.1 Device Authorization Request

Constructor Summary

Constructors

Constructor	Description
OAuth2DeviceAuthorizationRequestAuthenticationProvider(OAuth2AuthorizationService authorizationService)	Constructs an OAuth2DeviceAuthorizationRequestAuthenticationProvider using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Authentication	authenticate(Authentication authentication)	Performs authentication with the same contract as AuthenticationManager.authenticate(Authentication) .
void	setDeviceCodeGenerator(OAuth2TokenGenerator<OAuth2DeviceCode> deviceCodeGenerator)	Sets the OAuth2TokenGenerator that generates the OAuth2DeviceCode.
void	setUserCodeGenerator(OAuth2TokenGenerator<OAuth2UserCode> userCodeGenerator)	Sets the OAuth2TokenGenerator that generates the OAuth2UserCode.
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

OAuth2DeviceAuthorizationRequestAuthenticationProvider

public OAuth2DeviceAuthorizationRequestAuthenticationProvider(OAuth2AuthorizationService authorizationService)

Constructs an OAuth2DeviceAuthorizationRequestAuthenticationProvider using the provided parameters.

Parameters:

authorizationService - the authorization service

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

setDeviceCodeGenerator

public void setDeviceCodeGenerator(OAuth2TokenGenerator<OAuth2DeviceCode> deviceCodeGenerator)

Sets the OAuth2TokenGenerator that generates the OAuth2DeviceCode.

Parameters:

deviceCodeGenerator - the OAuth2TokenGenerator that generates the OAuth2DeviceCode

setUserCodeGenerator

public void setUserCodeGenerator(OAuth2TokenGenerator<OAuth2UserCode> userCodeGenerator)

Sets the OAuth2TokenGenerator that generates the OAuth2UserCode.

Parameters:

userCodeGenerator - the OAuth2TokenGenerator that generates the OAuth2UserCode