Package org.pac4j.core.logout.handler

Class DefaultLogoutHandler

java.lang.Object

org.pac4j.core.logout.handler.DefaultLogoutHandler

All Implemented Interfaces:

LogoutHandler

public class DefaultLogoutHandler
extends Object
implements LogoutHandler

Default logout handler.

Since:

2.0.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor	Description
DefaultLogoutHandler()
DefaultLogoutHandler(Store<String,Object> store)

Method Summary

Modifier and Type	Method	Description
protected void	destroy(WebContext context, SessionStore sessionStore, ProfileManagerFactory profileManagerFactory, String channel)
void	destroySessionBack(WebContext context, SessionStore sessionStore, ProfileManagerFactory profileManagerFactory, String key)	Destroys the current web session for the given key for a back channel logout.
void	destroySessionFront(WebContext context, SessionStore sessionStore, ProfileManagerFactory profileManagerFactory, String key)	Destroys the current web session for the given key for a front channel logout.
void	recordSession(WebContext context, SessionStore sessionStore, String key)	Associates a key with the current web session.
void	renewSession(String oldSessionId, WebContext context, SessionStore sessionStore)	Renew the web session.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultLogoutHandler

public DefaultLogoutHandler()

DefaultLogoutHandler

public DefaultLogoutHandler(Store<String,Object> store)

Method Details

recordSession

public void recordSession(WebContext context,
 SessionStore sessionStore,
 String key)

Description copied from interface: LogoutHandler

Associates a key with the current web session.

Specified by:

recordSession in interface LogoutHandler

Parameters:

context - the web context

sessionStore - the session store

key - the key

destroySessionFront

public void destroySessionFront(WebContext context,
 SessionStore sessionStore,
 ProfileManagerFactory profileManagerFactory,
 String key)

Description copied from interface: LogoutHandler

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

Specified by:

destroySessionFront in interface LogoutHandler

Parameters:

context - the web context

sessionStore - the session store

profileManagerFactory - the profile manager factory

key - the key

destroy

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

destroySessionBack

public void destroySessionBack(WebContext context,
 SessionStore sessionStore,
 ProfileManagerFactory profileManagerFactory,
 String key)

Description copied from interface: LogoutHandler

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

Specified by:

destroySessionBack in interface LogoutHandler

Parameters:

context - the web context

sessionStore - the session store

profileManagerFactory - the profile manager factory

key - the key

renewSession

public void renewSession(String oldSessionId,
 WebContext context,
 SessionStore sessionStore)

Description copied from interface: LogoutHandler

Renew the web session.

Specified by:

renewSession in interface LogoutHandler

Parameters:

oldSessionId - the old session identifier

context - the web context

sessionStore - the session store