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.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	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
void	doBind(org.springframework.webflow.execution.RequestContext context, Credential credential)
void	setCentralAuthenticationService(CentralAuthenticationService centralAuthenticationService)
void	setCredentialsBinder(CredentialsBinder credentialsBinder) Set a CredentialsBinder for additional binding of the HttpServletRequest to the Credential instance, beyond our default binding of the Credential as a Form Object in Spring WebMVC parlance.
void	setTicketRegistry(TicketRegistry ticketRegistry)
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)

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

logger

protected final org.slf4j.Logger logger

Logger instance.

Constructor Detail

AuthenticationViaFormAction

public AuthenticationViaFormAction()

Method Detail

doBind

public final void doBind(org.springframework.webflow.execution.RequestContext context,
          Credential credential)
                  throws Exception

Throws:

Exception

submit

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

Throws:

Exception

setCentralAuthenticationService

public final void setCentralAuthenticationService(CentralAuthenticationService centralAuthenticationService)

setTicketRegistry

public void setTicketRegistry(TicketRegistry ticketRegistry)

setCredentialsBinder

public final void setCredentialsBinder(CredentialsBinder credentialsBinder)

Set a CredentialsBinder for additional binding of the HttpServletRequest to the Credential instance, beyond our default binding of the Credential as a Form Object in Spring WebMVC parlance. By the time we invoke this CredentialsBinder, we have already engaged in default binding such that for each HttpServletRequest parameter, if there was a JavaBean property of the Credential implementation of the same name, we have set that property to be the value of the corresponding request parameter. This CredentialsBinder plugin point exists to allow consideration of things other than HttpServletRequest parameters in populating the Credential (or more sophisticated consideration of the HttpServletRequest parameters).

Parameters:

credentialsBinder - the credential binder to set.

setWarnCookieGenerator

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