org.jasig.cas.client.tomcat

Class AbstractLogoutHandler

java.lang.Object

org.jasig.cas.client.tomcat.AbstractLogoutHandler

All Implemented Interfaces:

LogoutHandler

Direct Known Subclasses:

RegexUriLogoutHandler, StaticUriLogoutHandler

public abstract class AbstractLogoutHandler
extends Object
implements LogoutHandler

Base class for all logout handlers.

Version:

$Revision$

Author:

Marvin S. Addison

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
protected String	redirectUrl

Constructor Summary

Constructors

Constructor and Description
AbstractLogoutHandler()

Method Summary

Modifier and Type	Method and Description
protected String	constructRedirectUrl(javax.servlet.http.HttpServletRequest request) Constructs a url to redirect to.
void	logout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Ends the current authenticated user session bound to the given request.
void	setRedirectUrl(String redirectUrl)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.cas.client.tomcat.LogoutHandler

isLogoutRequest

Field Detail

logger

protected final org.slf4j.Logger logger

redirectUrl

protected String redirectUrl

Constructor Detail

AbstractLogoutHandler

public AbstractLogoutHandler()

Method Detail

setRedirectUrl

public void setRedirectUrl(String redirectUrl)

logout

public void logout(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)

Ends the current authenticated user session bound to the given request. The response is provided to allow the handler to customize the response behavior on logout as needed.

Specified by:

logout in interface LogoutHandler

Parameters:

request - HTTP request.

response - HTTP response.

constructRedirectUrl

protected String constructRedirectUrl(javax.servlet.http.HttpServletRequest request)

Constructs a url to redirect to.

Parameters:

request - the original request.

Returns:

the url to redirect to. CAN be NULL.