org.ikasan.framework.flow
Class VisitingInvokerFlow

java.lang.Object
  org.ikasan.framework.flow.VisitingInvokerFlow

All Implemented Interfaces:

Flow

public class VisitingInvokerFlow
extends Object
implements Flow

Default implementation of a Flow

Author:

Ikasan Development Team

Constructor Summary

VisitingInvokerFlow(String name, String moduleName, FlowElement headElement, FlowElementInvoker visitingInvoker)
Constructor

Method Summary

ConfigurationService	getConfigurationService()
List<FlowElement>	getFlowElements() Returns a breadth first listing of the flowElements within this flow
String	getModuleName() Accessor for moduleName
String	getName() Returns the name of this flow
void	invoke(FlowInvocationContext flowInvocationContext, Event event) Invocation of this method represents the handling of the Event with respect to some business path
void	setConfigurationService(ConfigurationService configurationService)
void	setModuleName(String moduleName) Set the module name
void	start() Invoke all start operations for the flow that are required prior to an event invocation.
void	stop() Invoke all stop operations for the flow that are required on shutdown of the invoking client.
void	sync() Re-sync any dynamic configured resources

Methods inherited from class java.lang.Object

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

Constructor Detail

VisitingInvokerFlow

public VisitingInvokerFlow(String name,
                           String moduleName,
                           FlowElement headElement,
                           FlowElementInvoker visitingInvoker)

Constructor

Parameters:

name - - name of this flow

moduleName - - name of the module containing this flow

headElement - - first element in the flow

visitingInvoker - - invoker for this flow

Method Detail

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getConfigurationService

public ConfigurationService getConfigurationService()

getName

public String getName()

Description copied from interface: Flow

Returns the name of this flow

Specified by:

getName in interface Flow

Returns:

String name of this flow

invoke

public void invoke(FlowInvocationContext flowInvocationContext,
                   Event event)

Description copied from interface: Flow

Invocation of this method represents the handling of the Event with respect to some business path

Specified by:

invoke in interface Flow

Parameters:

flowInvocationContext - invocation context

event - The event we're dealing with

getFlowElements

public List<FlowElement> getFlowElements()

Returns a breadth first listing of the flowElements within this flow

Returns:

List

setModuleName

public void setModuleName(String moduleName)

Set the module name

Parameters:

moduleName - The name of the module to set

getModuleName

public String getModuleName()

Description copied from interface: Flow

Accessor for moduleName

Specified by:

getModuleName in interface Flow

Returns:

name of the module this flow exist for

sync

public void sync()

Re-sync any dynamic configured resources

Specified by:

sync in interface Flow

start

public void start()

Description copied from interface: Flow

Invoke all start operations for the flow that are required prior to an event invocation. For instance, this could include setting any flow component configurations, or starting any flow managed resources.

Specified by:

start in interface Flow

stop

public void stop()

Description copied from interface: Flow

Invoke all stop operations for the flow that are required on shutdown of the invoking client. For instance, this could include stopping any flow managed resources.

Specified by:

stop in interface Flow