public class

ModelMBeanInfoSupport

extends MBeanInfo
implements ModelMBeanInfo
java.lang.Object
   ↳ javax.management.MBeanInfo
     ↳ javax.management.modelmbean.ModelMBeanInfoSupport

Class Overview

This class represents the meta data for ModelMBeans. Descriptors have been added on the meta data objects.

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.

Summary

Public Constructors
ModelMBeanInfoSupport(ModelMBeanInfo mbi)
Constructs a ModelMBeanInfoSupport which is a duplicate of the given ModelMBeanInfo.
ModelMBeanInfoSupport(String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications)
Creates a ModelMBeanInfoSupport with the provided information, but the descriptor is a default.
ModelMBeanInfoSupport(String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications, Descriptor mbeandescriptor)
Creates a ModelMBeanInfoSupport with the provided information and the descriptor given in parameter.
Public Methods
Object clone()
Returns a shallow clone of this instance.
ModelMBeanAttributeInfo getAttribute(String inName)
Returns a ModelMBeanAttributeInfo requested by name.
ModelMBeanConstructorInfo getConstructor(String inName)
Returns the ModelMBeanConstructorInfo requested by name.
Descriptor getDescriptor(String inDescriptorName)
Returns a Descriptor requested by name.
Descriptor getDescriptor()
Get the descriptor of this MBeanInfo.
Descriptor getDescriptor(String inDescriptorName, String inDescriptorType)
Returns a Descriptor requested by name and descriptorType.
Descriptor[] getDescriptors(String inDescriptorType)
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(String inName)
Returns a ModelMBeanNotificationInfo requested by name.
ModelMBeanOperationInfo getOperation(String inName)
Returns a ModelMBeanOperationInfo requested by name.
void setDescriptor(Descriptor inDescriptor, String inDescriptorType)
Sets descriptors in the info array of type inDescriptorType for the ModelMBean.
void setDescriptors(Descriptor[] inDescriptors)
Adds or replaces descriptors in the ModelMBeanInfo.
void setMBeanDescriptor(Descriptor inMBeanDescriptor)
Sets the ModelMBean's descriptor.
[Expand]
Inherited Methods
From class javax.management.MBeanInfo
From class java.lang.Object
From interface javax.management.DescriptorRead
From interface javax.management.modelmbean.ModelMBeanInfo

Public Constructors

public ModelMBeanInfoSupport (ModelMBeanInfo mbi)

Constructs a ModelMBeanInfoSupport which is a duplicate of the given ModelMBeanInfo. The returned object is a shallow copy of the given object. Neither the Descriptor nor the contained arrays (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.

Parameters
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)

Creates a ModelMBeanInfoSupport with the provided information, but the descriptor is a default. The default descriptor is: name=mbeanName, descriptorType=mbean, displayName=ClassName, persistPolicy=never, log=F, visibility=1

Parameters
className classname of the MBean
description human readable description of the ModelMBean
attributes array of ModelMBeanAttributeInfo objects which have descriptors
constructors array of ModelMBeanConstructorInfo objects which have descriptors
operations array of ModelMBeanOperationInfo objects which have descriptors
notifications array of ModelMBeanNotificationInfo objects which have descriptors

public ModelMBeanInfoSupport (String className, String description, ModelMBeanAttributeInfo[] attributes, ModelMBeanConstructorInfo[] constructors, ModelMBeanOperationInfo[] operations, ModelMBeanNotificationInfo[] notifications, Descriptor mbeandescriptor)

Creates a ModelMBeanInfoSupport with the provided information and the descriptor given in parameter.

Parameters
className classname of the MBean
description human readable description of the ModelMBean
attributes array of ModelMBeanAttributeInfo objects which have descriptors
constructors array of ModelMBeanConstructorInfo objects which have descriptor
operations array of ModelMBeanOperationInfo objects which have descriptor
notifications array of ModelMBeanNotificationInfo objects which have descriptor
mbeandescriptor 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 these fields, they will be added with these default values.
Throws
RuntimeOperationsException Wraps an IllegalArgumentException for invalid descriptor passed in parameter. (see getMBeanDescriptor for the definition of a valid MBean descriptor.)

Public Methods

public Object clone ()

Returns a shallow clone of this instance. Neither the Descriptor nor the contained arrays (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.

Returns
  • a shallow clone of this instance.

public ModelMBeanAttributeInfo getAttribute (String inName)

Returns a ModelMBeanAttributeInfo requested by name.

Parameters
inName The name of the ModelMBeanAttributeInfo to get. If no ModelMBeanAttributeInfo exists for this name null is returned.
Returns
  • the attribute info for the named attribute, or null if there is none.
Throws
MBeanException
RuntimeOperationsException

public ModelMBeanConstructorInfo getConstructor (String inName)

Returns the ModelMBeanConstructorInfo requested by name. If no ModelMBeanConstructorInfo exists for this name null is returned.

Parameters
inName the name of the constructor.
Returns
  • the constructor info for the named constructor, or null if there is none.
Throws
MBeanException Wraps a distributed communication Exception.
RuntimeOperationsException Wraps an IllegalArgumentException for a null constructor name.

public Descriptor getDescriptor (String inDescriptorName)

Returns a Descriptor requested by name.

Parameters
inDescriptorName The name of the descriptor.
Returns
  • Descriptor containing a descriptor for the ModelMBean with the same name. If no descriptor is found, null is returned.
Throws
MBeanException Wraps a distributed communication Exception.
RuntimeOperationsException Wraps an IllegalArgumentException for null name.
See Also

public Descriptor getDescriptor ()

Get the descriptor of this MBeanInfo. Changing the returned value will have no affect on the original descriptor.

Returns
  • a descriptor that is either immutable or a copy of the original.

public Descriptor getDescriptor (String inDescriptorName, String inDescriptorType)

Returns a Descriptor requested by name and descriptorType.

Parameters
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.
Returns
  • Descriptor containing the descriptor for the ModelMBean with the same name and descriptorType. If no descriptor is found, null is returned.
Throws
MBeanException
RuntimeOperationsException

public Descriptor[] getDescriptors (String inDescriptorType)

Returns a Descriptor array consisting of all Descriptors for the ModelMBeanInfo of type inDescriptorType.

Parameters
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.
Returns
  • Descriptor array containing all descriptors for the ModelMBean if type inDescriptorType.
Throws
MBeanException
RuntimeOperationsException

public Descriptor getMBeanDescriptor ()

Returns 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: 

 name           : MBean name
 descriptorType : must be "mbean"
 displayName    : name of attribute to be used in displays
 persistPolicy  : OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never
 persistLocation : The fully qualified directory name where the MBean should be persisted (if appropriate)
 persistFile    : File name into which the MBean should be persisted
 persistPeriod  : seconds - frequency of persist cycle for OnTime and NoMoreOftenThan PersistPolicy
 currencyTimeLimit : how long value is valid, <0 never, =0 always, >0 seconds
 log            : where t: log all notifications f: log no notifications
 logfile        : fully qualified filename to log events to
 visibility     : 1-4 where 1: always visible 4: rarely visible
 export         : name to be used to export/expose this MBean so that it is findable by
                  other JMX Agents.
 presentationString : 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",export="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.

Returns
  • the MBean descriptor.
Throws
MBeanException

public ModelMBeanNotificationInfo getNotification (String inName)

Returns a ModelMBeanNotificationInfo requested by name.

Parameters
inName The name of the ModelMBeanNotificationInfo to get. If no ModelMBeanNotificationInfo exists for this name null is returned.
Returns
  • the info for the named notification, or null if there is none.
Throws
MBeanException
RuntimeOperationsException

public ModelMBeanOperationInfo getOperation (String inName)

Returns a ModelMBeanOperationInfo requested by name.

Parameters
inName The name of the ModelMBeanOperationInfo to get. If no ModelMBeanOperationInfo exists for this name null is returned.
Returns
  • the operation info for the named operation, or null if there is none.
Throws
MBeanException
RuntimeOperationsException

public void setDescriptor (Descriptor inDescriptor, String inDescriptorType)

Sets descriptors in the info array of type inDescriptorType for the ModelMBean. The setDescriptor method of the corresponding ModelMBean*Info will be called to set the specified descriptor.

Parameters
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".
Throws
MBeanException
RuntimeOperationsException

public void setDescriptors (Descriptor[] inDescriptors)

Adds or replaces descriptors in the ModelMBeanInfo.

Parameters
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.
Throws
MBeanException
RuntimeOperationsException

public void setMBeanDescriptor (Descriptor inMBeanDescriptor)

Sets the ModelMBean's descriptor. This descriptor contains default, MBean wide metadata about the MBean and default policies for persistence and caching. This operation does a complete replacement of the descriptor, no merging is done. If the descriptor to set to is null then the default descriptor will be created. The default descriptor is: name=className,descriptorType="mbean", displayName=className, persistPolicy="never",log="F",export="F",visibility="1" If the descriptor does not contain all these fields, they will be added with these default values. See getMBeanDescriptor method javadoc for description of valid field names.

Parameters
inMBeanDescriptor the descriptor to set.
Throws
MBeanException
RuntimeOperationsException