Package org.exoplatform.commons.api.event

Interface EventManager<S,D>

Type Parameters:
S - This is a generic object of source.
All Known Implementing Classes:
EventManagerImpl
public interface EventManager<S,D>
Is the central point of the event system where listeners are registered (and/or unregistered) and events are fired.
eXo level API
Experimental

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addEventListener(String eventName, org.exoplatform.services.listener.ListenerBase<S,D> listener)
    Registers a listener for a given event group in the event system.
    void
    addEventListener(org.exoplatform.services.listener.Listener<S,D> listener)
    Registers a listener into the event system.
    void
    broadcastEvent(org.exoplatform.services.listener.Event<S,D> event)
    Broadcasts an event to a dedicated listener when an action (such as create or update) is triggered.
    List<org.exoplatform.services.listener.ListenerBase<S,D>>
    getEventListeners(String type)
    Gets a list of listeners which are registered into the event system based on a given event group.
    void
    removeEventListener(String eventName, org.exoplatform.services.listener.ListenerBase<S,D> listener)
    Unregisters a listener out of a given event group in the event system.
    void
    removeEventListener(org.exoplatform.services.listener.Listener<S,D> listener)
    Unregisters a listener out of the event system.

  • Method Details

    • addEventListener

      void addEventListener(org.exoplatform.services.listener.Listener<S,D> listener)
      Registers a listener into the event system.
      Parameters:
      listener - An instance of Listener object.
      eXo level API
      Experimental

    • addEventListener

      void addEventListener(String eventName, org.exoplatform.services.listener.ListenerBase<S,D> listener)
      Registers a listener for a given event group in the event system.
      Parameters:
      eventName - Name of the event group.
      listener - An instance of ListenerBase object.
      eXo level API
      Experimental

    • removeEventListener

      void removeEventListener(org.exoplatform.services.listener.Listener<S,D> listener)
      Unregisters a listener out of the event system.
      Parameters:
      listener - An instance of Listener object.
      eXo level API
      Experimental

    • removeEventListener

      void removeEventListener(String eventName, org.exoplatform.services.listener.ListenerBase<S,D> listener)
      Unregisters a listener out of a given event group in the event system.
      Parameters:
      eventName - Name of the event group.
      listener - An instance of ListenerBase object.
      eXo level API
      Experimental

    • broadcastEvent

      void broadcastEvent(org.exoplatform.services.listener.Event<S,D> event)
      Broadcasts an event to a dedicated listener when an action (such as create or update) is triggered.
      Parameters:
      event - The Event object which keeps information to be processed in the listeners.
      eXo level API
      Experimental

    • getEventListeners

      List<org.exoplatform.services.listener.ListenerBase<S,D>> getEventListeners(String type)
      Gets a list of listeners which are registered into the event system based on a given event group. For example: If you want to get a list of listeners which are registered for listening to all the events on an instance of File object, the event group name will be getObjectType().
      Parameters:
      type - Name of the event group.
      Returns:
      The list of listeners which are registered.
      eXo level API
      Experimental