org.jasig.cas.client.session

Class SingleSignOutHandler

java.lang.Object

org.jasig.cas.client.session.SingleSignOutHandler

public final class SingleSignOutHandler
extends Object

Performs CAS single sign-out operations in an API-agnostic fashion.

Since:

3.1.12

Version:

$Revision$ $Date$

Author:

Marvin S. Addison

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ARTIFACT_PARAMETER_NAME
static String	DEFAULT_FRONT_LOGOUT_PARAMETER_NAME
static String	DEFAULT_LOGOUT_PARAMETER_NAME
static String	DEFAULT_RELAY_STATE_PARAMETER_NAME

Constructor Summary

Constructors

Constructor and Description
SingleSignOutHandler()

Method Summary

Methods

Modifier and Type	Method and Description
SessionMappingStorage	getSessionMappingStorage()
void	init() Initializes the component for use.
boolean	process(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Process a request regarding the SLO process: record the session or destroy it.
void	setArtifactParameterName(String name)
void	setArtifactParameterOverPost(boolean artifactParameterOverPost)
void	setCasServerUrlPrefix(String casServerUrlPrefix)
void	setEagerlyCreateSessions(boolean eagerlyCreateSessions)
void	setFrontLogoutParameterName(String name)
void	setLogoutParameterName(String name)
void	setRelayStateParameterName(String name)
void	setSessionMappingStorage(SessionMappingStorage storage)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ARTIFACT_PARAMETER_NAME

public static final String DEFAULT_ARTIFACT_PARAMETER_NAME

See Also:

Constant Field Values

DEFAULT_LOGOUT_PARAMETER_NAME

public static final String DEFAULT_LOGOUT_PARAMETER_NAME

See Also:

Constant Field Values

DEFAULT_FRONT_LOGOUT_PARAMETER_NAME

public static final String DEFAULT_FRONT_LOGOUT_PARAMETER_NAME

See Also:

Constant Field Values

DEFAULT_RELAY_STATE_PARAMETER_NAME

public static final String DEFAULT_RELAY_STATE_PARAMETER_NAME

See Also:

Constant Field Values

Constructor Detail

SingleSignOutHandler

public SingleSignOutHandler()

Method Detail

setSessionMappingStorage

public void setSessionMappingStorage(SessionMappingStorage storage)

setArtifactParameterOverPost

public void setArtifactParameterOverPost(boolean artifactParameterOverPost)

getSessionMappingStorage

public SessionMappingStorage getSessionMappingStorage()

setArtifactParameterName

public void setArtifactParameterName(String name)

Parameters:

name - Name of the authentication token parameter.

setLogoutParameterName

public void setLogoutParameterName(String name)

Parameters:

name - Name of parameter containing CAS logout request message for back channel SLO.

setCasServerUrlPrefix

public void setCasServerUrlPrefix(String casServerUrlPrefix)

Parameters:

casServerUrlPrefix - The prefix url of the CAS server.

setFrontLogoutParameterName

public void setFrontLogoutParameterName(String name)

Parameters:

name - Name of parameter containing CAS logout request message for front channel SLO.

setRelayStateParameterName

public void setRelayStateParameterName(String name)

Parameters:

name - Name of parameter containing the state of the CAS server webflow.

setEagerlyCreateSessions

public void setEagerlyCreateSessions(boolean eagerlyCreateSessions)

init

public void init()

Initializes the component for use.

process

public boolean process(javax.servlet.http.HttpServletRequest request,
              javax.servlet.http.HttpServletResponse response)

Process a request regarding the SLO process: record the session or destroy it.

Parameters:

request - the incoming HTTP request.

response - the HTTP response.

Returns:

if the request should continue to be processed.