Package com.vaadin.sso.core

Class BackChannelLogoutFilter

java.lang.Object
org.springframework.web.filter.GenericFilterBean
com.vaadin.sso.core.BackChannelLogoutFilter
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
@Deprecated(since="3.1", forRemoval=true) public class BackChannelLogoutFilter extends org.springframework.web.filter.GenericFilterBean
Deprecated, for removal: This API element is subject to removal in a future version.
Use built-in Spring Security support for OpenID Connect Back-Channel Logout
A filter responsible to handle OpenID Connect Back-Channel Logout requests.
Since:
1.0
Author:
Vaadin Ltd

  • Field Summary

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

    logger

  • Constructor Summary

    Constructors
    Constructor
    Description
    BackChannelLogoutFilter(org.springframework.security.core.session.SessionRegistry sessionRegistry, org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository, org.springframework.context.ApplicationEventPublisher eventPublisher)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates an instance of the filter.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    org.springframework.security.web.util.matcher.RequestMatcher
    getRequestMatcher()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the request-matcher configured for this filter.
    void
    setBackChannelLogoutRoute(String backChannelLogoutRoute)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the back-channel logout route to match for this filter to handle the requests.
    void
    setRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher logoutRequestMatcher)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the request-matcher for this filter.

    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

    • BackChannelLogoutFilter

      public BackChannelLogoutFilter(org.springframework.security.core.session.SessionRegistry sessionRegistry, org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository, org.springframework.context.ApplicationEventPublisher eventPublisher)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates an instance of the filter.
      Parameters:
      sessionRegistry - the session registry, not null
      clientRegistrationRepository - the client-registration repository, not null
      eventPublisher - the event-publisher to publish logout events, not null

  • Method Details

    • doFilter

      public void doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) throws IOException, jakarta.servlet.ServletException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      IOException
      jakarta.servlet.ServletException

    • getRequestMatcher

      public org.springframework.security.web.util.matcher.RequestMatcher getRequestMatcher()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the request-matcher configured for this filter.
      Returns:
      this filter's request-matcher, not null

    • setRequestMatcher

      public void setRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher logoutRequestMatcher)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the request-matcher for this filter.
      Parameters:
      logoutRequestMatcher - the request-matcher, not null

    • setBackChannelLogoutRoute

      public void setBackChannelLogoutRoute(String backChannelLogoutRoute)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the back-channel logout route to match for this filter to handle the requests.
      Parameters:
      backChannelLogoutRoute - the route to match, not null