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

Class OAuth2TokenIntrospectionEndpointFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

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

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 OAuth2TokenIntrospectionEndpointFilter
extends org.springframework.web.filter.OncePerRequestFilter

A Filter for the OAuth 2.0 Token Introspection endpoint.

Since:

7.0

See Also:

• OAuth2TokenIntrospectionAuthenticationProvider
• Section 2 Introspection Endpoint
• Section 2.1 Introspection 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
OAuth2TokenIntrospectionEndpointFilter(AuthenticationManager authenticationManager)	Constructs an OAuth2TokenIntrospectionEndpointFilter using the provided parameters.
OAuth2TokenIntrospectionEndpointFilter(AuthenticationManager authenticationManager, String tokenIntrospectionEndpointUri)	Constructs an OAuth2TokenIntrospectionEndpointFilter 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 an Introspection Request from HttpServletRequest to an instance of OAuth2TokenIntrospectionAuthenticationToken used for authenticating the request.
void	setAuthenticationFailureHandler(AuthenticationFailureHandler authenticationFailureHandler)	Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException and returning the Error Resonse.
void	setAuthenticationSuccessHandler(AuthenticationSuccessHandler authenticationSuccessHandler)	Sets the AuthenticationSuccessHandler used for handling an OAuth2TokenIntrospectionAuthenticationToken.

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

OAuth2TokenIntrospectionEndpointFilter

public OAuth2TokenIntrospectionEndpointFilter(AuthenticationManager authenticationManager)

Constructs an OAuth2TokenIntrospectionEndpointFilter using the provided parameters.

Parameters:

authenticationManager - the authentication manager

OAuth2TokenIntrospectionEndpointFilter

public OAuth2TokenIntrospectionEndpointFilter(AuthenticationManager authenticationManager,
 String tokenIntrospectionEndpointUri)

Constructs an OAuth2TokenIntrospectionEndpointFilter using the provided parameters.

Parameters:

authenticationManager - the authentication manager

tokenIntrospectionEndpointUri - the endpoint URI for token introspection 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 an Introspection Request from HttpServletRequest to an instance of OAuth2TokenIntrospectionAuthenticationToken used for authenticating the request.

Parameters:

authenticationConverter - the AuthenticationConverter used when attempting to extract an Introspection Request from HttpServletRequest

setAuthenticationSuccessHandler

public void setAuthenticationSuccessHandler(AuthenticationSuccessHandler authenticationSuccessHandler)

Sets the AuthenticationSuccessHandler used for handling an OAuth2TokenIntrospectionAuthenticationToken.

Parameters:

authenticationSuccessHandler - the AuthenticationSuccessHandler used for handling an OAuth2TokenIntrospectionAuthenticationToken

setAuthenticationFailureHandler

public void setAuthenticationFailureHandler(AuthenticationFailureHandler authenticationFailureHandler)

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

Parameters:

authenticationFailureHandler - the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException