org.exoplatform.commons.api.event

Interface EventManager<S,D>

Type Parameters:

S - This is a generic object of source. It can be a file/folder/content or something else extended from BaseObject.

D - This is a generic object of data. It can be an event type, such as NODE_ADDED/PROPERTY_CHANGED/NODE_REMOVED which is corresponding to the JCR events.

public interface EventManager<S,D>

Is the central point of the event system where listeners are registered (and/or unregistered) and events are fired.

Level API:

Experimental

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventListener(Listener<S,D> listener) Registers a listener into the event system.
void	addEventListener(String eventName, Listener<S,D> listener) Registers a listener for a given event group in 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<Listener<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(Listener<S,D> listener) Unregisters a listener out of the event system.
void	removeEventListener(String eventName, Listener<S,D> listener) Unregisters a listener out of a given event group in the event system.

Method Detail

addEventListener

void addEventListener(Listener<S,D> listener)

Registers a listener into the event system.

Parameters:

listener - An instance of Listener object.

Level API:

Experimental

addEventListener

void addEventListener(String eventName,
                    Listener<S,D> listener)

Registers a listener for a given event group in the event system.

Parameters:

listener - An instance of Listener object.

eventName - Name of the event group.

Level API:

Experimental

removeEventListener

void removeEventListener(Listener<S,D> listener)

Unregisters a listener out of the event system.

Parameters:

listener - An instance of Listener object.

Level API:

Experimental

removeEventListener

void removeEventListener(String eventName,
                       Listener<S,D> listener)

Unregisters a listener out of a given event group in the event system.

Parameters:

listener - An instance of Listener object.

eventName - Name of the event group.

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.

Level API:

Experimental

getEventListeners

List<Listener<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.

Level API:

Experimental