Class OAuth2AuthorizationEndpointFilter.OAuth2AuthorizationCodeRequestPreValidationFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.security.oauth2.server.authorization.web.OAuth2AuthorizationEndpointFilter.OAuth2AuthorizationCodeRequestPreValidationFilter

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

Enclosing class:

OAuth2AuthorizationEndpointFilter

public final class OAuth2AuthorizationEndpointFilter.OAuth2AuthorizationCodeRequestPreValidationFilter
extends org.springframework.web.filter.OncePerRequestFilter

A Filter that is applied before OAuth2AuthorizationEndpointFilter and handles the pre-validation of an OAuth 2.0 Authorization Code Request.

Since:

7.2

See Also:

• OAuth2AuthorizationCodeRequestAuthenticationValidator
• Section 4.1.1 Authorization Request

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
OAuth2AuthorizationCodeRequestPreValidationFilter(RegisteredClientRepository registeredClientRepository)	Constructs an OAuth2AuthorizationCodeRequestPreValidationFilter 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	setAuthenticationValidator(Consumer<OAuth2AuthorizationCodeRequestAuthenticationContext> authenticationValidator)	Sets the Consumer providing access to the OAuth2AuthorizationCodeRequestAuthenticationContext and is responsible for validating specific OAuth 2.0 Authorization Request parameters associated in the OAuth2AuthorizationCodeRequestAuthenticationToken.

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 Object

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

Constructor Details

OAuth2AuthorizationCodeRequestPreValidationFilter

public OAuth2AuthorizationCodeRequestPreValidationFilter(RegisteredClientRepository registeredClientRepository)

Constructs an OAuth2AuthorizationCodeRequestPreValidationFilter using the provided parameters.

Parameters:

registeredClientRepository - the repository of registered clients

Method Details

setAuthenticationValidator

public void setAuthenticationValidator(Consumer<OAuth2AuthorizationCodeRequestAuthenticationContext> authenticationValidator)

Sets the Consumer providing access to the OAuth2AuthorizationCodeRequestAuthenticationContext and is responsible for validating specific OAuth 2.0 Authorization Request parameters associated in the OAuth2AuthorizationCodeRequestAuthenticationToken. The default authentication validator is OAuth2AuthorizationCodeRequestAuthenticationValidator.

NOTE: The authentication validator MUST throw OAuth2AuthorizationCodeRequestAuthenticationException if validation fails.

Parameters:

authenticationValidator - the Consumer providing access to the OAuth2AuthorizationCodeRequestAuthenticationContext and is responsible for validating specific OAuth 2.0 Authorization Request parameters

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