GraphEngineImpl (telekom-workflow-engine 1.2.7 API)

java.lang.Object
- ee.telekom.workflow.graph.core.GraphEngineImpl

All Implemented Interfaces:: GraphEngine, GraphEngineFacade

public class GraphEngineImpl
extends Object
implements GraphEngine

Constructor Summary

Constructors
Constructor and Description

GraphEngineImpl()

Constructors
Constructor and Description
`GraphEngineImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abort(GraphInstance instance)` Aborts the given `GraphInstance`'s execution and cancels all associated tokens and work items.
`GraphWorkItem`	`addHumanTaskItem(GraphInstance instance, Token token, String role, String user, Map<String,Object> arguments)` Adds a new `HumanTaskItem` to the given instance which is associated to the given token.
`GraphWorkItem`	`addSignalItem(GraphInstance instance, Token token, String signal)` Adds a new `SignalItem` to the given instance which is associated to the given token.
`GraphWorkItem`	`addTaskItem(GraphInstance instance, Token token, String bean, String method, Object[] arguments)` Adds a new `TaskItem` to the given instance which is associated to the given token.
`GraphWorkItem`	`addTimerItem(GraphInstance instance, Token token, Date dueDate)` Adds a new `TimerItem` to the given instance which is associated to the given token.
`TokenImpl`	`addToken(GraphInstance instance, Node node, Token parent)` Adds a new, active token to the given instance pointing to the given node with the given parent.
`void`	`cancel(Token token)` Cancels the given token.
`void`	`cancelWorkItem(Token token)` If existent, cancels the active work item associated with the given token.
`void`	`complete(GraphWorkItem workItem)` Completes the executed work item and continues execution until another wait state is reached or until the graph instance is completed.
`void`	`complete(Token token, Object result)` A shorthand for `GraphEngine.complete(Token, Object, String)` using a the default transition name `Transition.DEFAULT_TRANSITION_NAME`.
`void`	`complete(Token token, Object result, String transitionName)` Finishes the execution of the given `Token`'s current `Node` on the associated `GraphInstance`.
`BeanResolver`	`getBeanResolver()` Returns the engine's `BeanResolver`, or `null` if the engine does not support to resolve beans.
`NewGraphInstanceCreator`	`getNewGraphInstanceCreator()` Returns the engine's `NewGraphInstanceCreator`, or `null` if the engine does not support to create sub graph instances.
`GraphRepository`	`getRepository()` Returns the engine's `GraphRepository`.
`void`	`registerInstanceEventListener(GraphInstanceEventListener listener)` Adds a `GraphInstanceEventListener` to the engine.
`void`	`registerNodeEventListener(NodeEventListener listener)` Adds a `NodeEventListener` to the engine.
`void`	`registerWorkItemEventListener(GraphWorkItemEventListener listener)` Adds a `GraphWorkItemEventListener` to the engine.
`void`	`setBeanResolver(BeanResolver beanResolver)`
`void`	`setNewGraphInstanceCreator(NewGraphInstanceCreator newGraphInstanceCreator)`
`void`	`setRepository(GraphRepository repository)`
`GraphInstanceImpl`	`start(Graph graph)` A shorthand for `#start(Graph, Environment, String)` using an empty initial environment and a `null` external id.
`GraphInstanceImpl`	`start(Graph graph, Environment initialEnvironment)`
`GraphInstanceImpl`	`start(Graph graph, Environment initialEnvironment, Long externalId)` Starts a `GraphInstance` of the given `Graph` using the given `Environment`.
`GraphInstanceImpl`	`start(String graphName)` A shorthand for `#start(String, Integer, Environment, String)` using the latest graph with the given name and an empty initial environment and a `null` external id.
`GraphInstanceImpl`	`start(String graphName, Integer version)` A shorthand for `#start(String, Integer, Environment, String)` using an empty initial environment and a `null` external id.
`GraphInstanceImpl`	`start(String graphName, Integer version, Environment initialEnvironment)` A shorthand for `#start(String, Integer, Environment, String)` using a `null` external id.
`GraphInstanceImpl`	`start(String graphName, Integer version, Environment initialEnvironment, Long externalId)` Starts a `GraphInstance` of the `Graph` with the given name and version and using the given `Environment` and associates the created `GraphInstance` with the given external.
`void`	`terminate(Token token)` Marks the given token and all direct parent tokens active that do not have any further active child tokens.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GraphEngineImpl
```
public GraphEngineImpl()
```
- Method Detail
  - start
```
public GraphInstanceImpl start(String graphName)
```
    Description copied from interface: GraphEngineFacade
    
    A shorthand for #start(String, Integer, Environment, String) using the latest graph with the given name and an empty initial environment and a null external id.
    
    Specified by:
    
    start in interface GraphEngineFacade
  - start
```
public GraphInstanceImpl start(String graphName,
                               Integer version)
```
    Description copied from interface: GraphEngineFacade
    
    A shorthand for #start(String, Integer, Environment, String) using an empty initial environment and a null external id.
    
    Specified by:
    
    start in interface GraphEngineFacade
  - start
```
public GraphInstanceImpl start(String graphName,
                               Integer version,
                               Environment initialEnvironment)
```
    Description copied from interface: GraphEngineFacade
    
    A shorthand for #start(String, Integer, Environment, String) using a null external id.
    
    Specified by:
    
    start in interface GraphEngineFacade
  - start
```
public GraphInstanceImpl start(String graphName,
                               Integer version,
                               Environment initialEnvironment,
                               Long externalId)
```
    Description copied from interface: GraphEngineFacade
    Starts a GraphInstance of the Graph with the given name and version and using the given Environment and associates the created GraphInstance with the given external. Is the equivalent of doing
```
 Graph graph = engine.getRepository().getLatestGraph(graphName);
 GraphInstance graphInstance = engine.start(graph, initialEnvironment,
                externalId);
 
```
    If no graph is found for the given graphName, a WorkflowException will be thrown.
    Specified by:
    
    start in interface GraphEngineFacade
    
    Parameters:
    
    graphName - the name of the graph to execute
    
    version - the version of the graph to execute of null for the latest graph with the given name.
    
    initialEnvironment - A starting environment for the GraphInstance. All attributes from this environment will be copied into the new graph instance's environment before execution starts.
    
    externalId - the external id that the graph instance is associated with
    
    Returns:
    
    a GraphInstance of the latest Graph with the given name and using the given Environment which has already been started (and, given that no wait states were entered, is already completed).
  - start
```
public GraphInstanceImpl start(Graph graph)
```
    Description copied from interface: GraphEngineFacade
    
    A shorthand for #start(Graph, Environment, String) using an empty initial environment and a null external id.
    
    Specified by:
    
    start in interface GraphEngineFacade
  - start
```
public GraphInstanceImpl start(Graph graph,
                               Environment initialEnvironment)
```
    Specified by:
    
    start in interface GraphEngineFacade
  - start
```
public GraphInstanceImpl start(Graph graph,
                               Environment initialEnvironment,
                               Long externalId)
```
    Description copied from interface: GraphEngineFacade
    
    Starts a GraphInstance of the given Graph using the given Environment. A Token will be generated for the start node (determined by Graph.getStartNode()), and this token will be executed. If the graph does not contain nodes which go into a wait state, the GraphInstance returned will be completed.
    Before the graph instance is started, the given initial environment will be copied into the one of the new graph instance.
    
    Specified by:
    
    start in interface GraphEngineFacade
    
    Parameters:
    
    graph - the graph to create a graph instance of
    
    initialEnvironment - an initial environment for the graph instance
    
    externalId - the external id that the graph instance is associated with
  - abort
```
public void abort(GraphInstance instance)
```
    Description copied from interface: GraphEngineFacade
    
    Aborts the given GraphInstance's execution and cancels all associated tokens and work items.
    
    Specified by:
    
    abort in interface GraphEngineFacade
    
    Parameters:
    
    instance - the graph instance to abort
  - complete
```
public void complete(GraphWorkItem workItem)
```
    Description copied from interface: GraphEngineFacade
    
    Completes the executed work item and continues execution until another wait state is reached or until the graph instance is completed.
    
    Specified by:
    
    complete in interface GraphEngineFacade
    
    Parameters:
    
    workItem - the work item to complete
  - getRepository
```
public GraphRepository getRepository()
```
    Description copied from interface: GraphEngineFacade
    
    Returns the engine's GraphRepository.
    
    Specified by:
    
    getRepository in interface GraphEngineFacade
    
    Returns:
    
    the engine's GraphRepository
  - setRepository
```
public void setRepository(GraphRepository repository)
```
  - getBeanResolver
```
public BeanResolver getBeanResolver()
```
    Description copied from interface: GraphEngineFacade
    
    Returns the engine's BeanResolver, or null if the engine does not support to resolve beans.
    
    Specified by:
    
    getBeanResolver in interface GraphEngineFacade
    
    Returns:
    
    the engine's BeanResolver, or null if the engine does not support to resolve beans.
  - setBeanResolver
```
public void setBeanResolver(BeanResolver beanResolver)
```
  - getNewGraphInstanceCreator
```
public NewGraphInstanceCreator getNewGraphInstanceCreator()
```
    Description copied from interface: GraphEngineFacade
    
    Returns the engine's NewGraphInstanceCreator, or null if the engine does not support to create sub graph instances.
    
    Specified by:
    
    getNewGraphInstanceCreator in interface GraphEngineFacade
    
    Returns:
    
    the engine's NewGraphInstanceCreator, or null if the engine does not support to create sub graph instances.
  - setNewGraphInstanceCreator
```
public void setNewGraphInstanceCreator(NewGraphInstanceCreator newGraphInstanceCreator)
```
  - registerInstanceEventListener
```
public void registerInstanceEventListener(GraphInstanceEventListener listener)
```
    Description copied from interface: GraphEngineFacade
    
    Adds a GraphInstanceEventListener to the engine.
    
    Specified by:
    
    registerInstanceEventListener in interface GraphEngineFacade
    
    Parameters:
    
    listener - listener to be added
  - registerWorkItemEventListener
```
public void registerWorkItemEventListener(GraphWorkItemEventListener listener)
```
    Description copied from interface: GraphEngineFacade
    
    Adds a GraphWorkItemEventListener to the engine.
    
    Specified by:
    
    registerWorkItemEventListener in interface GraphEngineFacade
    
    Parameters:
    
    listener - listener to be added
  - registerNodeEventListener
```
public void registerNodeEventListener(NodeEventListener listener)
```
    Description copied from interface: GraphEngineFacade
    
    Adds a NodeEventListener to the engine.
    
    Specified by:
    
    registerNodeEventListener in interface GraphEngineFacade
    
    Parameters:
    
    listener - listener to be added
  - addToken
```
public TokenImpl addToken(GraphInstance instance,
                          Node node,
                          Token parent)
```
    Description copied from interface: GraphEngine
    
    Adds a new, active token to the given instance pointing to the given node with the given parent.
    
    Specified by:
    
    addToken in interface GraphEngine
    
    Parameters:
    
    instance - the instance to add to
    
    node - the node that the new token will point to
    
    parent - the new token's parent token
    
    Returns:
    
    the new token
  - addSignalItem
```
public GraphWorkItem addSignalItem(GraphInstance instance,
                                   Token token,
                                   String signal)
```
    Description copied from interface: GraphEngine
    
    Adds a new SignalItem to the given instance which is associated to the given token. The SignalItem is awaiting a signal with the given name.
    
    Specified by:
    
    addSignalItem in interface GraphEngine
    
    Parameters:
    
    instance - the instance to add the new signal item to
    
    token - the token to associate the signal item with
    
    signal - the signal's name to wait for
    
    Returns:
    
    the new signal item
  - addTimerItem
```
public GraphWorkItem addTimerItem(GraphInstance instance,
                                  Token token,
                                  Date dueDate)
```
    Description copied from interface: GraphEngine
    
    Adds a new TimerItem to the given instance which is associated to the given token. The TimerItem is awaiting the given dueDate.
    
    Specified by:
    
    addTimerItem in interface GraphEngine
    
    Parameters:
    
    instance - the instance to add the new timer item to
    
    token - the token to associate the timer item with
    
    dueDate - the due date to wait for
    
    Returns:
    
    the new timer item
  - addTaskItem
```
public GraphWorkItem addTaskItem(GraphInstance instance,
                                 Token token,
                                 String bean,
                                 String method,
                                 Object[] arguments)
```
    Description copied from interface: GraphEngine
    
    Adds a new TaskItem to the given instance which is associated to the given token. The TaskItem is awaiting external execution.
    
    Specified by:
    
    addTaskItem in interface GraphEngine
    
    Parameters:
    
    instance - the instance to add the new task item to
    
    token - the token to associate the task item with
    
    bean - the bean to call a method on
    
    method - the method to call to
    
    arguments - the method call's arguments
    
    Returns:
    
    the new task item
  - addHumanTaskItem
```
public GraphWorkItem addHumanTaskItem(GraphInstance instance,
                                      Token token,
                                      String role,
                                      String user,
                                      Map<String,Object> arguments)
```
    Description copied from interface: GraphEngine
    
    Adds a new HumanTaskItem to the given instance which is associated to the given token. The HumanTaskItem is awaiting external resolution.
    
    Specified by:
    
    addHumanTaskItem in interface GraphEngine
    
    Parameters:
    
    instance - the instance to add the new human task item to
    
    token - the token to associate the human task item with
    
    role - the role a user must be assigned to resolve the given task
    
    user - the user the task is assigned to or null if the assignment is role based.
    
    arguments - the task arguments
    
    Returns:
    
    the new human task item
  - cancelWorkItem
```
public void cancelWorkItem(Token token)
```
    Description copied from interface: GraphEngine
    
    If existent, cancels the active work item associated with the given token.
    
    Specified by:
    
    cancelWorkItem in interface GraphEngine
  - complete
```
public void complete(Token token,
                     Object result)
```
    Description copied from interface: GraphEngine
    
    A shorthand for GraphEngine.complete(Token, Object, String) using a the default transition name Transition.DEFAULT_TRANSITION_NAME.
    
    Specified by:
    
    complete in interface GraphEngine
  - complete
```
public void complete(Token token,
                     Object result,
                     String transitionName)
```
    Description copied from interface: GraphEngine
    
    Finishes the execution of the given Token's current Node on the associated GraphInstance. The method will take the required steps to merge the given result into the graph instance's Environment and to continue the token's execution along the Transition with the given name.
    If a call to Node.execute(GraphEngine, Token) does not contain a call to this method, then the token's execution halts at that point. This is generally referred to as a wait state. This occurs, for example, if the action represented by that node must be done by a human or some external system.
    When the external system has determined that the Node has completed its work, it should invoke GraphEngineFacade#complete(WorkItem) to continue executing the graph instance.
    
    Specified by:
    
    complete in interface GraphEngine
    
    Parameters:
    
    token - The token to continue execution on
    
    result - The result of the node execution
    
    transitionName - The transition's name along which to continue execution
  - terminate
```
public void terminate(Token token)
```
    Description copied from interface: GraphEngine
    
    Marks the given token and all direct parent tokens active that do not have any further active child tokens.
    
    Specified by:
    
    terminate in interface GraphEngine
  - cancel
```
public void cancel(Token token)
```
    Description copied from interface: GraphEngine
    
    Cancels the given token. I.e. marks the token as inactive an call's the Node.cancel(GraphEngine, Token) on the node that this token is currently pointing to.
    
    Specified by:
    
    cancel in interface GraphEngine

Class GraphEngineImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphEngineImpl

Method Detail

start

start

start

start

start

start

start

abort

complete

getRepository

setRepository

getBeanResolver

setBeanResolver

getNewGraphInstanceCreator

setNewGraphInstanceCreator

registerInstanceEventListener

registerWorkItemEventListener

registerNodeEventListener

addToken

addSignalItem

addTimerItem

addTaskItem

addHumanTaskItem

cancelWorkItem

complete

complete

terminate

cancel