javax.management

Interface NotificationBroadcaster

All Known Subinterfaces:

NotificationEmitter

All Known Implementing Classes:

MBeanServerDelegate, NotificationBroadcasterSupport

public interface NotificationBroadcaster

Represents a bean that can emit notifications when events occur. Other beans can use this interface to add themselves to the list of recipients of such notifications.

Note: New classes should use NotificationEmitter, a subinterface of this, in preference to using this interface directly.

Since:

1.5

Method Summary

Methods

Modifier and Type	Method and Description
void	addNotificationListener(NotificationListener listener, NotificationFilter filter, Object passback) Registers the specified listener as a new recipient of notifications from this bean.
MBeanNotificationInfo[]	getNotificationInfo() Returns an array describing the notifications this bean may send to its registered listeners.
void	removeNotificationListener(NotificationListener listener) Removes the specified listener from the list of recipients of notifications from this bean.

Method Detail

addNotificationListener

void addNotificationListener(NotificationListener listener,
                           NotificationFilter filter,
                           Object passback)
                             throws IllegalArgumentException

Registers the specified listener as a new recipient of notifications from this bean. If non-null, the filter argument will be used to select which notifications are delivered. The supplied object will also be passed to the recipient with each notification. This should not be modified by the broadcaster, but instead should be passed unmodified to the listener.

Parameters:

listener - the new listener, who will receive notifications from this broadcasting bean.

filter - a filter to determine which notifications are delivered to the listener, or null if no filtering is required.

passback - an object to be passed to the listener with each notification.

Throws:

IllegalArgumentException - if listener is null.

See Also:

removeNotificationListener(NotificationListener)

getNotificationInfo

MBeanNotificationInfo[] getNotificationInfo()

Returns an array describing the notifications this bean may send to its registered listeners. Ideally, this array should be complete, but in some cases, this may not be possible. However, be aware that some listeners may expect this to be so.

Returns:

the array of possible notifications.

removeNotificationListener

void removeNotificationListener(NotificationListener listener)
                                throws ListenerNotFoundException

Removes the specified listener from the list of recipients of notifications from this bean. This includes all combinations of filters and passback objects registered for this listener. For more specific removal of listeners, see the subinterface NotificationEmitter.

Parameters:

listener - the listener to remove.

Throws:

ListenerNotFoundException - if the specified listener is not registered with this bean.

See Also:

addNotificationListener(NotificationListener, NotificationFilter, java.lang.Object)