Package org.gatein.sso.agent.filter

Class AbstractLogoutFilter

java.lang.Object
org.exoplatform.container.web.AbstractFilter
org.gatein.sso.agent.filter.api.AbstractSSOInterceptor
org.gatein.sso.agent.filter.AbstractLogoutFilter
All Implemented Interfaces:
javax.servlet.Filter, SSOInterceptor
Direct Known Subclasses:
OpenSSOLogoutFilter
public abstract class AbstractLogoutFilter extends AbstractSSOInterceptor
Author:
Sohil Shah

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.exoplatform.services.log.Log
    log
     
    protected String
    logoutUrl
     

    Fields inherited from class org.gatein.sso.agent.filter.api.AbstractSSOInterceptor

    PORTAL_CONTAINER_SUBSTITUTION_PATTERN

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

    config, servletContextName

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractLogoutFilter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    destroy()
     
    void
    doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
     
    protected abstract String
    getRedirectUrl(javax.servlet.http.HttpServletRequest httpRequest)
     
    protected boolean
    handleLogout(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)
    Handle logout on SSO server side
    protected void
    initImpl()
    This method needs to be implemented by conrete filter.
    protected boolean
    isLogoutInProgress(javax.servlet.http.HttpServletRequest request)
     

    Methods inherited from class org.gatein.sso.agent.filter.api.AbstractSSOInterceptor

    afterInit, getExoContainer, getInitParameter, initWithParams

    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 javax.servlet.Filter

    init

  • Field Details

    • logoutUrl

      protected String logoutUrl

    • log

      protected final org.exoplatform.services.log.Log log

  • Constructor Details

    • AbstractLogoutFilter

      public AbstractLogoutFilter()

  • Method Details

    • initImpl

      protected void initImpl()
      Description copied from class: AbstractSSOInterceptor
      This method needs to be implemented by conrete filter. Filter should obtain it's init parameters by calling AbstractSSOInterceptor.getInitParameter(String). This works in both types of initialization (Case1: Filter initialization through kernel, Case2: initialization through servlet API)
      Specified by:
      initImpl in class AbstractSSOInterceptor

    • destroy

      public void destroy()

    • 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

    • isLogoutInProgress

      protected boolean isLogoutInProgress(javax.servlet.http.HttpServletRequest request) throws UnsupportedEncodingException
      Throws:
      UnsupportedEncodingException

    • handleLogout

      protected boolean handleLogout(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) throws IOException
      Handle logout on SSO server side
      Parameters:
      httpRequest -
      httpResponse -
      Returns:
      true if redirection to SSO server was send. We need to return immediately from filter invocation then
      Throws:
      IOException

    • getRedirectUrl

      protected abstract String getRedirectUrl(javax.servlet.http.HttpServletRequest httpRequest)