org.apereo.cas.web.flow

Class DelegatedClientAuthenticationAction

java.lang.Object

org.springframework.webflow.action.AbstractAction

org.apereo.cas.web.flow.actions.AbstractAuthenticationAction

org.apereo.cas.web.flow.DelegatedClientAuthenticationAction

All Implemented Interfaces:

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

public class DelegatedClientAuthenticationAction
extends org.apereo.cas.web.flow.actions.AbstractAuthenticationAction

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	DelegatedClientAuthenticationAction.ProviderLoginPageConfiguration The Provider login page configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apereo.cas.authentication.AuthenticationSystemSupport	authenticationSystemSupport The Authentication system support.
protected org.pac4j.core.client.Clients	clients The Clients.
protected org.apereo.cas.audit.AuditableExecution	delegatedAuthenticationPolicyEnforcer The Delegated authentication policy enforcer.
protected DelegatedClientWebflowManager	delegatedClientWebflowManager The Delegated client webflow manager.
protected org.apereo.cas.web.pac4j.DelegatedSessionCookieManager	delegatedSessionCookieManager The Delegated session cookie manager.
protected java.lang.String	localeParamName The Locale param name.
static java.lang.String	PAC4J_URLS All the urls and names of the pac4j clients.
protected org.apereo.cas.services.ServicesManager	servicesManager The Services manager.
protected java.lang.String	themeParamName The Theme param name.

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

logger

Constructor Summary

Constructors

Constructor and Description

DelegatedClientAuthenticationAction(org.apereo.cas.web.flow.resolver.CasDelegatingWebflowEventResolver initialAuthenticationAttemptWebflowEventResolver, org.apereo.cas.web.flow.resolver.CasWebflowEventResolver serviceTicketRequestWebflowEventResolver, org.apereo.cas.authentication.adaptive.AdaptiveAuthenticationPolicy adaptiveAuthenticationPolicy, org.pac4j.core.client.Clients clients, org.apereo.cas.services.ServicesManager servicesManager, org.apereo.cas.audit.AuditableExecution delegatedAuthenticationPolicyEnforcer, DelegatedClientWebflowManager delegatedClientWebflowManager, org.apereo.cas.web.pac4j.DelegatedSessionCookieManager delegatedSessionCookieManager, org.apereo.cas.authentication.AuthenticationSystemSupport authenticationSystemSupport, java.lang.String localeParamName, java.lang.String themeParamName, org.apereo.cas.authentication.AuthenticationServiceSelectionPlan authenticationRequestServiceSelectionStrategies, org.apereo.cas.CentralAuthenticationService centralAuthenticationService)

Method Summary

Modifier and Type	Method and Description
protected java.util.Optional<DelegatedClientAuthenticationAction.ProviderLoginPageConfiguration>	buildProviderConfiguration(org.pac4j.core.client.IndirectClient client, org.pac4j.core.context.WebContext webContext, org.apereo.cas.authentication.principal.WebApplicationService service) Build provider configuration optional.
org.springframework.webflow.execution.Event	doExecute(org.springframework.webflow.execution.RequestContext context)
protected org.pac4j.core.client.BaseClient<org.pac4j.core.credentials.Credentials,org.pac4j.core.profile.CommonProfile>	findDelegatedClientByName(javax.servlet.http.HttpServletRequest request, java.lang.String clientName, org.apereo.cas.authentication.principal.Service service) Find delegated client by name base client.
protected java.lang.String	getCssClass(java.lang.String name) Get a valid CSS class for the given provider name.
protected org.springframework.webflow.execution.Event	handleException(org.pac4j.core.context.J2EContext webContext, org.pac4j.core.client.BaseClient<org.pac4j.core.credentials.Credentials,org.pac4j.core.profile.CommonProfile> client, java.lang.Exception e) Handle the thrown exception.
static java.util.Optional<org.springframework.web.servlet.ModelAndView>	hasDelegationRequestFailed(javax.servlet.http.HttpServletRequest request, int status) Determine if request has errors.
boolean	isDelegatedClientAuthorizedFor(java.lang.String clientName, org.apereo.cas.authentication.principal.Service service) Is delegated client authorized for boolean.
protected boolean	isDelegatedClientAuthorizedForService(org.pac4j.core.client.Client client, org.apereo.cas.authentication.principal.Service service) Is delegated client authorized for service boolean.
protected void	prepareForLoginPage(org.springframework.webflow.execution.RequestContext context) Prepare the data for the login page.
protected org.apereo.cas.authentication.principal.Service	restoreAuthenticationRequestInContext(org.springframework.webflow.execution.RequestContext requestContext, org.pac4j.core.context.J2EContext webContext, java.lang.String clientName) Restore authentication request in context service.
protected org.springframework.webflow.execution.Event	resumeWebflow() Resume webflow event.
protected org.springframework.webflow.execution.Event	stopWebflow() Stop webflow event.

Methods inherited from class org.apereo.cas.web.flow.actions.AbstractAuthenticationAction

onError, onSuccess, onWarn

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

PAC4J_URLS

public static final java.lang.String PAC4J_URLS

All the urls and names of the pac4j clients.

See Also:

Constant Field Values

clients

protected final org.pac4j.core.client.Clients clients

The Clients.

servicesManager

protected final org.apereo.cas.services.ServicesManager servicesManager

The Services manager.

delegatedAuthenticationPolicyEnforcer

protected final org.apereo.cas.audit.AuditableExecution delegatedAuthenticationPolicyEnforcer

The Delegated authentication policy enforcer.

delegatedClientWebflowManager

protected final DelegatedClientWebflowManager delegatedClientWebflowManager

The Delegated client webflow manager.

delegatedSessionCookieManager

protected final org.apereo.cas.web.pac4j.DelegatedSessionCookieManager delegatedSessionCookieManager

The Delegated session cookie manager.

authenticationSystemSupport

protected final org.apereo.cas.authentication.AuthenticationSystemSupport authenticationSystemSupport

The Authentication system support.

localeParamName

protected final java.lang.String localeParamName

The Locale param name.

themeParamName

protected final java.lang.String themeParamName

The Theme param name.

Constructor Detail

DelegatedClientAuthenticationAction

public DelegatedClientAuthenticationAction(org.apereo.cas.web.flow.resolver.CasDelegatingWebflowEventResolver initialAuthenticationAttemptWebflowEventResolver,
                                           org.apereo.cas.web.flow.resolver.CasWebflowEventResolver serviceTicketRequestWebflowEventResolver,
                                           org.apereo.cas.authentication.adaptive.AdaptiveAuthenticationPolicy adaptiveAuthenticationPolicy,
                                           org.pac4j.core.client.Clients clients,
                                           org.apereo.cas.services.ServicesManager servicesManager,
                                           org.apereo.cas.audit.AuditableExecution delegatedAuthenticationPolicyEnforcer,
                                           DelegatedClientWebflowManager delegatedClientWebflowManager,
                                           org.apereo.cas.web.pac4j.DelegatedSessionCookieManager delegatedSessionCookieManager,
                                           org.apereo.cas.authentication.AuthenticationSystemSupport authenticationSystemSupport,
                                           java.lang.String localeParamName,
                                           java.lang.String themeParamName,
                                           org.apereo.cas.authentication.AuthenticationServiceSelectionPlan authenticationRequestServiceSelectionStrategies,
                                           org.apereo.cas.CentralAuthenticationService centralAuthenticationService)

Method Detail

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.

doExecute

public org.springframework.webflow.execution.Event doExecute(org.springframework.webflow.execution.RequestContext context)

Overrides:

doExecute in class org.apereo.cas.web.flow.actions.AbstractAuthenticationAction

handleException

protected org.springframework.webflow.execution.Event handleException(org.pac4j.core.context.J2EContext webContext,
                                                                      org.pac4j.core.client.BaseClient<org.pac4j.core.credentials.Credentials,org.pac4j.core.profile.CommonProfile> client,
                                                                      java.lang.Exception e)

Handle the thrown exception.

Parameters:

webContext - the web context

client - the authentication client

e - the thrown exception

Returns:

the event to trigger

isDelegatedClientAuthorizedFor

public boolean isDelegatedClientAuthorizedFor(java.lang.String clientName,
                                              org.apereo.cas.authentication.principal.Service service)

Is delegated client authorized for boolean.

Parameters:

clientName - the client name

service - the service

Returns:

the boolean

findDelegatedClientByName

protected org.pac4j.core.client.BaseClient<org.pac4j.core.credentials.Credentials,org.pac4j.core.profile.CommonProfile> findDelegatedClientByName(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                  java.lang.String clientName,
                                                                                                                                                  org.apereo.cas.authentication.principal.Service service)

Find delegated client by name base client.

Parameters:

request - the request

clientName - the client name

service - the service

Returns:

the base client

prepareForLoginPage

protected void prepareForLoginPage(org.springframework.webflow.execution.RequestContext context)

Prepare the data for the login page.

Parameters:

context - The current webflow context

buildProviderConfiguration

protected java.util.Optional<DelegatedClientAuthenticationAction.ProviderLoginPageConfiguration> buildProviderConfiguration(org.pac4j.core.client.IndirectClient client,
                                                                                                                            org.pac4j.core.context.WebContext webContext,
                                                                                                                            org.apereo.cas.authentication.principal.WebApplicationService service)

Build provider configuration optional.

Parameters:

client - the client

webContext - the web context

service - the service

Returns:

the optional

getCssClass

protected java.lang.String getCssClass(java.lang.String name)

Get a valid CSS class for the given provider name.

Parameters:

name - Name of the provider

Returns:

the css class

stopWebflow

protected org.springframework.webflow.execution.Event stopWebflow()

Stop webflow event.

Returns:

the event

resumeWebflow

protected org.springframework.webflow.execution.Event resumeWebflow()

Resume webflow event.

Returns:

the event

isDelegatedClientAuthorizedForService

protected boolean isDelegatedClientAuthorizedForService(org.pac4j.core.client.Client client,
                                                        org.apereo.cas.authentication.principal.Service service)

Is delegated client authorized for service boolean.

Parameters:

client - the client

service - the service

Returns:

the boolean

restoreAuthenticationRequestInContext

protected org.apereo.cas.authentication.principal.Service restoreAuthenticationRequestInContext(org.springframework.webflow.execution.RequestContext requestContext,
                                                                                                org.pac4j.core.context.J2EContext webContext,
                                                                                                java.lang.String clientName)

Restore authentication request in context service.

Parameters:

requestContext - the request context

webContext - the web context

clientName - the client name

Returns:

the service