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: 24094 $ $Date: 2011-06-20 21:39:49 -0400 (Mon, 20 Jun 2011) $

Author:

Marvin S. Addison

Constructor Summary

SingleSignOutHandler()

Method Summary

void	destroySession(javax.servlet.http.HttpServletRequest request) Destroys the current HTTP session for the given CAS logout request.
SessionMappingStorage	getSessionMappingStorage()
void	init() Initializes the component for use.
boolean	isLogoutRequest(javax.servlet.http.HttpServletRequest request) Determines whether the given request is a CAS logout request.
boolean	isTokenRequest(javax.servlet.http.HttpServletRequest request) Determines whether the given request contains an authentication token.
void	recordSession(javax.servlet.http.HttpServletRequest request) Associates a token request with the current HTTP session by recording the mapping in the the configured SessionMappingStorage container.
void	setArtifactParameterName(String name)
void	setLogoutParameterName(String name)
void	setSessionMappingStorage(SessionMappingStorage storage)

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleSignOutHandler

public SingleSignOutHandler()

Method Detail

setSessionMappingStorage

public void setSessionMappingStorage(SessionMappingStorage storage)

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.

init

public void init()

Initializes the component for use.

isTokenRequest

public boolean isTokenRequest(javax.servlet.http.HttpServletRequest request)

Determines whether the given request contains an authentication token.

Parameters:

request - HTTP reqest.

Returns:

True if request contains authentication token, false otherwise.

isLogoutRequest

public boolean isLogoutRequest(javax.servlet.http.HttpServletRequest request)

Determines whether the given request is a CAS logout request.

Parameters:

request - HTTP request.

Returns:

True if request is logout request, false otherwise.

recordSession

public void recordSession(javax.servlet.http.HttpServletRequest request)

Associates a token request with the current HTTP session by recording the mapping in the the configured SessionMappingStorage container.

Parameters:

request - HTTP request containing an authentication token.

destroySession

public void destroySession(javax.servlet.http.HttpServletRequest request)

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

Parameters:

request - HTTP request containing a CAS logout message.