| javax.management.modelmbean.ModelMBeanNotificationBroadcaster
| ModelMBeanNotificationBroadcaster | | public interface ModelMBeanNotificationBroadcaster extends NotificationBroadcaster(Code) | | 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 instatiate 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/adapters 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 wrappering 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.
|
| addAttributeChangeNotificationListener | | public void addAttributeChangeNotificationListener(NotificationListener inlistener, String inAttributeName, Object inhandback) throws MBeanException, RuntimeOperationsException, IllegalArgumentException(Code) | | Registers an object which implements the NotificationListener interface
as a listener for AttributeChangeNotifications. This object's
'handleNotification()' method will be invoked when any
attributeChangeNotification is issued through or by the MBean. This
does not include other Notifications. They must be registered for
independently. An AttributeChangeNotification will be generated for this
attributeName.
Parameters:
inlistener - The listener object which will handles notificationsemitted by the registered MBean.
Parameters:
inAttributeName - The name of the MBean attribute for which toreceive change notifications. If null, then all attributechanges will cause an attributeChangeNotification to be issued.
Parameters:
inhandback - The context to be sent to the listener with thenotification when a notification is emitted.
exception:
MBeanException - Wrappering exceptions from distributed communications
exception:
RuntimeOPerationsException - RuntimeOperationsExceptionto wrapper IllegalArgumentExceptions.
exception:
IllegalArgumentException - Listener is null or attributeName is null. |
| removeAttributeChangeNotificationListener | | public void removeAttributeChangeNotificationListener(NotificationListener inlistener, String inAttributeName) throws MBeanException, RuntimeOperationsException, ListenerNotFoundException(Code) | | Removes a listener for attributeChangeNotifications from the MBean.
Parameters:
inlistener - The listener name which was handling notificationsemitted by the registered MBean. This method will removeall information related to this listener.
Parameters:
inAttributeName - The attribute for which the listener no longerwants to receive attributeChangeNotifications.
exception:
MBeanException - Wrappering exceptions from distributed communications
exception:
RuntimeOperationsException - Wrappering exceptions fromdistributed communications
exception:
ListenerNotFoundException - The couple (listener,handback) isnot registered in the MBean. The exception message containseither "listener", "handback" or the object name dependingon which object cannot be found. |
| sendAttributeChangeNotification | | public void sendAttributeChangeNotification(AttributeChangeNotification ntfyObj) throws MBeanException, RuntimeOperationsException(Code) | | Sends an attributeChangeNotification which is passed in to the
registered attributeChangeNotification listeners on the ModelMBean.
Parameters:
ntfyObj - The notification which is to be passed to the'handleNotification' method of the listener object.
exception:
MBeanException - The initializer of the object has thrown an exception.
exception:
RuntimeOperationsException - Wraps an IllegalArgumentException: TheNotification object passed in parameter is null or invalid. |
| sendAttributeChangeNotification | | public void sendAttributeChangeNotification(Attribute inOldVal, Attribute inNewVal) throws MBeanException, RuntimeOperationsException(Code) | | Sends an attributeChangeNotification which contains the old value and
new value for the attribute to the registered AttributeChangeNotification
listeners on the ModelMBean.
Parameters:
inOldVal - The origional value for the Attribute
Parameters:
inNewVal - The current value for the AttributeThe constructed attributeChangeNotification will be:type "jmx.attribute.change"source this ModelMBean instancesequence 1attributeName oldValue.getName()attributeType oldValue's classattributeOldValue oldValue.getValue()attributeNewValue newValue.getValue()
exception:
MBeanException - to wrapper implementation exceptions
exception:
RuntimeOperationsException - to wrapper IllegalArgumentExceptions.
|
| sendNotification | | public void sendNotification(Notification ntfyObj) throws MBeanException, RuntimeOperationsException(Code) | | Sends a Notification which is passed in to the registered Notification
listeners on the ModelMBean as a jmx.modelmbean.general notification.
Parameters:
ntfyObj - The notification which is to be passed to the'handleNotification' method of the listener object.
exception:
MBeanException - The initializer of the object has thrown an exception.
exception:
RuntimeOperationsException - Wraps an IllegalArgumentException:The Notification object passed in parameter is null or invalid. |
| sendNotification | | public void sendNotification(String ntfyText) throws MBeanException, RuntimeOperationsException(Code) | | Sends a Notification which contains the text string that is passed in
to the registered Notification listeners on the ModelMBean.
Parameters:
ntfyText - The text which is to be passed in the Notification tothe 'handleNotification' method of the listener object.the constructed Notification will be:type "jmx.modelmbean.general"source this ModelMBean instancesequence 1
exception:
MBeanException - The initializer of the object has thrown an exception.
exception:
RuntimeOperationsException - Wraps an IllegalArgumentException:The Notification text string passed in parameter is null or invalid. |
|
|