APIdia Launch Partner
Top Description Fields Constructors Methods
javax.management.modelmbean

public Class ModelMBeanInfoSupport

extends MBeanInfo
implements ModelMBeanInfo
Class Inheritance
All Implemented Interfaces
javax.management.modelmbean.ModelMBeanInfo
Static Imports
com.sun.jmx.defaults.JmxProperties.MODELMBEAN_LOGGER
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.

Since
1.5

Field Summary

Modifier and TypeField and Description
private static final String
ALL

private static final String
ATTR

private static final String
CONS

private static final String
currClass

private static final String
MMB

private MBeanAttributeInfo[]
modelMBeanAttributes

private MBeanConstructorInfo[]
modelMBeanConstructors

private Descriptor
modelMBeanDescriptor

private MBeanNotificationInfo[]
modelMBeanNotifications

private MBeanOperationInfo[]
modelMBeanOperations

private static final ModelMBeanAttributeInfo[]
NO_ATTRIBUTES

private static final ModelMBeanConstructorInfo[]
NO_CONSTRUCTORS

private static final ModelMBeanNotificationInfo[]
NO_NOTIFICATIONS

private static final ModelMBeanOperationInfo[]
NO_OPERATIONS

private static final String
NOTF

private static final String
OPER

private static final ObjectStreamField[]
serialPersistentFields

private static final long
serialVersionUID

Hides javax.management.MBeanInfo.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
ModelMBeanInfoSupport(ModelMBeanInfo
the ModelMBeanInfo instance from which the ModelMBeanInfo being created is initialized.
mbi)

Constructs a ModelMBeanInfoSupport which is a duplicate of the given ModelMBeanInfo.

public
ModelMBeanInfoSupport(String
classname of the MBean
className, String
human readable description of the ModelMBean
description, ModelMBeanAttributeInfo[]
array of ModelMBeanAttributeInfo objects which have descriptors
attributes, ModelMBeanConstructorInfo[]
array of ModelMBeanConstructorInfo objects which have descriptors
constructors, ModelMBeanOperationInfo[]
array of ModelMBeanOperationInfo objects which have descriptors
operations, ModelMBeanNotificationInfo[]
array of ModelMBeanNotificationInfo objects which have descriptors
notifications)

Creates a ModelMBeanInfoSupport with the provided information, but the descriptor is a default.

public
ModelMBeanInfoSupport(String
classname of the MBean
className, String
human readable description of the ModelMBean
description, ModelMBeanAttributeInfo[]
array of ModelMBeanAttributeInfo objects which have descriptors
attributes, ModelMBeanConstructorInfo[]
array of ModelMBeanConstructorInfo objects which have descriptor
constructors, ModelMBeanOperationInfo[]
array of ModelMBeanOperationInfo objects which have descriptor
operations, ModelMBeanNotificationInfo[]
array of ModelMBeanNotificationInfo objects which have descriptor
notifications, Descriptor
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.
mbeandescriptor)

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

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

a shallow clone of this instance.
clone()

Overrides javax.management.MBeanInfo.clone.

Implements javax.management.modelmbean.ModelMBeanInfo.clone.

Returns a shallow clone of this instance.

public ModelMBeanAttributeInfo
getAttribute(String inName)

Implements javax.management.modelmbean.ModelMBeanInfo.getAttribute.

Returns a ModelMBeanAttributeInfo requested by name.

public ModelMBeanConstructorInfo

Returns:

the constructor info for the named constructor, or null if there is none.
getConstructor(String
the name of the constructor.
inName)

Returns the ModelMBeanConstructorInfo requested by name.

public Descriptor

Returns:

Descriptor containing a descriptor for the ModelMBean with the same name. If no descriptor is found, null is returned.
getDescriptor(String
The name of the descriptor.
inDescriptorName)

Returns a Descriptor requested by name.

public Descriptor
getDescriptor(String inDescriptorName, String inDescriptorType)

Implements javax.management.modelmbean.ModelMBeanInfo.getDescriptor.

Returns a Descriptor requested by name and descriptorType.

public Descriptor
getDescriptor()

Overrides javax.management.MBeanInfo.getDescriptor.

Implements javax.management.DescriptorRead.getDescriptor.

Get the descriptor of this MBeanInfo.

public Descriptor[]
getDescriptors(String inDescriptorType)

Implements javax.management.modelmbean.ModelMBeanInfo.getDescriptors.

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

public Descriptor
getMBeanDescriptor()

Implements javax.management.modelmbean.ModelMBeanInfo.getMBeanDescriptor.

Returns the ModelMBean's descriptor which contains MBean wide policies.

private Descriptor
getMBeanDescriptorNoException()

public ModelMBeanNotificationInfo
getNotification(String inName)

Implements javax.management.modelmbean.ModelMBeanInfo.getNotification.

Returns a ModelMBeanNotificationInfo requested by name.

public ModelMBeanOperationInfo
getOperation(String inName)

Implements javax.management.modelmbean.ModelMBeanInfo.getOperation.

Returns a ModelMBeanOperationInfo requested by name.

private void
readObject(ObjectInputStream in)

Hides javax.management.MBeanInfo.readObject.

Deserializes a ModelMBeanInfoSupport from an ObjectInputStream.

public void
setDescriptor(Descriptor inDescriptor, String inDescriptorType)

Implements javax.management.modelmbean.ModelMBeanInfo.setDescriptor.

Sets descriptors in the info array of type inDescriptorType for the ModelMBean.

public void
setDescriptors(Descriptor[] inDescriptors)

Implements javax.management.modelmbean.ModelMBeanInfo.setDescriptors.

Adds or replaces descriptors in the ModelMBeanInfo.

public void
setMBeanDescriptor(Descriptor inMBeanDescriptor)

Implements javax.management.modelmbean.ModelMBeanInfo.setMBeanDescriptor.

Sets the ModelMBean's descriptor.

private Descriptor
validDescriptor(final Descriptor
Descriptor to be checked, or null which is equivalent to an empty Descriptor.
in)

Clones the passed in Descriptor, sets default values, and checks for validity.

private void
writeObject(ObjectOutputStream out)

Hides javax.management.MBeanInfo.writeObject.

Serializes a ModelMBeanInfoSupport to an ObjectOutputStream.

Inherited from javax.management.MBeanInfo:
equalsgetAttributesgetClassNamegetConstructorsgetDescriptiongetNotificationsgetOperationshashCodetoString

Field Detail

ALLback to summary
private static final String ALL
ATTRback to summary
private static final String ATTR
CONSback to summary
private static final String CONS
currClassback to summary
private static final String currClass
MMBback to summary
private static final String MMB
modelMBeanAttributesback to summary
private MBeanAttributeInfo[] modelMBeanAttributes
modelMBeanConstructorsback to summary
private MBeanConstructorInfo[] modelMBeanConstructors
modelMBeanDescriptorback to summary
private Descriptor modelMBeanDescriptor
modelMBeanNotificationsback to summary
private MBeanNotificationInfo[] modelMBeanNotifications
modelMBeanOperationsback to summary
private MBeanOperationInfo[] modelMBeanOperations
NO_ATTRIBUTESback to summary
private static final ModelMBeanAttributeInfo[] NO_ATTRIBUTES
NO_CONSTRUCTORSback to summary
private static final ModelMBeanConstructorInfo[] NO_CONSTRUCTORS
NO_NOTIFICATIONSback to summary
private static final ModelMBeanNotificationInfo[] NO_NOTIFICATIONS
NO_OPERATIONSback to summary
private static final ModelMBeanOperationInfo[] NO_OPERATIONS
NOTFback to summary
private static final String NOTF
OPERback to summary
private static final String OPER
serialPersistentFieldsback to summary
private static final ObjectStreamField[] serialPersistentFields
Serial Fields:
modelMBeanDescriptor:Descriptor
The descriptor containing MBean wide policy
modelMBeanAttributes:ModelMBeanAttributeInfo[]
The array of ModelMBeanAttributeInfo objects which have descriptors
modelMBeanConstructors:MBeanConstructorInfo[]
The array of ModelMBeanConstructorInfo objects which have descriptors
modelMBeanNotifications:MBeanNotificationInfo[]
The array of ModelMBeanNotificationInfo objects which have descriptors
modelMBeanOperations:MBeanOperationInfo[]
The array of ModelMBeanOperationInfo objects which have descriptors
serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.management.MBeanInfo.serialVersionUID.

Constructor Detail

ModelMBeanInfoSupportback to summary
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:ModelMBeanInfo

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

ModelMBeanInfoSupportback to summary
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=className, descriptorType="mbean", displayName=className, persistPolicy="never", log="F", visibility="1"

Parameters
className:String

classname of the MBean

description:String

human readable description of the ModelMBean

attributes:ModelMBeanAttributeInfo[]

array of ModelMBeanAttributeInfo objects which have descriptors

constructors:ModelMBeanConstructorInfo[]

array of ModelMBeanConstructorInfo objects which have descriptors

operations:ModelMBeanOperationInfo[]

array of ModelMBeanOperationInfo objects which have descriptors

notifications:ModelMBeanNotificationInfo[]

array of ModelMBeanNotificationInfo objects which have descriptors

ModelMBeanInfoSupportback to summary
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:String

classname of the MBean

description:String

human readable description of the ModelMBean

attributes:ModelMBeanAttributeInfo[]

array of ModelMBeanAttributeInfo objects which have descriptors

constructors:ModelMBeanConstructorInfo[]

array of ModelMBeanConstructorInfo objects which have descriptor

operations:ModelMBeanOperationInfo[]

array of ModelMBeanOperationInfo objects which have descriptor

notifications:ModelMBeanNotificationInfo[]

array of ModelMBeanNotificationInfo objects which have descriptor

mbeandescriptor:Descriptor

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.

Exceptions
RuntimeOperationsException:
Wraps an IllegalArgumentException for invalid descriptor passed in parameter. (see getMBeanDescriptor for the definition of a valid MBean descriptor.)

Method Detail

cloneback to summary
public Object clone()

Overrides javax.management.MBeanInfo.clone.

Implements javax.management.modelmbean.ModelMBeanInfo.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:Object

a shallow clone of this instance.

getAttributeback to summary
public ModelMBeanAttributeInfo getAttribute(String inName) throws MBeanException, RuntimeOperationsException

Implements javax.management.modelmbean.ModelMBeanInfo.getAttribute.

Doc from javax.management.modelmbean.ModelMBeanInfo.getAttribute.

Returns a ModelMBeanAttributeInfo requested by name.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException for a null attribute name.
getConstructorback to summary
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:String

the name of the constructor.

Returns:ModelMBeanConstructorInfo

the constructor info for the named constructor, or null if there is none.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException for a null constructor name.
getDescriptorback to summary
public Descriptor getDescriptor(String inDescriptorName) throws MBeanException, RuntimeOperationsException

Returns a Descriptor requested by name.

Parameters
inDescriptorName:String

The name of the descriptor.

Returns:Descriptor

Descriptor containing a descriptor for the ModelMBean with the same name. If no descriptor is found, null is returned.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException for null name.
See Also
setDescriptor
getDescriptorback to summary
public Descriptor getDescriptor(String inDescriptorName, String inDescriptorType) throws MBeanException, RuntimeOperationsException

Implements javax.management.modelmbean.ModelMBeanInfo.getDescriptor.

Doc from javax.management.modelmbean.ModelMBeanInfo.getDescriptor.

Returns a Descriptor requested by name and descriptorType.

Exceptions
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".
getDescriptorback to summary
public Descriptor getDescriptor()

Overrides javax.management.MBeanInfo.getDescriptor.

Implements javax.management.DescriptorRead.getDescriptor.

Doc from javax.management.MBeanInfo.getDescriptor.

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

Annotations
@Override
Since
1.6
getDescriptorsback to summary
public Descriptor[] getDescriptors(String inDescriptorType) throws MBeanException, RuntimeOperationsException

Implements javax.management.modelmbean.ModelMBeanInfo.getDescriptors.

Doc from javax.management.modelmbean.ModelMBeanInfo.getDescriptors.

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

Exceptions
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.
getMBeanDescriptorback to summary
public Descriptor getMBeanDescriptor() throws MBeanException

Implements javax.management.modelmbean.ModelMBeanInfo.getMBeanDescriptor.

Doc from javax.management.modelmbean.ModelMBeanInfo.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. Note that when the Type in this table is Number, a String that is the decimal representation of a Long can also be used.

ModelMBean Fields
NameTypeMeaning
nameString MBean name.
descriptorTypeString Must be "mbean".
displayNameString Name of MBean to be used in displays.
persistPolicyString One of: OnUpdate|OnTimer|NoMoreOftenThan|OnUnregister|Always|Never. See the section "MBean Descriptor Fields" in the JMX specification document.
persistLocationString The fully qualified directory name where the MBean should be persisted (if appropriate).
persistFileString File name into which the MBean should be persisted.
persistPeriodNumber Frequency of persist cycle in seconds, for OnTime and NoMoreOftenThan PersistPolicy
currencyTimeLimitNumber How long cached value is valid: <0 never, =0 always, >0 seconds.
logString t: log all notifications, f: log no notifications.
logfileString Fully qualified filename to log events to.
visibilityNumber 1-4 where 1: always visible 4: rarely visible.
exportString Name to be used to export/expose this MBean so that it is findable by other JMX Agents.
presentationStringString 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.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
getMBeanDescriptorNoExceptionback to summary
private Descriptor getMBeanDescriptorNoException()
getNotificationback to summary
public ModelMBeanNotificationInfo getNotification(String inName) throws MBeanException, RuntimeOperationsException

Implements javax.management.modelmbean.ModelMBeanInfo.getNotification.

Doc from javax.management.modelmbean.ModelMBeanInfo.getNotification.

Returns a ModelMBeanNotificationInfo requested by name.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException for a null notification name.
getOperationback to summary
public ModelMBeanOperationInfo getOperation(String inName) throws MBeanException, RuntimeOperationsException

Implements javax.management.modelmbean.ModelMBeanInfo.getOperation.

Doc from javax.management.modelmbean.ModelMBeanInfo.getOperation.

Returns a ModelMBeanOperationInfo requested by name.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException for a null operation name.
readObjectback to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException

Hides javax.management.MBeanInfo.readObject.

Deserializes a ModelMBeanInfoSupport from an ObjectInputStream.

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

Implements javax.management.modelmbean.ModelMBeanInfo.setDescriptor.

Doc from javax.management.modelmbean.ModelMBeanInfo.setDescriptor.

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.

Exceptions
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.
setDescriptorsback to summary
public void setDescriptors(Descriptor[] inDescriptors) throws MBeanException, RuntimeOperationsException

Implements javax.management.modelmbean.ModelMBeanInfo.setDescriptors.

Doc from javax.management.modelmbean.ModelMBeanInfo.setDescriptors.

Adds or replaces descriptors in the ModelMBeanInfo.

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException for a null or invalid descriptor.
setMBeanDescriptorback to summary
public void setMBeanDescriptor(Descriptor inMBeanDescriptor) throws MBeanException, RuntimeOperationsException

Implements javax.management.modelmbean.ModelMBeanInfo.setMBeanDescriptor.

Doc from javax.management.modelmbean.ModelMBeanInfo.setMBeanDescriptor.

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

Exceptions
MBeanException:
Wraps a distributed communication Exception.
RuntimeOperationsException:
Wraps an IllegalArgumentException for invalid descriptor.
validDescriptorback to summary
private Descriptor validDescriptor(final Descriptor in) throws RuntimeOperationsException

Clones the passed in Descriptor, sets default values, and checks for validity. If the Descriptor is invalid (for instance by having the wrong "name"), this indicates programming error and a RuntimeOperationsException will be thrown. The following fields will be defaulted if they are not already set: displayName=className,name=className,descriptorType="mbean", persistPolicy="never", log="F", visibility="1"

Parameters
in:Descriptor

Descriptor to be checked, or null which is equivalent to an empty Descriptor.

Exceptions
RuntimeOperationsException:
if Descriptor is invalid
writeObjectback to summary
private void writeObject(ObjectOutputStream out) throws IOException

Hides javax.management.MBeanInfo.writeObject.

Serializes a ModelMBeanInfoSupport to an ObjectOutputStream.