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.-
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
ConstructorsConstructorDescriptionOidcClientRegistrationEndpointFilter
(org.springframework.security.authentication.AuthenticationManager authenticationManager) Constructs anOidcClientRegistrationEndpointFilter
using the provided parameters.OidcClientRegistrationEndpointFilter
(org.springframework.security.authentication.AuthenticationManager authenticationManager, String clientRegistrationEndpointUri) Constructs anOidcClientRegistrationEndpointFilter
using the provided parameters. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
doFilterInternal
(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain) void
setAuthenticationConverter
(org.springframework.security.web.authentication.AuthenticationConverter authenticationConverter) Sets theAuthenticationConverter
used when attempting to extract a Client Registration Request fromHttpServletRequest
to an instance ofOidcClientRegistrationAuthenticationToken
used for authenticating the request.void
setAuthenticationFailureHandler
(org.springframework.security.web.authentication.AuthenticationFailureHandler authenticationFailureHandler) Sets theAuthenticationFailureHandler
used for handling anOAuth2AuthenticationException
and returning theError Response
.void
setAuthenticationSuccessHandler
(org.springframework.security.web.authentication.AuthenticationSuccessHandler authenticationSuccessHandler) Sets theAuthenticationSuccessHandler
used for handling anOidcClientRegistrationAuthenticationToken
and returning theClient 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
-
Constructor Details
-
OidcClientRegistrationEndpointFilter
public OidcClientRegistrationEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager) Constructs anOidcClientRegistrationEndpointFilter
using the provided parameters.- Parameters:
authenticationManager
- the authentication manager
-
OidcClientRegistrationEndpointFilter
public OidcClientRegistrationEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager, String clientRegistrationEndpointUri) Constructs anOidcClientRegistrationEndpointFilter
using the provided parameters.- Parameters:
authenticationManager
- the authentication managerclientRegistrationEndpointUri
- the endpointURI
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 classorg.springframework.web.filter.OncePerRequestFilter
- Throws:
jakarta.servlet.ServletException
IOException
-
setAuthenticationConverter
public void setAuthenticationConverter(org.springframework.security.web.authentication.AuthenticationConverter authenticationConverter) Sets theAuthenticationConverter
used when attempting to extract a Client Registration Request fromHttpServletRequest
to an instance ofOidcClientRegistrationAuthenticationToken
used for authenticating the request.- Parameters:
authenticationConverter
- anAuthenticationConverter
used when attempting to extract a Client Registration Request fromHttpServletRequest
- Since:
- 0.4.0
-
setAuthenticationSuccessHandler
public void setAuthenticationSuccessHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler authenticationSuccessHandler) Sets theAuthenticationSuccessHandler
used for handling anOidcClientRegistrationAuthenticationToken
and returning theClient Registration Response
.- Parameters:
authenticationSuccessHandler
- theAuthenticationSuccessHandler
used for handling anOidcClientRegistrationAuthenticationToken
- Since:
- 0.4.0
-
setAuthenticationFailureHandler
public void setAuthenticationFailureHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler authenticationFailureHandler) Sets theAuthenticationFailureHandler
used for handling anOAuth2AuthenticationException
and returning theError Response
.- Parameters:
authenticationFailureHandler
- theAuthenticationFailureHandler
used for handling anOAuth2AuthenticationException
- Since:
- 0.4.0
-