javax.management.openmbean

Home » openjdk-7 » javax » management » openmbean »

javax.management.openmbean

CompositeData	The `CompositeData` interface specifies the behavior of a specific type of complex open data objects which represent composite data structures.	code \| html
CompositeDataView	A Java class can implement this interface to indicate how it is to be converted into a {@code CompositeData} by the MXBean framework. A typical way to use this class is to add extra items to the {@code CompositeData} in addition to the ones that are declared in the {@code CompositeType} supplied by the MXBean framework.	code \| html
OpenMBeanAttributeInfo	Describes an attribute of an open MBean. This interface declares the same methods as the class javax.management.MBeanAttributeInfo .	code \| html
OpenMBeanConstructorInfo	Describes a constructor of an Open MBean. This interface declares the same methods as the class javax.management.MBeanConstructorInfo .	code \| html
OpenMBeanInfo	Describes an Open MBean: an Open MBean is recognized as such if its getMBeanInfo() method returns an instance of a class which implements the OpenMBeanInfo interface, typically OpenMBeanInfoSupport . This interface declares the same methods as the class javax.management.MBeanInfo .	code \| html
OpenMBeanOperationInfo	Describes an operation of an Open MBean. This interface declares the same methods as the class javax.management.MBeanOperationInfo .	code \| html
OpenMBeanParameterInfo	Describes a parameter used in one or more operations or constructors of an open MBean. This interface declares the same methods as the class javax.management.MBeanParameterInfo .	code \| html
TabularData	The `TabularData` interface specifies the behavior of a specific type of complex open data objects which represent tabular data structures.	code \| html

Abstract Classes:

OpenType The OpenType class is the parent abstract class of all classes which describe the actual open type of open data values. code | html

Classes:

ArrayType	The `ArrayType` class is the open type class whose instances describe all open data values which are n-dimensional arrays of open data values.	code \| html
CompositeDataInvocationHandler	An InvocationHandler that forwards getter methods to a CompositeData .	code \| html
CompositeDataSupport	The `CompositeDataSupport` class is the open data class which implements the `CompositeData` interface.	code \| html
CompositeType	The `CompositeType` class is the open type class whose instances describe the types of `CompositeData` values.	code \| html
InvalidKeyException	This runtime exception is thrown to indicate that a method parameter which was expected to be an item name of a composite data or a row index of a tabular data is not valid.	code \| html
InvalidOpenTypeException	This runtime exception is thrown to indicate that the open type of an open data value is not the one expected.	code \| html
KeyAlreadyExistsException	This runtime exception is thrown to indicate that the index of a row to be added to a tabular data instance is already used to refer to another row in this tabular data instance.	code \| html
OpenDataException	This checked exception is thrown when an open type, an open data or an open MBean metadata info instance could not be constructed because one or more validity constraints were not met.	code \| html
OpenMBeanAttributeInfoSupport	OpenMBeanAttributeInfo implementation	code \| html
OpenMBeanConstructorInfoSupport	Describes a constructor of an Open MBean.	code \| html
OpenMBeanInfoSupport	The {@code OpenMBeanInfoSupport} class describes the management information of an open MBean: it is a subclass of javax.management.MBeanInfo , and it implements the OpenMBeanInfo interface.	code \| html
OpenMBeanOperationInfoSupport	Describes an operation of an Open MBean.	code \| html
OpenMBeanParameterInfoSupport	OpenMBeanParameterInfo implementation	code \| html
SimpleType	The `SimpleType` class is the open type class whose instances describe all open data values which are neither arrays, nor `CompositeData` values, nor `TabularData` values.	code \| html
TabularDataSupport	The `TabularDataSupport` class is the open data class which implements the `TabularData` and the `Map` interfaces, and which is internally based on a hash map data structure.	code \| html
TabularType	The `TabularType` class is the open type class whose instances describe the types of `TabularData` values.	code \| html

Provides the open data types and Open MBean descriptor classes. An Open MBean is an MBean where the types of attributes and of operation parameters and return values are built using a small set of predefined Java classes. Open MBeans facilitate operation with remote management programs that do not necessarily have access to application-specific types, including non-Java programs.

Every MBean has an MBeanInfo with information about the MBean itself, and its attributes, operations, constructors, and notifications. In an Open MBean, this MBeanInfo implements the OpenMBeanInfo interface, usually by being an instance of OpenMBeanInfoSupport .

The attribute information returned by MBeanInfo.getAttributes for an Open MBean is an array of objects implementing OpenMBeanAttributeInfo , usually instances of OpenMBeanAttributeInfoSupport . In addition to the usual information about attributes, an OpenMBeanAttributeInfo specifies the OpenType of the attribute. The possible OpenType values are predefined, which is what ensures that remote managers will understand them.

Similar remarks apply to the parameter types of operations and constructors, and to the return types of operations.

There is a distinction between an attribute's Java language type, as returned by getType() , and its OpenType, as returned by getOpenType() . For example, if the Java language type is java.lang.String, the OpenType will be SimpleType.String . If the Java language type is javax.management.openmbean.CompositeData , the OpenType will be a CompositeType that describes the items in the CompositeData instances for the attribute.

Default values and constraints

In Open MBeans, attributes and parameters can have default values and/or constraints associated with them in the {@code OpenMBeanAttributeInfo} or {@code OpenMBeanParameterInfo}. There are two ways to specify these constraints. Either the values are directly specified as parameters to one of the constructors of {@code OpenMBeanAttributeInfoSupport} or {@code OpenMBeanParameterInfoSupport}, for example javax.management.openmbean.OpenMBeanParameterInfoSupport#OpenMBeanParameterInfoSupport( String, String, OpenType, Object, Object[]) ; or the values are specified in a Descriptor given as a parameter to one of the constructors.

When a {@code Descriptor} is used, the fields of interest are these:

{@code defaultValue} defines the value returned by getDefaultValue() ;
{@code minValue} defines the value returned by getMinValue() ;
{@code maxValue} defines the value returned by getMaxValue() ;
{@code legalValues} defines the values returned by getLegalValues() .

For {@code defaultValue}, {@code minValue}, and {@code maxValue}, the associated value must either be of the Java type corresponding to {@code openType}, or be a string that can be converted into that type. The conversion uses the static method {@code valueOf(String)} if it finds one; otherwise a constructor with a single {@code String} parameter if it finds one; otherwise it fails.

For {@code legalValues}, the associated value must be either an array or a {@code Set}, and the elements of the array or set must be convertible as described for {@code defaultValue} etc.

The following conditions must be met for these fields:

the values must be of the appropriate type, or be strings that can be converted to the appropriate type as explained above;
if {@code legalValues} is present then neither {@code minValue} nor {@code maxValue} must be present;
if {@code defaultValue} is present then it must satisfy the constraints defined by {@code legalValues}, {@code minValue}, or {@code maxValue} when any of these is also present;
if {@code minValue} and {@code maxValue} are both present then {@code minValue} must not be greater than {@code maxValue}.

Java Platform documentation on JMX technology

JMX Specification, version 1.4