brainslug.flow.context

Interface BrainslugContext

public interface BrainslugContext

The BrainslugContext is the main configuration and interface for the execution of flow definitions.

Method Summary

Modifier and Type	Method and Description
BrainslugContext	addFlowDefinition(FlowDefinition flowDefinition) add a flow definition to the definition store to make it executable
BrainslugContext	destroy() initialize context this will stop the schedulers (if enabled)
Collection<? extends FlowInstance>	findInstances(FlowInstanceSelector instanceSelector) find the flow instance matching the given instance selector
FlowDefinition	getDefinitionById(Identifier flowId)
Collection<FlowDefinition>	getDefinitions()
<T> T	getService(Class<T> clazz)
BrainslugContext	init() initialize context this will start the schedulers (if enabled)
<T> BrainslugContext	registerService(Class<T> serviceClass, T serviceInstance)
void	signalEvent(Identifier eventId, Identifier instanceId, Identifier definitionId) send a signaling trigger to the specified event
FlowInstance	startFlow(FlowDefinition flowDefinition) start an instance with the start node definition there must only be one definied
FlowInstance	startFlow(FlowDefinition flowDefinition, FlowInstanceProperties properties) start an instance with the start node definition there must only be one definied
FlowInstance	startFlow(FlowDefinition flowDefinition, FlowNodeDefinition startNode, FlowInstanceProperties properties) start an instance of the given flow definition
FlowInstance	startFlow(Identifier definitionId) start the flow at the given startNodeId
FlowInstance	startFlow(Identifier definitionId, FlowInstanceProperties properties) start the flow at the given startNodeId
FlowInstance	startFlow(Identifier definitionId, Identifier startNodeId) start the flow at the given startNodeId
FlowInstance	startFlow(Identifier definitionId, Identifier startNodeId, FlowInstanceProperties properties) start the flow at the given startNodeId
void	trigger(TriggerContext context) trigger a node in a given instance and definition for further exeution

Method Detail

addFlowDefinition

BrainslugContext addFlowDefinition(FlowDefinition flowDefinition)

add a flow definition to the definition store to make it executable

Parameters:

flowDefinition - the flow definition to add

Returns:

context with added store

getDefinitions

Collection<FlowDefinition> getDefinitions()

Returns:

the stored flow definitions from the definition store

getDefinitionById

FlowDefinition getDefinitionById(Identifier flowId)

Returns:

get a flow definition by id from the definition store

trigger

void trigger(TriggerContext context)

trigger a node in a given instance and definition for further exeution

Parameters:

context - the definition of the trigger environment

signalEvent

void signalEvent(Identifier eventId,
                 Identifier instanceId,
                 Identifier definitionId)

send a signaling trigger to the specified event

Parameters:

eventId - id of the event node

instanceId - id of the instance containing this event node

definitionId - id of the flow definition where the event is defined

startFlow

FlowInstance startFlow(FlowDefinition flowDefinition)

start an instance with the start node definition there must only be one definied

Parameters:

flowDefinition - the definition to be started

Returns:

id of the started flow instance

Throws:

IllegalStateException - if more the one start node definition exists

startFlow

FlowInstance startFlow(FlowDefinition flowDefinition,
                       FlowInstanceProperties properties)

start an instance with the start node definition there must only be one definied

Parameters:

flowDefinition - the definition to be started

properties - the properties to be available during execution

Returns:

id of the started flow instance

Throws:

IllegalStateException - if more the one start node definition exists

startFlow

FlowInstance startFlow(FlowDefinition flowDefinition,
                       FlowNodeDefinition startNode,
                       FlowInstanceProperties properties)

start an instance of the given flow definition

Parameters:

flowDefinition - the definition to be started

startNode - the node in the definition to start at

properties - the properties to be available during execution

Returns:

id of the started flow instance

startFlow

FlowInstance startFlow(Identifier definitionId)

start the flow at the given startNodeId

Parameters:

definitionId - the definition to be started

Returns:

id of the instance

startFlow

FlowInstance startFlow(Identifier definitionId,
                       Identifier startNodeId)

start the flow at the given startNodeId

Parameters:

definitionId - the definition to be started

startNodeId - the node in the definition to start at

Returns:

id of the instance

startFlow

FlowInstance startFlow(Identifier definitionId,
                       FlowInstanceProperties properties)

start the flow at the given startNodeId

Parameters:

definitionId - the definition to be started

properties - the properties to be available during execution

Returns:

id of the instance

startFlow

FlowInstance startFlow(Identifier definitionId,
                       Identifier startNodeId,
                       FlowInstanceProperties properties)

start the flow at the given startNodeId

Parameters:

definitionId - the definition to be started

startNodeId - the node in the definition to start at

properties - the properties to be available during execution

Returns:

id of the instance

findInstances

Collection<? extends FlowInstance> findInstances(FlowInstanceSelector instanceSelector)

find the flow instance matching the given instance selector

Parameters:

instanceSelector -

Returns:

a optional flow instance

init

BrainslugContext init()

initialize context this will start the schedulers (if enabled)

Returns:

initialized BrainslugContext with schedulers started

destroy

BrainslugContext destroy()

initialize context this will stop the schedulers (if enabled)

Returns:

initialized BrainslugContext with schedulers stopped

registerService

<T> BrainslugContext registerService(Class<T> serviceClass,
                                     T serviceInstance)

getService

<T> T getService(Class<T> clazz)