org.apereo.cas.web.flow.logout

Class TerminateSessionAction

java.lang.Object

org.springframework.webflow.action.AbstractAction

org.apereo.cas.web.flow.logout.TerminateSessionAction

All Implemented Interfaces:

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

public class TerminateSessionAction
extends org.springframework.webflow.action.AbstractAction

Terminates the CAS SSO session by destroying all SSO state data (i.e. TGT, cookies).

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apereo.cas.CentralAuthenticationService	centralAuthenticationService The authentication service.
protected org.springframework.webflow.action.EventFactorySupport	eventFactorySupport The event factory.
protected org.apereo.cas.configuration.model.core.logout.LogoutProperties	logoutProperties The logout properties.
static java.lang.String	REQUEST_PARAM_LOGOUT_REQUEST_CONFIRMED Parameter to indicate logout request is confirmed.
protected org.apereo.cas.web.support.CookieRetrievingCookieGenerator	ticketGrantingTicketCookieGenerator The TGT cookie generator.
protected org.apereo.cas.web.support.CookieRetrievingCookieGenerator	warnCookieGenerator The warn cookie generator.

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

logger

Constructor Summary

Constructors

Constructor and Description
TerminateSessionAction()

Method Summary

Modifier and Type	Method and Description
protected void	destroyApplicationSession(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Destroy application session.
org.springframework.webflow.execution.Event	doExecute(org.springframework.webflow.execution.RequestContext requestContext)
protected static boolean	isLogoutRequestConfirmed(org.springframework.webflow.execution.RequestContext requestContext) Check if the logout must be confirmed.
org.springframework.webflow.execution.Event	terminate(org.springframework.webflow.execution.RequestContext context) Terminates the CAS SSO session by destroying the TGT (if any) and removing cookies related to the SSO session.

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

REQUEST_PARAM_LOGOUT_REQUEST_CONFIRMED

public static final java.lang.String REQUEST_PARAM_LOGOUT_REQUEST_CONFIRMED

Parameter to indicate logout request is confirmed.

See Also:

Constant Field Values

eventFactorySupport

protected final org.springframework.webflow.action.EventFactorySupport eventFactorySupport

The event factory.

centralAuthenticationService

protected final org.apereo.cas.CentralAuthenticationService centralAuthenticationService

The authentication service.

ticketGrantingTicketCookieGenerator

protected final org.apereo.cas.web.support.CookieRetrievingCookieGenerator ticketGrantingTicketCookieGenerator

The TGT cookie generator.

warnCookieGenerator

protected final org.apereo.cas.web.support.CookieRetrievingCookieGenerator warnCookieGenerator

The warn cookie generator.

logoutProperties

protected final org.apereo.cas.configuration.model.core.logout.LogoutProperties logoutProperties

The logout properties.

Constructor Detail

TerminateSessionAction

public TerminateSessionAction()

Method Detail

doExecute

public org.springframework.webflow.execution.Event doExecute(org.springframework.webflow.execution.RequestContext requestContext)

Specified by:

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

terminate

public org.springframework.webflow.execution.Event terminate(org.springframework.webflow.execution.RequestContext context)

Terminates the CAS SSO session by destroying the TGT (if any) and removing cookies related to the SSO session.

Parameters:

context - Request context.

Returns:

"success"

destroyApplicationSession

protected void destroyApplicationSession(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)

Destroy application session. Also kills all delegated authn profiles via pac4j.

Parameters:

request - the request

response - the response

isLogoutRequestConfirmed

protected static boolean isLogoutRequestConfirmed(org.springframework.webflow.execution.RequestContext requestContext)

Check if the logout must be confirmed.

Parameters:

requestContext - the request context

Returns:

if the logout must be confirmed