Package org.pac4j.core.logout.handler

Interface LogoutHandler

All Known Implementing Classes:
DefaultLogoutHandler
public interface LogoutHandler
This interface defines how to handle logout requests on client side. For the CAS support, the key is the service ticket. For the SAML support, the key is the session index.
Since:
1.9.2
Author:
Jerome Leleu

  • Method Details

    • recordSession

      default void recordSession(WebContext context, SessionStore sessionStore, String key)
      Associates a key with the current web session.
      Parameters:
      context - the web context
      sessionStore - the session store
      key - the key

    • destroySessionFront

      default void destroySessionFront(WebContext context, SessionStore sessionStore, String key)
      Destroys the current web session for the given key for a front channel logout.
      Parameters:
      context - the web context
      sessionStore - the session store
      key - the key

    • destroySessionBack

      default void destroySessionBack(WebContext context, SessionStore sessionStore, String key)
      Destroys the current web session for the given key for a back channel logout.
      Parameters:
      context - the web context
      sessionStore - the session store
      key - the key

    • renewSession

      default void renewSession(String oldSessionId, WebContext context, SessionStore sessionStore)
      Renew the web session.
      Parameters:
      oldSessionId - the old session identifier
      context - the web context
      sessionStore - the session store