Package org.springframework.security.oauth2.server.authorization.oidc.web

Class OidcClientRegistrationEndpointFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.security.oauth2.server.authorization.oidc.web.OidcClientRegistrationEndpointFilter

All Implemented Interfaces:

jakarta.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public final class OidcClientRegistrationEndpointFilter
extends org.springframework.web.filter.OncePerRequestFilter

A Filter that processes OpenID Connect 1.0 Dynamic Client Registration (and Client Read) Requests.

Since:

7.0

See Also:

• OidcClientRegistration
• OidcClientRegistrationAuthenticationConverter
• OidcClientRegistrationAuthenticationProvider
• OidcClientConfigurationAuthenticationProvider
• 3. Client Registration Endpoint
• 4. Client Configuration Endpoint

Field Summary

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor	Description
OidcClientRegistrationEndpointFilter(AuthenticationManager authenticationManager)	Constructs an OidcClientRegistrationEndpointFilter using the provided parameters.
OidcClientRegistrationEndpointFilter(AuthenticationManager authenticationManager, String clientRegistrationEndpointUri)	Constructs an OidcClientRegistrationEndpointFilter using the provided parameters.

Method Summary

Modifier and Type	Method	Description
protected void	doFilterInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain)
void	setAuthenticationConverter(AuthenticationConverter authenticationConverter)	Sets the AuthenticationConverter used when attempting to extract a Client Registration Request from HttpServletRequest to an instance of OidcClientRegistrationAuthenticationToken used for authenticating the request.
void	setAuthenticationFailureHandler(AuthenticationFailureHandler authenticationFailureHandler)	Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException and returning the Error Response.
void	setAuthenticationSuccessHandler(AuthenticationSuccessHandler authenticationSuccessHandler)	Sets the AuthenticationSuccessHandler used for handling an OidcClientRegistrationAuthenticationToken and returning the Client Registration Response.

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Details

OidcClientRegistrationEndpointFilter

public OidcClientRegistrationEndpointFilter(AuthenticationManager authenticationManager)

Constructs an OidcClientRegistrationEndpointFilter using the provided parameters.

Parameters:

authenticationManager - the authentication manager

OidcClientRegistrationEndpointFilter

public OidcClientRegistrationEndpointFilter(AuthenticationManager authenticationManager,
 String clientRegistrationEndpointUri)

Constructs an OidcClientRegistrationEndpointFilter using the provided parameters.

Parameters:

authenticationManager - the authentication manager

clientRegistrationEndpointUri - the endpoint URI for OpenID Client Registration requests

Method Details

doFilterInternal

protected void doFilterInternal(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain filterChain)
                         throws jakarta.servlet.ServletException,
IOException

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

jakarta.servlet.ServletException

IOException

setAuthenticationConverter

public void setAuthenticationConverter(AuthenticationConverter authenticationConverter)

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

Parameters:

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

setAuthenticationSuccessHandler

public void setAuthenticationSuccessHandler(AuthenticationSuccessHandler authenticationSuccessHandler)

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

Parameters:

authenticationSuccessHandler - the AuthenticationSuccessHandler used for handling an OidcClientRegistrationAuthenticationToken

setAuthenticationFailureHandler

public void setAuthenticationFailureHandler(AuthenticationFailureHandler authenticationFailureHandler)

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

Parameters:

authenticationFailureHandler - the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException