public interface ModelMBean extends DynamicMBean, PersistentMBean, ModelMBeanNotificationBroadcaster
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.
| Modifier and Type | Method and Description |
|---|---|
void |
setManagedResource(Object mr,
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.
|
getAttribute, getAttributes, getMBeanInfo, invoke, setAttribute, setAttributesload, storeaddAttributeChangeNotificationListener, removeAttributeChangeNotificationListener, sendAttributeChangeNotification, sendAttributeChangeNotification, sendNotification, sendNotificationaddNotificationListener, getNotificationInfo, removeNotificationListenervoid setModelMBeanInfo(ModelMBeanInfo inModelMBeanInfo) throws MBeanException, RuntimeOperationsException
If the ModelMBean is currently registered, this method throws
a RuntimeOperationsException wrapping an
IllegalStateException
inModelMBeanInfo - The ModelMBeanInfo object to be used
by the ModelMBean.MBeanException - Wraps a distributed communication
Exception.RuntimeOperationsException - IllegalArgumentException if
the MBeanInfo passed in parameter is null.IllegalStateException if the ModelMBean
is currently registered in the MBeanServer.void setManagedResource(Object mr, String mr_type) throws MBeanException, RuntimeOperationsException, InstanceNotFoundException, InvalidTargetObjectTypeException
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.MBeanException - The initializer of the object has thrown an exception.RuntimeOperationsException - Wraps an IllegalArgumentException:
The managed resource type passed in parameter is null.InstanceNotFoundException - The managed resource object could not be foundInvalidTargetObjectTypeException - The managed resource type cannot be processed by the
ModelMBean or JMX Agent. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138