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

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:

7.0

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

Constructors

Constructor	Description
OAuth2ClientAuthenticationFilter(AuthenticationManager authenticationManager, RequestMatcher requestMatcher)	Constructs an OAuth2ClientAuthenticationFilter 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 client credentials from HttpServletRequest to an instance of OAuth2ClientAuthenticationToken used for authenticating the client.
void	setAuthenticationFailureHandler(AuthenticationFailureHandler authenticationFailureHandler)	Sets the AuthenticationFailureHandler used for handling a failed client authentication and returning the Error Response.
void	setAuthenticationSuccessHandler(AuthenticationSuccessHandler authenticationSuccessHandler)	Sets the AuthenticationSuccessHandler used for handling a successful client authentication and associating the OAuth2ClientAuthenticationToken to the SecurityContext.

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

OAuth2ClientAuthenticationFilter

public OAuth2ClientAuthenticationFilter(AuthenticationManager authenticationManager,
 RequestMatcher requestMatcher)

Constructs an OAuth2ClientAuthenticationFilter using the provided parameters.

Parameters:

authenticationManager - the AuthenticationManager used for authenticating the client

requestMatcher - the RequestMatcher used for matching against the HttpServletRequest

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 client credentials from HttpServletRequest to an instance of OAuth2ClientAuthenticationToken used for authenticating the client.

Parameters:

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

setAuthenticationSuccessHandler

public void setAuthenticationSuccessHandler(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

setAuthenticationFailureHandler

public void setAuthenticationFailureHandler(AuthenticationFailureHandler authenticationFailureHandler)

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

Parameters:

authenticationFailureHandler - the AuthenticationFailureHandler used for handling a failed client authentication