|
Spring Web Flow | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.webflow.engine.builder.DefaultFlowHolder
public class DefaultFlowHolder
A flow definition holder that can detect changes on an underlying flow definition resource and refresh that resource automatically.
This class is thread-safe.
Note that this FlowDefinition
holder uses a FlowAssembler
. This class bridges the abstract
world of flow definitions
with the concrete world of flow implementations.
FlowAssembler
,
FlowDefinition
Constructor Summary | |
---|---|
DefaultFlowHolder(FlowAssembler assembler)
Creates a new refreshable flow definition holder that uses the configured assembler (GOF director) to drive flow assembly, on initial use and on any resource change or refresh. |
Method Summary | |
---|---|
void |
destroy()
Indicates that the system is being shutdown and any resources flow resources should be released. |
FlowDefinition |
getFlowDefinition()
Returns the flow definition held by this holder. |
java.lang.String |
getFlowDefinitionId()
Returns the id of the flow definition held by this holder. |
java.lang.String |
getFlowDefinitionResourceString()
Returns a descriptive string that identifies the source of this FlowDefinition. |
void |
refresh()
Refresh the flow definition held by this holder. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DefaultFlowHolder(FlowAssembler assembler)
assembler
- the flow assembler to useMethod Detail |
---|
public java.lang.String getFlowDefinitionId()
FlowDefinitionHolder
id
of the flow definition held by this holder. This is a lightweight method
callers may call to obtain the id of the flow without triggering full flow definition assembly (which may be an
expensive operation).
getFlowDefinitionId
in interface FlowDefinitionHolder
public java.lang.String getFlowDefinitionResourceString()
FlowDefinitionHolder
getFlowDefinitionResourceString
in interface FlowDefinitionHolder
public FlowDefinition getFlowDefinition() throws FlowDefinitionConstructionException
FlowDefinitionHolder
getFlowDefinition
in interface FlowDefinitionHolder
FlowDefinitionConstructionException
- if there is a problem constructing the target flow definitionpublic void refresh() throws FlowDefinitionConstructionException
FlowDefinitionHolder
refresh
in interface FlowDefinitionHolder
FlowDefinitionConstructionException
- if there is a problem constructing the target flow definitionpublic void destroy()
FlowDefinitionHolder
FlowDefinitionHolder.getFlowDefinition()
are undefined. Should only be called once. May be a no-op
if the held flow was never constructed to begin with.
destroy
in interface FlowDefinitionHolder
public java.lang.String toString()
toString
in class java.lang.Object
|
Spring Web Flow | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |