org.pac4j.cas.logout

Class DefaultCasLogoutHandler<C extends WebContext>

java.lang.Object

org.pac4j.cas.logout.DefaultCasLogoutHandler<C>

All Implemented Interfaces:

CasLogoutHandler<C>

public class DefaultCasLogoutHandler<C extends WebContext>
extends java.lang.Object
implements CasLogoutHandler<C>

This class is the logout handler for the CasClient, inspired by the SingleSignOutHandler of the Apereo CAS client.

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
DefaultCasLogoutHandler()
DefaultCasLogoutHandler(Store<java.lang.String,java.lang.Object> store)

Method Summary

Modifier and Type	Method and Description
protected void	destroy(C context, SessionStore sessionStore, java.lang.String channel)
void	destroySessionBack(C context, java.lang.String ticket) Destroys the current web session for the given ticket for a back channel logout.
void	destroySessionFront(C context, java.lang.String ticket) Destroys the current web session for the given ticket for a front channel logout.
Store<java.lang.String,java.lang.Object>	getStore()
boolean	isDestroySession()
void	recordSession(C context, java.lang.String ticket) Associates a ticket with the current web session.
void	renewSession(java.lang.String oldSessionId, C context) Renew the web session.
void	setDestroySession(boolean destroySession)
void	setStore(Store<java.lang.String,java.lang.Object> store)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

DefaultCasLogoutHandler

public DefaultCasLogoutHandler()

DefaultCasLogoutHandler

public DefaultCasLogoutHandler(Store<java.lang.String,java.lang.Object> store)

Method Detail

recordSession

public void recordSession(C context,
                          java.lang.String ticket)

Description copied from interface: CasLogoutHandler

Associates a ticket with the current web session.

Specified by:

recordSession in interface CasLogoutHandler<C extends WebContext>

Parameters:

context - the web context

ticket - the ticket

destroySessionFront

public void destroySessionFront(C context,
                                java.lang.String ticket)

Description copied from interface: CasLogoutHandler

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

Specified by:

destroySessionFront in interface CasLogoutHandler<C extends WebContext>

Parameters:

context - the web context

ticket - the ticket

destroy

protected void destroy(C context,
                       SessionStore sessionStore,
                       java.lang.String channel)

destroySessionBack

public void destroySessionBack(C context,
                               java.lang.String ticket)

Description copied from interface: CasLogoutHandler

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

Specified by:

destroySessionBack in interface CasLogoutHandler<C extends WebContext>

Parameters:

context - the web context

ticket - the ticket

renewSession

public void renewSession(java.lang.String oldSessionId,
                         C context)

Description copied from interface: CasLogoutHandler

Renew the web session.

Specified by:

renewSession in interface CasLogoutHandler<C extends WebContext>

Parameters:

oldSessionId - the old session identifier

context - the web context

getStore

public Store<java.lang.String,java.lang.Object> getStore()

setStore

public void setStore(Store<java.lang.String,java.lang.Object> store)

isDestroySession

public boolean isDestroySession()

setDestroySession

public void setDestroySession(boolean destroySession)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object