Save This Page
Home » openjdk-7 » javax » management » [javadoc | source]
javax.management
public class: NotificationBroadcasterSupport [javadoc | source]
java.lang.Object
   javax.management.NotificationBroadcasterSupport

All Implemented Interfaces:
    NotificationEmitter

Direct Known Subclasses:
    CounterMonitor, GaugeMonitor, Monitor, Timer, RelationService, RMIConnectorServer, JMXConnectorServer, StringMonitor

Provides an implementation of NotificationEmitter interface. This can be used as the super class of an MBean that sends notifications.

By default, the notification dispatch model is synchronous. That is, when a thread calls sendNotification, the NotificationListener.handleNotification method of each listener is called within that thread. You can override this default by overriding handleNotification in a subclass, or by passing an Executor to the constructor.

If the method call of a filter or listener throws an Exception , then that exception does not prevent other listeners from being invoked. However, if the method call of a filter or of {@code Executor.execute} or of {@code handleNotification} (when no {@code Excecutor} is specified) throws an Error , then that {@code Error} is propagated to the caller of sendNotification .

Remote listeners added using the JMX Remote API (see JMXConnector) are not usually called synchronously. That is, when sendNotification returns, it is not guaranteed that any remote listeners have yet received the notification.

Constructor:
 public NotificationBroadcasterSupport() 
 public NotificationBroadcasterSupport(Executor executor) 
    Parameters:
    executor - an executor used by the method sendNotification to send each notification. If it is null, the thread calling sendNotification will invoke the handleNotification method itself.
    since: 1.6 -
 public NotificationBroadcasterSupport(MBeanNotificationInfo info) 

    Constructs a NotificationBroadcasterSupport with information about the notifications that may be sent. Each listener is invoked by the thread sending the notification. This constructor is equivalent to MBeanNotificationInfo[] info) info) .

    If the info array is not empty, then it is cloned by the constructor as if by {@code info.clone()}, and each call to #getNotificationInfo() returns a new clone.

    Parameters:
    info - an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type. Can be null, which is equivalent to an empty array.
    since: 1.6 -
 public NotificationBroadcasterSupport(Executor executor,
    MBeanNotificationInfo info) 

    Constructs a NotificationBroadcasterSupport with information about the notifications that may be sent, and where each listener is invoked using the given java.util.concurrent.Executor .

    When sendNotification is called, a listener is selected if it was added with a null NotificationFilter , or if isNotificationEnabled returns true for the notification being sent. The call to NotificationFilter.isNotificationEnabled takes place in the thread that called sendNotification. Then, for each selected listener, executor.execute is called with a command that calls the handleNotification method.

    If the info array is not empty, then it is cloned by the constructor as if by {@code info.clone()}, and each call to #getNotificationInfo() returns a new clone.

    Parameters:
    executor - an executor used by the method sendNotification to send each notification. If it is null, the thread calling sendNotification will invoke the handleNotification method itself.
    info - an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type. Can be null, which is equivalent to an empty array.
    since: 1.6 -
Method from javax.management.NotificationBroadcasterSupport Summary:
addNotificationListener,   getNotificationInfo,   handleNotification,   removeNotificationListener,   removeNotificationListener,   sendNotification
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.management.NotificationBroadcasterSupport Detail:
 public  void addNotificationListener(NotificationListener listener,
    NotificationFilter filter,
    Object handback) 
    Adds a listener.
 public MBeanNotificationInfo[] getNotificationInfo() 
 protected  void handleNotification(NotificationListener listener,
    Notification notif,
    Object handback) 

    This method is called by sendNotification for each listener in order to send the notification to that listener. It can be overridden in subclasses to change the behavior of notification delivery, for instance to deliver the notification in a separate thread.

    The default implementation of this method is equivalent to

    listener.handleNotification(notif, handback);
    
 public  void removeNotificationListener(NotificationListener listener) throws ListenerNotFoundException 
 public  void removeNotificationListener(NotificationListener listener,
    NotificationFilter filter,
    Object handback) throws ListenerNotFoundException 
 public  void sendNotification(Notification notification) 
    Sends a notification. If an {@code Executor} was specified in the constructor, it will be given one task per selected listener to deliver the notification to that listener.