org.apereo.cas.support.pac4j.web.flow

Class ClientAction

java.lang.Object

org.springframework.webflow.action.AbstractAction

org.apereo.cas.support.pac4j.web.flow.ClientAction

All Implemented Interfaces:

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

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

This class represents an action to put at the beginning of the webflow.

Before any authentication, redirection urls are computed for the different clients defined as well as the theme, locale, method and service are saved into the web session.

After authentication, appropriate information are expected on this callback url to finish the authentication process with the provider.

Since:

3.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientAction.ProviderLoginPageConfiguration The Provider login page configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLIENT_ACTION Client action state id in the webflow.
static java.lang.String	PAC4J_URLS All the urls and names of the pac4j clients.
static java.lang.String	STOP Stop the webflow.
static java.lang.String	STOP_WEBFLOW Stop the webflow for pac4j and route to view.
static java.lang.String	VIEW_ID_STOP_WEBFLOW View id that stops the webflow.

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

logger

Constructor Summary

Constructors

Constructor and Description
ClientAction(org.apereo.cas.configuration.CasConfigurationProperties casProperties) Build the ClientAction.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.webflow.execution.Event	doExecute(org.springframework.webflow.execution.RequestContext context)
org.apereo.cas.authentication.AuthenticationSystemSupport	getAuthenticationSystemSupport()
org.apereo.cas.CentralAuthenticationService	getCentralAuthenticationService()
org.pac4j.core.client.Clients	getClients()
static java.util.Optional<org.springframework.web.servlet.ModelAndView>	hasDelegationRequestFailed(javax.servlet.http.HttpServletRequest request, int status) Determine if request has errors.
protected void	prepareForLoginPage(org.springframework.webflow.execution.RequestContext context) Prepare the data for the login page.
void	setAuthenticationSystemSupport(org.apereo.cas.authentication.AuthenticationSystemSupport authenticationSystemSupport)
void	setCentralAuthenticationService(org.apereo.cas.CentralAuthenticationService centralAuthenticationService)
void	setClients(org.pac4j.core.client.Clients clients)

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

STOP_WEBFLOW

public static final java.lang.String STOP_WEBFLOW

Stop the webflow for pac4j and route to view.

See Also:

Constant Field Values

STOP

public static final java.lang.String STOP

Stop the webflow.

See Also:

Constant Field Values

CLIENT_ACTION

public static final java.lang.String CLIENT_ACTION

Client action state id in the webflow.

See Also:

Constant Field Values

PAC4J_URLS

public static final java.lang.String PAC4J_URLS

All the urls and names of the pac4j clients.

See Also:

Constant Field Values

VIEW_ID_STOP_WEBFLOW

public static final java.lang.String VIEW_ID_STOP_WEBFLOW

View id that stops the webflow.

See Also:

Constant Field Values

Constructor Detail

ClientAction

public ClientAction(org.apereo.cas.configuration.CasConfigurationProperties casProperties)

Build the ClientAction.

Parameters:

casProperties - the cas properties

Method Detail

doExecute

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

Specified by:

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

Throws:

java.lang.Exception

prepareForLoginPage

protected void prepareForLoginPage(org.springframework.webflow.execution.RequestContext context)
                            throws org.pac4j.core.exception.HttpAction

Prepare the data for the login page.

Parameters:

context - The current webflow context

Throws:

org.pac4j.core.exception.HttpAction - the http action

getClients

public org.pac4j.core.client.Clients getClients()

setClients

public void setClients(org.pac4j.core.client.Clients clients)

getCentralAuthenticationService

public org.apereo.cas.CentralAuthenticationService getCentralAuthenticationService()

setCentralAuthenticationService

public void setCentralAuthenticationService(org.apereo.cas.CentralAuthenticationService centralAuthenticationService)

getAuthenticationSystemSupport

public org.apereo.cas.authentication.AuthenticationSystemSupport getAuthenticationSystemSupport()

setAuthenticationSystemSupport

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

hasDelegationRequestFailed

public static java.util.Optional<org.springframework.web.servlet.ModelAndView> hasDelegationRequestFailed(javax.servlet.http.HttpServletRequest request,
                                                                                                          int status)

Determine if request has errors.

Parameters:

request - the request

status - the status

Returns:

the optional model and view, if request is an error.