Package org.bonitasoft.engine.core.process.instance.event.impl

Class EventInstanceRepositoryImpl

java.lang.Object

org.bonitasoft.engine.core.process.instance.event.impl.EventInstanceRepositoryImpl

All Implemented Interfaces:

EventInstanceRepository

public class EventInstanceRepositoryImpl
extends Object
implements EventInstanceRepository

Author:

Elias Ricken de Medeiros, Matthieu Chaffotte, Frederic Bouquet, Celine Souchet

Field Summary

Fields

Modifier and Type	Field	Description
static final String	QUERY_RESET_IN_PROGRESS_WAITING_EVENTS

Fields inherited from interface org.bonitasoft.engine.core.process.instance.api.event.EventInstanceRepository

EVENT_INSTANCE, EVENT_TRIGGER_INSTANCE, IN_REQUEST_SIZE, MESSAGE_INSTANCE

Constructor Summary

Constructors

Constructor	Description
EventInstanceRepositoryImpl(Recorder recorder, PersistenceService persistenceService, EventService eventService, ArchiveService archiveService)

Method Summary

Modifier and Type	Method	Description
void	createEventInstance(SEventInstance eventInstance)
void	createMessageInstance(SMessageInstance messageInstance)
void	createTimerEventTriggerInstance(STimerEventTriggerInstance eventTriggerInstance)	STimerEventTriggerInstance is used to keep track of currently running timers using ProcessRuntimeAPI.searchTimerEventTriggerInstances(long, SearchOptions)
void	createWaitingEvent(SWaitingEvent waitingEvent)
void	deleteEventTriggerInstance(STimerEventTriggerInstance eventTriggerInstance)
void	deleteMessageInstance(SMessageInstance messageInstance)
void	deleteMessageInstanceByIds(List<Long> ids)
void	deleteWaitingEvent(SWaitingEvent waitingEvent)
List<SBoundaryEventInstance>	getActivityBoundaryEventInstances(long activityInstanceId, int fromIndex, int maxResults)
List<SWaitingEvent>	getAllWaitingEventsForProcessInstance(long processInstanceId, int fromIndex, int maxResults)	Return waiting events related to the process instance passed as parameter, including the ones at flow node level.
SWaitingErrorEvent	getBoundaryWaitingErrorEvent(long relatedActivityInstanceId, String errorCode)
List<SEventInstance>	getEventInstances(long rootContainerId, int fromIndex, int maxResults, String fieldName, OrderByType orderByType)
<T extends STimerEventTriggerInstance> T	getEventTriggerInstance(Class<T> entityClass, long eventTriggerInstanceId)
List<SMessageEventCouple>	getMessageEventCouples(int fromIndex, int maxResults)
SMessageInstance	getMessageInstance(long messageInstanceId)
List<Long>	getMessageInstanceIdOlderThanCreationDate(long creationDate, QueryOptions queryOptions)
long	getNumberOfTimerEventTriggerInstances(long processInstanceId, QueryOptions queryOptions)	Get the number of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria
long	getNumberOfWaitingEvents(Class<? extends SWaitingEvent> entityClass, QueryOptions countOptions)
List<SWaitingEvent>	getStartWaitingEventsOfProcessDefinition(long processDefinitionId)	search start waiting events related to a process definition (not its event sub processes)
Optional<STimerEventTriggerInstance>	getTimerEventTriggerInstanceOfFlowNode(long flowNodeInstanceId)
List<SWaitingEvent>	getWaitingEventsForFlowNodeId(long flowNodeInstanceId)
SWaitingMessageEvent	getWaitingMessage(long waitingMessageId)
SWaitingSignalEvent	getWaitingSignalEvent(long id)
List<SWaitingSignalEvent>	getWaitingSignalEvents(String signalName, int fromIndex, int maxResults)
int	resetInProgressWaitingEvents()	Resets all Waiting Message Events marked as 'in progress", so that they are eligible to match Message Instances again.
int	resetProgressMessageInstances()	Resets all Message Instances marked as handled, so that they are eligible to match Waiting Events again.
List<STimerEventTriggerInstance>	searchTimerEventTriggerInstances(long processInstanceId, QueryOptions queryOptions)	Search the list of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria
<T extends SWaitingEvent> List<T>	searchWaitingEvents(Class<T> entityClass, QueryOptions searchOptions)
void	updateEventTriggerInstance(STimerEventTriggerInstance sTimerEventTriggerInstance, EntityUpdateDescriptor descriptor)	Update an event trigger instance.
void	updateMessageInstance(SMessageInstance messageInstance, EntityUpdateDescriptor descriptor)
void	updateWaitingMessage(SWaitingMessageEvent waitingMessageEvent, EntityUpdateDescriptor descriptor)

Methods inherited from class java.lang.Object

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

Field Details

QUERY_RESET_IN_PROGRESS_WAITING_EVENTS

public static final String QUERY_RESET_IN_PROGRESS_WAITING_EVENTS

See Also:

• Constant Field Values

Constructor Details

EventInstanceRepositoryImpl

public EventInstanceRepositoryImpl(Recorder recorder,
 PersistenceService persistenceService,
 EventService eventService,
 ArchiveService archiveService)

Method Details

createEventInstance

public void createEventInstance(SEventInstance eventInstance)
                         throws SEventInstanceCreationException

Specified by:

createEventInstance in interface EventInstanceRepository

Throws:

SEventInstanceCreationException

createTimerEventTriggerInstance

public void createTimerEventTriggerInstance(STimerEventTriggerInstance eventTriggerInstance)
                                     throws SEventTriggerInstanceCreationException

Description copied from interface: EventInstanceRepository

STimerEventTriggerInstance is used to keep track of currently running timers using ProcessRuntimeAPI.searchTimerEventTriggerInstances(long, SearchOptions)

Specified by:

createTimerEventTriggerInstance in interface EventInstanceRepository

Throws:

SEventTriggerInstanceCreationException

createMessageInstance

public void createMessageInstance(SMessageInstance messageInstance)
                           throws SMessageInstanceCreationException

Specified by:

createMessageInstance in interface EventInstanceRepository

Throws:

SMessageInstanceCreationException

createWaitingEvent

public void createWaitingEvent(SWaitingEvent waitingEvent)
                        throws SWaitingEventCreationException

Specified by:

createWaitingEvent in interface EventInstanceRepository

Throws:

SWaitingEventCreationException

deleteEventTriggerInstance

public void deleteEventTriggerInstance(STimerEventTriggerInstance eventTriggerInstance)
                                throws SEventTriggerInstanceDeletionException

Specified by:

deleteEventTriggerInstance in interface EventInstanceRepository

Throws:

SEventTriggerInstanceDeletionException

deleteMessageInstance

public void deleteMessageInstance(SMessageInstance messageInstance)
                           throws SMessageModificationException

Specified by:

deleteMessageInstance in interface EventInstanceRepository

Throws:

SMessageModificationException

getActivityBoundaryEventInstances

public List<SBoundaryEventInstance> getActivityBoundaryEventInstances(long activityInstanceId,
 int fromIndex,
 int maxResults)
                                                               throws SEventInstanceReadException

Specified by:

getActivityBoundaryEventInstances in interface EventInstanceRepository

Returns:

List of SBoundaryEventInstance, ordered by identifier ascending

Throws:

SEventInstanceReadException

getBoundaryWaitingErrorEvent

public SWaitingErrorEvent getBoundaryWaitingErrorEvent(long relatedActivityInstanceId,
 String errorCode)
                                                throws SWaitingEventReadException

Specified by:

getBoundaryWaitingErrorEvent in interface EventInstanceRepository

Throws:

SWaitingEventReadException

getEventInstances

public List<SEventInstance> getEventInstances(long rootContainerId,
 int fromIndex,
 int maxResults,
 String fieldName,
 OrderByType orderByType)
                                       throws SEventInstanceReadException

Specified by:

getEventInstances in interface EventInstanceRepository

Throws:

SEventInstanceReadException

getEventTriggerInstance

public <T extends STimerEventTriggerInstance> T getEventTriggerInstance(Class<T> entityClass,
 long eventTriggerInstanceId)
                                                                 throws SEventTriggerInstanceReadException

Specified by:

getEventTriggerInstance in interface EventInstanceRepository

Returns:

Throws:

SEventTriggerInstanceReadException

resetProgressMessageInstances

public int resetProgressMessageInstances()
                                  throws SMessageModificationException

Description copied from interface: EventInstanceRepository

Resets all Message Instances marked as handled, so that they are eligible to match Waiting Events again.

Specified by:

resetProgressMessageInstances in interface EventInstanceRepository

Throws:

SMessageModificationException - if an error occurs when resetting the 'handled' flag.

resetInProgressWaitingEvents

public int resetInProgressWaitingEvents()
                                 throws SWaitingEventModificationException

Description copied from interface: EventInstanceRepository

Resets all Waiting Message Events marked as 'in progress", so that they are eligible to match Message Instances again.

Specified by:

resetInProgressWaitingEvents in interface EventInstanceRepository

Returns:

the number of waiting events reset.

Throws:

SWaitingEventModificationException - if an error occurs when resetting the 'progress' flag.

getMessageEventCouples

public List<SMessageEventCouple> getMessageEventCouples(int fromIndex,
 int maxResults)
                                                 throws SEventTriggerInstanceReadException

Specified by:

getMessageEventCouples in interface EventInstanceRepository

Throws:

SEventTriggerInstanceReadException

getMessageInstance

public SMessageInstance getMessageInstance(long messageInstanceId)
                                    throws SMessageInstanceReadException

Specified by:

getMessageInstance in interface EventInstanceRepository

Throws:

SMessageInstanceReadException

getMessageInstanceIdOlderThanCreationDate

public List<Long> getMessageInstanceIdOlderThanCreationDate(long creationDate,
 QueryOptions queryOptions)
                                                     throws SMessageInstanceReadException

Specified by:

getMessageInstanceIdOlderThanCreationDate in interface EventInstanceRepository

Throws:

SMessageInstanceReadException

deleteMessageInstanceByIds

public void deleteMessageInstanceByIds(List<Long> ids)
                                throws SMessageModificationException

Specified by:

deleteMessageInstanceByIds in interface EventInstanceRepository

Throws:

SMessageModificationException

getNumberOfWaitingEvents

public long getNumberOfWaitingEvents(Class<? extends SWaitingEvent> entityClass,
 QueryOptions countOptions)
                              throws SBonitaReadException

Specified by:

getNumberOfWaitingEvents in interface EventInstanceRepository

Throws:

SBonitaReadException

getStartWaitingEventsOfProcessDefinition

public List<SWaitingEvent> getStartWaitingEventsOfProcessDefinition(long processDefinitionId)
                                                             throws SBonitaReadException

Description copied from interface: EventInstanceRepository

search start waiting events related to a process definition (not its event sub processes)

Specified by:

getStartWaitingEventsOfProcessDefinition in interface EventInstanceRepository

Returns:

Throws:

SBonitaReadException

getWaitingMessage

public SWaitingMessageEvent getWaitingMessage(long waitingMessageId)
                                       throws SWaitingEventReadException

Specified by:

getWaitingMessage in interface EventInstanceRepository

Throws:

SWaitingEventReadException

deleteWaitingEvent

public void deleteWaitingEvent(SWaitingEvent waitingEvent)
                        throws SWaitingEventModificationException

Specified by:

deleteWaitingEvent in interface EventInstanceRepository

Throws:

SWaitingEventModificationException

getWaitingEventsForFlowNodeId

public List<SWaitingEvent> getWaitingEventsForFlowNodeId(long flowNodeInstanceId)
                                                  throws SEventTriggerInstanceReadException

Specified by:

getWaitingEventsForFlowNodeId in interface EventInstanceRepository

Throws:

SEventTriggerInstanceReadException

getAllWaitingEventsForProcessInstance

public List<SWaitingEvent> getAllWaitingEventsForProcessInstance(long processInstanceId,
 int fromIndex,
 int maxResults)
                                                          throws SEventTriggerInstanceReadException

Description copied from interface: EventInstanceRepository

Return waiting events related to the process instance passed as parameter, including the ones at flow node level.

Specified by:

getAllWaitingEventsForProcessInstance in interface EventInstanceRepository

Throws:

SEventTriggerInstanceReadException

getWaitingSignalEvents

public List<SWaitingSignalEvent> getWaitingSignalEvents(String signalName,
 int fromIndex,
 int maxResults)
                                                 throws SEventTriggerInstanceReadException

Specified by:

getWaitingSignalEvents in interface EventInstanceRepository

Returns:

Throws:

SEventTriggerInstanceReadException

getWaitingSignalEvent

public SWaitingSignalEvent getWaitingSignalEvent(long id)
                                          throws SEventTriggerInstanceReadException,
SEventTriggerInstanceNotFoundException

Specified by:

getWaitingSignalEvent in interface EventInstanceRepository

Throws:

SEventTriggerInstanceReadException

SEventTriggerInstanceNotFoundException

getTimerEventTriggerInstanceOfFlowNode

public Optional<STimerEventTriggerInstance> getTimerEventTriggerInstanceOfFlowNode(long flowNodeInstanceId)
                                                                            throws SBonitaReadException

Specified by:

getTimerEventTriggerInstanceOfFlowNode in interface EventInstanceRepository

Parameters:

flowNodeInstanceId - the flow node instance id

Returns:

the timer event trigger instance of this flow node if there is one

Throws:

SBonitaReadException

getNumberOfTimerEventTriggerInstances

public long getNumberOfTimerEventTriggerInstances(long processInstanceId,
 QueryOptions queryOptions)
                                           throws SBonitaReadException

Description copied from interface: EventInstanceRepository

Get the number of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria

Specified by:

getNumberOfTimerEventTriggerInstances in interface EventInstanceRepository

Parameters:

processInstanceId - The identifier of the process instance

queryOptions - Criteria of the search

Returns:

The number of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria

Throws:

SBonitaReadException

searchTimerEventTriggerInstances

public List<STimerEventTriggerInstance> searchTimerEventTriggerInstances(long processInstanceId,
 QueryOptions queryOptions)
                                                                  throws SBonitaReadException

Description copied from interface: EventInstanceRepository

Search the list of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria

Specified by:

searchTimerEventTriggerInstances in interface EventInstanceRepository

Parameters:

processInstanceId - The identifier of the process instance

queryOptions - Criteria of the search

Returns:

The list of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria

Throws:

SBonitaReadException

searchWaitingEvents

public <T extends SWaitingEvent> List<T> searchWaitingEvents(Class<T> entityClass,
 QueryOptions searchOptions)
                                                      throws SBonitaReadException

Specified by:

searchWaitingEvents in interface EventInstanceRepository

Throws:

SBonitaReadException

updateMessageInstance

public void updateMessageInstance(SMessageInstance messageInstance,
 EntityUpdateDescriptor descriptor)
                           throws SMessageModificationException

Specified by:

updateMessageInstance in interface EventInstanceRepository

Throws:

SMessageModificationException

updateWaitingMessage

public void updateWaitingMessage(SWaitingMessageEvent waitingMessageEvent,
 EntityUpdateDescriptor descriptor)
                          throws SWaitingEventModificationException

Specified by:

updateWaitingMessage in interface EventInstanceRepository

Throws:

SWaitingEventModificationException

updateEventTriggerInstance

public void updateEventTriggerInstance(STimerEventTriggerInstance sTimerEventTriggerInstance,
 EntityUpdateDescriptor descriptor)
                                throws SEventTriggerInstanceModificationException

Description copied from interface: EventInstanceRepository

Update an event trigger instance.

Specified by:

updateEventTriggerInstance in interface EventInstanceRepository

Parameters:

sTimerEventTriggerInstance - The event trigger instance to update

descriptor - The fields to update

Throws:

SEventTriggerInstanceModificationException