org.apereo.cas.web.flow

Class AbstractCasWebflowConfigurer

java.lang.Object

org.apereo.cas.web.flow.AbstractCasWebflowConfigurer

All Implemented Interfaces:

org.apereo.cas.web.flow.CasWebflowConfigurer

Direct Known Subclasses:

AbstractCasMultifactorWebflowConfigurer, DefaultWebflowConfigurer

public abstract class AbstractCasWebflowConfigurer
extends java.lang.Object
implements org.apereo.cas.web.flow.CasWebflowConfigurer

The AbstractCasWebflowConfigurer is responsible for providing an entry point into the CAS webflow.

Since:

4.2

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext Application context.
protected org.apereo.cas.configuration.CasConfigurationProperties	casProperties CAS Properties.
protected org.springframework.webflow.engine.builder.support.FlowBuilderServices	flowBuilderServices Flow builder services.
protected org.springframework.webflow.definition.registry.FlowDefinitionRegistry	loginFlowDefinitionRegistry The Login flow definition registry.
protected org.springframework.webflow.definition.registry.FlowDefinitionRegistry	logoutFlowDefinitionRegistry The logout flow definition registry.

Fields inherited from interface org.apereo.cas.web.flow.CasWebflowConfigurer

FLOW_ID_LOGIN, FLOW_ID_LOGOUT

Constructor Summary

Constructors

Constructor and Description
AbstractCasWebflowConfigurer(org.springframework.webflow.engine.builder.support.FlowBuilderServices flowBuilderServices, org.springframework.webflow.definition.registry.FlowDefinitionRegistry loginFlowDefinitionRegistry)

Method Summary

Modifier and Type	Method and Description
org.springframework.webflow.engine.Flow	buildFlow(java.lang.String location, java.lang.String id)
protected boolean	containsFlowState(org.springframework.webflow.engine.Flow flow, java.lang.String stateId) Contains flow state?
protected boolean	containsTransition(org.springframework.webflow.engine.TransitionableState state, java.lang.String transition) Contains transition boolean.
org.springframework.webflow.engine.ActionState	createActionState(org.springframework.webflow.engine.Flow flow, java.lang.String name, org.springframework.webflow.execution.Action... actions)
org.springframework.webflow.engine.DecisionState	createDecisionState(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String testExpression, java.lang.String thenStateId, java.lang.String elseStateId)
org.springframework.webflow.engine.EndState	createEndState(org.springframework.webflow.engine.Flow flow, java.lang.String id)
org.springframework.webflow.engine.EndState	createEndState(org.springframework.webflow.engine.Flow flow, java.lang.String id, org.springframework.binding.expression.Expression expression)
org.springframework.webflow.engine.EndState	createEndState(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String viewId)
org.springframework.webflow.engine.EndState	createEndState(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String viewId, boolean redirect)
org.springframework.webflow.engine.EndState	createEndState(org.springframework.webflow.engine.Flow flow, java.lang.String id, org.springframework.webflow.execution.ViewFactory viewFactory)
org.springframework.webflow.action.EvaluateAction	createEvaluateAction(java.lang.String expression)
protected org.springframework.binding.expression.Expression	createExpression(java.lang.String expression, java.lang.Class expectedType) Create expression expression.
protected org.springframework.webflow.engine.FlowVariable	createFlowVariable(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.Class type) Create flow variable flow variable.
protected org.springframework.binding.mapping.Mapper	createMapperToSubflowState(java.util.List<org.springframework.binding.mapping.impl.DefaultMapping> mappings) Create mapper to subflow state.
protected org.springframework.binding.mapping.impl.DefaultMapping	createMappingToSubflowState(java.lang.String name, java.lang.String value, boolean required, java.lang.Class type) Create mapping to subflow state.
protected org.springframework.webflow.engine.builder.BinderConfiguration	createStateBinderConfiguration(java.util.List<java.lang.String> properties) Create state model bindings.
protected void	createStateDefaultTransition(org.springframework.webflow.engine.TransitionableState state, java.lang.String targetState) Add a default transition to a given state.
protected void	createStateModelBinding(org.springframework.webflow.engine.TransitionableState state, java.lang.String modelName, java.lang.Class modelType) Create state model binding.
protected org.springframework.webflow.engine.SubflowAttributeMapper	createSubflowAttributeMapper(org.springframework.binding.mapping.Mapper inputMapper, org.springframework.binding.mapping.Mapper outputMapper) Create subflow attribute mapper.
org.springframework.webflow.engine.SubflowState	createSubflowState(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String subflow)
org.springframework.webflow.engine.SubflowState	createSubflowState(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String subflow, org.springframework.webflow.execution.Action entryAction)
org.springframework.webflow.engine.Transition	createTransition(org.springframework.binding.expression.Expression criteriaOutcomeExpression, java.lang.String targetState)
org.springframework.webflow.engine.Transition	createTransition(java.lang.String targetState)
org.springframework.webflow.engine.Transition	createTransition(java.lang.String criteriaOutcome, java.lang.String targetState)
org.springframework.webflow.engine.Transition	createTransition(java.lang.String criteriaOutcome, org.springframework.webflow.engine.TransitionableState targetState)
protected org.springframework.webflow.engine.Transition	createTransitionForState(org.springframework.webflow.engine.TransitionableState state, java.lang.String criteriaOutcome, java.lang.String targetState) Create transition for state transition.
protected org.springframework.webflow.engine.Transition	createTransitionForState(org.springframework.webflow.engine.TransitionableState state, java.lang.String criteriaOutcome, java.lang.String targetState, boolean removeExisting) Add transition to action state.
org.springframework.webflow.engine.ViewState	createViewState(org.springframework.webflow.engine.Flow flow, java.lang.String id, org.springframework.binding.expression.Expression expression, org.springframework.webflow.engine.builder.BinderConfiguration binder)
org.springframework.webflow.engine.ViewState	createViewState(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String viewId)
org.springframework.webflow.engine.ViewState	createViewState(org.springframework.webflow.engine.Flow flow, java.lang.String id, java.lang.String viewId, org.springframework.webflow.engine.builder.BinderConfiguration binder)
protected abstract void	doInitialize() Handle the initialization of the webflow.
protected org.springframework.binding.expression.Expression	getExpressionStringFromAction(org.springframework.webflow.action.EvaluateAction act) Gets expression string from action.
org.springframework.webflow.engine.Flow	getLoginFlow()
org.springframework.webflow.engine.Flow	getLogoutFlow()
protected org.springframework.binding.expression.spel.SpringELExpressionParser	getSpringExpressionParser() Gets spring expression parser.
org.springframework.webflow.engine.TransitionableState	getStartState(org.springframework.webflow.engine.Flow flow)
protected org.springframework.webflow.engine.builder.BinderConfiguration	getViewStateBinderConfiguration(org.springframework.webflow.engine.ViewState state) Gets state binder configuration.
void	initialize()
protected void	registerMultifactorProvidersStateTransitionsIntoWebflow(org.springframework.webflow.engine.TransitionableState state) Register multifactor providers state transitions into webflow.
void	setLogoutFlowDefinitionRegistry(org.springframework.webflow.definition.registry.FlowDefinitionRegistry logoutFlowDefinitionRegistry)
void	setStartState(org.springframework.webflow.engine.Flow flow, java.lang.String state)
void	setStartState(org.springframework.webflow.engine.Flow flow, org.springframework.webflow.engine.TransitionableState state)

Methods inherited from class java.lang.Object

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

Field Detail

logoutFlowDefinitionRegistry

protected org.springframework.webflow.definition.registry.FlowDefinitionRegistry logoutFlowDefinitionRegistry

The logout flow definition registry.

loginFlowDefinitionRegistry

protected final org.springframework.webflow.definition.registry.FlowDefinitionRegistry loginFlowDefinitionRegistry

The Login flow definition registry.

applicationContext

@Autowired
protected org.springframework.context.ApplicationContext applicationContext

Application context.

casProperties

@Autowired
protected org.apereo.cas.configuration.CasConfigurationProperties casProperties

CAS Properties.

flowBuilderServices

protected final org.springframework.webflow.engine.builder.support.FlowBuilderServices flowBuilderServices

Flow builder services.

Constructor Detail

AbstractCasWebflowConfigurer

public AbstractCasWebflowConfigurer(org.springframework.webflow.engine.builder.support.FlowBuilderServices flowBuilderServices,
                                    org.springframework.webflow.definition.registry.FlowDefinitionRegistry loginFlowDefinitionRegistry)

Method Detail

initialize

@PostConstruct
public void initialize()

Specified by:

initialize in interface org.apereo.cas.web.flow.CasWebflowConfigurer

doInitialize

protected abstract void doInitialize()
                              throws java.lang.Exception

Handle the initialization of the webflow.

Throws:

java.lang.Exception - the exception

buildFlow

public org.springframework.webflow.engine.Flow buildFlow(java.lang.String location,
                                                         java.lang.String id)

Specified by:

buildFlow in interface org.apereo.cas.web.flow.CasWebflowConfigurer

getLoginFlow

public org.springframework.webflow.engine.Flow getLoginFlow()

Specified by:

getLoginFlow in interface org.apereo.cas.web.flow.CasWebflowConfigurer

getLogoutFlow

public org.springframework.webflow.engine.Flow getLogoutFlow()

Specified by:

getLogoutFlow in interface org.apereo.cas.web.flow.CasWebflowConfigurer

getStartState

public org.springframework.webflow.engine.TransitionableState getStartState(org.springframework.webflow.engine.Flow flow)

Specified by:

getStartState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createActionState

public org.springframework.webflow.engine.ActionState createActionState(org.springframework.webflow.engine.Flow flow,
                                                                        java.lang.String name,
                                                                        org.springframework.webflow.execution.Action... actions)

Specified by:

createActionState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createDecisionState

public org.springframework.webflow.engine.DecisionState createDecisionState(org.springframework.webflow.engine.Flow flow,
                                                                            java.lang.String id,
                                                                            java.lang.String testExpression,
                                                                            java.lang.String thenStateId,
                                                                            java.lang.String elseStateId)

Specified by:

createDecisionState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

setStartState

public void setStartState(org.springframework.webflow.engine.Flow flow,
                          java.lang.String state)

Specified by:

setStartState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

setStartState

public void setStartState(org.springframework.webflow.engine.Flow flow,
                          org.springframework.webflow.engine.TransitionableState state)

Specified by:

setStartState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createEvaluateAction

public org.springframework.webflow.action.EvaluateAction createEvaluateAction(java.lang.String expression)

Specified by:

createEvaluateAction in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createStateDefaultTransition

protected void createStateDefaultTransition(org.springframework.webflow.engine.TransitionableState state,
                                            java.lang.String targetState)

Add a default transition to a given state.

Parameters:

state - the state to include the default transition

targetState - the id of the destination state to which the flow should transfer

createTransitionForState

protected org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.TransitionableState state,
                                                                                 java.lang.String criteriaOutcome,
                                                                                 java.lang.String targetState)

Create transition for state transition.

Parameters:

state - the state

criteriaOutcome - the criteria outcome

targetState - the target state

Returns:

the transition

createTransitionForState

protected org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.TransitionableState state,
                                                                                 java.lang.String criteriaOutcome,
                                                                                 java.lang.String targetState,
                                                                                 boolean removeExisting)

Add transition to action state.

Parameters:

state - the action state

criteriaOutcome - the criteria outcome

targetState - the target state

removeExisting - the remove existing

Returns:

the transition

createTransition

public org.springframework.webflow.engine.Transition createTransition(java.lang.String criteriaOutcome,
                                                                      java.lang.String targetState)

Specified by:

createTransition in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createTransition

public org.springframework.webflow.engine.Transition createTransition(java.lang.String criteriaOutcome,
                                                                      org.springframework.webflow.engine.TransitionableState targetState)

Specified by:

createTransition in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createTransition

public org.springframework.webflow.engine.Transition createTransition(org.springframework.binding.expression.Expression criteriaOutcomeExpression,
                                                                      java.lang.String targetState)

Specified by:

createTransition in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createExpression

protected org.springframework.binding.expression.Expression createExpression(java.lang.String expression,
                                                                             java.lang.Class expectedType)

Create expression expression.

Parameters:

expression - the expression

expectedType - the expected type

Returns:

the expression

getSpringExpressionParser

protected org.springframework.binding.expression.spel.SpringELExpressionParser getSpringExpressionParser()

Gets spring expression parser.

Returns:

the spring expression parser

createTransition

public org.springframework.webflow.engine.Transition createTransition(java.lang.String targetState)

Specified by:

createTransition in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createEndState

public org.springframework.webflow.engine.EndState createEndState(org.springframework.webflow.engine.Flow flow,
                                                                  java.lang.String id)

Specified by:

createEndState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createEndState

public org.springframework.webflow.engine.EndState createEndState(org.springframework.webflow.engine.Flow flow,
                                                                  java.lang.String id,
                                                                  java.lang.String viewId)

Specified by:

createEndState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createEndState

public org.springframework.webflow.engine.EndState createEndState(org.springframework.webflow.engine.Flow flow,
                                                                  java.lang.String id,
                                                                  org.springframework.binding.expression.Expression expression)

Specified by:

createEndState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createEndState

public org.springframework.webflow.engine.EndState createEndState(org.springframework.webflow.engine.Flow flow,
                                                                  java.lang.String id,
                                                                  java.lang.String viewId,
                                                                  boolean redirect)

Specified by:

createEndState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createEndState

public org.springframework.webflow.engine.EndState createEndState(org.springframework.webflow.engine.Flow flow,
                                                                  java.lang.String id,
                                                                  org.springframework.webflow.execution.ViewFactory viewFactory)

Specified by:

createEndState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createViewState

public org.springframework.webflow.engine.ViewState createViewState(org.springframework.webflow.engine.Flow flow,
                                                                    java.lang.String id,
                                                                    org.springframework.binding.expression.Expression expression,
                                                                    org.springframework.webflow.engine.builder.BinderConfiguration binder)

Specified by:

createViewState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createViewState

public org.springframework.webflow.engine.ViewState createViewState(org.springframework.webflow.engine.Flow flow,
                                                                    java.lang.String id,
                                                                    java.lang.String viewId)

Specified by:

createViewState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createViewState

public org.springframework.webflow.engine.ViewState createViewState(org.springframework.webflow.engine.Flow flow,
                                                                    java.lang.String id,
                                                                    java.lang.String viewId,
                                                                    org.springframework.webflow.engine.builder.BinderConfiguration binder)

Specified by:

createViewState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createSubflowState

public org.springframework.webflow.engine.SubflowState createSubflowState(org.springframework.webflow.engine.Flow flow,
                                                                          java.lang.String id,
                                                                          java.lang.String subflow,
                                                                          org.springframework.webflow.execution.Action entryAction)

Specified by:

createSubflowState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createSubflowState

public org.springframework.webflow.engine.SubflowState createSubflowState(org.springframework.webflow.engine.Flow flow,
                                                                          java.lang.String id,
                                                                          java.lang.String subflow)

Specified by:

createSubflowState in interface org.apereo.cas.web.flow.CasWebflowConfigurer

createMapperToSubflowState

protected org.springframework.binding.mapping.Mapper createMapperToSubflowState(java.util.List<org.springframework.binding.mapping.impl.DefaultMapping> mappings)

Create mapper to subflow state.

Parameters:

mappings - the mappings

Returns:

the mapper

createMappingToSubflowState

protected org.springframework.binding.mapping.impl.DefaultMapping createMappingToSubflowState(java.lang.String name,
                                                                                              java.lang.String value,
                                                                                              boolean required,
                                                                                              java.lang.Class type)

Create mapping to subflow state.

Parameters:

name - the name

value - the value

required - the required

type - the type

Returns:

the default mapping

createSubflowAttributeMapper

protected org.springframework.webflow.engine.SubflowAttributeMapper createSubflowAttributeMapper(org.springframework.binding.mapping.Mapper inputMapper,
                                                                                                 org.springframework.binding.mapping.Mapper outputMapper)

Create subflow attribute mapper.

Parameters:

inputMapper - the input mapper

outputMapper - the output mapper

Returns:

the subflow attribute mapper

setLogoutFlowDefinitionRegistry

public void setLogoutFlowDefinitionRegistry(org.springframework.webflow.definition.registry.FlowDefinitionRegistry logoutFlowDefinitionRegistry)

containsFlowState

protected boolean containsFlowState(org.springframework.webflow.engine.Flow flow,
                                    java.lang.String stateId)

Contains flow state?

Parameters:

flow - the flow

stateId - the state id

Returns:

true if flow contains the state.

containsTransition

protected boolean containsTransition(org.springframework.webflow.engine.TransitionableState state,
                                     java.lang.String transition)

Contains transition boolean.

Parameters:

state - the state

transition - the transition

Returns:

the boolean

createFlowVariable

protected org.springframework.webflow.engine.FlowVariable createFlowVariable(org.springframework.webflow.engine.Flow flow,
                                                                             java.lang.String id,
                                                                             java.lang.Class type)

Create flow variable flow variable.

Parameters:

flow - the flow

id - the id

type - the type

Returns:

the flow variable

createStateBinderConfiguration

protected org.springframework.webflow.engine.builder.BinderConfiguration createStateBinderConfiguration(java.util.List<java.lang.String> properties)

Create state model bindings.

Parameters:

properties - the properties

Returns:

the binder configuration

createStateModelBinding

protected void createStateModelBinding(org.springframework.webflow.engine.TransitionableState state,
                                       java.lang.String modelName,
                                       java.lang.Class modelType)

Create state model binding.

Parameters:

state - the state

modelName - the model name

modelType - the model type

getViewStateBinderConfiguration

protected org.springframework.webflow.engine.builder.BinderConfiguration getViewStateBinderConfiguration(org.springframework.webflow.engine.ViewState state)

Gets state binder configuration.

Parameters:

state - the state

Returns:

the state binder configuration

getExpressionStringFromAction

protected org.springframework.binding.expression.Expression getExpressionStringFromAction(org.springframework.webflow.action.EvaluateAction act)

Gets expression string from action.

Parameters:

act - the act

Returns:

the expression string from action

registerMultifactorProvidersStateTransitionsIntoWebflow

protected void registerMultifactorProvidersStateTransitionsIntoWebflow(org.springframework.webflow.engine.TransitionableState state)

Register multifactor providers state transitions into webflow.

Parameters:

state - the state