org.pac4j.cas.logout

Class CasSingleSignOutHandler

java.lang.Object

org.pac4j.cas.logout.CasSingleSignOutHandler

All Implemented Interfaces:

LogoutHandler

public class CasSingleSignOutHandler
extends Object
implements LogoutHandler

This class is the logout handler for the CasClient class based on the SingleSignOutHandler class of the Jasig CAS client.

It should only be used in J2E context.

Since:

1.4.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
CasSingleSignOutHandler() Construct an instance.
CasSingleSignOutHandler(org.jasig.cas.client.session.SingleSignOutHandler singleSignOutHandler) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	destroySession(WebContext context) Destroys the current web session for the given CAS logout request.
org.jasig.cas.client.session.SessionMappingStorage	getSessionMappingStorage()
boolean	isLogoutRequest(WebContext context) Defines if this request is a logout one.
boolean	isTokenRequest(WebContext context) Defines if this request is a token one.
void	recordSession(WebContext context, String ticket) Associates a token request with the current web session.
void	setSessionMappingStorage(org.jasig.cas.client.session.SessionMappingStorage sessionMappingStorage)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

CasSingleSignOutHandler

public CasSingleSignOutHandler()

Construct an instance.

CasSingleSignOutHandler

@Deprecated
public CasSingleSignOutHandler(org.jasig.cas.client.session.SingleSignOutHandler singleSignOutHandler)

Deprecated.

Construct an instance from a given SingleSignOutHandler class. The provided handler is not taken into account.

Parameters:

singleSignOutHandler - the real SSOut handler

Method Detail

isTokenRequest

public boolean isTokenRequest(WebContext context)

Description copied from interface: LogoutHandler

Defines if this request is a token one.

Specified by:

isTokenRequest in interface LogoutHandler

Parameters:

context - the web context

Returns:

if this request is a token one

isLogoutRequest

public boolean isLogoutRequest(WebContext context)

Description copied from interface: LogoutHandler

Defines if this request is a logout one.

Specified by:

isLogoutRequest in interface LogoutHandler

Parameters:

context - the web context

Returns:

if this request is a logout one

recordSession

public void recordSession(WebContext context,
                          String ticket)

Description copied from interface: LogoutHandler

Associates a token request with the current web session.

Specified by:

recordSession in interface LogoutHandler

Parameters:

context - the web context

ticket - the service ticket

destroySession

public void destroySession(WebContext context)

Description copied from interface: LogoutHandler

Destroys the current web session for the given CAS logout request.

Specified by:

destroySession in interface LogoutHandler

Parameters:

context - the web context

getSessionMappingStorage

public org.jasig.cas.client.session.SessionMappingStorage getSessionMappingStorage()

setSessionMappingStorage

public void setSessionMappingStorage(org.jasig.cas.client.session.SessionMappingStorage sessionMappingStorage)