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

Class OAuth2TokenRevocationEndpointFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

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

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

A Filter for the OAuth 2.0 Token Revocation endpoint.

Since:

0.0.3

See Also:

• OAuth2TokenRevocationAuthenticationProvider
• Section 2 Token Revocation
• Section 2.1 Revocation 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
OAuth2TokenRevocationEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager)	Constructs an OAuth2TokenRevocationEndpointFilter using the provided parameters.
OAuth2TokenRevocationEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager, String tokenRevocationEndpointUri)	Constructs an OAuth2TokenRevocationEndpointFilter 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(org.springframework.security.web.authentication.AuthenticationConverter authenticationConverter)	Sets the AuthenticationConverter used when attempting to extract a Revoke Token Request from HttpServletRequest to an instance of OAuth2TokenRevocationAuthenticationToken used for authenticating the request.
void	setAuthenticationDetailsSource(org.springframework.security.authentication.AuthenticationDetailsSource<jakarta.servlet.http.HttpServletRequest,?> authenticationDetailsSource)	Sets the AuthenticationDetailsSource used for building an authentication details instance from HttpServletRequest.
void	setAuthenticationFailureHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler authenticationFailureHandler)	Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException and returning the Error Response.
void	setAuthenticationSuccessHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler authenticationSuccessHandler)	Sets the AuthenticationSuccessHandler used for handling an OAuth2TokenRevocationAuthenticationToken.

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

OAuth2TokenRevocationEndpointFilter

public OAuth2TokenRevocationEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager)

Constructs an OAuth2TokenRevocationEndpointFilter using the provided parameters.

Parameters:

authenticationManager - the authentication manager

OAuth2TokenRevocationEndpointFilter

public OAuth2TokenRevocationEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager,
 String tokenRevocationEndpointUri)

Constructs an OAuth2TokenRevocationEndpointFilter using the provided parameters.

Parameters:

authenticationManager - the authentication manager

tokenRevocationEndpointUri - the endpoint URI for token revocation 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

setAuthenticationDetailsSource

public void setAuthenticationDetailsSource(org.springframework.security.authentication.AuthenticationDetailsSource<jakarta.servlet.http.HttpServletRequest,?> authenticationDetailsSource)

Sets the AuthenticationDetailsSource used for building an authentication details instance from HttpServletRequest.

Parameters:

authenticationDetailsSource - the AuthenticationDetailsSource used for building an authentication details instance from HttpServletRequest

Since:

1.4

setAuthenticationConverter

public void setAuthenticationConverter(org.springframework.security.web.authentication.AuthenticationConverter authenticationConverter)

Sets the AuthenticationConverter used when attempting to extract a Revoke Token Request from HttpServletRequest to an instance of OAuth2TokenRevocationAuthenticationToken used for authenticating the request.

Parameters:

authenticationConverter - the AuthenticationConverter used when attempting to extract a Revoke Token Request from HttpServletRequest

Since:

0.2.2

setAuthenticationSuccessHandler

public void setAuthenticationSuccessHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler authenticationSuccessHandler)

Sets the AuthenticationSuccessHandler used for handling an OAuth2TokenRevocationAuthenticationToken.

Parameters:

authenticationSuccessHandler - the AuthenticationSuccessHandler used for handling an OAuth2TokenRevocationAuthenticationToken

Since:

0.2.2

setAuthenticationFailureHandler

public void setAuthenticationFailureHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler authenticationFailureHandler)

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

Parameters:

authenticationFailureHandler - the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException

Since:

0.2.2