org.springframework.webflow.definition.registry
Interface FlowDefinitionHolder

All Known Implementing Classes:

RefreshableFlowDefinitionHolder, StaticFlowDefinitionHolder

public interface FlowDefinitionHolder

A holder holding a reference to a Flow definition. Provides a layer of indirection, enabling things like "hot-reloadable" flow definitions.

Author:

Keith Donald

See Also:

FlowDefinitionRegistry.registerFlowDefinition(FlowDefinitionHolder)

Method Summary

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.
void	refresh() Refresh the flow definition held by this holder.

Method Detail

getFlowDefinitionId

java.lang.String getFlowDefinitionId()

Returns the 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).

getFlowDefinition

FlowDefinition getFlowDefinition()
                                 throws FlowDefinitionConstructionException

Returns the flow definition held by this holder. Calling this method the first time may trigger flow assembly (which may be expensive).

Throws:

FlowDefinitionConstructionException - if there is a problem constructing the target flow definition

refresh

void refresh()
             throws FlowDefinitionConstructionException

Refresh the flow definition held by this holder. Calling this method typically triggers flow reassembly, which may include a refresh from an externalized resource such as a file.

Throws:

FlowDefinitionConstructionException - if there is a problem constructing the target flow definition