Package org.apereo.cas.web.flow
Interface CasWebflowConfigurer
- All Superinterfaces:
org.springframework.core.Ordered
public interface CasWebflowConfigurer
extends org.springframework.core.Ordered
This is
CasWebflowConfigurer.- Since:
- 5.0.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringFlow id for account profiles.static final StringFlow id for delegated authentication redirect.static final StringMain login flow id.static final StringMain logout flow id.static final StringFlow id for password reset.static final StringFlow id for risk-based authentication's verification.Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.webflow.engine.FlowBuild flow.booleancontainsFlowState(org.springframework.webflow.engine.Flow flow, String stateId) Contains flow state boolean.booleancontainsSubflowState(org.springframework.webflow.engine.Flow flow, String stateId) Contains subflow state boolean.booleancontainsTransition(org.springframework.webflow.engine.TransitionableState state, String transition) Contains transition boolean.org.springframework.webflow.engine.ActionStatecreateActionState(org.springframework.webflow.engine.Flow flow, String name) Create action state action state.org.springframework.webflow.engine.ActionStatecreateActionState(org.springframework.webflow.engine.Flow flow, String name, String... action) Create action state action state.org.springframework.webflow.engine.ActionStatecreateActionState(org.springframework.webflow.engine.Flow flow, String name, org.springframework.webflow.execution.Action action) Create action state action state.org.springframework.webflow.engine.ActionStatecreateActionState(org.springframework.webflow.engine.Flow flow, String name, org.springframework.webflow.execution.Action... actions) Create action state action state.org.springframework.webflow.engine.DecisionStatecreateDecisionState(org.springframework.webflow.engine.Flow flow, String id, String testExpression, String thenStateId, String elseStateId) Create decision state decision state.org.springframework.webflow.engine.EndStatecreateEndState(org.springframework.webflow.engine.Flow flow, String id) Create end state.org.springframework.webflow.engine.EndStatecreateEndState(org.springframework.webflow.engine.Flow flow, String id, String viewId) Create end state.org.springframework.webflow.engine.EndStatecreateEndState(org.springframework.webflow.engine.Flow flow, String id, String viewId, boolean redirect) Create end state with option to handle an external redirect.org.springframework.webflow.engine.EndStatecreateEndState(org.springframework.webflow.engine.Flow flow, String id, org.springframework.binding.expression.Expression expression) Create end state.org.springframework.webflow.engine.EndStatecreateEndState(org.springframework.webflow.engine.Flow flow, String id, org.springframework.webflow.execution.ViewFactory viewFactory) Create end state.org.springframework.webflow.action.EvaluateActioncreateEvaluateAction(String expression) Create evaluate action evaluate action.org.springframework.binding.expression.ExpressioncreateExpression(String expression) Create expression expression.org.springframework.binding.expression.ExpressioncreateExpression(String expression, Class expectedType) Create expression expression.org.springframework.webflow.engine.FlowVariablecreateFlowVariable(org.springframework.webflow.engine.Flow flow, String id, Class type) Create flow variable flow variable.org.springframework.webflow.action.RenderActioncreateRenderAction(String... fragmentExpression) Create render action.org.springframework.webflow.action.SetActioncreateSetAction(String name, String value) Create set action set action.org.springframework.webflow.engine.builder.BinderConfigurationcreateStateBinderConfiguration(List<String> properties) Create state binder configuration binder configuration.org.springframework.webflow.engine.builder.BinderConfigurationCreate state binder configuration.voidcreateStateDefaultTransition(org.springframework.webflow.engine.TransitionableState state, String targetState) Create state default transition.voidcreateStateDefaultTransition(org.springframework.webflow.engine.TransitionableState state, org.springframework.webflow.definition.StateDefinition targetState) Create state default transition.voidcreateStateModelBinding(org.springframework.webflow.engine.TransitionableState state, String modelName, Class modelType) Create state model binding.org.springframework.webflow.engine.SubflowStatecreateSubflowState(org.springframework.webflow.engine.Flow flow, String id, String subflow) Create subflow state subflow state.org.springframework.webflow.engine.SubflowStatecreateSubflowState(org.springframework.webflow.engine.Flow flow, String id, String subflow, org.springframework.webflow.execution.Action entryAction) Create subflow state subflow state.org.springframework.webflow.engine.TransitioncreateTransition(String targetState) Create transition transition.org.springframework.webflow.engine.TransitioncreateTransition(String criteriaOutcome, String targetState) Create transition transition.org.springframework.webflow.engine.TransitioncreateTransition(String criteriaOutcome, String targetState, org.springframework.webflow.execution.Action... actions) Create transition transition.org.springframework.webflow.engine.TransitioncreateTransition(String criteriaOutcome, org.springframework.webflow.engine.TransitionableState targetState) Create transition transition.org.springframework.webflow.engine.TransitioncreateTransition(org.springframework.binding.expression.Expression criteriaOutcomeExpression, String targetState, org.springframework.webflow.execution.Action... actions) Create transition transition.org.springframework.webflow.engine.TransitioncreateTransitionForState(org.springframework.webflow.engine.Flow flow, String stateId, String criteriaOutcome, String targetState) Create transition for state transition.org.springframework.webflow.engine.TransitioncreateTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome) Create transition for state transition.org.springframework.webflow.engine.TransitioncreateTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState) Create transition for state transition.org.springframework.webflow.engine.TransitioncreateTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, boolean removeExisting) Create transition for state transition.org.springframework.webflow.engine.TransitioncreateTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, boolean removeExisting, Map<String, Object> attributes) Create transition for state transition.org.springframework.webflow.engine.TransitioncreateTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, boolean removeExisting, Map<String, Object> attributes, org.springframework.webflow.execution.Action... actions) Create transition for state transition.org.springframework.webflow.engine.TransitioncreateTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, Map<String, Object> attributes) Create transition for state transition.org.springframework.webflow.engine.TransitioncreateTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, Map<String, Object> attributes, org.springframework.webflow.execution.Action... actions) Create transition for state transition.org.springframework.webflow.engine.TransitioncreateTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, org.springframework.webflow.execution.Action... actions) Create transition for state transition.org.springframework.webflow.engine.ViewStatecreateViewState(org.springframework.webflow.engine.Flow flow, String id, String viewId) Create view state view state.org.springframework.webflow.engine.ViewStatecreateViewState(org.springframework.webflow.engine.Flow flow, String id, String viewId, org.springframework.webflow.engine.builder.BinderConfiguration binder) Create view state view state.org.springframework.webflow.engine.ViewStatecreateViewState(org.springframework.webflow.engine.Flow flow, String id, org.springframework.binding.expression.Expression expression, org.springframework.webflow.engine.builder.BinderConfiguration binder) Create view state view state.org.springframework.webflow.engine.ViewStatecreateViewState(org.springframework.webflow.engine.Flow flow, String id, org.springframework.webflow.execution.ViewFactory viewFactory) Create view state view state.org.springframework.webflow.engine.FlowGets flow.org.springframework.webflow.engine.FlowGets flow.org.springframework.webflow.engine.FlowGets login flow.org.springframework.webflow.engine.FlowGets logout flow.default StringgetName()Gets name.org.springframework.webflow.engine.TransitionableStategetStartState(org.springframework.webflow.engine.Flow flow) Gets start state.org.springframework.webflow.engine.TransitionableStateGets state.<T> TGets state.List<org.springframework.webflow.engine.TransitionCriteria> getTransitionExecutionCriteriaChainForTransition(org.springframework.webflow.engine.Transition def) Gets transition execution criteria chain for transition.org.springframework.webflow.engine.builder.BinderConfigurationgetViewStateBinderConfiguration(org.springframework.webflow.engine.ViewState state) Gets view state binder configuration.voidInitialize.org.springframework.webflow.engine.TransitioninsertTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState) Insert transition for state.default voidpostInitialization(org.springframework.context.ConfigurableApplicationContext applicationContext) Post initialization, typically after the state of application is declared as ready.voidsetStartState(org.springframework.webflow.engine.Flow flow, String state) Sets start state.voidsetStartState(org.springframework.webflow.engine.Flow flow, org.springframework.webflow.engine.TransitionableState state) Sets start state.Methods inherited from interface org.springframework.core.Ordered
getOrder
-
Field Details
-
FLOW_ID_RISK_VERIFICATION
Flow id for risk-based authentication's verification.- See Also:
-
FLOW_ID_DELEGATION_REDIRECT
Flow id for delegated authentication redirect.- See Also:
-
FLOW_ID_PASSWORD_RESET
Flow id for password reset.- See Also:
-
FLOW_ID_ACCOUNT
Flow id for account profiles.- See Also:
-
FLOW_ID_LOGIN
Main login flow id.- See Also:
-
FLOW_ID_LOGOUT
Main logout flow id.- See Also:
-
-
Method Details
-
initialize
void initialize()Initialize. -
postInitialization
default void postInitialization(org.springframework.context.ConfigurableApplicationContext applicationContext) Post initialization, typically after the state of application is declared as ready.- Parameters:
applicationContext- the application context
-
getLoginFlow
org.springframework.webflow.engine.Flow getLoginFlow()Gets login flow.- Returns:
- the login flow
-
getLogoutFlow
org.springframework.webflow.engine.Flow getLogoutFlow()Gets logout flow.- Returns:
- the logout flow
-
getStartState
org.springframework.webflow.engine.TransitionableState getStartState(org.springframework.webflow.engine.Flow flow) Gets start state.- Parameters:
flow- the flow- Returns:
- the start state
-
createTransition
org.springframework.webflow.engine.Transition createTransition(String criteriaOutcome, String targetState) Create transition transition.- Parameters:
criteriaOutcome- the criteria outcometargetState- the target state- Returns:
- the transition
-
createTransition
org.springframework.webflow.engine.Transition createTransition(String criteriaOutcome, String targetState, org.springframework.webflow.execution.Action... actions) Create transition transition.- Parameters:
criteriaOutcome- the criteria outcometargetState- the target stateactions- the actions- Returns:
- the transition
-
createTransition
org.springframework.webflow.engine.Transition createTransition(String criteriaOutcome, org.springframework.webflow.engine.TransitionableState targetState) Create transition transition.- Parameters:
criteriaOutcome- the criteria outcometargetState- the target state- Returns:
- the transition
-
createTransition
org.springframework.webflow.engine.Transition createTransition(org.springframework.binding.expression.Expression criteriaOutcomeExpression, String targetState, org.springframework.webflow.execution.Action... actions) Create transition transition.- Parameters:
criteriaOutcomeExpression- the criteria outcome expressiontargetState- the target stateactions- the actions- Returns:
- the transition
-
createTransition
Create transition transition.- Parameters:
targetState- the target state- Returns:
- the transition
-
createRenderAction
Create render action.- Parameters:
fragmentExpression- the fragment expression- Returns:
- the render action
-
createSetAction
Create set action set action.- Parameters:
name- the namevalue- the value- Returns:
- the set action
-
createEvaluateAction
Create evaluate action evaluate action.- Parameters:
expression- the expression- Returns:
- the evaluate action
-
createActionState
org.springframework.webflow.engine.ActionState createActionState(org.springframework.webflow.engine.Flow flow, String name) Create action state action state.- Parameters:
flow- the flowname- the name- Returns:
- the action state
-
createActionState
org.springframework.webflow.engine.ActionState createActionState(org.springframework.webflow.engine.Flow flow, String name, String... action) Create action state action state.- Parameters:
flow- the flowname- the nameaction- the action- Returns:
- the action state
-
createActionState
org.springframework.webflow.engine.ActionState createActionState(org.springframework.webflow.engine.Flow flow, String name, org.springframework.webflow.execution.Action... actions) Create action state action state.- Parameters:
flow- the flowname- the nameactions- the actions- Returns:
- the action state
-
createActionState
org.springframework.webflow.engine.ActionState createActionState(org.springframework.webflow.engine.Flow flow, String name, org.springframework.webflow.execution.Action action) Create action state action state.- Parameters:
flow- the flowname- the nameaction- the action- Returns:
- the action state
-
createDecisionState
org.springframework.webflow.engine.DecisionState createDecisionState(org.springframework.webflow.engine.Flow flow, String id, String testExpression, String thenStateId, String elseStateId) Create decision state decision state.- Parameters:
flow- the flowid- the idtestExpression- the test expressionthenStateId- the then state idelseStateId- the else state id- Returns:
- the decision state
-
setStartState
Sets start state.- Parameters:
flow- the flowstate- the state
-
setStartState
void setStartState(org.springframework.webflow.engine.Flow flow, org.springframework.webflow.engine.TransitionableState state) Sets start state.- Parameters:
flow- the flowstate- the state
-
createEndState
org.springframework.webflow.engine.EndState createEndState(org.springframework.webflow.engine.Flow flow, String id) Create end state.- Parameters:
flow- the flowid- the id- Returns:
- the end state
-
createEndState
org.springframework.webflow.engine.EndState createEndState(org.springframework.webflow.engine.Flow flow, String id, String viewId, boolean redirect) Create end state with option to handle an external redirect.- Parameters:
flow- the flowid- the idviewId- the view idredirect- the redirect- Returns:
- the end state
-
createEndState
org.springframework.webflow.engine.EndState createEndState(org.springframework.webflow.engine.Flow flow, String id, String viewId) Create end state.- Parameters:
flow- the flowid- the idviewId- the view id- Returns:
- the end state
-
createEndState
org.springframework.webflow.engine.EndState createEndState(org.springframework.webflow.engine.Flow flow, String id, org.springframework.binding.expression.Expression expression) Create end state.- Parameters:
flow- the flowid- the idexpression- the expression- Returns:
- the end state
-
createEndState
org.springframework.webflow.engine.EndState createEndState(org.springframework.webflow.engine.Flow flow, String id, org.springframework.webflow.execution.ViewFactory viewFactory) Create end state.- Parameters:
flow- the flowid- the idviewFactory- the view factory- Returns:
- the end state
-
createViewState
org.springframework.webflow.engine.ViewState createViewState(org.springframework.webflow.engine.Flow flow, String id, org.springframework.binding.expression.Expression expression, org.springframework.webflow.engine.builder.BinderConfiguration binder) Create view state view state.- Parameters:
flow- the flowid- the idexpression- the expressionbinder- the binder- Returns:
- the view state
-
createViewState
org.springframework.webflow.engine.ViewState createViewState(org.springframework.webflow.engine.Flow flow, String id, org.springframework.webflow.execution.ViewFactory viewFactory) Create view state view state.- Parameters:
flow- the flowid- the idviewFactory- the view factory- Returns:
- the view state
-
createViewState
org.springframework.webflow.engine.ViewState createViewState(org.springframework.webflow.engine.Flow flow, String id, String viewId) Create view state view state.- Parameters:
flow- the flowid- the idviewId- the view id- Returns:
- the view state
-
createViewState
org.springframework.webflow.engine.ViewState createViewState(org.springframework.webflow.engine.Flow flow, String id, String viewId, org.springframework.webflow.engine.builder.BinderConfiguration binder) Create view state view state.- Parameters:
flow- the flowid- the idviewId- the view idbinder- the binder- Returns:
- the view state
-
createSubflowState
org.springframework.webflow.engine.SubflowState createSubflowState(org.springframework.webflow.engine.Flow flow, String id, String subflow, org.springframework.webflow.execution.Action entryAction) Create subflow state subflow state.- Parameters:
flow- the flowid- the idsubflow- the subflowentryAction- the entry action- Returns:
- the subflow state
-
createSubflowState
org.springframework.webflow.engine.SubflowState createSubflowState(org.springframework.webflow.engine.Flow flow, String id, String subflow) Create subflow state subflow state.- Parameters:
flow- the flowid- the idsubflow- the subflow- Returns:
- the subflow state
-
buildFlow
Build flow.- Parameters:
id- the id- Returns:
- the flow
-
getName
Gets name.- Returns:
- the name
-
createStateDefaultTransition
void createStateDefaultTransition(org.springframework.webflow.engine.TransitionableState state, String targetState) Create state default transition.- Parameters:
state- the statetargetState- the target state
-
createStateDefaultTransition
void createStateDefaultTransition(org.springframework.webflow.engine.TransitionableState state, org.springframework.webflow.definition.StateDefinition targetState) Create state default transition.- Parameters:
state- the statetargetState- the target state
-
createTransitionForState
org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, Map<String, Object> attributes) Create transition for state transition.- Parameters:
state- the statecriteriaOutcome- the criteria outcometargetState- the target stateattributes- the attributes- Returns:
- the transition
-
createTransitionForState
org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome) Create transition for state transition.- Parameters:
state- the statecriteriaOutcome- the criteria outcome- Returns:
- the transition
-
createTransitionForState
org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState) Create transition for state transition.- Parameters:
state- the statecriteriaOutcome- the criteria outcometargetState- the target state- Returns:
- the transition
-
createTransitionForState
org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, Map<String, Object> attributes, org.springframework.webflow.execution.Action... actions) Create transition for state transition.- Parameters:
state- the statecriteriaOutcome- the criteria outcometargetState- the target stateattributes- the attributesactions- the actions- Returns:
- the transition
-
createTransitionForState
org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, org.springframework.webflow.execution.Action... actions) Create transition for state transition.- Parameters:
state- the statecriteriaOutcome- the criteria outcometargetState- the target stateactions- the actions- Returns:
- the transition
-
createTransitionForState
org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.Flow flow, String stateId, String criteriaOutcome, String targetState) Create transition for state transition.- Parameters:
flow- the flowstateId- the state idcriteriaOutcome- the criteria outcometargetState- the target state- Returns:
- the transition
-
createTransitionForState
org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, boolean removeExisting, Map<String, Object> attributes, org.springframework.webflow.execution.Action... actions) Create transition for state transition.- Parameters:
state- the statecriteriaOutcome- the criteria outcometargetState- the target stateremoveExisting- the remove existingattributes- the attributesactions- the actions- Returns:
- the transition
-
createTransitionForState
org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, boolean removeExisting, Map<String, Object> attributes) Create transition for state transition.- Parameters:
state- the statecriteriaOutcome- the criteria outcometargetState- the target stateremoveExisting- the remove existingattributes- the attributes- Returns:
- the transition
-
createTransitionForState
org.springframework.webflow.engine.Transition createTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState, boolean removeExisting) Create transition for state transition.- Parameters:
state- the statecriteriaOutcome- the criteria outcometargetState- the target stateremoveExisting- the remove existing- Returns:
- the transition
-
insertTransitionForState
org.springframework.webflow.engine.Transition insertTransitionForState(org.springframework.webflow.engine.TransitionableState state, String criteriaOutcome, String targetState) Insert transition for state.- Parameters:
state- the statecriteriaOutcome- the criteria outcometargetState- the target state- Returns:
- the transition
-
createExpression
org.springframework.binding.expression.Expression createExpression(String expression, Class expectedType) Create expression expression.- Parameters:
expression- the expressionexpectedType- the expected type- Returns:
- the expression
-
createExpression
Create expression expression.- Parameters:
expression- the expression- Returns:
- the expression
-
containsFlowState
Contains flow state boolean.- Parameters:
flow- the flowstateId- the state id- Returns:
- true/false
-
containsSubflowState
Contains subflow state boolean.- Parameters:
flow- the flowstateId- the state id- Returns:
- true/false
-
containsTransition
boolean containsTransition(org.springframework.webflow.engine.TransitionableState state, String transition) Contains transition boolean.- Parameters:
state- the statetransition- the transition- Returns:
- true/false
-
createFlowVariable
org.springframework.webflow.engine.FlowVariable createFlowVariable(org.springframework.webflow.engine.Flow flow, String id, Class type) Create flow variable flow variable.- Parameters:
flow- the flowid- the idtype- the type- Returns:
- the flow variable
-
createStateBinderConfiguration
org.springframework.webflow.engine.builder.BinderConfiguration createStateBinderConfiguration(Map<String, Map<String, String>> properties) Create state binder configuration.- Parameters:
properties- the properties- Returns:
- the binder configuration
-
createStateBinderConfiguration
org.springframework.webflow.engine.builder.BinderConfiguration createStateBinderConfiguration(List<String> properties) Create state binder configuration binder configuration.- Parameters:
properties- the properties- Returns:
- the binder configuration
-
createStateModelBinding
void createStateModelBinding(org.springframework.webflow.engine.TransitionableState state, String modelName, Class modelType) Create state model binding.- Parameters:
state- the statemodelName- the model namemodelType- the model type
-
getViewStateBinderConfiguration
org.springframework.webflow.engine.builder.BinderConfiguration getViewStateBinderConfiguration(org.springframework.webflow.engine.ViewState state) Gets view state binder configuration.- Parameters:
state- the state- Returns:
- the view state binder configuration
-
getTransitionExecutionCriteriaChainForTransition
List<org.springframework.webflow.engine.TransitionCriteria> getTransitionExecutionCriteriaChainForTransition(org.springframework.webflow.engine.Transition def) Gets transition execution criteria chain for transition.- Parameters:
def- the def- Returns:
- the transition execution criteria chain for transition
-
getState
Gets state.- Type Parameters:
T- the type parameter- Parameters:
flow- the flowstateId- the state idclazz- the clazz- Returns:
- the state
-
getState
org.springframework.webflow.engine.TransitionableState getState(org.springframework.webflow.engine.Flow flow, String stateId) Gets state.- Parameters:
flow- the flowstateId- the state id- Returns:
- the state
-
getFlow
Gets flow.- Parameters:
id- the id- Returns:
- the flow
-
getFlow
org.springframework.webflow.engine.Flow getFlow(org.springframework.webflow.definition.registry.FlowDefinitionRegistry registry, String id) Gets flow.- Parameters:
registry- the registryid- the id- Returns:
- the flow
-