Package org.pac4j.core.logout.handler

Interface LogoutHandler<C extends WebContext>

  • All Known Implementing Classes:
    DefaultLogoutHandler
    public interface LogoutHandler<C extends WebContext>
    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 Detail

      • recordSession

        default void recordSession​(C context,
                           String key)
        Associates a key with the current web session.
        Parameters:
        context - the web context
        key - the key

      • destroySessionFront

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

      • destroySessionBack

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

      • renewSession

        default void renewSession​(String oldSessionId,
                          C context)
        Renew the web session.
        Parameters:
        oldSessionId - the old session identifier
        context - the web context