org.jasig.cas.client.tomcat

Interface LogoutHandler

All Known Implementing Classes:

AbstractLogoutHandler, RegexUriLogoutHandler, StaticUriLogoutHandler

public interface LogoutHandler

Strategy pattern interface for ending a CAS authentication session.

Since:

3.1.12

Version:

$Revision$

Author:

Marvin S. Addison

Method Summary

Modifier and Type	Method and Description
boolean	isLogoutRequest(javax.servlet.http.HttpServletRequest request) Determines whether the given request is a logout request.
void	logout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Ends the current authenticated user session bound to the given request.

Method Detail

isLogoutRequest

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

Determines whether the given request is a logout request.

Parameters:

request - HTTP request.

Returns:

True if request is a logout request, false otherwise.

logout

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.

Parameters:

request - HTTP request.

response - HTTP response.