org.jasig.cas.web.flow

Class AuthenticationViaFormAction

java.lang.Object

org.jasig.cas.web.flow.AuthenticationViaFormAction

@Component(value="authenticationViaFormAction")
public class AuthenticationViaFormAction
extends java.lang.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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AuthenticationViaFormAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	addWarningMessagesToMessageContextIfNeeded(org.jasig.cas.ticket.TicketGrantingTicket tgtId, org.springframework.binding.message.MessageContext messageContext) Add warning messages to message context if needed.
protected org.springframework.webflow.execution.Event	createTicketGrantingTicket(org.springframework.webflow.execution.RequestContext context, org.jasig.cas.authentication.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, org.jasig.cas.authentication.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?
void	setAuthenticationSystemSupport(org.jasig.cas.authentication.AuthenticationSystemSupport authenticationSystemSupport)
void	setCentralAuthenticationService(org.jasig.cas.CentralAuthenticationService centralAuthenticationService)
void	setWarnCookieGenerator(org.springframework.web.util.CookieGenerator warnCookieGenerator)
org.springframework.webflow.execution.Event	submit(org.springframework.webflow.execution.RequestContext context, org.jasig.cas.authentication.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_WITH_WARNINGS

public static final java.lang.String SUCCESS_WITH_WARNINGS

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

See Also:

Constant Field Values

AUTHENTICATION_FAILURE

public static final java.lang.String AUTHENTICATION_FAILURE

Authentication failure result.

See Also:

Constant Field Values

PUBLIC_WORKSTATION_ATTRIBUTE

public static final java.lang.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 transient 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,
                                                 org.jasig.cas.authentication.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

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,
                                                             org.jasig.cas.authentication.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,
                                                                     org.jasig.cas.authentication.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(org.jasig.cas.ticket.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 void setCentralAuthenticationService(org.jasig.cas.CentralAuthenticationService centralAuthenticationService)

setWarnCookieGenerator

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

setAuthenticationSystemSupport

public void setAuthenticationSystemSupport(org.jasig.cas.authentication.AuthenticationSystemSupport authenticationSystemSupport)