|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hyperic.hq.zevents.ZeventManager
public class ZeventManager
The Zevent subsystem is an event system for fast, non-reliable transmission of events. Important data should not be transmitted on this bus, since it is not persisted, and there is never any guarantee of receipt. This manager provides no transactional guarantees, so the caller must rollback additions of listeners if the transaction fails.
Method Summary | |
---|---|
boolean |
addBufferedGlobalListener(ZeventListener listener)
|
ZeventListener |
addBufferedListener(java.lang.Class eventClass,
ZeventListener listener)
|
ZeventListener |
addBufferedListener(java.util.Set eventClasses,
ZeventListener listener)
Add a buffered listener for event types. |
boolean |
addGlobalListener(ZeventListener listener)
Add an event listener which is called for every event type which comes through the queue. |
boolean |
addListener(java.lang.Class eventClass,
ZeventListener listener)
Add a listener for a specific type of event. |
void |
enqueueEvent(Zevent event)
Enqueues an Zevent for processing |
void |
enqueueEventAfterCommit(Zevent event)
|
void |
enqueueEvents(java.util.List events)
Enqueue events onto the event queue. |
void |
enqueueEventsAfterCommit(java.util.List inEvents)
Enqueue events if the current running transaction successfully commits. |
static ZeventManager |
getInstance()
|
long |
getMaxTimeInQueue()
|
long |
getQueueSize()
|
long |
getZeventsProcessed()
|
boolean |
registerEventClass(java.lang.Class eventClass)
Register an event class. |
boolean |
removeGlobalListener(ZeventListener listener)
Remove a global event listener |
boolean |
removeListener(java.lang.Class eventClass,
ZeventListener listener)
Remove a specific event type listener. |
void |
shutdown()
|
boolean |
unregisterEventClass(java.lang.Class eventClass)
Unregister an event class |
void |
waitUntilNoEvents()
Wait until the queue is empty. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public long getQueueSize()
public void shutdown() throws java.lang.InterruptedException
java.lang.InterruptedException
public long getMaxTimeInQueue()
public long getZeventsProcessed()
public boolean registerEventClass(java.lang.Class eventClass)
eventClass
- a subclass of Zevent
public boolean unregisterEventClass(java.lang.Class eventClass)
eventClass
- subclass of Zevent
public boolean addGlobalListener(ZeventListener listener)
public boolean addBufferedGlobalListener(ZeventListener listener)
public boolean removeGlobalListener(ZeventListener listener)
public ZeventListener addBufferedListener(java.util.Set eventClasses, ZeventListener listener)
eventClasses
- Class
es which subclass Zevent
to
listen forlistener
- Listener to invoke with events
public ZeventListener addBufferedListener(java.lang.Class eventClass, ZeventListener listener)
public boolean addListener(java.lang.Class eventClass, ZeventListener listener)
eventClass
- A subclass of Zevent
public boolean removeListener(java.lang.Class eventClass, ZeventListener listener)
addListener(Class, ZeventListener)
public void enqueueEvents(java.util.List events) throws java.lang.InterruptedException
enqueueEvents
in interface ZeventEnqueuer
events
- List of Zevent
s
java.lang.InterruptedException
- if the queue was full and the thread was
interruptedpublic void enqueueEventAfterCommit(Zevent event)
public void enqueueEventsAfterCommit(java.util.List inEvents)
enqueueEvents(List)
public void enqueueEvent(Zevent event) throws java.lang.InterruptedException
ZeventEnqueuer
Zevent
for processing
enqueueEvent
in interface ZeventEnqueuer
event
- The Zevent
to enqueue
java.lang.InterruptedException
- If interrupted while enqueueing eventpublic void waitUntilNoEvents() throws java.lang.InterruptedException
java.lang.InterruptedException
public static ZeventManager getInstance()
|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |