Package org.springframework.security.saml2.provider.service.web.authentication.logout

Class Saml2LogoutRequestFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.security.saml2.provider.service.web.authentication.logout.Saml2LogoutRequestFilter

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

A filter for handling logout requests in the form of a <saml2:LogoutRequest> sent from the asserting party.

Since:

5.6

See Also:

• Saml2LogoutRequestValidator

Field Summary

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Constructor Summary

Constructors

Constructor	Description
Saml2LogoutRequestFilter(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver, Saml2LogoutRequestValidator logoutRequestValidator, Saml2LogoutResponseResolver logoutResponseResolver, LogoutHandler... handlers)	Constructs a Saml2LogoutResponseFilter for accepting SAML 2.0 Logout Requests from the asserting party

Method Summary

Modifier and Type	Method	Description
protected void	doFilterInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain)
void	setLogoutRequestMatcher(RequestMatcher logoutRequestMatcher)
void	setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy)	Sets the SecurityContextHolderStrategy to use.

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

Saml2LogoutRequestFilter

public Saml2LogoutRequestFilter(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver,
 Saml2LogoutRequestValidator logoutRequestValidator,
 Saml2LogoutResponseResolver logoutResponseResolver,
 LogoutHandler... handlers)

Constructs a Saml2LogoutResponseFilter for accepting SAML 2.0 Logout Requests from the asserting party

Parameters:

relyingPartyRegistrationResolver - the strategy for resolving a RelyingPartyRegistration

logoutRequestValidator - the SAML 2.0 Logout Request authenticator

logoutResponseResolver - the strategy for creating a SAML 2.0 Logout Response

handlers - the actions that perform logout

Method Details

doFilterInternal

protected void doFilterInternal(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain chain)
                         throws jakarta.servlet.ServletException,
IOException

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

jakarta.servlet.ServletException

IOException

setLogoutRequestMatcher

public void setLogoutRequestMatcher(RequestMatcher logoutRequestMatcher)

setSecurityContextHolderStrategy

public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy)

Sets the SecurityContextHolderStrategy to use. The default action is to use the SecurityContextHolderStrategy stored in SecurityContextHolder.

Since:

5.8