Package com.vaadin.sso.starter

Class BackChannelLogoutFilter

  • All Implemented Interfaces:
    javax.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 class BackChannelLogoutFilter
extends org.springframework.web.filter.GenericFilterBean
    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)
      Creates an instance of the filter.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void doFilter​(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)  
      org.springframework.security.web.util.matcher.RequestMatcher getRequestMatcher()
      Gets the request-matcher configured for this filter.
      void setBackChannelLogoutRoute​(String backChannelLogoutRoute)
      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)
      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

    • Constructor Detail

      • BackChannelLogoutFilter

        public BackChannelLogoutFilter​(org.springframework.security.core.session.SessionRegistry sessionRegistry,
                               org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository)
        Creates an instance of the filter.
        Parameters:
        sessionRegistry - the session registry, not null
        clientRegistrationRepository - the client-registration repository, not null

    • Method Detail

      • doFilter

        public void doFilter​(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException
        Throws:
        IOException
        javax.servlet.ServletException

      • getRequestMatcher

        public org.springframework.security.web.util.matcher.RequestMatcher getRequestMatcher()
        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)
        Sets the request-matcher for this filter.
        Parameters:
        logoutRequestMatcher - the request-matcher, not null

      • setBackChannelLogoutRoute

        public void setBackChannelLogoutRoute​(String backChannelLogoutRoute)
        Sets the back-channel logout route to match for this filter to handle the requests.
        Parameters:
        backChannelLogoutRoute - the route to match, not null