Top Description Methods
javax.management.modelmbean

public Interface ModelMBeanNotificationBroadcaster

extends NotificationBroadcaster
Known Direct Subinterfaces
javax.management.modelmbean.ModelMBean
Imports
javax.management.Attribute, .AttributeChangeNotification, .ListenerNotFoundException, .MBeanException, .Notification, .NotificationBroadcaster, .NotificationListener, .RuntimeOperationsException
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.

Since
1.5

Method Summary

Modifier and TypeMethod and Description
public void
addAttributeChangeNotificationListener(NotificationListener
The listener object which will handles notifications emitted by the registered MBean.
listener, String
The name of the ModelMBean attribute for which to receive change notifications. If null, then all attribute changes will cause an attributeChangeNotification to be issued.
attributeName, Object
The context to be sent to the listener with the notification when a notification is emitted.
handback)

Registers an object which implements the NotificationListener interface as a listener.

public void
removeAttributeChangeNotificationListener(NotificationListener
The listener name which was handling notifications emitted by the registered MBean. This method will remove all information related to this listener.
listener, String
The attribute for which the listener no longer wants to receive attributeChangeNotifications. If null the listener will be removed for all attributeChangeNotifications.
attributeName)

Removes a listener for attributeChangeNotifications from the RequiredModelMBean.

public void
sendAttributeChangeNotification(AttributeChangeNotification
The notification which is to be passed to the 'handleNotification' method of the listener object.
notification)

Sends an attributeChangeNotification which is passed in to the registered attributeChangeNotification listeners on the ModelMBean.

public void
sendAttributeChangeNotification(Attribute
The original value for the Attribute
oldValue, Attribute
The current value for the Attribute 
The constructed attributeChangeNotification will be:
  type        "jmx.attribute.change"
  source      this ModelMBean instance
  sequence    1
  attributeName oldValue.getName()
  attributeType oldValue's class
  attributeOldValue oldValue.getValue()
  attributeNewValue newValue.getValue()
newValue)

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
The notification which is to be passed to the 'handleNotification' method of the listener object.
ntfyObj)

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
The text which is to be passed in the Notification to the 'handleNotification' method of the listener object. the constructed Notification will be: type "jmx.modelmbean.generic" source this ModelMBean instance sequence 1
ntfyText)

Sends a Notification which contains the text string that is passed in to the registered Notification listeners on the ModelMBean.

Inherited from javax.management.NotificationBroadcaster:
addNotificationListenergetNotificationInforemoveNotificationListener

Method Detail

addAttributeChangeNotificationListenerback to summary
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.

Parameters
listener:NotificationListener

The listener object which will handles notifications emitted by the registered MBean.

attributeName:String

The name of the ModelMBean attribute for which to receive change notifications. If null, then all attribute changes will cause an attributeChangeNotification to be issued.

handback:Object

The context to be sent to the listener with the notification when a notification is emitted.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException The attribute name passed in parameter does not exist.
IllegalArgumentException:
The listener cannot be null.
See Also
removeAttributeChangeNotificationListener
removeAttributeChangeNotificationListenerback to summary
public void removeAttributeChangeNotificationListener(NotificationListener listener, String attributeName) throws MBeanException, RuntimeOperationsException, ListenerNotFoundException

Removes a listener for attributeChangeNotifications from the RequiredModelMBean.

Parameters
listener:NotificationListener

The listener name which was handling notifications emitted by the registered MBean. This method will remove all information related to this listener.

attributeName:String

The attribute for which the listener no longer wants to receive attributeChangeNotifications. If null the listener will be removed for all attributeChangeNotifications.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException If the inAttributeName parameter does not correspond to an attribute name.
ListenerNotFoundException:
The listener is not registered in the MBean or is null.
See Also
addAttributeChangeNotificationListener
sendAttributeChangeNotificationback to summary
public void sendAttributeChangeNotification(AttributeChangeNotification notification) throws MBeanException, RuntimeOperationsException

Sends an attributeChangeNotification which is passed in to the registered attributeChangeNotification listeners on the ModelMBean.

Parameters
notification:AttributeChangeNotification

The notification which is to be passed to the 'handleNotification' method of the listener object.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException: The AttributeChangeNotification object passed in parameter is null.
sendAttributeChangeNotificationback to summary
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.

Parameters
oldValue:Attribute

The original value for the Attribute

newValue:Attribute

The current value for the Attribute 

The constructed attributeChangeNotification will be:
  type        "jmx.attribute.change"
  source      this ModelMBean instance
  sequence    1
  attributeName oldValue.getName()
  attributeType oldValue's class
  attributeOldValue oldValue.getValue()
  attributeNewValue newValue.getValue()
Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException: An Attribute object passed in parameter is null or the names of the two Attribute objects in parameter are not the same.
sendNotificationback to summary
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.

Parameters
ntfyObj:Notification

The notification which is to be passed to the 'handleNotification' method of the listener object.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException: The Notification object passed in parameter is null.
sendNotificationback to summary
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.

Parameters
ntfyText:String

The text which is to be passed in the Notification to the 'handleNotification' method of the listener object. the constructed Notification will be: type "jmx.modelmbean.generic" source this ModelMBean instance sequence 1

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException: The Notification text string passed in parameter is null.