Home » openjdk-7 » javax » management » modelmbean » [javadoc | source]
javax.management.modelmbean
public interface: ModelMBeanNotificationBroadcaster [javadoc | source]

All Implemented Interfaces:
    NotificationBroadcaster

All Known Implementing Classes:
    RequiredModelMBean, ModelMBean

This interface must be implemented by the ModelMBeans. An implementation of this interface must be shipped with every JMX Agent.

Java resources wishing to be manageable instantiate the ModelMBean using the MBeanServer's createMBean method. The resource then sets the ModelMBeanInfo (with Descriptors) for the ModelMBean instance. The attributes and operations exposed via the ModelMBeanInfo for the ModelMBean are accessible from MBeans, connectors/adaptors like other MBeans. Through the ModelMBeanInfo Descriptors, values and methods in the managed application can be defined and mapped to attributes and operations of the ModelMBean. This mapping can be defined during development in an XML formatted file or dynamically and programmatically at runtime.

Every ModelMBean which is instantiated in the MBeanServer becomes manageable: its attributes and operations become remotely accessible through the connectors/adaptors connected to that MBeanServer. A Java object cannot be registered in the MBeanServer unless it is a JMX compliant MBean. By instantiating a ModelMBean, resources are guaranteed that the MBean is valid.

MBeanException and RuntimeOperationsException must be thrown on every public method. This allows for wrapping exceptions from distributed communications (RMI, EJB, etc.). These exceptions do not have to be thrown by the implementation except in the scenarios described in the specification and javadoc.

Method from javax.management.modelmbean.ModelMBeanNotificationBroadcaster Summary:
addAttributeChangeNotificationListener,   removeAttributeChangeNotificationListener,   sendAttributeChangeNotification,   sendAttributeChangeNotification,   sendNotification,   sendNotification
Method from javax.management.modelmbean.ModelMBeanNotificationBroadcaster Detail:
 public  void addAttributeChangeNotificationListener(NotificationListener listener,
    String attributeName,
    Object handback) throws MBeanException, RuntimeOperationsException, IllegalArgumentException
    Registers an object which implements the NotificationListener interface as a listener. This object's 'handleNotification()' method will be invoked when any attributeChangeNotification is issued through or by the ModelMBean. This does not include other Notifications. They must be registered for independently. An AttributeChangeNotification will be generated for this attributeName.
 public  void removeAttributeChangeNotificationListener(NotificationListener listener,
    String attributeName) throws MBeanException, RuntimeOperationsException, ListenerNotFoundException
    Removes a listener for attributeChangeNotifications from the RequiredModelMBean.
 public  void sendAttributeChangeNotification(AttributeChangeNotification notification) throws MBeanException, RuntimeOperationsException
    Sends an attributeChangeNotification which is passed in to the registered attributeChangeNotification listeners on the ModelMBean.
 public  void sendAttributeChangeNotification(Attribute oldValue,
    Attribute newValue) throws MBeanException, RuntimeOperationsException
    Sends an attributeChangeNotification which contains the old value and new value for the attribute to the registered AttributeChangeNotification listeners on the ModelMBean.

 public  void sendNotification(Notification ntfyObj) throws MBeanException, RuntimeOperationsException
    Sends a Notification which is passed in to the registered Notification listeners on the ModelMBean as a jmx.modelmbean.generic notification.
 public  void sendNotification(String ntfyText) throws MBeanException, RuntimeOperationsException
    Sends a Notification which contains the text string that is passed in to the registered Notification listeners on the ModelMBean.