org.bonitasoft.engine.execution

Class FlowNodeExecutorImpl

java.lang.Object

org.bonitasoft.engine.execution.FlowNodeExecutorImpl

All Implemented Interfaces:

ContainerExecutor, FlowNodeExecutor

public class FlowNodeExecutorImpl
extends Object
implements FlowNodeExecutor

Author:

Baptiste Mesta, Yanyan Liu, Elias Ricken de Medeiros, Emmanuel Duchastenier, Celine Souchet, Matthieu Chaffotte

Constructor Summary

Constructors

Constructor and Description

FlowNodeExecutorImpl(FlowNodeStateManager flowNodeStateManager, org.bonitasoft.engine.core.process.instance.api.ActivityInstanceService activityInstanceManager, org.bonitasoft.engine.core.operation.OperationService operationService, org.bonitasoft.engine.archive.ArchiveService archiveService, org.bonitasoft.engine.data.instance.api.DataInstanceService dataInstanceService, ContainerRegistry containerRegistry, ProcessDefinitionService processDefinitionService, org.bonitasoft.engine.core.process.comment.api.SCommentService commentService, org.bonitasoft.engine.core.process.instance.api.ProcessInstanceService processInstanceService, org.bonitasoft.engine.core.connector.ConnectorInstanceService connectorInstanceService, org.bonitasoft.engine.classloader.ClassLoaderService classLoaderService, org.bonitasoft.engine.work.WorkService workService)

Method Summary

Methods

Modifier and Type	Method and Description
void	archiveFlowNodeInstance(org.bonitasoft.engine.core.process.instance.model.SFlowNodeInstance flowNodeInstance, boolean deleteAfterArchive, long processDefinitionId) Archive the flow node instance given as parameter.
void	childFinished(long processDefinitionId, long flowNodeInstanceId, long parentId) Method called to notify this container executor that a child reached the given state
void	childReachedState(org.bonitasoft.engine.core.process.instance.model.SProcessInstance childProcInst, ProcessInstanceState childState, boolean hasActionsToExecute)
org.bonitasoft.engine.core.process.instance.api.states.FlowNodeState	executeFlowNode(long flowNodeInstanceId, org.bonitasoft.engine.core.expression.control.model.SExpressionContext contextDependency, List<org.bonitasoft.engine.core.operation.model.SOperation> operations, long processInstanceId, Long executerId, Long executerSubstituteId) Execute a flow node in the context of this container executor
org.bonitasoft.engine.core.process.instance.api.states.StateCode	executeState(SProcessDefinition processDefinition, org.bonitasoft.engine.core.process.instance.model.SFlowNodeInstance flowNodeInstance, org.bonitasoft.engine.core.process.instance.api.states.FlowNodeState state)
String	getHandledType()
protected org.bonitasoft.engine.core.process.instance.model.builder.SFlowNodeInstanceLogBuilder	getQueriableLog(org.bonitasoft.engine.queriablelogger.model.builder.ActionType actionType, String message)
protected <T extends org.bonitasoft.engine.queriablelogger.model.builder.SLogBuilder> void	initializeLogBuilder(T logBuilder, String message)
void	setStateByStateId(long sProcessDefinitionId, long flowNodeInstanceId, int stateId)
org.bonitasoft.engine.core.process.instance.api.states.FlowNodeState	stepForward(long flowNodeInstanceId, org.bonitasoft.engine.core.expression.control.model.SExpressionContext expressionContext, List<org.bonitasoft.engine.core.operation.model.SOperation> operations, long processInstanceId, Long executerId, Long executerSubstituteId)
protected <T extends org.bonitasoft.engine.queriablelogger.model.builder.HasCRUDEAction> void	updateLog(org.bonitasoft.engine.queriablelogger.model.builder.ActionType actionType, T logBuilder)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowNodeExecutorImpl

public FlowNodeExecutorImpl(FlowNodeStateManager flowNodeStateManager,
                    org.bonitasoft.engine.core.process.instance.api.ActivityInstanceService activityInstanceManager,
                    org.bonitasoft.engine.core.operation.OperationService operationService,
                    org.bonitasoft.engine.archive.ArchiveService archiveService,
                    org.bonitasoft.engine.data.instance.api.DataInstanceService dataInstanceService,
                    ContainerRegistry containerRegistry,
                    ProcessDefinitionService processDefinitionService,
                    org.bonitasoft.engine.core.process.comment.api.SCommentService commentService,
                    org.bonitasoft.engine.core.process.instance.api.ProcessInstanceService processInstanceService,
                    org.bonitasoft.engine.core.connector.ConnectorInstanceService connectorInstanceService,
                    org.bonitasoft.engine.classloader.ClassLoaderService classLoaderService,
                    org.bonitasoft.engine.work.WorkService workService)

Method Detail

executeState

public org.bonitasoft.engine.core.process.instance.api.states.StateCode executeState(SProcessDefinition processDefinition,
                                                                            org.bonitasoft.engine.core.process.instance.model.SFlowNodeInstance flowNodeInstance,
                                                                            org.bonitasoft.engine.core.process.instance.api.states.FlowNodeState state)
                                                                              throws org.bonitasoft.engine.core.process.instance.api.exceptions.SActivityStateExecutionException,
                                                                                     org.bonitasoft.engine.core.process.instance.api.exceptions.SActivityExecutionException

Specified by:

executeState in interface FlowNodeExecutor

Parameters:

processDefinition - the process definition of the SFlowNodeInstance on which to execute the state.

flowNodeInstance - the SFlowNodeInstance whose state has to be executed

state - the FlowNodeState to execute

Returns:

the next FlowNodeState, after executing current state

Throws:

org.bonitasoft.engine.core.process.instance.api.exceptions.SActivityStateExecutionException - if an exception occurs when executing current state

org.bonitasoft.engine.core.process.instance.api.exceptions.SActivityExecutionException - if an exception occurs when retrieving next state

stepForward

public org.bonitasoft.engine.core.process.instance.api.states.FlowNodeState stepForward(long flowNodeInstanceId,
                                                                               org.bonitasoft.engine.core.expression.control.model.SExpressionContext expressionContext,
                                                                               List<org.bonitasoft.engine.core.operation.model.SOperation> operations,
                                                                               long processInstanceId,
                                                                               Long executerId,
                                                                               Long executerSubstituteId)
                                                                                 throws org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeExecutionException

Specified by:

stepForward in interface FlowNodeExecutor

Returns:

Throws:

org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeExecutionException

initializeLogBuilder

protected <T extends org.bonitasoft.engine.queriablelogger.model.builder.SLogBuilder> void initializeLogBuilder(T logBuilder,
                                                                                                    String message)

updateLog

protected <T extends org.bonitasoft.engine.queriablelogger.model.builder.HasCRUDEAction> void updateLog(org.bonitasoft.engine.queriablelogger.model.builder.ActionType actionType,
                                                                                            T logBuilder)

getQueriableLog

protected org.bonitasoft.engine.core.process.instance.model.builder.SFlowNodeInstanceLogBuilder getQueriableLog(org.bonitasoft.engine.queriablelogger.model.builder.ActionType actionType,
                                                                                                    String message)

setStateByStateId

public void setStateByStateId(long sProcessDefinitionId,
                     long flowNodeInstanceId,
                     int stateId)
                       throws org.bonitasoft.engine.core.process.instance.api.exceptions.SActivityStateExecutionException

Specified by:

setStateByStateId in interface FlowNodeExecutor

Throws:

org.bonitasoft.engine.core.process.instance.api.exceptions.SActivityStateExecutionException

childFinished

public void childFinished(long processDefinitionId,
                 long flowNodeInstanceId,
                 long parentId)
                   throws org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeNotFoundException,
                          org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeReadException,
                          SProcessDefinitionNotFoundException,
                          SProcessDefinitionReadException,
                          SArchivingException,
                          org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeModificationException,
                          org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeExecutionException

Description copied from interface: ContainerExecutor

Method called to notify this container executor that a child reached the given state

Specified by:

childFinished in interface ContainerExecutor

Parameters:

processDefinitionId - The identifier of the process definition

flowNodeInstanceId - The identifier of the flow node instance

parentId - The identifier of the parent of the flow node

Throws:

org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeNotFoundException

org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeReadException

SProcessDefinitionNotFoundException

SProcessDefinitionReadException

SArchivingException

org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeModificationException

org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeExecutionException

childReachedState

public void childReachedState(org.bonitasoft.engine.core.process.instance.model.SProcessInstance childProcInst,
                     ProcessInstanceState childState,
                     boolean hasActionsToExecute)
                       throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Specified by:

childReachedState in interface FlowNodeExecutor

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

getHandledType

public String getHandledType()

Specified by:

getHandledType in interface ContainerExecutor

Returns:

The handled type

executeFlowNode

public org.bonitasoft.engine.core.process.instance.api.states.FlowNodeState executeFlowNode(long flowNodeInstanceId,
                                                                                   org.bonitasoft.engine.core.expression.control.model.SExpressionContext contextDependency,
                                                                                   List<org.bonitasoft.engine.core.operation.model.SOperation> operations,
                                                                                   long processInstanceId,
                                                                                   Long executerId,
                                                                                   Long executerSubstituteId)
                                                                                     throws org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeExecutionException

Description copied from interface: ContainerExecutor

Execute a flow node in the context of this container executor

Specified by:

executeFlowNode in interface ContainerExecutor

Parameters:

flowNodeInstanceId - The identifier of the flow node instance

processInstanceId - The identifier of the process instance

executerId - The identifier of the user which execute the flow node

executerSubstituteId - The identifier of the delegated user which execute the flow node

Returns:

The new state of the flow node after execution

Throws:

org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeExecutionException - Throw if there is an error when execute the flow node

archiveFlowNodeInstance

public void archiveFlowNodeInstance(org.bonitasoft.engine.core.process.instance.model.SFlowNodeInstance flowNodeInstance,
                           boolean deleteAfterArchive,
                           long processDefinitionId)
                             throws SArchivingException

Description copied from interface: FlowNodeExecutor

Archive the flow node instance given as parameter. Also archive all related object that needs to be archived as well.

Specified by:

archiveFlowNodeInstance in interface FlowNodeExecutor

Parameters:

flowNodeInstance - The flow node instance to be archived.

processDefinitionId - the identifier of process definition

Throws:

SArchivingException