Package org.gatein.sso.saml.plugin.filter

Class SAML2LogoutFilter

  • All Implemented Interfaces:
    javax.servlet.Filter, org.gatein.sso.agent.filter.api.SSOInterceptor
    public class SAML2LogoutFilter
extends org.picketlink.identity.federation.web.filters.SPFilter
implements org.gatein.sso.agent.filter.api.SSOInterceptor

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected javax.servlet.FilterConfig config
      The filter configuration
      static String COOKIE_NAME  
      static String OAUTH_COOKIE_NAME  
      static String SAML_LOGOUT_ATTRIBUTE  
      protected String servletContextName
      The Servlet context name

      • Fields inherited from class org.picketlink.identity.federation.web.filters.SPFilter

        canonicalizationMethod, configFile, identityURL, ignoreSignatures, picketLinkConfiguration, serviceURL, spConfiguration

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void doFilter​(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain)  
      protected String getInitParameter​(String paramName)
      Read init parameter (works for both kernel initialization or Servlet API initialization)
      protected javax.servlet.ServletContext getServletContext()  
      void init​(javax.servlet.FilterConfig config)
      protected void initImpl()
      This method needs to be implemented by conrete filter.
      void initWithParams​(org.exoplatform.container.xml.InitParams params, org.exoplatform.container.ExoContainerContext containerContext)
      Method is invoked if we are performing initialization through exo kernel
      static boolean isPortalLogoutInProgress​(javax.servlet.http.HttpServletRequest request)  
      static boolean isSAMLLogoutInProgress​(javax.servlet.http.HttpServletRequest request)  
      protected boolean requirePortalEnvironment()
      Indicates if it requires that a full portal environment must be set

      • Methods inherited from class org.picketlink.identity.federation.web.filters.SPFilter

        decryptAssertion, destroy, handleSAMLResponse, isTrusted, sendRequestToIDP, sendToDestination, validate, verifySignature

      • Methods inherited from interface javax.servlet.Filter

        destroy

    • Constructor Detail

      • SAML2LogoutFilter

        public SAML2LogoutFilter()

    • Method Detail

      • init

        public final void init​(javax.servlet.FilterConfig config)
                throws javax.servlet.ServletException
        Specified by:
        init in interface javax.servlet.Filter
        Overrides:
        init in class org.picketlink.identity.federation.web.filters.SPFilter
        Throws:
        javax.servlet.ServletException

      • doFilter

        public void doFilter​(javax.servlet.ServletRequest servletRequest,
                     javax.servlet.ServletResponse servletResponse,
                     javax.servlet.FilterChain filterChain)
              throws IOException,
                     javax.servlet.ServletException
        Specified by:
        doFilter in interface javax.servlet.Filter
        Overrides:
        doFilter in class org.picketlink.identity.federation.web.filters.SPFilter
        Throws:
        IOException
        javax.servlet.ServletException

      • isPortalLogoutInProgress

        public static boolean isPortalLogoutInProgress​(javax.servlet.http.HttpServletRequest request)

      • isSAMLLogoutInProgress

        public static boolean isSAMLLogoutInProgress​(javax.servlet.http.HttpServletRequest request)

      • initWithParams

        public final void initWithParams​(org.exoplatform.container.xml.InitParams params,
                                 org.exoplatform.container.ExoContainerContext containerContext)
        Method is invoked if we are performing initialization through exo kernel
        Specified by:
        initWithParams in interface org.gatein.sso.agent.filter.api.SSOInterceptor

      • initImpl

        protected void initImpl()
                 throws javax.servlet.ServletException
        This method needs to be implemented by conrete filter. Filter should obtain it's init parameters by calling getInitParameter(String). This works in both types of initialization (Case1: Filter initialization through kernel, Case2: initialization through servlet API)
        Throws:
        javax.servlet.ServletException - an init exception happens when calling super class init method

      • getInitParameter

        protected String getInitParameter​(String paramName)
        Read init parameter (works for both kernel initialization or Servlet API initialization)
        Parameters:
        paramName - parameter name
        Returns:
        parameter value

      • requirePortalEnvironment

        protected boolean requirePortalEnvironment()
        Indicates if it requires that a full portal environment must be set
        Returns:
        true if it requires the portal environment false otherwise.

      • getServletContext

        protected javax.servlet.ServletContext getServletContext()
        Returns:
        the current ServletContext