Package org.pac4j.core.logout.handler
Interface SessionLogoutHandler
- All Known Implementing Classes:
DefaultSessionLogoutHandler
public interface SessionLogoutHandler
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 or the nameID.
For the OIDC support, the key is the ssid claim.
- Since:
- 1.9.2
- Author:
- Jerome Leleu
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
destroySession
(CallContext ctx, String key) Destroys the current web session for the given key for a front or back channel logout.default void
recordSession
(CallContext ctx, String key) Associates a key with the current web session.default void
renewSession
(CallContext ctx, String oldSessionId) Renew the web session.
-
Method Details
-
recordSession
Associates a key with the current web session.- Parameters:
ctx
- the contextkey
- the key
-
destroySession
Destroys the current web session for the given key for a front or back channel logout.- Parameters:
ctx
- the contextkey
- the key
-
renewSession
Renew the web session.- Parameters:
ctx
- the contextoldSessionId
- the old session identifier
-