org.jasig.cas.web.flow

Class AbstractLogoutAction

java.lang.Object

org.springframework.webflow.action.AbstractAction

org.jasig.cas.web.flow.AbstractLogoutAction

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, org.springframework.webflow.execution.Action

Direct Known Subclasses:

FrontChannelLogoutAction, LogoutAction

public abstract class AbstractLogoutAction
extends org.springframework.webflow.action.AbstractAction

Abstract logout action, which prevents caching on logout.

Since:

4.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static String	FINISH_EVENT The finish event in webflow.
static String	FRONT_EVENT The front event in webflow.
static String	LOGOUT_INDEX A constant for the logout index in web flow.
static String	REDIRECT_APP_EVENT The redirect to app event in webflow.

Fields inherited from class org.springframework.webflow.action.AbstractAction

logger

Constructor Summary

Constructors

Constructor and Description
AbstractLogoutAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.springframework.webflow.execution.Event	doExecute(org.springframework.webflow.execution.RequestContext context)
protected abstract org.springframework.webflow.execution.Event	doInternalExecute(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.webflow.execution.RequestContext context) Execute the logout action after invalidating the cache.
protected int	getLogoutIndex(org.springframework.webflow.execution.RequestContext context)
protected void	preventCaching(javax.servlet.http.HttpServletResponse response) Prevent caching by adding the appropriate headers.
protected void	putLogoutIndex(org.springframework.webflow.execution.RequestContext context, int index)

Methods inherited from class org.springframework.webflow.action.AbstractAction

afterPropertiesSet, doPostExecute, doPreExecute, error, error, execute, getActionNameForLogging, getEventFactorySupport, initAction, no, result, result, result, result, success, success, yes

Methods inherited from class java.lang.Object

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

Field Detail

LOGOUT_INDEX

public static final String LOGOUT_INDEX

A constant for the logout index in web flow.

See Also:

Constant Field Values

FINISH_EVENT

public static final String FINISH_EVENT

The finish event in webflow.

See Also:

Constant Field Values

FRONT_EVENT

public static final String FRONT_EVENT

The front event in webflow.

See Also:

Constant Field Values

REDIRECT_APP_EVENT

public static final String REDIRECT_APP_EVENT

The redirect to app event in webflow.

See Also:

Constant Field Values

Constructor Detail

AbstractLogoutAction

public AbstractLogoutAction()

Method Detail

doExecute

protected final org.springframework.webflow.execution.Event doExecute(org.springframework.webflow.execution.RequestContext context)
                                                               throws Exception

Specified by:

doExecute in class org.springframework.webflow.action.AbstractAction

Throws:

Exception

doInternalExecute

protected abstract org.springframework.webflow.execution.Event doInternalExecute(javax.servlet.http.HttpServletRequest request,
                                                            javax.servlet.http.HttpServletResponse response,
                                                            org.springframework.webflow.execution.RequestContext context)
                                                                          throws Exception

Execute the logout action after invalidating the cache.

Parameters:

request - the HTTP request.

response - the HTTP response.

context - the webflow context.

Returns:

the event triggered by this actions.

Throws:

Exception - exception returned by this action.

preventCaching

protected final void preventCaching(javax.servlet.http.HttpServletResponse response)

Prevent caching by adding the appropriate headers. Copied from the preventCaching method in the WebContentGenerator class.

Parameters:

response - the HTTP response.

putLogoutIndex

protected final void putLogoutIndex(org.springframework.webflow.execution.RequestContext context,
                  int index)

getLogoutIndex

protected final int getLogoutIndex(org.springframework.webflow.execution.RequestContext context)