Package org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization

Class OAuth2DeviceAuthorizationEndpointConfigurer

java.lang.Object

org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization.OAuth2DeviceAuthorizationEndpointConfigurer

public final class OAuth2DeviceAuthorizationEndpointConfigurer
extends Object

Configurer for the OAuth 2.0 Device Authorization Endpoint.

Since:

7.0

See Also:

• OAuth2AuthorizationServerConfigurer.deviceAuthorizationEndpoint(org.springframework.security.config.Customizer<org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization.OAuth2DeviceAuthorizationEndpointConfigurer>)
• OAuth2DeviceAuthorizationEndpointFilter

Method Summary

Modifier and Type	Method	Description
OAuth2DeviceAuthorizationEndpointConfigurer	authenticationProvider(AuthenticationProvider authenticationProvider)	Adds an AuthenticationProvider used for authenticating an OAuth2DeviceAuthorizationRequestAuthenticationToken.
OAuth2DeviceAuthorizationEndpointConfigurer	authenticationProviders(Consumer<List<AuthenticationProvider>> authenticationProvidersConsumer)	Sets the Consumer providing access to the List of default and (optionally) added AuthenticationProvider's allowing the ability to add, remove, or customize a specific AuthenticationProvider.
void	configure(HttpSecurity builder)
OAuth2DeviceAuthorizationEndpointConfigurer	deviceAuthorizationRequestConverter(AuthenticationConverter deviceAuthorizationRequestConverter)	Sets the AuthenticationConverter used when attempting to extract a Device Authorization Request from HttpServletRequest to an instance of OAuth2DeviceAuthorizationRequestAuthenticationToken used for authenticating the request.
OAuth2DeviceAuthorizationEndpointConfigurer	deviceAuthorizationRequestConverters(Consumer<List<AuthenticationConverter>> deviceAuthorizationRequestConvertersConsumer)	Sets the Consumer providing access to the List of default and (optionally) added AuthenticationConverter's allowing the ability to add, remove, or customize a specific AuthenticationConverter.
OAuth2DeviceAuthorizationEndpointConfigurer	deviceAuthorizationResponseHandler(AuthenticationSuccessHandler deviceAuthorizationResponseHandler)	Sets the AuthenticationSuccessHandler used for handling an OAuth2DeviceAuthorizationRequestAuthenticationToken and returning the Device Authorization Response.
OAuth2DeviceAuthorizationEndpointConfigurer	errorResponseHandler(AuthenticationFailureHandler errorResponseHandler)	Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException and returning the Error Response.
protected final ObjectPostProcessor<Object>	getObjectPostProcessor()
void	init(HttpSecurity builder)
protected final <T> T	postProcess(T object)
OAuth2DeviceAuthorizationEndpointConfigurer	verificationUri(String verificationUri)	Sets the end-user verification URI on the authorization server.

Methods inherited from class java.lang.Object

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

Method Details

deviceAuthorizationRequestConverter

public OAuth2DeviceAuthorizationEndpointConfigurer deviceAuthorizationRequestConverter(AuthenticationConverter deviceAuthorizationRequestConverter)

Sets the AuthenticationConverter used when attempting to extract a Device Authorization Request from HttpServletRequest to an instance of OAuth2DeviceAuthorizationRequestAuthenticationToken used for authenticating the request.

Parameters:

deviceAuthorizationRequestConverter - the AuthenticationConverter used when attempting to extract a Device Authorization Request from HttpServletRequest

Returns:

the OAuth2DeviceAuthorizationEndpointConfigurer for further configuration

deviceAuthorizationRequestConverters

public OAuth2DeviceAuthorizationEndpointConfigurer deviceAuthorizationRequestConverters(Consumer<List<AuthenticationConverter>> deviceAuthorizationRequestConvertersConsumer)

Sets the Consumer providing access to the List of default and (optionally) added AuthenticationConverter's allowing the ability to add, remove, or customize a specific AuthenticationConverter.

Parameters:

deviceAuthorizationRequestConvertersConsumer - the Consumer providing access to the List of default and (optionally) added AuthenticationConverter's

Returns:

the OAuth2DeviceAuthorizationEndpointConfigurer for further configuration

authenticationProvider

public OAuth2DeviceAuthorizationEndpointConfigurer authenticationProvider(AuthenticationProvider authenticationProvider)

Adds an AuthenticationProvider used for authenticating an OAuth2DeviceAuthorizationRequestAuthenticationToken.

Parameters:

authenticationProvider - an AuthenticationProvider used for authenticating an OAuth2DeviceAuthorizationRequestAuthenticationToken

Returns:

the OAuth2DeviceAuthorizationEndpointConfigurer for further configuration

authenticationProviders

public OAuth2DeviceAuthorizationEndpointConfigurer authenticationProviders(Consumer<List<AuthenticationProvider>> authenticationProvidersConsumer)

Sets the Consumer providing access to the List of default and (optionally) added AuthenticationProvider's allowing the ability to add, remove, or customize a specific AuthenticationProvider.

Parameters:

authenticationProvidersConsumer - the Consumer providing access to the List of default and (optionally) added AuthenticationProvider's

Returns:

the OAuth2DeviceAuthorizationEndpointConfigurer for further configuration

deviceAuthorizationResponseHandler

public OAuth2DeviceAuthorizationEndpointConfigurer deviceAuthorizationResponseHandler(AuthenticationSuccessHandler deviceAuthorizationResponseHandler)

Sets the AuthenticationSuccessHandler used for handling an OAuth2DeviceAuthorizationRequestAuthenticationToken and returning the Device Authorization Response.

Parameters:

deviceAuthorizationResponseHandler - the AuthenticationSuccessHandler used for handling an OAuth2DeviceAuthorizationRequestAuthenticationToken

Returns:

the OAuth2DeviceAuthorizationEndpointConfigurer for further configuration

errorResponseHandler

public OAuth2DeviceAuthorizationEndpointConfigurer errorResponseHandler(AuthenticationFailureHandler errorResponseHandler)

Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException and returning the Error Response.

Parameters:

errorResponseHandler - the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException

Returns:

the OAuth2DeviceAuthorizationEndpointConfigurer for further configuration

verificationUri

public OAuth2DeviceAuthorizationEndpointConfigurer verificationUri(String verificationUri)

Sets the end-user verification URI on the authorization server.

Parameters:

verificationUri - the end-user verification URI on the authorization server

Returns:

the OAuth2DeviceAuthorizationEndpointConfigurer for further configuration

init

public void init(HttpSecurity builder)

configure

public void configure(HttpSecurity builder)

postProcess

protected final <T> T postProcess(T object)

getObjectPostProcessor

protected final ObjectPostProcessor<Object> getObjectPostProcessor()