NotificationBroadcasterModelMBeanRequiredModelMBeanpublic interface ModelMBeanNotificationBroadcaster extends NotificationBroadcaster
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.
| Modifier and Type | Method | Description |
|---|---|---|
void |
addAttributeChangeNotificationListener |
Registers an object which implements the NotificationListener interface as a listener. |
void |
removeAttributeChangeNotificationListener |
Removes a listener for attributeChangeNotifications from the RequiredModelMBean. |
void |
sendAttributeChangeNotification |
Sends an attributeChangeNotification which is passed in to the registered attributeChangeNotification listeners on the ModelMBean. |
void |
sendAttributeChangeNotification |
Sends an attributeChangeNotification which contains the old value and new value for the attribute to the registered AttributeChangeNotification listeners on the ModelMBean. |
void |
sendNotification |
Sends a Notification which contains the text string that is passed in to the registered Notification listeners on the ModelMBean. |
void |
sendNotification |
Sends a Notification which is passed in to the registered Notification listeners on the ModelMBean as a jmx.modelmbean.generic notification. |
addNotificationListener, getNotificationInfo, removeNotificationListener
void sendNotification(Notification ntfyObj) throws MBeanException, RuntimeOperationsException
ntfyObj - The notification which is to be passed to the 'handleNotification' method of the listener object.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException: The Notification object passed in parameter is null.void sendNotification(String ntfyText) throws MBeanException, RuntimeOperationsException
ntfyText - 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 1MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException: The Notification text string passed in parameter is null.void sendAttributeChangeNotification(AttributeChangeNotification notification) throws MBeanException, RuntimeOperationsException
notification - The notification which is to be passed to the 'handleNotification' method of the listener object.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException: The AttributeChangeNotification object passed in parameter is null.void sendAttributeChangeNotification(Attribute oldValue, Attribute newValue) throws MBeanException, RuntimeOperationsException
oldValue - The original value for the AttributenewValue - 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()
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.void addAttributeChangeNotificationListener(NotificationListener listener, String attributeName, Object handback) throws MBeanException, RuntimeOperationsException, IllegalArgumentException
listener - The listener object which will handles notifications emitted by the registered MBean.attributeName - 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 - The context to be sent to the listener with the notification when a notification is emitted.IllegalArgumentException - The listener cannot be null.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException The attribute name passed in parameter does not exist.void removeAttributeChangeNotificationListener(NotificationListener listener, String attributeName) throws MBeanException, RuntimeOperationsException, ListenerNotFoundException
listener - The listener name which was handling notifications emitted by the registered MBean. This method will remove all information related to this listener.attributeName - The attribute for which the listener no longer wants to receive attributeChangeNotifications. If null the listener will be removed for all attributeChangeNotifications.ListenerNotFoundException - The listener is not registered in the MBean or is null.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException If the inAttributeName parameter does not correspond to an attribute name.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.management/javax/management/modelmbean/ModelMBeanNotificationBroadcaster.html