Class OAuth2ClientAuthenticationFilter
java.lang.Object
org.springframework.web.filter.GenericFilterBean
org.springframework.web.filter.OncePerRequestFilter
org.springframework.security.oauth2.server.authorization.web.OAuth2ClientAuthenticationFilter
- 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 OAuth2ClientAuthenticationFilter
extends org.springframework.web.filter.OncePerRequestFilter
A
Filter
that processes an authentication request for an OAuth 2.0 Client.- Since:
- 0.0.1
- See Also:
-
AuthenticationManager
JwtClientAssertionAuthenticationConverter
JwtClientAssertionAuthenticationProvider
X509ClientCertificateAuthenticationConverter
X509ClientCertificateAuthenticationProvider
ClientSecretBasicAuthenticationConverter
ClientSecretPostAuthenticationConverter
ClientSecretAuthenticationProvider
PublicClientAuthenticationConverter
PublicClientAuthenticationProvider
- Section 2.3 Client Authentication
- Section 3.2.1 Token Endpoint Client Authentication
-
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
ConstructorsConstructorDescriptionOAuth2ClientAuthenticationFilter
(org.springframework.security.authentication.AuthenticationManager authenticationManager, org.springframework.security.web.util.matcher.RequestMatcher requestMatcher) Constructs anOAuth2ClientAuthenticationFilter
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 client credentials fromHttpServletRequest
to an instance ofOAuth2ClientAuthenticationToken
used for authenticating the client.void
setAuthenticationFailureHandler
(org.springframework.security.web.authentication.AuthenticationFailureHandler authenticationFailureHandler) Sets theAuthenticationFailureHandler
used for handling a failed client authentication and returning theError Response
.void
setAuthenticationSuccessHandler
(org.springframework.security.web.authentication.AuthenticationSuccessHandler authenticationSuccessHandler) Sets theAuthenticationSuccessHandler
used for handling a successful client authentication and associating theOAuth2ClientAuthenticationToken
to theSecurityContext
.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
-
OAuth2ClientAuthenticationFilter
public OAuth2ClientAuthenticationFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager, org.springframework.security.web.util.matcher.RequestMatcher requestMatcher) Constructs anOAuth2ClientAuthenticationFilter
using the provided parameters.- Parameters:
authenticationManager
- theAuthenticationManager
used for authenticating the clientrequestMatcher
- theRequestMatcher
used for matching against theHttpServletRequest
-
-
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 client credentials fromHttpServletRequest
to an instance ofOAuth2ClientAuthenticationToken
used for authenticating the client.- Parameters:
authenticationConverter
- theAuthenticationConverter
used when attempting to extract client credentials fromHttpServletRequest
-
setAuthenticationSuccessHandler
public void setAuthenticationSuccessHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler authenticationSuccessHandler) Sets theAuthenticationSuccessHandler
used for handling a successful client authentication and associating theOAuth2ClientAuthenticationToken
to theSecurityContext
.- Parameters:
authenticationSuccessHandler
- theAuthenticationSuccessHandler
used for handling a successful client authentication
-
setAuthenticationFailureHandler
public void setAuthenticationFailureHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler authenticationFailureHandler) Sets theAuthenticationFailureHandler
used for handling a failed client authentication and returning theError Response
.- Parameters:
authenticationFailureHandler
- theAuthenticationFailureHandler
used for handling a failed client authentication
-