javax.management.modelmbean
Class ModelMBeanInfoSupport

java.lang.Object
  javax.management.MBeanInfo
      javax.management.modelmbean.ModelMBeanInfoSupport

All Implemented Interfaces:

Serializable, Cloneable, ModelMBeanInfo

public class ModelMBeanInfoSupport
extends MBeanInfo
implements ModelMBeanInfo, Serializable

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

Since:

1.5

See Also:

Serialized Form

Constructor Summary

ModelMBeanInfoSupport(ModelMBeanInfo mbi)
Constructs a ModelMBeanInfoSupport which is a duplicate of the one passed in.

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.

Method Summary

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(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.

Methods inherited from class javax.management.MBeanInfo

equals, getAttributes, getClassName, getConstructors, getDescription, getNotifications, getOperations, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.management.modelmbean.ModelMBeanInfo

getAttributes, getClassName, getConstructors, getDescription, getNotifications, getOperations

Constructor Detail

ModelMBeanInfoSupport

public ModelMBeanInfoSupport(ModelMBeanInfo mbi)

Constructs a ModelMBeanInfoSupport which is a duplicate of the one passed in.

Parameters:

mbi - the ModelMBeanInfo instance from which the ModelMBeanInfo being created is initialized.

ModelMBeanInfoSupport

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

ModelMBeanInfoSupport

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

Method Detail

clone

public Object clone()

Description copied from class: MBeanInfo

Returns a shallow clone of this instance. The clone is obtained by simply calling super.clone(), thus calling the default native shallow cloning mechanism implemented by Object.clone(). No deeper cloning of any internal field is made.

Since this class is immutable, the clone method is chiefly of interest to subclasses.

Specified by:

clone in interface ModelMBeanInfo

Overrides:

clone in class MBeanInfo

Returns:

a clone of this instance.

See Also:

Cloneable

getDescriptors

public Descriptor[] getDescriptors(String inDescriptorType)
                            throws MBeanException,
                                   RuntimeOperationsException

Description copied from interface: ModelMBeanInfo

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

Specified by:

getDescriptors in interface ModelMBeanInfo

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 - 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.

See Also:

ModelMBeanInfo.setDescriptors(javax.management.Descriptor[])

setDescriptors

public void setDescriptors(Descriptor[] inDescriptors)
                    throws MBeanException,
                           RuntimeOperationsException

Description copied from interface: ModelMBeanInfo

Adds or replaces descriptors in the ModelMBeanInfo.

Specified by:

setDescriptors in interface 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 - Wraps a distributed communication Exception.

RuntimeOperationsException - Wraps an IllegalArgumentException for a null or invalid descriptor.

See Also:

ModelMBeanInfo.getDescriptors(java.lang.String)

getDescriptor

public Descriptor getDescriptor(String inDescriptorName)
                         throws MBeanException,
                                RuntimeOperationsException

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:

setDescriptor(javax.management.Descriptor, java.lang.String)

getDescriptor

public Descriptor getDescriptor(String inDescriptorName,
                                String inDescriptorType)
                         throws MBeanException,
                                RuntimeOperationsException

Description copied from interface: ModelMBeanInfo

Returns a Descriptor requested by name and descriptorType.

Specified by:

getDescriptor in interface ModelMBeanInfo

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 - 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".

See Also:

ModelMBeanInfo.setDescriptor(javax.management.Descriptor, java.lang.String)

setDescriptor

public void setDescriptor(Descriptor inDescriptor,
                          String inDescriptorType)
                   throws MBeanException,
                          RuntimeOperationsException

Description copied from interface: ModelMBeanInfo

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.

Specified by:

setDescriptor in interface ModelMBeanInfo

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 - 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.

See Also:

ModelMBeanInfo.getDescriptor(java.lang.String, java.lang.String)

getAttribute

public ModelMBeanAttributeInfo getAttribute(String inName)
                                     throws MBeanException,
                                            RuntimeOperationsException

Description copied from interface: ModelMBeanInfo

Returns a ModelMBeanAttributeInfo requested by name.

Specified by:

getAttribute in interface ModelMBeanInfo

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 - Wraps a distributed communication Exception.

RuntimeOperationsException - Wraps an IllegalArgumentException for a null attribute name.

getOperation

public ModelMBeanOperationInfo getOperation(String inName)
                                     throws MBeanException,
                                            RuntimeOperationsException

Description copied from interface: ModelMBeanInfo

Returns a ModelMBeanOperationInfo requested by name.

Specified by:

getOperation in interface ModelMBeanInfo

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 - Wraps a distributed communication Exception.

RuntimeOperationsException - Wraps an IllegalArgumentException for a null operation name.

getConstructor

public ModelMBeanConstructorInfo getConstructor(String inName)
                                         throws MBeanException,
                                                RuntimeOperationsException

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.

getNotification

public ModelMBeanNotificationInfo getNotification(String inName)
                                           throws MBeanException,
                                                  RuntimeOperationsException

Description copied from interface: ModelMBeanInfo

Returns a ModelMBeanNotificationInfo requested by name.

Specified by:

getNotification in interface ModelMBeanInfo

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 - Wraps a distributed communication Exception.

RuntimeOperationsException - Wraps an IllegalArgumentException for a null notification name.

getMBeanDescriptor

public Descriptor getMBeanDescriptor()
                              throws MBeanException,
                                     RuntimeOperationsException

Description copied from interface: ModelMBeanInfo

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|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=mbeanName,descriptorType=mbean, displayName=this.getClassName(), 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.

Specified by:

getMBeanDescriptor in interface ModelMBeanInfo

Returns:

the MBean descriptor.

Throws:

MBeanException - Wraps a distributed communication Exception.

RuntimeOperationsException - a RuntimeException occurred while getting the descriptor.

See Also:

ModelMBeanInfo.setMBeanDescriptor(javax.management.Descriptor)

setMBeanDescriptor

public void setMBeanDescriptor(Descriptor inMBeanDescriptor)
                        throws MBeanException,
                               RuntimeOperationsException

Description copied from interface: ModelMBeanInfo

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=mbeanName,descriptorType=mbean, displayName=this.getClassName(), 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.

Specified by:

setMBeanDescriptor in interface ModelMBeanInfo

Parameters:

inMBeanDescriptor - the descriptor to set.

Throws:

MBeanException - Wraps a distributed communication Exception.

RuntimeOperationsException - Wraps an IllegalArgumentException for invalid descriptor.

See Also:

ModelMBeanInfo.getMBeanDescriptor()