org.bonitasoft.engine.execution.event

Class EventsHandler

java.lang.Object

org.bonitasoft.engine.execution.event.EventsHandler

public class EventsHandler
extends Object

Handle event depending on its type TODO * Move all code that instantiate process/execute flow node after a event was triggered here + make it call reachedCatchEvent * For event sub process: the instantiate process must cancel all activities then instantiate the process * the instantiate event subprocess method is like the start of the process executor but with less things: factorise it * check that there is no execution issues with event sub proces (add more test) * add test for each kind of start event in event sub process * try to trigger event subprocess with multiple events

Author:

Baptiste Mesta, Elias Ricken de Medeiros, Celine Souchet

Constructor Summary

Constructors

Constructor and Description

EventsHandler(org.bonitasoft.engine.scheduler.SchedulerService schedulerService, org.bonitasoft.engine.core.expression.control.api.ExpressionResolverService expressionResolverService, org.bonitasoft.engine.core.process.instance.api.event.EventInstanceService eventInstanceService, BPMInstancesCreator bpmInstancesCreator, org.bonitasoft.engine.data.instance.api.DataInstanceService dataInstanceService, org.bonitasoft.engine.core.process.definition.ProcessDefinitionService processDefinitionService, ContainerRegistry containerRegistry, org.bonitasoft.engine.core.process.instance.api.ProcessInstanceService processInstanceService, org.bonitasoft.engine.core.process.instance.api.TokenService tokenService, org.bonitasoft.engine.log.technical.TechnicalLoggerService logger)

Method Summary

Methods

Modifier and Type	Method and Description
EventHandlerStrategy	getHandler(org.bonitasoft.engine.core.process.definition.model.event.trigger.SEventTriggerType triggerType)
void	handleCatchEvent(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition processDefinition, org.bonitasoft.engine.core.process.definition.model.event.SEventDefinition eventDefinition, org.bonitasoft.engine.core.process.instance.model.event.SEventInstance eventInstance) called when a catchEvent is reached e.g. we are going on a catch event in the flow of a process This is different of trigger catch event: e.g. for a message handleCatchEvent will create the waiting event and triggerCatchEvent is called when the message is received
void	handleCatchMessage(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition processDefinition, org.bonitasoft.engine.core.process.definition.model.SReceiveTaskDefinition receiveTaskDefinition, org.bonitasoft.engine.core.process.instance.model.SReceiveTaskInstance receiveTaskInstance)
void	handleEventSubProcess(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition sDefinition, org.bonitasoft.engine.core.process.instance.model.SProcessInstance parentProcessInstance)
boolean	handlePostThrowEvent(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition sProcessDefinition, org.bonitasoft.engine.core.process.definition.model.event.SEndEventDefinition sEndEventDefinition, org.bonitasoft.engine.core.process.instance.model.event.SThrowEventInstance sThrowEventInstance, org.bonitasoft.engine.core.process.instance.model.SFlowNodeInstance sFlowNodeInstance)
void	handleThrowEvent(org.bonitasoft.engine.core.process.definition.model.event.trigger.SEventTriggerDefinition sEventTriggerDefinition) called when a BPM event is triggered by the API
void	handleThrowEvent(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition processDefinition, org.bonitasoft.engine.core.process.definition.model.event.SEventDefinition eventDefinition, org.bonitasoft.engine.core.process.instance.model.event.SEventInstance eventInstance) called when we reach a throw event in the flow of a process
void	handleThrowMessage(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition processDefinition, org.bonitasoft.engine.core.process.definition.model.SSendTaskDefinition sendTaskDefinition, org.bonitasoft.engine.core.process.instance.model.SSendTaskInstance sendTaskInstance)
void	setProcessExecutor(ProcessExecutor processExecutor)
void	triggerCatchEvent(org.bonitasoft.engine.core.process.definition.model.event.trigger.SEventTriggerType eventTriggerType, Long processDefinitionId, Long targetSFlowNodeDefinitionId, String containerType, long subProcessId, Long parentProcessInstanceId, Long rootProcessInstanceId, Boolean isInterrupting)
void	triggerCatchEvent(String eventType, Long processDefinitionId, Long targetSFlowNodeDefinitionId, Long flowNodeInstanceId, String containerType)
void	triggerCatchEvent(org.bonitasoft.engine.core.process.instance.model.event.handling.SWaitingEvent waitingEvent, Long triggeringElementID) When a trigger is 'launched' the catch event is reached and is waken up/created using its waiting event Depending on the type it will execute the catch event of instantiate the process/subprocess
void	unregisterEventSubProcess(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition sDefinition, org.bonitasoft.engine.core.process.instance.model.SProcessInstance parentProcessInstance)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventsHandler

public EventsHandler(org.bonitasoft.engine.scheduler.SchedulerService schedulerService,
             org.bonitasoft.engine.core.expression.control.api.ExpressionResolverService expressionResolverService,
             org.bonitasoft.engine.core.process.instance.api.event.EventInstanceService eventInstanceService,
             BPMInstancesCreator bpmInstancesCreator,
             org.bonitasoft.engine.data.instance.api.DataInstanceService dataInstanceService,
             org.bonitasoft.engine.core.process.definition.ProcessDefinitionService processDefinitionService,
             ContainerRegistry containerRegistry,
             org.bonitasoft.engine.core.process.instance.api.ProcessInstanceService processInstanceService,
             org.bonitasoft.engine.core.process.instance.api.TokenService tokenService,
             org.bonitasoft.engine.log.technical.TechnicalLoggerService logger)

Method Detail

setProcessExecutor

public void setProcessExecutor(ProcessExecutor processExecutor)

handleCatchEvent

public void handleCatchEvent(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition processDefinition,
                    org.bonitasoft.engine.core.process.definition.model.event.SEventDefinition eventDefinition,
                    org.bonitasoft.engine.core.process.instance.model.event.SEventInstance eventInstance)
                      throws org.bonitasoft.engine.commons.exceptions.SBonitaException

called when a catchEvent is reached e.g. we are going on a catch event in the flow of a process This is different of trigger catch event: e.g. for a message handleCatchEvent will create the waiting event and triggerCatchEvent is called when the message is received

Parameters:

processDefinition -

eventDefinition -

eventInstance -

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

handleCatchMessage

public void handleCatchMessage(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition processDefinition,
                      org.bonitasoft.engine.core.process.definition.model.SReceiveTaskDefinition receiveTaskDefinition,
                      org.bonitasoft.engine.core.process.instance.model.SReceiveTaskInstance receiveTaskInstance)
                        throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

handleEventSubProcess

public void handleEventSubProcess(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition sDefinition,
                         org.bonitasoft.engine.core.process.instance.model.SProcessInstance parentProcessInstance)
                           throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

unregisterEventSubProcess

public void unregisterEventSubProcess(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition sDefinition,
                             org.bonitasoft.engine.core.process.instance.model.SProcessInstance parentProcessInstance)
                               throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

handleThrowEvent

public void handleThrowEvent(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition processDefinition,
                    org.bonitasoft.engine.core.process.definition.model.event.SEventDefinition eventDefinition,
                    org.bonitasoft.engine.core.process.instance.model.event.SEventInstance eventInstance)
                      throws org.bonitasoft.engine.commons.exceptions.SBonitaException

called when we reach a throw event in the flow of a process

Parameters:

processDefinition -

eventDefinition -

eventInstance -

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

handleThrowMessage

public void handleThrowMessage(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition processDefinition,
                      org.bonitasoft.engine.core.process.definition.model.SSendTaskDefinition sendTaskDefinition,
                      org.bonitasoft.engine.core.process.instance.model.SSendTaskInstance sendTaskInstance)
                        throws org.bonitasoft.engine.core.process.instance.api.exceptions.event.trigger.SEventTriggerInstanceCreationException,
                               org.bonitasoft.engine.core.process.instance.api.exceptions.event.trigger.SMessageInstanceCreationException,
                               org.bonitasoft.engine.data.instance.exception.SDataInstanceException,
                               org.bonitasoft.engine.expression.exception.SExpressionException

Throws:

org.bonitasoft.engine.core.process.instance.api.exceptions.event.trigger.SEventTriggerInstanceCreationException

org.bonitasoft.engine.core.process.instance.api.exceptions.event.trigger.SMessageInstanceCreationException

org.bonitasoft.engine.data.instance.exception.SDataInstanceException

org.bonitasoft.engine.expression.exception.SExpressionException

handlePostThrowEvent

public boolean handlePostThrowEvent(org.bonitasoft.engine.core.process.definition.model.SProcessDefinition sProcessDefinition,
                           org.bonitasoft.engine.core.process.definition.model.event.SEndEventDefinition sEndEventDefinition,
                           org.bonitasoft.engine.core.process.instance.model.event.SThrowEventInstance sThrowEventInstance,
                           org.bonitasoft.engine.core.process.instance.model.SFlowNodeInstance sFlowNodeInstance)
                             throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

handleThrowEvent

public void handleThrowEvent(org.bonitasoft.engine.core.process.definition.model.event.trigger.SEventTriggerDefinition sEventTriggerDefinition)
                      throws org.bonitasoft.engine.commons.exceptions.SBonitaException

called when a BPM event is triggered by the API

Parameters:

sEventTriggerDefinition -

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

triggerCatchEvent

public void triggerCatchEvent(org.bonitasoft.engine.core.process.instance.model.event.handling.SWaitingEvent waitingEvent,
                     Long triggeringElementID)
                       throws org.bonitasoft.engine.commons.exceptions.SBonitaException

When a trigger is 'launched' the catch event is reached and is waken up/created using its waiting event Depending on the type it will execute the catch event of instantiate the process/subprocess

Parameters:

waitingEvent -

triggeringElementID -

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

triggerCatchEvent

public void triggerCatchEvent(String eventType,
                     Long processDefinitionId,
                     Long targetSFlowNodeDefinitionId,
                     Long flowNodeInstanceId,
                     String containerType)
                       throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

triggerCatchEvent

public void triggerCatchEvent(org.bonitasoft.engine.core.process.definition.model.event.trigger.SEventTriggerType eventTriggerType,
                     Long processDefinitionId,
                     Long targetSFlowNodeDefinitionId,
                     String containerType,
                     long subProcessId,
                     Long parentProcessInstanceId,
                     Long rootProcessInstanceId,
                     Boolean isInterrupting)
                       throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

getHandler

public EventHandlerStrategy getHandler(org.bonitasoft.engine.core.process.definition.model.event.trigger.SEventTriggerType triggerType)