javax.management.modelmbean
Interface ModelMBean

All Superinterfaces:
DynamicMBean sample code for javax.management.DynamicMBean definition code for javax.management.DynamicMBean , ModelMBeanNotificationBroadcaster sample code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster definition code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster , NotificationBroadcaster sample code for javax.management.NotificationBroadcaster definition code for javax.management.NotificationBroadcaster , PersistentMBean sample code for javax.management.PersistentMBean definition code for javax.management.PersistentMBean
All Known Implementing Classes:
RequiredModelMBean sample code for javax.management.modelmbean.RequiredModelMBean definition code for javax.management.modelmbean.RequiredModelMBean

public interface ModelMBean
extends DynamicMBean sample code for javax.management.DynamicMBean definition code for javax.management.DynamicMBean , PersistentMBean sample code for javax.management.PersistentMBean definition code for javax.management.PersistentMBean , ModelMBeanNotificationBroadcaster sample code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster definition code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster

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
 void setManagedResource sample code for javax.management.modelmbean.ModelMBean.setManagedResource(java.lang.Object, java.lang.String) definition code for javax.management.modelmbean.ModelMBean.setManagedResource(java.lang.Object, java.lang.String) (Object sample code for java.lang.Object definition code for java.lang.Object  mr, String sample code for java.lang.String definition code for java.lang.String  mr_type)
          Sets the instance handle of the object against which to execute all methods in this ModelMBean management interface (MBeanInfo and Descriptors).
 void setModelMBeanInfo sample code for javax.management.modelmbean.ModelMBean.setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo) definition code for javax.management.modelmbean.ModelMBean.setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo) (ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo  inModelMBeanInfo)
          Initializes a ModelMBean object using ModelMBeanInfo passed in.
 
Methods inherited from interface javax.management.DynamicMBean sample code for javax.management.DynamicMBean definition code for javax.management.DynamicMBean
getAttribute sample code for javax.management.DynamicMBean.getAttribute(java.lang.String) definition code for javax.management.DynamicMBean.getAttribute(java.lang.String) , getAttributes sample code for javax.management.DynamicMBean.getAttributes(java.lang.String[]) definition code for javax.management.DynamicMBean.getAttributes(java.lang.String[]) , getMBeanInfo sample code for javax.management.DynamicMBean.getMBeanInfo() definition code for javax.management.DynamicMBean.getMBeanInfo() , invoke sample code for javax.management.DynamicMBean.invoke(java.lang.String, java.lang.Object[], java.lang.String[]) definition code for javax.management.DynamicMBean.invoke(java.lang.String, java.lang.Object[], java.lang.String[]) , setAttribute sample code for javax.management.DynamicMBean.setAttribute(javax.management.Attribute) definition code for javax.management.DynamicMBean.setAttribute(javax.management.Attribute) , setAttributes sample code for javax.management.DynamicMBean.setAttributes(javax.management.AttributeList) definition code for javax.management.DynamicMBean.setAttributes(javax.management.AttributeList)
 
Methods inherited from interface javax.management.PersistentMBean sample code for javax.management.PersistentMBean definition code for javax.management.PersistentMBean
load sample code for javax.management.PersistentMBean.load() definition code for javax.management.PersistentMBean.load() , store sample code for javax.management.PersistentMBean.store() definition code for javax.management.PersistentMBean.store()
 
Methods inherited from interface javax.management.modelmbean.ModelMBeanNotificationBroadcaster sample code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster definition code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster
addAttributeChangeNotificationListener sample code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.addAttributeChangeNotificationListener(javax.management.NotificationListener, java.lang.String, java.lang.Object) definition code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.addAttributeChangeNotificationListener(javax.management.NotificationListener, java.lang.String, java.lang.Object) , removeAttributeChangeNotificationListener sample code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.removeAttributeChangeNotificationListener(javax.management.NotificationListener, java.lang.String) definition code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.removeAttributeChangeNotificationListener(javax.management.NotificationListener, java.lang.String) , sendAttributeChangeNotification sample code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.sendAttributeChangeNotification(javax.management.Attribute, javax.management.Attribute) definition code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.sendAttributeChangeNotification(javax.management.Attribute, javax.management.Attribute) , sendAttributeChangeNotification sample code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.sendAttributeChangeNotification(javax.management.AttributeChangeNotification) definition code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.sendAttributeChangeNotification(javax.management.AttributeChangeNotification) , sendNotification sample code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.sendNotification(javax.management.Notification) definition code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.sendNotification(javax.management.Notification) , sendNotification sample code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.sendNotification(java.lang.String) definition code for javax.management.modelmbean.ModelMBeanNotificationBroadcaster.sendNotification(java.lang.String)
 
Methods inherited from interface javax.management.NotificationBroadcaster sample code for javax.management.NotificationBroadcaster definition code for javax.management.NotificationBroadcaster
addNotificationListener sample code for javax.management.NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object) definition code for javax.management.NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object) , getNotificationInfo sample code for javax.management.NotificationBroadcaster.getNotificationInfo() definition code for javax.management.NotificationBroadcaster.getNotificationInfo() , removeNotificationListener sample code for javax.management.NotificationBroadcaster.removeNotificationListener(javax.management.NotificationListener) definition code for javax.management.NotificationBroadcaster.removeNotificationListener(javax.management.NotificationListener)
 

Method Detail

setModelMBeanInfo sample code for javax.management.modelmbean.ModelMBean.setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo) definition code for javax.management.modelmbean.ModelMBean.setModelMBeanInfo(javax.management.modelmbean.ModelMBeanInfo)

void setModelMBeanInfo(ModelMBeanInfo sample code for javax.management.modelmbean.ModelMBeanInfo definition code for javax.management.modelmbean.ModelMBeanInfo  inModelMBeanInfo)
                       throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                              RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException 
Initializes a ModelMBean object using ModelMBeanInfo passed in. This method makes it possible to set a customized ModelMBeanInfo on the ModelMBean as long as it is not registered with the MBeanServer.
Once the ModelMBean's ModelMBeanInfo (with Descriptors) are customized and set on the ModelMBean, the ModelMBean can be registered with the MBeanServer.

If the ModelMBean is currently registered, this method throws a RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException wrapping an IllegalStateException sample code for java.lang.IllegalStateException definition code for java.lang.IllegalStateException

Parameters:
inModelMBeanInfo - The ModelMBeanInfo object to be used by the ModelMBean.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - Wraps a distributed communication Exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException -

setManagedResource sample code for javax.management.modelmbean.ModelMBean.setManagedResource(java.lang.Object, java.lang.String) definition code for javax.management.modelmbean.ModelMBean.setManagedResource(java.lang.Object, java.lang.String)

void setManagedResource(Object sample code for java.lang.Object definition code for java.lang.Object  mr,
                        String sample code for java.lang.String definition code for java.lang.String  mr_type)
                        throws MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException ,
                               RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException ,
                               InstanceNotFoundException sample code for javax.management.InstanceNotFoundException definition code for javax.management.InstanceNotFoundException ,
                               InvalidTargetObjectTypeException sample code for javax.management.modelmbean.InvalidTargetObjectTypeException definition code for javax.management.modelmbean.InvalidTargetObjectTypeException 
Sets the instance handle of the object against which to execute all methods in this ModelMBean management interface (MBeanInfo and Descriptors).

Parameters:
mr - Object that is the managed resource
mr_type - The type of reference for the managed resource. Can be: ObjectReference, Handle, IOR, EJBHandle, RMIReference. If the MBeanServer cannot process the mr_type passed in, an InvalidTargetTypeException will be thrown.
Throws:
MBeanException sample code for javax.management.MBeanException definition code for javax.management.MBeanException - The initializer of the object has thrown an exception.
RuntimeOperationsException sample code for javax.management.RuntimeOperationsException definition code for javax.management.RuntimeOperationsException - Wraps an IllegalArgumentException: The managed resource type passed in parameter is null.
InstanceNotFoundException sample code for javax.management.InstanceNotFoundException definition code for javax.management.InstanceNotFoundException - The managed resource object could not be found
InvalidTargetObjectTypeException sample code for javax.management.modelmbean.InvalidTargetObjectTypeException definition code for javax.management.modelmbean.InvalidTargetObjectTypeException - The managed resource type cannot be processed by the ModelMBean or JMX Agent.