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 Summary
Modifier and TypeMethodDescriptiondefault void
destroySessionBack
(WebContext context, SessionStore sessionStore, String key) Destroys the current web session for the given key for a back channel logout.default void
destroySessionFront
(WebContext context, SessionStore sessionStore, String key) Destroys the current web session for the given key for a front channel logout.default void
recordSession
(WebContext context, SessionStore sessionStore, String key) Associates a key with the current web session.default void
renewSession
(String oldSessionId, WebContext context, SessionStore sessionStore) Renew the web session.
-
Method Details
-
recordSession
Associates a key with the current web session.- Parameters:
context
- the web contextsessionStore
- the session storekey
- the key
-
destroySessionFront
Destroys the current web session for the given key for a front channel logout.- Parameters:
context
- the web contextsessionStore
- the session storekey
- the key
-
destroySessionBack
Destroys the current web session for the given key for a back channel logout.- Parameters:
context
- the web contextsessionStore
- the session storekey
- the key
-
renewSession
Renew the web session.- Parameters:
oldSessionId
- the old session identifiercontext
- the web contextsessionStore
- the session store
-