StandardMBean (Java Platform SE 6)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java™ Platform
Standard Ed. 6

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.management
Class StandardMBean

java.lang.Object
  javax.management.StandardMBean

All Implemented Interfaces:: DynamicMBean, MBeanRegistration

Direct Known Subclasses:: StandardEmitterMBean

public class StandardMBean
extends Object
implements DynamicMBean, MBeanRegistration
extends Object
implements DynamicMBean, MBeanRegistration

An MBean whose management interface is determined by reflection on a Java interface.

This class brings more flexibility to the notion of Management Interface in the use of Standard MBeans. Straightforward use of the patterns for Standard MBeans described in the JMX Specification means that there is a fixed relationship between the implementation class of an MBean and its management interface (i.e., if the implementation class is Thing, the management interface must be ThingMBean). This class makes it possible to keep the convenience of specifying the management interface with a Java interface, without requiring that there be any naming relationship between the implementation and interface classes.

By making a DynamicMBean out of an MBean, this class makes it possible to select any interface implemented by the MBean as its management interface, provided that it complies with JMX patterns (i.e., attributes defined by getter/setter etc...).

This class also provides hooks that make it possible to supply custom descriptions and names for the MBeanInfo returned by the DynamicMBean interface.

Using this class, an MBean can be created with any implementation class name Impl and with a management interface defined (as for current Standard MBeans) by any interface Intf, in one of two general ways:

Using the public constructor StandardMBean(impl,interface):

     MBeanServer mbs;
     ...
     Impl impl = new Impl(...);
     StandardMBean mbean = new StandardMBean(impl, Intf.class, false);
     mbs.registerMBean(mbean, objectName);

Subclassing StandardMBean:

     public class Impl extends StandardMBean implements Intf {
        public Impl() {
          super(Intf.class, false);
       }
       // implement methods of Intf
     }

     [...]

     MBeanServer mbs;
     ....
     Impl impl = new Impl();
     mbs.registerMBean(impl, objectName);

In either case, the class Impl must implement the interface Intf.

Standard MBeans based on the naming relationship between implementation and interface classes are of course still available.

This class may also be used to construct MXBeans. The usage is exactly the same as for Standard MBeans except that in the examples above, the false parameter to the constructor or super(...) invocation is instead true.

Since:: 1.5

Constructor Summary
`protected`	`StandardMBean(Class<?> mbeanInterface)` Make a DynamicMBean out of `this`, using the specified `mbeanInterface` class.
`protected`	`StandardMBean(Class<?> mbeanInterface, boolean isMXBean)` Make a DynamicMBean out of `this`, using the specified `mbeanInterface` class.
	`StandardMBean(T implementation, Class<T> mbeanInterface)` Make a DynamicMBean out of the object `implementation`, using the specified `mbeanInterface` class.
	`StandardMBean(T implementation, Class<T> mbeanInterface, boolean isMXBean)` Make a DynamicMBean out of the object `implementation`, using the specified `mbeanInterface` class.

Method Summary
`protected void`	`cacheMBeanInfo(MBeanInfo info)` Customization hook: cache the MBeanInfo built for this object.
`Object`	`getAttribute(String attribute)` Obtain the value of a specific attribute of the Dynamic MBean.
`AttributeList`	`getAttributes(String[] attributes)` Get the values of several attributes of the Dynamic MBean.
`protected MBeanInfo`	`getCachedMBeanInfo()` Customization hook: Return the MBeanInfo cached for this object.
`protected String`	`getClassName(MBeanInfo info)` Customization hook: Get the className that will be used in the MBeanInfo returned by this MBean.
`protected MBeanConstructorInfo[]`	`getConstructors(MBeanConstructorInfo[] ctors, Object impl)` Customization hook: Get the MBeanConstructorInfo[] that will be used in the MBeanInfo returned by this MBean.
`protected String`	`getDescription(MBeanAttributeInfo info)` Customization hook: Get the description that will be used in the MBeanAttributeInfo returned by this MBean.
`protected String`	`getDescription(MBeanConstructorInfo info)` Customization hook: Get the description that will be used in the MBeanConstructorInfo returned by this MBean.
`protected String`	`getDescription(MBeanConstructorInfo ctor, MBeanParameterInfo param, int sequence)` Customization hook: Get the description that will be used for the `sequence` MBeanParameterInfo of the MBeanConstructorInfo returned by this MBean.
`protected String`	`getDescription(MBeanFeatureInfo info)` Customization hook: Get the description that will be used in the MBeanFeatureInfo returned by this MBean.
`protected String`	`getDescription(MBeanInfo info)` Customization hook: Get the description that will be used in the MBeanInfo returned by this MBean.
`protected String`	`getDescription(MBeanOperationInfo info)` Customization hook: Get the description that will be used in the MBeanOperationInfo returned by this MBean.
`protected String`	`getDescription(MBeanOperationInfo op, MBeanParameterInfo param, int sequence)` Customization hook: Get the description that will be used for the `sequence` MBeanParameterInfo of the MBeanOperationInfo returned by this MBean.
`protected int`	`getImpact(MBeanOperationInfo info)` Customization hook: Get the `impact` flag of the operation that will be used in the MBeanOperationInfo returned by this MBean.
`Object`	`getImplementation()` Get the implementation of this Standard MBean (or MXBean).
`Class<?>`	`getImplementationClass()` Get the class of the implementation of this Standard MBean (or MXBean).
`MBeanInfo`	`getMBeanInfo()` Get the `MBeanInfo` for this MBean.
`Class<?>`	`getMBeanInterface()` Get the Management Interface of this Standard MBean (or MXBean).
`protected String`	`getParameterName(MBeanConstructorInfo ctor, MBeanParameterInfo param, int sequence)` Customization hook: Get the name that will be used for the `sequence` MBeanParameterInfo of the MBeanConstructorInfo returned by this MBean.
`protected String`	`getParameterName(MBeanOperationInfo op, MBeanParameterInfo param, int sequence)` Customization hook: Get the name that will be used for the `sequence` MBeanParameterInfo of the MBeanOperationInfo returned by this MBean.
`Object`	`invoke(String actionName, Object[] params, String[] signature)` Allows an action to be invoked on the Dynamic MBean.
`void`	`postDeregister()` Allows the MBean to perform any operations needed after having been unregistered in the MBean server.
`void`	`postRegister(Boolean registrationDone)` Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.
`void`	`preDeregister()` Allows the MBean to perform any operations it needs before being unregistered by the MBean server.
`ObjectName`	`preRegister(MBeanServer server, ObjectName name)` Allows the MBean to perform any operations it needs before being registered in the MBean server.
`void`	`setAttribute(Attribute attribute)` Set the value of a specific attribute of the Dynamic MBean.
`AttributeList`	`setAttributes(AttributeList attributes)` Sets the values of several attributes of the Dynamic MBean.
`void`	`setImplementation(Object implementation)` Replace the implementation object wrapped in this object.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

StandardMBean

public StandardMBean(T implementation,
                     Class<T> mbeanInterface)
              throws NotCompliantMBeanException

Make a DynamicMBean out of the object implementation, using the specified mbeanInterface class.

Type Parameters:: T - Allows the compiler to check that implementation does indeed implement the class described by mbeanInterface. The compiler can only check this if mbeanInterface is a class literal such as MyMBean.class.
Parameters:: implementation - The implementation of this MBean.; mbeanInterface - The Management Interface exported by this MBean's implementation. If null, then this object will use standard JMX design pattern to determine the management interface associated with the given implementation.
Throws:: IllegalArgumentException - if the given implementation is null.; NotCompliantMBeanException - if the mbeanInterface does not follow JMX design patterns for Management Interfaces, or if the given implementation does not implement the specified interface.

StandardMBean

protected StandardMBean(Class<?> mbeanInterface)
                 throws NotCompliantMBeanException

Make a DynamicMBean out of this, using the specified mbeanInterface class.

Call this(this,mbeanInterface). This constructor is reserved to subclasses.

Parameters:: mbeanInterface - The Management Interface exported by this MBean.
Throws:: NotCompliantMBeanException - if the mbeanInterface does not follow JMX design patterns for Management Interfaces, or if this does not implement the specified interface.

StandardMBean

public StandardMBean(T implementation,
                     Class<T> mbeanInterface,
                     boolean isMXBean)

Make a DynamicMBean out of the object implementation, using the specified mbeanInterface class. This constructor can be used to make either Standard MBeans or MXBeans. Unlike the constructor StandardMBean(Object, Class), it does not throw NotCompliantMBeanException.

Type Parameters:: T - Allows the compiler to check that implementation does indeed implement the class described by mbeanInterface. The compiler can only check this if mbeanInterface is a class literal such as MyMBean.class.
Parameters:: implementation - The implementation of this MBean.; mbeanInterface - The Management Interface exported by this MBean's implementation. If null, then this object will use standard JMX design pattern to determine the management interface associated with the given implementation.; isMXBean - If true, the mbeanInterface parameter names an MXBean interface and the resultant MBean is an MXBean.
Throws:: IllegalArgumentException - if the given implementation is null, or if the mbeanInterface does not follow JMX design patterns for Management Interfaces, or if the given implementation does not implement the specified interface.
Since:: 1.6

StandardMBean

protected StandardMBean(Class<?> mbeanInterface,
                        boolean isMXBean)

Make a DynamicMBean out of this, using the specified mbeanInterface class. This constructor can be used to make either Standard MBeans or MXBeans. Unlike the constructor StandardMBean(Object, Class), it does not throw NotCompliantMBeanException.

Call this(this, mbeanInterface, isMXBean). This constructor is reserved to subclasses.

Parameters:: mbeanInterface - The Management Interface exported by this MBean.; isMXBean - If true, the mbeanInterface parameter names an MXBean interface and the resultant MBean is an MXBean.
Throws:: IllegalArgumentException - if the mbeanInterface does not follow JMX design patterns for Management Interfaces, or if this does not implement the specified interface.
Since:: 1.6

Method Detail

setImplementation

public void setImplementation(Object implementation)
                       throws NotCompliantMBeanException

Replace the implementation object wrapped in this object.

Parameters:: implementation - The new implementation of this Standard MBean (or MXBean). The implementation object must implement the Standard MBean (or MXBean) interface that was supplied when this StandardMBean was constructed.
Throws:: IllegalArgumentException - if the given implementation is null.; NotCompliantMBeanException - if the given implementation does not implement the Standard MBean (or MXBean) interface that was supplied at construction.
See Also:: getImplementation()

getImplementation

public Object getImplementation()

Get the implementation of this Standard MBean (or MXBean).

Returns:: The implementation of this Standard MBean (or MXBean).
See Also:: setImplementation(java.lang.Object)

getMBeanInterface

public final Class<?> getMBeanInterface()

Get the Management Interface of this Standard MBean (or MXBean).

Returns:: The management interface of this Standard MBean (or MXBean).

getImplementationClass

public Class<?> getImplementationClass()

Get the class of the implementation of this Standard MBean (or MXBean).

Returns:: The class of the implementation of this Standard MBean (or MXBean).