Package net.shibboleth.idp.profile.spring.factory

Class FlowModelFlowBuilder

java.lang.Object

org.springframework.webflow.engine.builder.support.AbstractFlowBuilder

net.shibboleth.idp.profile.spring.factory.FlowModelFlowBuilder

All Implemented Interfaces:

FlowBuilder

public class FlowModelFlowBuilder
extends AbstractFlowBuilder

This code is extended from FlowModelFlowBuilder in order to customize the Spring ApplicationContext used for flow configuration. The only method changed is createFlowApplicationContext(String[]) (parameter changed from Resource, but it's private and there are too many threads pulled by anything but a wholesale duplication of this class). Builds a runtime Flow definition object from a FlowModel.

Field Summary

Fields

Modifier and Type	Field	Description
private FlowModel	flowModel
private FlowModelHolder	flowModelHolder
private static final boolean	IS_SPRING_FACES_PRESENT
private LocalFlowBuilderContext	localFlowBuilderContext
static final String	VALIDATION_HINT_RESOLVER_FLOW_ATTR
static final String	VALIDATOR_FLOW_ATTR

Constructor Summary

Constructors

Constructor	Description
FlowModelFlowBuilder(FlowModelHolder flowModelHolder)	Creates a flow builder that can build a Flow from a FlowModel.

Method Summary

Modifier and Type	Method	Description
void	buildEndActions()	Builds any end actions to execute when the flow ends.
void	buildExceptionHandlers()	Creates and adds all exception handlers to the flow built by this builder.
void	buildGlobalTransitions()	Builds any transitions shared by all states of the flow.
void	buildInputMapper()	Builds the input mapper responsible for mapping flow input on start.
void	buildOutputMapper()	Builds the output mapper responsible for mapping flow output on end.
void	buildStartActions()	Builds any start actions to execute when the flow starts.
void	buildStates()	Builds the states of the flow.
void	buildVariables()	Builds any variables initialized by the flow when it starts.
private BinderConfiguration	createBinderConfiguration(BinderModel binderModel)
protected Flow	createFlow()
private GenericApplicationContext	createFlowApplicationContext(String[] resources)
private ViewFactory	createViewFactory(Expression viewId, BinderModel binderModel)
protected void	doDispose()	Shutdown the builder, releasing any resources it holds.
protected void	doInit()	Initialize this builder.
private ConversionExecutor	fromStringTo(Class<?> targetType)
protected FlowModel	getFlowModel()
String	getFlowResourceString()
protected LocalFlowBuilderContext	getLocalContext()
boolean	hasFlowChanged()
private void	initLocalFlowContext()
private boolean	isFlowInDevelopment()
private Action[]	parseActions(List<AbstractActionModel> actionModels)
private void	parseAndAddActionState(ActionStateModel state, Flow flow)
private void	parseAndAddDecisionState(DecisionStateModel state, Flow flow)
private void	parseAndAddEndState(EndStateModel state, Flow flow)
private void	parseAndAddSubflowState(SubflowStateModel state, Flow flow)
private void	parseAndAddViewState(ViewStateModel state, Flow flow)
private void	parseAndPutMetaAttribute(AttributeModel attribute, MutableAttributeMap<Object> attributes)
private void	parseAndPutPersistenceContext(PersistenceContextModel persistenceContext, MutableAttributeMap<Object> attributes)
private void	parseAndPutSecured(SecuredModel secured, MutableAttributeMap<Object> attributes)
private void	parseAndSetMappingConversionExecutor(AbstractMappingModel mappingModel, DefaultMapping mapping)
private void	parseAndSetMappingRequired(AbstractMappingModel mappingModel, DefaultMapping mapping)
private Object	parseAttributeValueIfNecessary(AttributeModel attribute, String stringValue)
private String[]	parseContextResources(List<BeanImportModel> beanImports)
private FlowExecutionExceptionHandler	parseCustomExceptionHandler(ExceptionHandlerModel exceptionHandler)
private FlowExecutionExceptionHandler[]	parseCustomExceptionHandlers(List<ExceptionHandlerModel> exceptionHandlerModels)
private Transition	parseElse(IfModel ifModel)
private Action	parseEvaluateAction(EvaluateModel evaluate)
private FlowExecutionExceptionHandler[]	parseExceptionHandlers(List<ExceptionHandlerModel> modelExceptionHandlers, List<TransitionModel> modelTransitions)
private Mapper	parseFlowInputMapper(List<InputModel> inputs)
private DefaultMapping	parseFlowInputMapping(InputModel input)
private AttributeMap<Object>	parseFlowMetaAttributes(FlowModel flow)
private Mapper	parseFlowOutputMapper(List<OutputModel> outputs)
private DefaultMapping	parseFlowOutputMapping(OutputModel output)
private FlowVariable	parseFlowVariable(VarModel var)
private Transition[]	parseIf(IfModel ifModel)
private Transition[]	parseIfs(List<IfModel> ifModels)
private MutableAttributeMap<Object>	parseMetaAttributes(List<AttributeModel> attributeModels)
private Action	parseRenderAction(RenderModel render)
private Action	parseSetAction(SetModel set)
private SubflowAttributeMapper	parseSubflowAttributeMapper(SubflowStateModel state)
private Expression	parseSubflowExpression(String subflow)
private Mapper	parseSubflowInputMapper(List<InputModel> inputs)
private DefaultMapping	parseSubflowInputMapping(InputModel input)
private Mapper	parseSubflowOutputMapper(List<OutputModel> outputs)
private DefaultMapping	parseSubflowOutputMapping(OutputModel output)
private Transition	parseThen(IfModel ifModel)
private Transition	parseTransition(TransitionModel transition)
private FlowExecutionExceptionHandler	parseTransitionExecutingExceptionHandler(TransitionModel transition)
private FlowExecutionExceptionHandler[]	parseTransitionExecutingExceptionHandlers(List<TransitionModel> transitionModels)
private Transition[]	parseTransitions(List<TransitionModel> transitionModels)
private ViewFactory	parseViewFactory(String view, String stateId, boolean endState, BinderModel binderModel)
private ViewVariable	parseViewVariable(VarModel var)
private ViewVariable[]	parseViewVariables(List<VarModel> vars)
protected void	registerFlowBeans(ConfigurableBeanFactory beanFactory)	Register beans in the bean factory local to the flow definition being built.
private void	registerMessageSource(GenericApplicationContext flowContext, Resource flowResource)
protected void	setLocalContext(LocalFlowBuilderContext localFlowBuilderContext)
private Class<?>	toClass(String name)
private <T> Class<T>	toClass(String name, Class<T> superType)
String	toString()

Methods inherited from class org.springframework.webflow.engine.builder.support.AbstractFlowBuilder

dispose, getContext, getFlow, init

Methods inherited from class java.lang.Object

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

Field Details

IS_SPRING_FACES_PRESENT

private static final boolean IS_SPRING_FACES_PRESENT

VALIDATOR_FLOW_ATTR

public static final String VALIDATOR_FLOW_ATTR

VALIDATION_HINT_RESOLVER_FLOW_ATTR

public static final String VALIDATION_HINT_RESOLVER_FLOW_ATTR

flowModelHolder

private FlowModelHolder flowModelHolder

flowModel

private FlowModel flowModel

localFlowBuilderContext

private LocalFlowBuilderContext localFlowBuilderContext

Constructor Details

FlowModelFlowBuilder

public FlowModelFlowBuilder(FlowModelHolder flowModelHolder)

Creates a flow builder that can build a Flow from a FlowModel.

Parameters:

flowModelHolder - the flow model holder

Method Details

doInit

protected void doInit()
               throws FlowBuilderException

Initialize this builder. This could cause the builder to open a stream to an externalized resource representing the flow definition, for example.

Overrides:

doInit in class AbstractFlowBuilder

Throws:

FlowBuilderException - an exception occurred building the flow

createFlow

protected Flow createFlow()

Overrides:

createFlow in class AbstractFlowBuilder

buildVariables

public void buildVariables()
                    throws FlowBuilderException

Builds any variables initialized by the flow when it starts.

Specified by:

buildVariables in interface FlowBuilder

Overrides:

buildVariables in class AbstractFlowBuilder

Throws:

FlowBuilderException - an exception occurred building the flow

buildInputMapper

public void buildInputMapper()
                      throws FlowBuilderException

Builds the input mapper responsible for mapping flow input on start.

Specified by:

buildInputMapper in interface FlowBuilder

Overrides:

buildInputMapper in class AbstractFlowBuilder

Throws:

FlowBuilderException - an exception occurred building the flow

buildStartActions

public void buildStartActions()
                       throws FlowBuilderException

Builds any start actions to execute when the flow starts.

Specified by:

buildStartActions in interface FlowBuilder

Overrides:

buildStartActions in class AbstractFlowBuilder

Throws:

FlowBuilderException - an exception occurred building the flow

buildStates

public void buildStates()
                 throws FlowBuilderException

Builds the states of the flow.

Specified by:

buildStates in interface FlowBuilder

Specified by:

buildStates in class AbstractFlowBuilder

Throws:

FlowBuilderException - an exception occurred building the flow

buildGlobalTransitions

public void buildGlobalTransitions()
                            throws FlowBuilderException

Builds any transitions shared by all states of the flow.

Specified by:

buildGlobalTransitions in interface FlowBuilder

Overrides:

buildGlobalTransitions in class AbstractFlowBuilder

Throws:

FlowBuilderException - an exception occurred building the flow

buildEndActions

public void buildEndActions()
                     throws FlowBuilderException

Builds any end actions to execute when the flow ends.

Specified by:

buildEndActions in interface FlowBuilder

Overrides:

buildEndActions in class AbstractFlowBuilder

Throws:

FlowBuilderException - an exception occurred building the flow

buildOutputMapper

public void buildOutputMapper()
                       throws FlowBuilderException

Builds the output mapper responsible for mapping flow output on end.

Specified by:

buildOutputMapper in interface FlowBuilder

Overrides:

buildOutputMapper in class AbstractFlowBuilder

Throws:

FlowBuilderException - an exception occurred building the flow

buildExceptionHandlers

public void buildExceptionHandlers()
                            throws FlowBuilderException

Creates and adds all exception handlers to the flow built by this builder.

Specified by:

buildExceptionHandlers in interface FlowBuilder

Overrides:

buildExceptionHandlers in class AbstractFlowBuilder

Throws:

FlowBuilderException - an exception occurred building this flow

hasFlowChanged

public boolean hasFlowChanged()

Specified by:

hasFlowChanged in interface FlowBuilder

Overrides:

hasFlowChanged in class AbstractFlowBuilder

getFlowResourceString

public String getFlowResourceString()

Specified by:

getFlowResourceString in interface FlowBuilder

Overrides:

getFlowResourceString in class AbstractFlowBuilder

doDispose

protected void doDispose()
                  throws FlowBuilderException

Shutdown the builder, releasing any resources it holds. A new flow construction process should start with another call to the AbstractFlowBuilder.init(FlowBuilderContext) method.

Overrides:

doDispose in class AbstractFlowBuilder

Throws:

FlowBuilderException - an exception occurred building this flow

getFlowModel

protected FlowModel getFlowModel()

getLocalContext

protected LocalFlowBuilderContext getLocalContext()

setLocalContext

protected void setLocalContext(LocalFlowBuilderContext localFlowBuilderContext)

registerFlowBeans

protected void registerFlowBeans(ConfigurableBeanFactory beanFactory)

Register beans in the bean factory local to the flow definition being built.

Subclasses may override this method to customize the population of the bean factory local to the flow definition being built; for example, to register mock implementations of services in a test environment.

Parameters:

beanFactory - the bean factory; register local beans with it using SingletonBeanRegistry.registerSingleton(String, Object)

initLocalFlowContext

private void initLocalFlowContext()

parseContextResources

private String[] parseContextResources(List<BeanImportModel> beanImports)

createFlowApplicationContext

private GenericApplicationContext createFlowApplicationContext(String[] resources)

isFlowInDevelopment

private boolean isFlowInDevelopment()

registerMessageSource

private void registerMessageSource(GenericApplicationContext flowContext,
 Resource flowResource)

parseFlowMetaAttributes

private AttributeMap<Object> parseFlowMetaAttributes(FlowModel flow)

parseFlowVariable

private FlowVariable parseFlowVariable(VarModel var)

parseFlowInputMapper

private Mapper parseFlowInputMapper(List<InputModel> inputs)

parseFlowInputMapping

private DefaultMapping parseFlowInputMapping(InputModel input)

parseSubflowInputMapper

private Mapper parseSubflowInputMapper(List<InputModel> inputs)

parseSubflowInputMapping

private DefaultMapping parseSubflowInputMapping(InputModel input)

parseFlowOutputMapper

private Mapper parseFlowOutputMapper(List<OutputModel> outputs)

parseFlowOutputMapping

private DefaultMapping parseFlowOutputMapping(OutputModel output)

parseSubflowOutputMapper

private Mapper parseSubflowOutputMapper(List<OutputModel> outputs)

parseSubflowOutputMapping

private DefaultMapping parseSubflowOutputMapping(OutputModel output)

parseAndSetMappingConversionExecutor

private void parseAndSetMappingConversionExecutor(AbstractMappingModel mappingModel,
 DefaultMapping mapping)

parseAndSetMappingRequired

private void parseAndSetMappingRequired(AbstractMappingModel mappingModel,
 DefaultMapping mapping)

parseAndAddViewState

private void parseAndAddViewState(ViewStateModel state,
 Flow flow)

parseAndAddActionState

private void parseAndAddActionState(ActionStateModel state,
 Flow flow)

parseAndAddDecisionState

private void parseAndAddDecisionState(DecisionStateModel state,
 Flow flow)

parseAndAddSubflowState

private void parseAndAddSubflowState(SubflowStateModel state,
 Flow flow)

parseAndAddEndState

private void parseAndAddEndState(EndStateModel state,
 Flow flow)

parseViewFactory

private ViewFactory parseViewFactory(String view,
 String stateId,
 boolean endState,
 BinderModel binderModel)

createViewFactory

private ViewFactory createViewFactory(Expression viewId,
 BinderModel binderModel)

createBinderConfiguration

private BinderConfiguration createBinderConfiguration(BinderModel binderModel)

parseViewVariables

private ViewVariable[] parseViewVariables(List<VarModel> vars)

parseViewVariable

private ViewVariable parseViewVariable(VarModel var)

parseIfs

private Transition[] parseIfs(List<IfModel> ifModels)

parseIf

private Transition[] parseIf(IfModel ifModel)

parseThen

private Transition parseThen(IfModel ifModel)

parseElse

private Transition parseElse(IfModel ifModel)

parseSubflowExpression

private Expression parseSubflowExpression(String subflow)

parseSubflowAttributeMapper

private SubflowAttributeMapper parseSubflowAttributeMapper(SubflowStateModel state)

parseExceptionHandlers

private FlowExecutionExceptionHandler[] parseExceptionHandlers(List<ExceptionHandlerModel> modelExceptionHandlers,
 List<TransitionModel> modelTransitions)

parseTransitionExecutingExceptionHandlers

private FlowExecutionExceptionHandler[] parseTransitionExecutingExceptionHandlers(List<TransitionModel> transitionModels)

parseTransitionExecutingExceptionHandler

private FlowExecutionExceptionHandler parseTransitionExecutingExceptionHandler(TransitionModel transition)

parseCustomExceptionHandlers

private FlowExecutionExceptionHandler[] parseCustomExceptionHandlers(List<ExceptionHandlerModel> exceptionHandlerModels)

parseCustomExceptionHandler

private FlowExecutionExceptionHandler parseCustomExceptionHandler(ExceptionHandlerModel exceptionHandler)

parseTransitions

private Transition[] parseTransitions(List<TransitionModel> transitionModels)

parseTransition

private Transition parseTransition(TransitionModel transition)

parseActions

private Action[] parseActions(List<AbstractActionModel> actionModels)

parseEvaluateAction

private Action parseEvaluateAction(EvaluateModel evaluate)

parseRenderAction

private Action parseRenderAction(RenderModel render)

parseSetAction

private Action parseSetAction(SetModel set)

parseMetaAttributes

private MutableAttributeMap<Object> parseMetaAttributes(List<AttributeModel> attributeModels)

parseAndPutMetaAttribute

private void parseAndPutMetaAttribute(AttributeModel attribute,
 MutableAttributeMap<Object> attributes)

parseAttributeValueIfNecessary

private Object parseAttributeValueIfNecessary(AttributeModel attribute,
 String stringValue)

parseAndPutPersistenceContext

private void parseAndPutPersistenceContext(PersistenceContextModel persistenceContext,
 MutableAttributeMap<Object> attributes)

parseAndPutSecured

private void parseAndPutSecured(SecuredModel secured,
 MutableAttributeMap<Object> attributes)

fromStringTo

private ConversionExecutor fromStringTo(Class<?> targetType)
                                 throws ConversionExecutionException

Throws:

ConversionExecutionException

toClass

private Class<?> toClass(String name)

toClass

private <T> Class<T> toClass(String name,
 Class<T> superType)

toString

public String toString()

Overrides:

toString in class Object