Package org.opencms.main
Class CmsEventManager
- java.lang.Object
-
- org.opencms.main.CmsEventManager
-
public class CmsEventManager extends java.lang.Object
Manager that controls the OpenCms event system. There is only one instance of this event manager class used by the OpenCms runtime. This instance can be obtained by callingOpenCms.getEventManager()
.Events can be used in OpenCms to notify custom event listeners that certain system events have happened. Event listeners have to implement the interface
I_CmsEventListener
.- Since:
- 7.0.0
- See Also:
CmsEvent
,I_CmsEventListener
-
-
Field Summary
Fields Modifier and Type Field Description protected static I_CmsEventListener[]
EVENT_LIST
Required as template for event list generation.
-
Constructor Summary
Constructors Constructor Description CmsEventManager()
Create a new instance of an OpenCms event manager.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addCmsEventListener(I_CmsEventListener listener)
Add an OpenCms event listener that listens to all events.void
addCmsEventListener(I_CmsEventListener listener, int[] eventTypes)
Add an OpenCms event listener.void
fireEvent(int type)
Notify all event listeners that a particular event has occurred without any additional event data.void
fireEvent(int type, java.util.Map<java.lang.String,java.lang.Object> data)
Notify all event listeners that a particular event has occurred.void
fireEvent(CmsEvent event)
Notify all event listeners that a particular event has occurred.protected void
fireEventHandler(java.util.List<I_CmsEventListener> listeners, CmsEvent event)
Fires the specified event to a list of event listeners.protected java.util.Map<java.lang.Integer,java.util.List<I_CmsEventListener>>
getEventListeners()
Returns the map of all configured event listeners.protected void
initialize(CmsEventManager base)
Initialize this event manager with all events from the given base event manager.void
removeCmsEventListener(I_CmsEventListener listener)
Removes a cms event listener.
-
-
-
Field Detail
-
EVENT_LIST
protected static final I_CmsEventListener[] EVENT_LIST
Required as template for event list generation.
-
-
Constructor Detail
-
CmsEventManager
public CmsEventManager()
Create a new instance of an OpenCms event manager.
-
-
Method Detail
-
addCmsEventListener
public void addCmsEventListener(I_CmsEventListener listener)
Add an OpenCms event listener that listens to all events.- Parameters:
listener
- the listener to add
-
addCmsEventListener
public void addCmsEventListener(I_CmsEventListener listener, int[] eventTypes)
Add an OpenCms event listener.- Parameters:
listener
- the listener to addeventTypes
- the events to listen for
-
fireEvent
public void fireEvent(CmsEvent event)
Notify all event listeners that a particular event has occurred.- Parameters:
event
- the event that is forwarded to all listeners
-
fireEvent
public void fireEvent(int type)
Notify all event listeners that a particular event has occurred without any additional event data.- Parameters:
type
- event type
-
fireEvent
public void fireEvent(int type, java.util.Map<java.lang.String,java.lang.Object> data)
Notify all event listeners that a particular event has occurred.- Parameters:
type
- event typedata
- event data
-
removeCmsEventListener
public void removeCmsEventListener(I_CmsEventListener listener)
Removes a cms event listener.- Parameters:
listener
- the listener to remove
-
fireEventHandler
protected void fireEventHandler(java.util.List<I_CmsEventListener> listeners, CmsEvent event)
Fires the specified event to a list of event listeners.- Parameters:
listeners
- the listeners to fireevent
- the event to fire
-
getEventListeners
protected java.util.Map<java.lang.Integer,java.util.List<I_CmsEventListener>> getEventListeners()
Returns the map of all configured event listeners.- Returns:
- the map of all configured event listeners
-
initialize
protected void initialize(CmsEventManager base)
Initialize this event manager with all events from the given base event manager.- Parameters:
base
- the base event manager to initialize this event manager with
-
-