org.jasig.cas.web.flow

Class AuthenticationViaFormAction

java.lang.Object

org.jasig.cas.web.flow.AuthenticationViaFormAction

public class AuthenticationViaFormAction
extends Object

Action to authenticate credential and retrieve a TicketGrantingTicket for those credential. If there is a request for renew, then it also generates the Service Ticket required.

Since:

3.0.0.4

Author:

Scott Battaglia

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHENTICATION_FAILURE Authentication failure result.
static String	ERROR Error result.
protected org.slf4j.Logger	logger Logger instance.
static String	PUBLIC_WORKSTATION_ATTRIBUTE Flow scope attribute that determines if authn is happening at a public workstation.
static String	SUCCESS Authentication success result.
static String	SUCCESS_WITH_WARNINGS Authentication succeeded with warnings from authn subsystem that should be displayed to user.
static String	WARN Authentication success with "warn" enabled.

Constructor Summary

Constructors

Constructor and Description
AuthenticationViaFormAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	addWarningMessagesToMessageContextIfNeeded(TicketGrantingTicket tgtId, org.springframework.binding.message.MessageContext messageContext) Add warning messages to message context if needed.
protected boolean	checkLoginTicketIfExists(org.springframework.webflow.execution.RequestContext context) Tries to to determine if the login ticket in the request flow scope matches the login ticket provided by the request.
protected org.springframework.webflow.execution.Event	createTicketGrantingTicket(org.springframework.webflow.execution.RequestContext context, Credential credential, org.springframework.binding.message.MessageContext messageContext) Create ticket granting ticket for the given credentials.
protected org.springframework.webflow.execution.Event	grantServiceTicket(org.springframework.webflow.execution.RequestContext context, Credential credential) Grant service ticket for the given credential based on the service and tgt that are found in the request context.
protected boolean	isRequestAskingForServiceTicket(org.springframework.webflow.execution.RequestContext context) Is request asking for service ticket?
protected org.springframework.webflow.execution.Event	returnInvalidLoginTicketEvent(org.springframework.webflow.execution.RequestContext context, org.springframework.binding.message.MessageContext messageContext) Return invalid login ticket event.
void	setCentralAuthenticationService(CentralAuthenticationService centralAuthenticationService)
void	setTicketRegistry(TicketRegistry ticketRegistry) Deprecated. As of 4.1
void	setWarnCookieGenerator(org.springframework.web.util.CookieGenerator warnCookieGenerator)
org.springframework.webflow.execution.Event	submit(org.springframework.webflow.execution.RequestContext context, Credential credential, org.springframework.binding.message.MessageContext messageContext) Handle the submission of credentials from the post.

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final String SUCCESS

Authentication success result.

See Also:

Constant Field Values

SUCCESS_WITH_WARNINGS

public static final String SUCCESS_WITH_WARNINGS

Authentication succeeded with warnings from authn subsystem that should be displayed to user.

See Also:

Constant Field Values

WARN

public static final String WARN

Authentication success with "warn" enabled.

See Also:

Constant Field Values

AUTHENTICATION_FAILURE

public static final String AUTHENTICATION_FAILURE

Authentication failure result.

See Also:

Constant Field Values

ERROR

public static final String ERROR

Error result.

See Also:

Constant Field Values

PUBLIC_WORKSTATION_ATTRIBUTE

public static final String PUBLIC_WORKSTATION_ATTRIBUTE

Flow scope attribute that determines if authn is happening at a public workstation.

See Also:

Constant Field Values

logger

protected final org.slf4j.Logger logger

Logger instance.

Constructor Detail

AuthenticationViaFormAction

public AuthenticationViaFormAction()

Method Detail

submit

public final org.springframework.webflow.execution.Event submit(org.springframework.webflow.execution.RequestContext context,
                                                 Credential credential,
                                                 org.springframework.binding.message.MessageContext messageContext)

Handle the submission of credentials from the post.

Parameters:

context - the context

credential - the credential

messageContext - the message context

Returns:

the event

Since:

4.1.0

checkLoginTicketIfExists

protected boolean checkLoginTicketIfExists(org.springframework.webflow.execution.RequestContext context)

Tries to to determine if the login ticket in the request flow scope matches the login ticket provided by the request. The comparison is case-sensitive.

Parameters:

context - the context

Returns:

true if valid

Since:

4.1.0

returnInvalidLoginTicketEvent

protected org.springframework.webflow.execution.Event returnInvalidLoginTicketEvent(org.springframework.webflow.execution.RequestContext context,
                                                                        org.springframework.binding.message.MessageContext messageContext)

Return invalid login ticket event.

Parameters:

context - the context

messageContext - the message context

Returns:

the error event

Since:

4.1.0

isRequestAskingForServiceTicket

protected boolean isRequestAskingForServiceTicket(org.springframework.webflow.execution.RequestContext context)

Is request asking for service ticket?

Parameters:

context - the context

Returns:

true, if both service and tgt are found, and the request is not asking to renew.

Since:

4.1.0

grantServiceTicket

protected org.springframework.webflow.execution.Event grantServiceTicket(org.springframework.webflow.execution.RequestContext context,
                                                             Credential credential)

Grant service ticket for the given credential based on the service and tgt that are found in the request context.

Parameters:

context - the context

credential - the credential

Returns:

the resulting event. Warning, authentication failure or error.

Since:

4.1.0

createTicketGrantingTicket

protected org.springframework.webflow.execution.Event createTicketGrantingTicket(org.springframework.webflow.execution.RequestContext context,
                                                                     Credential credential,
                                                                     org.springframework.binding.message.MessageContext messageContext)

Create ticket granting ticket for the given credentials. Adds all warnings into the message context.

Parameters:

context - the context

credential - the credential

messageContext - the message context

Returns:

the resulting event.

Since:

4.1.0

addWarningMessagesToMessageContextIfNeeded

protected boolean addWarningMessagesToMessageContextIfNeeded(TicketGrantingTicket tgtId,
                                                 org.springframework.binding.message.MessageContext messageContext)

Add warning messages to message context if needed.

Parameters:

tgtId - the tgt id

messageContext - the message context

Returns:

true if warnings were found and added, false otherwise.

Since:

4.1.0

setCentralAuthenticationService

public final void setCentralAuthenticationService(CentralAuthenticationService centralAuthenticationService)

setWarnCookieGenerator

public final void setWarnCookieGenerator(org.springframework.web.util.CookieGenerator warnCookieGenerator)

setTicketRegistry

@Deprecated
public void setTicketRegistry(TicketRegistry ticketRegistry)

Deprecated. As of 4.1

Sets ticket registry.

Parameters:

ticketRegistry - the ticket registry. No longer needed as the core service layer returns the correct object type. Will be removed in future versions.