Package org.flowable.engine.delegate.event

Class BaseEntityEventListener

  • All Implemented Interfaces:
    org.flowable.common.engine.api.delegate.event.FlowableEventListener
    Direct Known Subclasses:
    DebugInfoEntityEventListener
    public class BaseEntityEventListener
extends org.flowable.common.engine.api.delegate.event.AbstractFlowableEventListener
    Base event listener that can be used when implementing an FlowableEventListener to get notified when an entity is created, updated, deleted or if another entity-related event occurs. Override the onXX(..) methods to respond to entity changes accordingly.
    Author:
    Frederik Heremans

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Class<?> entityClass  
      protected boolean failOnException  

      • Fields inherited from class org.flowable.common.engine.api.delegate.event.AbstractFlowableEventListener

        onTransaction

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isFailOnException()  
      protected boolean isValidEvent​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)  
      protected void onCreate​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
      Called when an entity create event is received.
      protected void onDelete​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
      Called when an entity delete event is received.
      protected void onEntityEvent​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
      Called when an event is received, which is not a create, an update or delete.
      void onEvent​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)  
      protected void onInitialized​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
      Called when an entity initialized event is received.
      protected void onUpdate​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
      Called when an entity update event is received.

      • Methods inherited from class org.flowable.common.engine.api.delegate.event.AbstractFlowableEventListener

        getOnTransaction, isFireOnTransactionLifecycleEvent, setOnTransaction

      • Methods inherited from interface org.flowable.common.engine.api.delegate.event.FlowableEventListener

        getTypes

    • Field Detail

      • failOnException

        protected boolean failOnException

      • entityClass

        protected Class<?> entityClass

    • Constructor Detail

      • BaseEntityEventListener

        public BaseEntityEventListener()
        Create a new BaseEntityEventListener, notified when an event that targets any type of entity is received. Returning true when isFailOnException() is called.

      • BaseEntityEventListener

        public BaseEntityEventListener​(boolean failOnException)
        Create a new BaseEntityEventListener.
        Parameters:
        failOnException - return value for isFailOnException().

      • BaseEntityEventListener

        public BaseEntityEventListener​(boolean failOnException,
                               Class<?> entityClass)

    • Method Detail

      • onEvent

        public final void onEvent​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)

      • isFailOnException

        public boolean isFailOnException()

      • isValidEvent

        protected boolean isValidEvent​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
        Returns:
        true, if the event is an FlowableEntityEvent and (if needed) the entityClass set in this instance, is assignable from the entity class in the event.

      • onCreate

        protected void onCreate​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
        Called when an entity create event is received.

      • onInitialized

        protected void onInitialized​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
        Called when an entity initialized event is received.

      • onDelete

        protected void onDelete​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
        Called when an entity delete event is received.

      • onUpdate

        protected void onUpdate​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
        Called when an entity update event is received.

      • onEntityEvent

        protected void onEntityEvent​(org.flowable.common.engine.api.delegate.event.FlowableEvent event)
        Called when an event is received, which is not a create, an update or delete.