Serializable, Cloneable, DescriptorRead, ModelMBeanInfo
public class ModelMBeanInfoSupport extends MBeanInfo implements ModelMBeanInfo
Java resources wishing to be manageable instantiate the ModelMBean using the MBeanServer's createMBean method. The resource then sets the ModelMBeanInfo and 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 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 a 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.)
The serialVersionUID of this class is -1935722590756516193L.
| Constructor | Description |
|---|---|
ModelMBeanInfoSupport |
Creates a ModelMBeanInfoSupport with the provided information, but the descriptor is a default. |
ModelMBeanInfoSupport |
Creates a ModelMBeanInfoSupport with the provided information and the descriptor given in parameter. |
ModelMBeanInfoSupport |
Constructs a ModelMBeanInfoSupport which is a duplicate of the given ModelMBeanInfo. |
| Modifier and Type | Method | Description |
|---|---|---|
Object |
clone() |
Returns a shallow clone of this instance. |
ModelMBeanAttributeInfo |
getAttribute |
Returns a ModelMBeanAttributeInfo requested by name. |
ModelMBeanConstructorInfo |
getConstructor |
Returns the ModelMBeanConstructorInfo requested by name. |
Descriptor |
getDescriptor() |
Get the descriptor of this MBeanInfo. |
Descriptor |
getDescriptor |
Returns a Descriptor requested by name. |
Descriptor |
getDescriptor |
Returns a Descriptor requested by name and descriptorType. |
Descriptor[] |
getDescriptors |
Returns a Descriptor array consisting of all Descriptors for the ModelMBeanInfo of type inDescriptorType. |
Descriptor |
getMBeanDescriptor() |
Returns the ModelMBean's descriptor which contains MBean wide policies. |
ModelMBeanNotificationInfo |
getNotification |
Returns a ModelMBeanNotificationInfo requested by name. |
ModelMBeanOperationInfo |
getOperation |
Returns a ModelMBeanOperationInfo requested by name. |
void |
setDescriptor |
Sets descriptors in the info array of type inDescriptorType for the ModelMBean. |
void |
setDescriptors |
Adds or replaces descriptors in the ModelMBeanInfo. |
void |
setMBeanDescriptor |
Sets the ModelMBean's descriptor. |
equals, getAttributes, getClassName, getConstructors, getDescription, getNotifications, getOperations
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAttributes, getClassName, getConstructors, getDescription, getNotifications, getOperations
public ModelMBeanInfoSupport(ModelMBeanInfo mbi)
ModelMBeanAttributeInfo[] etc) are cloned. This method is chiefly of interest to modify the Descriptor of the returned instance via setDescriptor without affecting the Descriptor of the original object.mbi - the ModelMBeanInfo instance from which the ModelMBeanInfo being created is initialized.public ModelMBeanInfoSupport(String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications)
className - classname of the MBeandescription - human readable description of the ModelMBeanattributes - array of ModelMBeanAttributeInfo objects which have descriptorsconstructors - array of ModelMBeanConstructorInfo objects which have descriptorsoperations - array of ModelMBeanOperationInfo objects which have descriptorsnotifications - array of ModelMBeanNotificationInfo objects which have descriptorspublic ModelMBeanInfoSupport(String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications, Descriptor mbeandescriptor)
className - classname of the MBeandescription - human readable description of the ModelMBeanattributes - array of ModelMBeanAttributeInfo objects which have descriptorsconstructors - array of ModelMBeanConstructorInfo objects which have descriptoroperations - array of ModelMBeanOperationInfo objects which have descriptornotifications - array of ModelMBeanNotificationInfo objects which have descriptormbeandescriptor - descriptor to be used as the MBeanDescriptor containing MBean wide policy. If the descriptor is null, a default descriptor will be constructed. The default descriptor is: name=className, descriptorType="mbean", displayName=className, persistPolicy="never", log="F", visibility="1". If the descriptor does not contain all of these fields, the missing ones are added with these default values.RuntimeOperationsException - Wraps an IllegalArgumentException for invalid descriptor passed in parameter. (see getMBeanDescriptor for the definition of a valid MBean descriptor.)public Object clone()
ModelMBeanAttributeInfo[] etc) are cloned. This method is chiefly of interest to modify the Descriptor of the clone via setDescriptor without affecting the Descriptor of the original object.clone in interface ModelMBeanInfo
clone in class MBeanInfo
public Descriptor[] getDescriptors(String inDescriptorType) throws MBeanException, RuntimeOperationsException
ModelMBeanInfogetDescriptors in interface ModelMBeanInfo
inDescriptorType - value of descriptorType field that must be set for the descriptor to be returned. Must be "mbean", "attribute", "operation", "constructor" or "notification". If it is null or empty then all types will be returned.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException when the descriptorType in parameter is not one of: "mbean", "attribute", "operation", "constructor", "notification", empty or null.public void setDescriptors(Descriptor[] inDescriptors) throws MBeanException, RuntimeOperationsException
ModelMBeanInfosetDescriptors in interface ModelMBeanInfo
inDescriptors - The descriptors to be set in the ModelMBeanInfo. Null elements of the list will be ignored. All descriptors must have name and descriptorType fields.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException for a null or invalid descriptor.public Descriptor getDescriptor(String inDescriptorName) throws MBeanException, RuntimeOperationsException
inDescriptorName - The name of the descriptor.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException for null name.public Descriptor getDescriptor(String inDescriptorName, String inDescriptorType) throws MBeanException, RuntimeOperationsException
ModelMBeanInfogetDescriptor in interface ModelMBeanInfo
inDescriptorName - The name of the descriptor.inDescriptorType - The type of the descriptor being requested. If this is null or empty then all types are searched. Valid types are 'mbean', 'attribute', 'constructor' 'operation', and 'notification'. This value will be equal to the 'descriptorType' field in the descriptor that is returned.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException for a null descriptor name or null or invalid type. The type must be "mbean","attribute", "constructor", "operation", or "notification".public void setDescriptor(Descriptor inDescriptor, String inDescriptorType) throws MBeanException, RuntimeOperationsException
ModelMBeanInfosetDescriptor in interface ModelMBeanInfo
inDescriptor - The descriptor to be set in the ModelMBean. It must NOT be null. All descriptors must have name and descriptorType fields.inDescriptorType - The type of the descriptor being set. If this is null then the descriptorType field in the descriptor is used. If specified this value must be set in the descriptorType field in the descriptor. Must be "mbean","attribute", "constructor", "operation", or "notification".MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException for illegal or null arguments or if the name field of the descriptor is not found in the corresponding MBeanAttributeInfo or MBeanConstructorInfo or MBeanNotificationInfo or MBeanOperationInfo.public ModelMBeanAttributeInfo getAttribute(String inName) throws MBeanException, RuntimeOperationsException
ModelMBeanInfogetAttribute in interface ModelMBeanInfo
inName - The name of the ModelMBeanAttributeInfo to get. If no ModelMBeanAttributeInfo exists for this name null is returned.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException for a null attribute name.public ModelMBeanOperationInfo getOperation(String inName) throws MBeanException, RuntimeOperationsException
ModelMBeanInfogetOperation in interface ModelMBeanInfo
inName - The name of the ModelMBeanOperationInfo to get. If no ModelMBeanOperationInfo exists for this name null is returned.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException for a null operation name.public ModelMBeanConstructorInfo getConstructor(String inName) throws MBeanException, RuntimeOperationsException
inName - the name of the constructor.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException for a null constructor name.public ModelMBeanNotificationInfo getNotification(String inName) throws MBeanException, RuntimeOperationsException
ModelMBeanInfogetNotification in interface ModelMBeanInfo
inName - The name of the ModelMBeanNotificationInfo to get. If no ModelMBeanNotificationInfo exists for this name null is returned.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException for a null notification name.public Descriptor getDescriptor()
MBeanInfogetDescriptor in interface DescriptorRead
getDescriptor in class MBeanInfo
public Descriptor getMBeanDescriptor() throws MBeanException
ModelMBeanInfoReturns the ModelMBean's descriptor which contains MBean wide policies. This descriptor contains metadata about the MBean and default policies for persistence and caching.
The fields in the descriptor are defined, but not limited to, the following. Note that when the Type in this table is Number, a String that is the decimal representation of a Long can also be used.
| Name | Type | Meaning |
|---|---|---|
| name | String | MBean name. |
| descriptorType | String | Must be "mbean". |
| displayName | String | Name of MBean to be used in displays. |
| persistPolicy | String | One of: OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never. See the section "MBean Descriptor Fields" in the JMX specification document. |
| persistLocation | String | The fully qualified directory name where the MBean should be persisted (if appropriate). |
| persistFile | String | File name into which the MBean should be persisted. |
| persistPeriod | Number | Frequency of persist cycle in seconds, for OnTime and NoMoreOftenThan PersistPolicy |
| currencyTimeLimit | Number | How long cached value is valid: <0 never, =0 always, >0 seconds. |
| log | String | t: log all notifications, f: log no notifications. |
| logfile | String | Fully qualified filename to log events to. |
| visibility | Number | 1-4 where 1: always visible 4: rarely visible. |
| export | String | Name to be used to export/expose this MBean so that it is findable by other JMX Agents. |
| presentationString | String | XML formatted string to allow presentation of data to be associated with the MBean. |
The default descriptor is: name=className,descriptorType="mbean", displayName=className, persistPolicy="never",log="F",visibility="1" If the descriptor does not contain all these fields, they will be added with these default values.
Note: because of inconsistencies in previous versions of this specification, it is recommended not to use negative or zero values for currencyTimeLimit. To indicate that a cached value is never valid, omit the currencyTimeLimit field. To indicate that it is always valid, use a very large number for this field.
getMBeanDescriptor in interface ModelMBeanInfo
MBeanException - Wraps a distributed communication Exception.public void setMBeanDescriptor(Descriptor inMBeanDescriptor) throws MBeanException, RuntimeOperationsException
ModelMBeanInfogetMBeanDescriptor method javadoc for description of valid field names.setMBeanDescriptor in interface ModelMBeanInfo
inMBeanDescriptor - the descriptor to set.MBeanException - Wraps a distributed communication Exception.RuntimeOperationsException - Wraps an IllegalArgumentException for invalid descriptor.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.management/javax/management/modelmbean/ModelMBeanInfoSupport.html