|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
void |
addAttributeChangeNotificationListener(NotificationListener inlistener,
java.lang.String inAttributeName,
java.lang.Object inhandback)
Registers an object which implements the NotificationListener interface as a listener for AttributeChangeNotifications. |
void |
removeAttributeChangeNotificationListener(NotificationListener inlistener,
java.lang.String inAttributeName)
Removes a listener for attributeChangeNotifications from the MBean. |
void |
sendAttributeChangeNotification(Attribute inOldVal,
Attribute inNewVal)
Sends an attributeChangeNotification which contains the old value and new value for the attribute to the registered AttributeChangeNotification listeners on the ModelMBean. |
void |
sendAttributeChangeNotification(AttributeChangeNotification ntfyObj)
Sends an attributeChangeNotification which is passed in to the registered attributeChangeNotification listeners on the ModelMBean. |
void |
sendNotification(Notification ntfyObj)
Sends a Notification which is passed in to the registered Notification listeners on the ModelMBean as a jmx.modelmbean.general notification. |
void |
sendNotification(java.lang.String ntfyText)
Sends a Notification which contains the text string that is passed in to the registered Notification listeners on the ModelMBean. |
Methods inherited from interface javax.management.NotificationBroadcaster |
addNotificationListener, getNotificationInfo, removeNotificationListener |
Method Detail |
public void addAttributeChangeNotificationListener(NotificationListener inlistener, java.lang.String inAttributeName, java.lang.Object inhandback) throws MBeanException, RuntimeOperationsException, java.lang.IllegalArgumentException
inlistener
- The listener object which will handles notifications
emitted by the registered MBean.inAttributeName
- The name of the MBean attribute for which to
receive change notifications. If null, then all attribute
changes will cause an attributeChangeNotification to be issued.inhandback
- The context to be sent to the listener with the
notification when a notification is emitted.MBeanException
- Wrappering exceptions from distributed communicationsRuntimeOPerationsException
- RuntimeOperationsException
to wrapper IllegalArgumentExceptions.java.lang.IllegalArgumentException
- Listener is null or attributeName is null.public void removeAttributeChangeNotificationListener(NotificationListener inlistener, java.lang.String inAttributeName) throws MBeanException, RuntimeOperationsException, ListenerNotFoundException
inlistener
- The listener name which was handling notifications
emitted by the registered MBean. This method will remove
all information related to this listener.inAttributeName
- The attribute for which the listener no longer
wants to receive attributeChangeNotifications.MBeanException
- Wrappering exceptions from distributed communicationsRuntimeOperationsException
- Wrappering exceptions from
distributed communicationsListenerNotFoundException
- The couple (listener,handback) is
not registered in the MBean. The exception message contains
either "listener", "handback" or the object name depending
on which object cannot be found.public void sendNotification(Notification ntfyObj) throws MBeanException, RuntimeOperationsException
ntfyObj
- The notification which is to be passed to the
'handleNotification' method of the listener object.MBeanException
- The initializer of the object has thrown an exception.RuntimeOperationsException
- Wraps an IllegalArgumentException:
The Notification object passed in parameter is null or invalid.public void sendNotification(java.lang.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.general"
source this ModelMBean instance
sequence 1MBeanException
- The initializer of the object has thrown an exception.RuntimeOperationsException
- Wraps an IllegalArgumentException:
The Notification text string passed in parameter is null or invalid.public void sendAttributeChangeNotification(AttributeChangeNotification ntfyObj) throws MBeanException, RuntimeOperationsException
ntfyObj
- The notification which is to be passed to the
'handleNotification' method of the listener object.MBeanException
- The initializer of the object has thrown an exception.RuntimeOperationsException
- Wraps an IllegalArgumentException: The
Notification object passed in parameter is null or invalid.public void sendAttributeChangeNotification(Attribute inOldVal, Attribute inNewVal) throws MBeanException, RuntimeOperationsException
inOldVal
- The origional value for the AttributeinNewVal
- 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
- to wrapper implementation exceptionsRuntimeOperationsException
- to wrapper IllegalArgumentExceptions.
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |