---

javax.management.modelmbean
Interface ModelMBean

All Known Implementing Classes:

RequiredModelMBean

---

public interface ModelMBean

extends DynamicMBean, PersistentMBean, 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 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 RuntimeOperatiosException 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 teh implementation except in the scenarios described in the specification and javadoc.

Version:

1.3

Author:

Max Parlione

---

Method Summary
void	setManagedResource(java.lang.Object mr, 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(ModelMBeanInfo inModelMBeanInfo)     Initializes a ModelMBean object using ModelMBeanInfo passed in.

 

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, getMBeanInfo, invoke, setAttribute, setAttributes

 

Methods inherited from interface javax.management.PersistentMBean

load, store

 

Methods inherited from interface javax.management.modelmbean.ModelMBeanNotificationBroadcaster

addAttributeChangeNotificationListener, removeAttributeChangeNotificationListener, sendAttributeChangeNotification, sendAttributeChangeNotification, sendNotification, sendNotification

 

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

 

Method Detail

setModelMBeanInfo

public void setModelMBeanInfo(ModelMBeanInfo inModelMBeanInfo)
                       throws MBeanException,
                              RuntimeOperationsException

Initializes a ModelMBean object using ModelMBeanInfo passed in. The ModelMBean must be instantiated, but not registered with the MBeanServer. After the ModelMBean's ModelMBeanInfo (with Descriptors) are customized,the ModelMBean should be registered with the MBeanServer.

 

Parameters:

inModelMBeanInfo - The ModelMBeanInfo object to be used by the ModelMBean.

 

Throws:

MBeanException - The constructor of the MBeanInfo has return null or thrown an exception.

RuntimeOperationsException - Wraps an IllegalArgumentException: The MBeanInfo passed in parameter is null or invalid.

---

setManagedResource

public void setManagedResource(java.lang.Object mr,
                               java.lang.String mr_type)
                        throws MBeanException,
                               RuntimeOperationsException,
                               InstanceNotFoundException,
                               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 - The initializer of the object has thrown an exception.

RuntimeOperationsException - Wraps an IllegalArgumentException: The managed resource or managed resoure type passed in parameter is null or invalid.

InstanceNotFoundException - The managed resource object could not be found

InvalidTargetObjectType - The managed resource type cannot be processed by the ModelMBean or JMX Agent.

---

---