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

Class OidcClientRegistrationEndpointConfigurer

java.lang.Object

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

public final class OidcClientRegistrationEndpointConfigurer
extends Object

Configurer for OpenID Connect 1.0 Dynamic Client Registration Endpoint.

Since:

7.0

See Also:

• OidcConfigurer.clientRegistrationEndpoint(org.springframework.security.config.Customizer<org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization.OidcClientRegistrationEndpointConfigurer>)
• OidcClientRegistrationEndpointFilter

Method Summary

Modifier and Type	Method	Description
OidcClientRegistrationEndpointConfigurer	authenticationProvider(AuthenticationProvider authenticationProvider)	Adds an AuthenticationProvider used for authenticating an OidcClientRegistrationAuthenticationToken.
OidcClientRegistrationEndpointConfigurer	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.
OidcClientRegistrationEndpointConfigurer	clientRegistrationRequestConverter(AuthenticationConverter clientRegistrationRequestConverter)	Adds an AuthenticationConverter used when attempting to extract a Client Registration Request from HttpServletRequest to an instance of OidcClientRegistrationAuthenticationToken used for authenticating the request.
OidcClientRegistrationEndpointConfigurer	clientRegistrationRequestConverters(Consumer<List<AuthenticationConverter>> clientRegistrationRequestConvertersConsumer)	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.
OidcClientRegistrationEndpointConfigurer	clientRegistrationResponseHandler(AuthenticationSuccessHandler clientRegistrationResponseHandler)	Sets the AuthenticationSuccessHandler used for handling an OidcClientRegistrationAuthenticationToken and returning the Client Registration Response.
OidcClientRegistrationEndpointConfigurer	errorResponseHandler(AuthenticationFailureHandler errorResponseHandler)	Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException 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

clientRegistrationRequestConverter

public OidcClientRegistrationEndpointConfigurer clientRegistrationRequestConverter(AuthenticationConverter clientRegistrationRequestConverter)

Adds an AuthenticationConverter used when attempting to extract a Client Registration Request from HttpServletRequest to an instance of OidcClientRegistrationAuthenticationToken used for authenticating the request.

Parameters:

clientRegistrationRequestConverter - an AuthenticationConverter used when attempting to extract a Client Registration Request from HttpServletRequest

Returns:

the OidcClientRegistrationEndpointConfigurer for further configuration

clientRegistrationRequestConverters

public OidcClientRegistrationEndpointConfigurer clientRegistrationRequestConverters(Consumer<List<AuthenticationConverter>> clientRegistrationRequestConvertersConsumer)

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:

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

Returns:

the OidcUserInfoEndpointConfigurer for further configuration

authenticationProvider

public OidcClientRegistrationEndpointConfigurer authenticationProvider(AuthenticationProvider authenticationProvider)

Adds an AuthenticationProvider used for authenticating an OidcClientRegistrationAuthenticationToken.

Parameters:

authenticationProvider - an AuthenticationProvider used for authenticating an OidcClientRegistrationAuthenticationToken

Returns:

the OidcClientRegistrationEndpointConfigurer for further configuration

authenticationProviders

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

clientRegistrationResponseHandler

public OidcClientRegistrationEndpointConfigurer clientRegistrationResponseHandler(AuthenticationSuccessHandler clientRegistrationResponseHandler)

Sets the AuthenticationSuccessHandler used for handling an OidcClientRegistrationAuthenticationToken and returning the Client Registration Response.

Parameters:

clientRegistrationResponseHandler - the AuthenticationSuccessHandler used for handling an OidcClientRegistrationAuthenticationToken

Returns:

the OidcClientRegistrationEndpointConfigurer for further configuration

errorResponseHandler

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

postProcess

protected final <T> T postProcess(T object)

getObjectPostProcessor

protected final ObjectPostProcessor<Object> getObjectPostProcessor()