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 which should be 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 corresponding with JCR events.

public interface EventManager<S,D>

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

Method Summary

void	addEventListener(org.exoplatform.services.listener.Listener<S,D> listener) This will be used to register a listener to the event system.
void	addEventListener(String eventName, org.exoplatform.services.listener.Listener<S,D> listener) This will be used to register a listener to the event system.
void	broadcastEvent(org.exoplatform.services.listener.Event<S,D> event) When an action triggered such as file created/updated then it will be broadcast to the dedicated listener to dispatch the event.
List<org.exoplatform.services.listener.Listener<S,D>>	getEventListeners(String type) Return a list of Listener which registered to the event system based on its object type.
void	removeEventListener(org.exoplatform.services.listener.Listener<S,D> listener) This will be used to unregister a listener out of the event system.
void	removeEventListener(String eventName, org.exoplatform.services.listener.Listener<S,D> listener) This will be used to unregister a listener out of the event system.

Method Detail

addEventListener

void addEventListener(org.exoplatform.services.listener.Listener<S,D> listener)

This will be used to register a listener to the event system.

Parameters:

listener - An instance of Listener object.

addEventListener

void addEventListener(String eventName,
                      org.exoplatform.services.listener.Listener<S,D> listener)

This will be used to register a listener to the event system.

Parameters:

listener - An instance of Listener object.

eventName - Name of event which will be used to group listeners.

removeEventListener

void removeEventListener(org.exoplatform.services.listener.Listener<S,D> listener)

This will be used to unregister a listener out of the event system.

Parameters:

listener - An instance of Listener object.

removeEventListener

void removeEventListener(String eventName,
                         org.exoplatform.services.listener.Listener<S,D> listener)

This will be used to unregister a listener out of the event system.

Parameters:

listener - An instance of Listener object.

eventName - The event name which used to group listeners.

broadcastEvent

void broadcastEvent(org.exoplatform.services.listener.Event<S,D> event)

When an action triggered such as file created/updated then it will be broadcast to the dedicated listener to dispatch the event.

Parameters:

event - The Event object which keep the information to be processed in the listeners.

getEventListeners

List<org.exoplatform.services.listener.Listener<S,D>> getEventListeners(String type)

Return a list of Listener which registered to the event system based on its object type. For example: If we want to get a list of listeners which registered to listen all the event on an instance of File object then the type should be gotten from its method is getObjectType().

Parameters:

type - Type of Object

Returns:

List of listeners which registered