Package org.gatein.sso.agent.filter.api

Class AbstractSSOInterceptor

java.lang.Object
org.exoplatform.container.web.AbstractFilter
org.gatein.sso.agent.filter.api.AbstractSSOInterceptor
All Implemented Interfaces:
jakarta.servlet.Filter, SSOInterceptor
Direct Known Subclasses:
LoginRedirectFilter
public abstract class AbstractSSOInterceptor extends org.exoplatform.container.web.AbstractFilter implements SSOInterceptor
Base SSOInterceptor which adds possibility to be initialized either through Servlet API or through eXo kernel

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PORTAL_CONTAINER_SUBSTITUTION_PATTERN
     

    Fields inherited from class org.exoplatform.container.web.AbstractFilter

    config, servletContextName

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractSSOInterceptor()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final void
    afterInit(jakarta.servlet.FilterConfig filterConfig)
    Method is invoked if we are performing initialization through servlet api (web filter)
    protected org.exoplatform.container.ExoContainer
    getExoContainer()
    Need to use different method name because method "super.getContainer()" is final :-/
    String
    getInitParameter(String paramName)
    Read init parameter (works for both kernel initialization or Servlet API initialization)
    protected abstract void
    initImpl()
    This method needs to be implemented by conrete filter.
    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

    Methods inherited from class org.exoplatform.container.web.AbstractFilter

    getContainer, getServletContext, init, requirePortalEnvironment

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface jakarta.servlet.Filter

    destroy, doFilter, init

  • Field Details

    • PORTAL_CONTAINER_SUBSTITUTION_PATTERN

      public static final String PORTAL_CONTAINER_SUBSTITUTION_PATTERN
      See Also:

  • Constructor Details

    • AbstractSSOInterceptor

      public AbstractSSOInterceptor()

  • Method Details

    • afterInit

      protected final void afterInit(jakarta.servlet.FilterConfig filterConfig) throws jakarta.servlet.ServletException
      Method is invoked if we are performing initialization through servlet api (web filter)
      Overrides:
      afterInit in class org.exoplatform.container.web.AbstractFilter
      Throws:
      jakarta.servlet.ServletException

    • 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 SSOInterceptor

    • initImpl

      protected abstract void initImpl()
      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)

    • getInitParameter

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

    • getExoContainer

      protected org.exoplatform.container.ExoContainer getExoContainer()
      Need to use different method name because method "super.getContainer()" is final :-/