Package org.pac4j.core.logout.handler

Class DefaultSessionLogoutHandler

java.lang.Object

org.pac4j.core.logout.handler.DefaultSessionLogoutHandler

All Implemented Interfaces:

SessionLogoutHandler

public class DefaultSessionLogoutHandler
extends Object
implements SessionLogoutHandler

Default session logout handler.

Since:

2.0.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor	Description
DefaultSessionLogoutHandler()	Constructor for DefaultSessionLogoutHandler.
DefaultSessionLogoutHandler(Store<String,Object> store)	Constructor for DefaultSessionLogoutHandler.

Method Summary

Modifier and Type	Method	Description
Optional<String>	cleanRecord(String sessionId)	Clean a recorded sessionId.
protected void	destroy(WebContext webContext, SessionStore sessionStore, ProfileManagerFactory profileManagerFactory, String channel)	destroy.
void	destroySession(CallContext ctx, String key)	Destroys the current web session for the given key for a front or back channel logout.
void	recordSession(CallContext ctx, String key)	Associates a key with the current web session.
void	renewSession(CallContext ctx, String oldSessionId)	Renew the web session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultSessionLogoutHandler

public DefaultSessionLogoutHandler()

Constructor for DefaultSessionLogoutHandler.

DefaultSessionLogoutHandler

public DefaultSessionLogoutHandler(Store<String,Object> store)

Constructor for DefaultSessionLogoutHandler.

Parameters:

store - a Store object

Method Details

recordSession

public void recordSession(CallContext ctx,
 String key)

Associates a key with the current web session.

Specified by:

recordSession in interface SessionLogoutHandler

Parameters:

ctx - the context

key - the key

destroySession

public void destroySession(CallContext ctx,
 String key)

Destroys the current web session for the given key for a front or back channel logout.

Specified by:

destroySession in interface SessionLogoutHandler

Parameters:

ctx - the context

key - the key

destroy

protected void destroy(WebContext webContext,
 SessionStore sessionStore,
 ProfileManagerFactory profileManagerFactory,
 String channel)

destroy.

Parameters:

webContext - a WebContext object

sessionStore - a SessionStore object

profileManagerFactory - a ProfileManagerFactory object

channel - a String object

renewSession

public void renewSession(CallContext ctx,
 String oldSessionId)

Renew the web session.

Specified by:

renewSession in interface SessionLogoutHandler

Parameters:

ctx - the context

oldSessionId - the old session identifier

cleanRecord

public Optional<String> cleanRecord(String sessionId)

Clean a recorded sessionId.

Specified by:

cleanRecord in interface SessionLogoutHandler

Parameters:

sessionId - the sessionId

Returns:

the associated key.