javax.management.modelmbean
Interface ModelMBean
- All Superinterfaces:
- DynamicMBean, ModelMBeanNotificationBroadcaster, NotificationBroadcaster, PersistentMBean
- All Known Implementing Classes:
- RequiredModelMBean
- public interface ModelMBean
- extends DynamicMBean, PersistentMBean, ModelMBeanNotificationBroadcaster
ModelMBean interface is used to expose its management data,
operations and notifications for use by the management system.
This interface provides a management template for managed resources.
The adaptors will interact with the ModelMBean through the JMX agent(server).
It will find the managed resource provided attributes and operations through
the MBeanInfo object. It find the behavior details about the supported
attribute, operations and notifications through this ModelMBean interface.
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 the implementation
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. |
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 resourcemr_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 foundInvalidTargetObjectTypeException
- The managed resource type
cannot be processed by the ModelMBean or JMX Agent.
Copyright ©2003 XMOJO.org. All Rights Reserved.