Java Doc for StandardMBean.java in  » JMX » jfoxmx » javax » management » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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.StandardMBean(java.lang.Object,java.lang.Class)StandardMBean(impl,interface) :

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

• Subclassing StandardMBean:

   public class Impl extends StandardMBean implements Intf {
   public Impl() {
   super(Intf.class);
   }
   // 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.

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

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

Call StandardMBean.StandardMBean(java.lang.Object,java.lang.Class)this(this,mbeanInterface) .

Subclasses may redefine this method in order to implement their own caching policy.

Subclasses may redefine this method in order to implement their own caching policy.

Customization hook: Get the description that will be used in the MBeanFeatureInfo returned by this MBean.

Subclasses may redefine this method in order to supply their custom description.

Subclasses may redefine this method in order to supply their custom description.

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

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

Call StandardMBean.StandardMBean(java.lang.Object,java.lang.Class)this(this,mbeanInterface) . This constructor is reserved to subclasses.

Subclasses may redefine this method in order to implement their own caching policy. The default implementation stores info in this instance. A subclass can define other policies, such as not saving info (so it is reconstructed every time StandardMBean.getMBeanInfo() is called) or sharing a unique MBeanInfo object when several StandardMBean instances have equal MBeanInfo values.
Parameters:
  info - the new MBeanInfo to cache. Anypreviously cached value is discarded. This parameter may benull, in which case there is no new cached value.

Subclasses may redefine this method in order to implement their own caching policy. The default implementation stores one MBeanInfo object per instance. The cached MBeanInfo, or null if no MBeanInfo is cached.
See Also:   StandardMBean.cacheMBeanInfo(MBeanInfo)

Customization hook: Get the description that will be used in the MBeanFeatureInfo returned by this MBean.

Subclasses may redefine this method in order to supply their custom description. The default implementation returns MBeanFeatureInfo.getDescriptioninfo.getDescription() .

This method is called by StandardMBean.getDescription(MBeanAttributeInfo) , StandardMBean.getDescription(MBeanOperationInfo) , StandardMBean.getDescription(MBeanConstructorInfo) .

Subclasses may redefine this method in order to supply their custom description. The default implementation returns StandardMBean.getDescription(MBeanFeatureInfo)getDescription((MBeanFeatureInfo) info) .
Parameters:
  info - The default MBeanAttributeInfo derived by reflection. the description for the given MBeanAttributeInfo.

Replace the implementation object wrapped in this object.