org.ikasan.spec.flow

Interface Flow

public interface Flow

Interface representing a business path for a FlowEvent Invocation represents the traversal of that business path.

Author:

Ikasan Development Team

Method Summary

Methods

Modifier and Type	Method and Description
FlowConfiguration	getFlowConfiguration() Method to get the configuration for the given flow.
FlowElement<?>	getFlowElement(String name) Accessor for getting the flow element by its given name.
List<FlowElement<?>>	getFlowElements() Accessor for getting the flow elements TODO - is this really needed ?
String	getModuleName() Accessor for moduleName
String	getName() Returns the name of this flow
SerialiserFactory	getSerialiserFactory() Get the serialiser factory associated with this flow.
String	getState() Returns the current runtmie state of this flow.
boolean	isPaused() Is this flow in a paused state
boolean	isRunning() Is this flow in a running state
void	pause() Invoke stop on the consumer component only.
void	resume() Invoke start on the consumer component only.
void	setFlowListener(FlowEventListener flowEventListener) Setter for a listener for flow events
void	start() Invoke all start operations for the flow that are required prior to an event invocation including starting the consumer.
void	startPause() Invoke all start operations for the flow that are required prior to an event invocation, but immediately pause the consumer.
void	stop() Invoke all stop operations for the flow that are required on shutdown of the invoking client.

Method Detail

getName

String getName()

Returns the name of this flow

Returns:

String name of this flow

getModuleName

String getModuleName()

Accessor for moduleName

Returns:

name of the module this flow exist for

getFlowElements

List<FlowElement<?>> getFlowElements()

Accessor for getting the flow elements TODO - is this really needed ?

Returns:

list of flow elements

getFlowElement

FlowElement<?> getFlowElement(String name)

Accessor for getting the flow element by its given name. If the name does not exist then null is returned. If more than one element exists with this name then the first one encountered is returned.

Returns:

list of flow elements

getFlowConfiguration

FlowConfiguration getFlowConfiguration()

Method to get the configuration for the given flow.

Returns:

the flow configuration.

setFlowListener

void setFlowListener(FlowEventListener flowEventListener)

Setter for a listener for flow events

Parameters:

flowEventListener -

start

void start()

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

startPause

void startPause()

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

stop

void stop()

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.

pause

void pause()

Invoke stop on the consumer component only. All other components will remain initialised and running.

resume

void resume()

Invoke start on the consumer component only. All other components will remain initialised and running.

getState

String getState()

Returns the current runtmie state of this flow. String - runtime state

getSerialiserFactory

SerialiserFactory getSerialiserFactory()

Get the serialiser factory associated with this flow.

Returns:

isRunning

boolean isRunning()

Is this flow in a running state

Returns:

isPaused

boolean isPaused()

Is this flow in a paused state

Returns: