org.apereo.cas.web.flow

Class TicketGrantingTicketCheckAction

java.lang.Object

org.springframework.webflow.action.AbstractAction

org.apereo.cas.web.flow.TicketGrantingTicketCheckAction

All Implemented Interfaces:

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

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

Webflow action that checks whether the TGT in the request context is valid. There are three possible outcomes:

1. NOT_EXISTS - TGT not found in flow request context.
2. INVALID TGT has expired or is not found in ticket registry.
3. VALID - TGT found in ticket registry and has not expired.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INVALID TGT invalid event ID="invalid".
static java.lang.String	NOT_EXISTS TGT does not exist event ID="notExists".
static java.lang.String	VALID TGT valid event ID="valid".

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

logger

Constructor Summary

Constructors

Constructor and Description
TicketGrantingTicketCheckAction()
TicketGrantingTicketCheckAction(CentralAuthenticationService centralAuthenticationService) Creates a new instance with the given ticket registry.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.webflow.execution.Event	doExecute(org.springframework.webflow.execution.RequestContext requestContext) Determines whether the TGT in the flow request context is valid.

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

NOT_EXISTS

public static final java.lang.String NOT_EXISTS

TGT does not exist event ID="notExists".

See Also:

Constant Field Values

INVALID

public static final java.lang.String INVALID

TGT invalid event ID="invalid".

See Also:

Constant Field Values

VALID

public static final java.lang.String VALID

TGT valid event ID="valid".

See Also:

Constant Field Values

Constructor Detail

TicketGrantingTicketCheckAction

public TicketGrantingTicketCheckAction()

TicketGrantingTicketCheckAction

public TicketGrantingTicketCheckAction(CentralAuthenticationService centralAuthenticationService)

Creates a new instance with the given ticket registry.

Parameters:

centralAuthenticationService - the central authentication service

Method Detail

doExecute

protected org.springframework.webflow.execution.Event doExecute(org.springframework.webflow.execution.RequestContext requestContext)
                                                         throws java.lang.Exception

Determines whether the TGT in the flow request context is valid.

Specified by:

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

Parameters:

requestContext - Flow request context.

Returns:

NOT_EXISTS, INVALID, or VALID.

Throws:

java.lang.Exception - in case ticket cannot be retrieved from the service layer