JmxEventEmitter (groovy 2.2.0 API)

Overview

Package

Class

Deprecated

Index

Help

Groovy 2.2.0

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

groovy.jmx.builder
[Java] Class JmxEventEmitter

java.lang.Object
  javax.management.NotificationBroadcasterSupport
      groovy.jmx.builder.JmxEventEmitter

All Implemented Interfaces:: JmxEventEmitterMBean

public class JmxEventEmitter
extends NotificationBroadcasterSupport

The JmxEventEmitter is a JMX Broadcaster class that is used to send generic events on the MBeanServer's event bus. It is used by the Emitter node () to send event to registered listeners.

 def jmx = JmxBuilder()
 jmx.emitter(name:"Object name"|ObjectName(), event:"event type")
 ...
 jmx.emitter.send(object)

Authors:: Vladimir Vivien

See Also:: JmxEmitterFactory

Method Summary
`String`	`getEvent()` Event type getter
`String`	`getMessage()` Event message getter
`long`	`send(Object data)` Called to broadcast message on MBeanServer event bus.
`void`	`setEvent(String event)` Event type setter
`void`	`setMessage(String message)` Event message setter.

Methods inherited from class NotificationBroadcasterSupport
getNotificationInfo, sendNotification, addNotificationListener, removeNotificationListener, removeNotificationListener, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll

Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll

Method Detail

getEvent

public String getEvent()

Event type getter

Returns:: - returns event type string thrown by this emitter

getMessage

public String getMessage()

Event message getter

Returns:: - message that is associated with event.

send

public long send(Object data)

Called to broadcast message on MBeanServer event bus. Internally, it calls NotificationBroadCasterSupport.sendNotification() method to dispatch the event.

Parameters:: data - - a data object sent as part of the event parameter.

Returns:: a sequence number associated with the emitted event.

setEvent

public void setEvent(String event)

Event type setter

Parameters:: event - - event type set for this emitter.

setMessage

public void setMessage(String message)

Event message setter.

Parameters:: message - - message that is associated with event emitted.