org.jboss.mx.util
Class JBossNotificationBroadcasterSupport

java.lang.Object
  org.jboss.mx.util.JBossNotificationBroadcasterSupport

All Implemented Interfaces:

javax.management.NotificationBroadcaster, javax.management.NotificationEmitter

Direct Known Subclasses:

AsynchNotificationBroadcasterSupport

public class JBossNotificationBroadcasterSupport

extends Object

implements javax.management.NotificationEmitter

A helper class for notification broadcasters/emitters

Version:

$Revision: 1.3 $

Author:

Juha Lindfors., Adrian Brock.

Constructor Summary

JBossNotificationBroadcasterSupport()
Construct the new notification broadcaster support object

Method Summary

void	addNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, Object handback) Add a listener to an MBean.
javax.management.MBeanNotificationInfo[]	getNotificationInfo() Returns the notification metadata associated with the MBean.
void	handleNotification(javax.management.NotificationListener listener, javax.management.Notification notification, Object handback) Handle the notification, the default implementation is to synchronously invoke the listener.
long	nextNotificationSequenceNumber() The nextNotificationSequenceNumber method returns the next sequence number for use in notifications.
void	removeNotificationListener(javax.management.NotificationListener listener) Removes a listener from an MBean.
void	removeNotificationListener(javax.management.NotificationListener listener, javax.management.NotificationFilter filter, Object handback) Removes a listener from the Emitter.
void	sendNotification(javax.management.Notification notification)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JBossNotificationBroadcasterSupport

public JBossNotificationBroadcasterSupport()

Construct the new notification broadcaster support object

Method Detail

addNotificationListener

public void addNotificationListener(javax.management.NotificationListener listener,
                                    javax.management.NotificationFilter filter,
                                    Object handback)

Description copied from interface: javax.management.NotificationBroadcaster

Add a listener to an MBean.

Specified by:

addNotificationListener in interface javax.management.NotificationBroadcaster

Parameters:

listener - implementation of the listener object

filter - implementation of the filter object or null if no filtering is required

handback - A handback object associated with each notification sent by this notification broadcaster.

removeNotificationListener

public void removeNotificationListener(javax.management.NotificationListener listener)
                                throws javax.management.ListenerNotFoundException

Description copied from interface: javax.management.NotificationBroadcaster

Removes a listener from an MBean.

Specified by:

removeNotificationListener in interface javax.management.NotificationBroadcaster

Parameters:

listener - the listener object to remove

Throws:

javax.management.ListenerNotFoundException - if the listener was not found

removeNotificationListener

public void removeNotificationListener(javax.management.NotificationListener listener,
                                       javax.management.NotificationFilter filter,
                                       Object handback)
                                throws javax.management.ListenerNotFoundException

Description copied from interface: javax.management.NotificationEmitter

Removes a listener from the Emitter.

Only the listener, filter, handback triplet is removed

Specified by:

removeNotificationListener in interface javax.management.NotificationEmitter

Parameters:

listener - the listener object to remove

filter - the filter registered with the listener

handback - the handback object associated with the registered listener

Throws:

javax.management.ListenerNotFoundException - if the listener was not found

getNotificationInfo

public javax.management.MBeanNotificationInfo[] getNotificationInfo()

Description copied from interface: javax.management.NotificationBroadcaster

Returns the notification metadata associated with the MBean.

Specified by:

getNotificationInfo in interface javax.management.NotificationBroadcaster

Returns:

MBean's notification metadata

See Also:

MBeanNotificationInfo

sendNotification

public void sendNotification(javax.management.Notification notification)

handleNotification

public void handleNotification(javax.management.NotificationListener listener,
                               javax.management.Notification notification,
                               Object handback)

Handle the notification, the default implementation is to synchronously invoke the listener.

Parameters:

listener - the listener to notify

notification - the notification

handback - the handback object

nextNotificationSequenceNumber

public long nextNotificationSequenceNumber()

The nextNotificationSequenceNumber method returns the next sequence number for use in notifications.

Returns:

a long value