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

Class OAuth2ClientAuthenticationConfigurer

java.lang.Object

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

public final class OAuth2ClientAuthenticationConfigurer
extends Object

Configurer for OAuth 2.0 Client Authentication.

Since:

7.0

See Also:

• OAuth2AuthorizationServerConfigurer.clientAuthentication(org.springframework.security.config.Customizer<org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization.OAuth2ClientAuthenticationConfigurer>)
• OAuth2ClientAuthenticationFilter

Method Summary

Modifier and Type	Method	Description
OAuth2ClientAuthenticationConfigurer	authenticationConverter(AuthenticationConverter authenticationConverter)	Adds an AuthenticationConverter used when attempting to extract client credentials from HttpServletRequest to an instance of OAuth2ClientAuthenticationToken used for authenticating the client.
OAuth2ClientAuthenticationConfigurer	authenticationConverters(Consumer<List<AuthenticationConverter>> authenticationConvertersConsumer)	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.
OAuth2ClientAuthenticationConfigurer	authenticationProvider(AuthenticationProvider authenticationProvider)	Adds an AuthenticationProvider used for authenticating an OAuth2ClientAuthenticationToken.
OAuth2ClientAuthenticationConfigurer	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.
OAuth2ClientAuthenticationConfigurer	authenticationSuccessHandler(AuthenticationSuccessHandler authenticationSuccessHandler)	Sets the AuthenticationSuccessHandler used for handling a successful client authentication and associating the OAuth2ClientAuthenticationToken to the SecurityContext.
OAuth2ClientAuthenticationConfigurer	errorResponseHandler(AuthenticationFailureHandler errorResponseHandler)	Sets the AuthenticationFailureHandler used for handling a failed client authentication and returning the Error Response.
protected final ObjectPostProcessor<Object>	getObjectPostProcessor()
protected final <T> T	postProcess(T object)

Methods inherited from class java.lang.Object

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

Method Details

authenticationConverter

public OAuth2ClientAuthenticationConfigurer authenticationConverter(AuthenticationConverter authenticationConverter)

Adds an AuthenticationConverter used when attempting to extract client credentials from HttpServletRequest to an instance of OAuth2ClientAuthenticationToken used for authenticating the client.

Parameters:

authenticationConverter - an AuthenticationConverter used when attempting to extract client credentials from HttpServletRequest

Returns:

the OAuth2ClientAuthenticationConfigurer for further configuration

authenticationConverters

public OAuth2ClientAuthenticationConfigurer authenticationConverters(Consumer<List<AuthenticationConverter>> authenticationConvertersConsumer)

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:

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

Returns:

the OAuth2ClientAuthenticationConfigurer for further configuration

authenticationProvider

public OAuth2ClientAuthenticationConfigurer authenticationProvider(AuthenticationProvider authenticationProvider)

Adds an AuthenticationProvider used for authenticating an OAuth2ClientAuthenticationToken.

Parameters:

authenticationProvider - an AuthenticationProvider used for authenticating an OAuth2ClientAuthenticationToken

Returns:

the OAuth2ClientAuthenticationConfigurer for further configuration

authenticationProviders

public OAuth2ClientAuthenticationConfigurer 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 OAuth2ClientAuthenticationConfigurer for further configuration

authenticationSuccessHandler

public OAuth2ClientAuthenticationConfigurer authenticationSuccessHandler(AuthenticationSuccessHandler authenticationSuccessHandler)

Sets the AuthenticationSuccessHandler used for handling a successful client authentication and associating the OAuth2ClientAuthenticationToken to the SecurityContext.

Parameters:

authenticationSuccessHandler - the AuthenticationSuccessHandler used for handling a successful client authentication

Returns:

the OAuth2ClientAuthenticationConfigurer for further configuration

errorResponseHandler

public OAuth2ClientAuthenticationConfigurer errorResponseHandler(AuthenticationFailureHandler errorResponseHandler)

Sets the AuthenticationFailureHandler used for handling a failed client authentication and returning the Error Response.

Parameters:

errorResponseHandler - the AuthenticationFailureHandler used for handling a failed client authentication

Returns:

the OAuth2ClientAuthenticationConfigurer for further configuration

postProcess

protected final <T> T postProcess(T object)

getObjectPostProcessor

protected final ObjectPostProcessor<Object> getObjectPostProcessor()