Interface FlowableEventListener
-
- All Known Implementing Classes:
AbstractFlowableEventListener
public interface FlowableEventListenerDescribes a class that listens forFlowableEvents dispatched by the engine.- Author:
- Frederik Heremans, Joram Barrez, Filip Hrisafov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description StringgetOnTransaction()default Collection<? extends FlowableEventType>getTypes()The event types that this event listener needs to be registered forbooleanisFailOnException()booleanisFireOnTransactionLifecycleEvent()voidonEvent(FlowableEvent event)Called when an event has been fired
-
-
-
Method Detail
-
onEvent
void onEvent(FlowableEvent event)
Called when an event has been fired- Parameters:
event- the event
-
isFailOnException
boolean isFailOnException()
- Returns:
- whether or not the current operation should fail when this listeners execution throws an exception.
-
isFireOnTransactionLifecycleEvent
boolean isFireOnTransactionLifecycleEvent()
- Returns:
- Returns whether this event listener fires immediately when the event occurs or on a transaction lifecycle event (before/after commit or rollback).
-
getOnTransaction
String getOnTransaction()
- Returns:
- if non-null, indicates the point in the lifecycle of the current transaction when the event should be fired.
-
getTypes
default Collection<? extends FlowableEventType> getTypes()
The event types that this event listener needs to be registered for- Returns:
- the specific event types that this listeners should register itself for
-
-