| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.management.StandardMBean
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:
StandardMBean(impl,interface):
     
     MBeanServer mbs;
     ...
     Impl impl = new Impl(...);
     StandardMBean mbean = new StandardMBean(impl, Intf.class);
     mbs.registerMBean(mbean, objectName);
     
     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.
| Constructor Summary | |
| protected  | StandardMBean(java.lang.Class mbeanInterface)Make a DynamicMBean out of this, using the specified mbeanInterface class. | 
|   | StandardMBean(java.lang.Object implementation,
              java.lang.Class mbeanInterface)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. | 
|  java.lang.Object | getAttribute(java.lang.String attribute)Obtain the value of a specific attribute of the Dynamic MBean. | 
|  AttributeList | getAttributes(java.lang.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  java.lang.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,
                java.lang.Object impl)Customization hook: Get the MBeanConstructorInfo[] that will be used in the MBeanInfo returned by this MBean. | 
| protected  java.lang.String | getDescription(MBeanAttributeInfo info)Customization hook: Get the description that will be used in the MBeanAttributeInfo returned by this MBean. | 
| protected  java.lang.String | getDescription(MBeanConstructorInfo info)Customization hook: Get the description that will be used in the MBeanConstructorInfo returned by this MBean. | 
| protected  java.lang.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  java.lang.String | getDescription(MBeanFeatureInfo info)Customization hook: Get the description that will be used in the MBeanFeatureInfo returned by this MBean. | 
| protected  java.lang.String | getDescription(MBeanInfo info)Customization hook: Get the description that will be used in the MBeanInfo returned by this MBean. | 
| protected  java.lang.String | getDescription(MBeanOperationInfo info)Customization hook: Get the description that will be used in the MBeanOperationInfo returned by this MBean. | 
| protected  java.lang.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. | 
|  java.lang.Object | getImplementation()Get the implementation of this MBean. | 
|  java.lang.Class | getImplementationClass()Get the class of the implementation of this MBean. | 
|  MBeanInfo | getMBeanInfo()Get the MBeanInfofor this MBean. | 
|  java.lang.Class | getMBeanInterface()Get the Management Interface of this MBean. | 
| protected  java.lang.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  java.lang.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. | 
|  java.lang.Object | invoke(java.lang.String actionName,
       java.lang.Object[] params,
       java.lang.String[] signature)Allows an action to be invoked on the Dynamic MBean. | 
|  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(java.lang.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 | 
public StandardMBean(java.lang.Object implementation,
                     java.lang.Class mbeanInterface)
              throws NotCompliantMBeanException
Make a DynamicMBean out of the object implementation, using the specified mbeanInterface class.
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.
java.lang.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.
protected StandardMBean(java.lang.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.
mbeanInterface - The Management Interface exported by this
        MBean.
NotCompliantMBeanException - if the mbeanInterface
    does not follow JMX design patterns for Management Interfaces, or
    if this does not implement the specified interface.| Method Detail | 
public void setImplementation(java.lang.Object implementation)
                       throws NotCompliantMBeanException
Replace the implementation object wrapped in this object.
implementation - The new implementation of this MBean.
 The implementation object must implement the MBean
 interface that was supplied when this
 StandardMBean was constructed.
java.lang.IllegalArgumentException - if the given
    implementation is null.
NotCompliantMBeanException - if the given
 implementation does not implement the MBean
 interface that was supplied at construction.getImplementation()public java.lang.Object getImplementation()
setImplementation(java.lang.Object)public final java.lang.Class getMBeanInterface()
public java.lang.Class getImplementationClass()
public java.lang.Object getAttribute(java.lang.String attribute)
                              throws AttributeNotFoundException,
                                     MBeanException,
                                     ReflectionException
DynamicMBean
getAttribute in interface DynamicMBeanattribute - The name of the attribute to be retrieved
ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the getter.
AttributeNotFoundException
MBeanException - Wraps a java.lang.Exception thrown by the MBean's getter.DynamicMBean.setAttribute(javax.management.Attribute)
public void setAttribute(Attribute attribute)
                  throws AttributeNotFoundException,
                         InvalidAttributeValueException,
                         MBeanException,
                         ReflectionException
DynamicMBean
setAttribute in interface DynamicMBeanattribute - The identification of the attribute to
 be set and  the value it is to be set to.
AttributeNotFoundException
ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the MBean's setter.
MBeanException - Wraps a java.lang.Exception thrown by the MBean's setter.
InvalidAttributeValueExceptionDynamicMBean.getAttribute(java.lang.String)public AttributeList getAttributes(java.lang.String[] attributes)
DynamicMBean
getAttributes in interface DynamicMBeanattributes - A list of the attributes to be retrieved.
DynamicMBean.setAttributes(javax.management.AttributeList)public AttributeList setAttributes(AttributeList attributes)
DynamicMBean
setAttributes in interface DynamicMBeanattributes - A list of attributes: The identification of the
 attributes to be set and  the values they are to be set to.
DynamicMBean.getAttributes(java.lang.String[])
public java.lang.Object invoke(java.lang.String actionName,
                               java.lang.Object[] params,
                               java.lang.String[] signature)
                        throws MBeanException,
                               ReflectionException
DynamicMBean
invoke in interface DynamicMBeanactionName - The name of the action to be invoked.params - An array containing the parameters to be set when the action is
 invoked.signature - An array containing the signature of the action. The class objects will
 be loaded through the same class loader as the one used for loading the
 MBean on which the action is invoked.
ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the method
MBeanException - Wraps a java.lang.Exception thrown by the MBean's invoked method.public MBeanInfo getMBeanInfo()
MBeanInfo for this MBean.
 
 This method implements 
 DynamicMBean.getMBeanInfo().
 
 This method first calls getCachedMBeanInfo() in order to
 retrieve the cached MBeanInfo for this MBean, if any. If the
 MBeanInfo returned by getCachedMBeanInfo() is not null,
 then it is returned.
 Otherwise, this method builds a default MBeanInfo for this MBean, 
 using the Management Interface specified for this MBean.
 
 While building the MBeanInfo, this method calls the customization 
 hooks that make it possible for subclasses to supply their custom
 descriptions, parameter names, etc...
 Finally, it calls cacheMBeanInfo() in order to cache the new MBeanInfo.
getMBeanInfo in interface DynamicMBeanprotected java.lang.String getClassName(MBeanInfo info)
info.getClassName().
info - The default MBeanInfo derived by reflection.
protected java.lang.String getDescription(MBeanInfo info)
info.getDescription().
info - The default MBeanInfo derived by reflection.
protected java.lang.String getDescription(MBeanFeatureInfo info)
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
 info.getDescription().
This method is called by 
      getDescription(MBeanAttributeInfo),
      getDescription(MBeanOperationInfo),
      getDescription(MBeanConstructorInfo).
info - The default MBeanFeatureInfo derived by reflection.
protected java.lang.String getDescription(MBeanAttributeInfo info)
Subclasses may redefine this method in order to supply their
 custom description.  The default implementation returns getDescription((MBeanFeatureInfo) info).
info - The default MBeanAttributeInfo derived by reflection.
protected java.lang.String getDescription(MBeanConstructorInfo info)
getDescription((MBeanFeatureInfo) info).
info - The default MBeanConstructorInfo derived by reflection.
protected java.lang.String getDescription(MBeanConstructorInfo ctor,
                                          MBeanParameterInfo param,
                                          int sequence)
param.getDescription().
ctor - The default MBeanConstructorInfo derived by reflection.param - The default MBeanParameterInfo derived by reflection.sequence - The sequence number of the parameter considered 
        ("0" for the first parameter, "1" for the second parameter,
        etc...).
protected java.lang.String getParameterName(MBeanConstructorInfo ctor,
                                            MBeanParameterInfo param,
                                            int sequence)
param.getName().
ctor - The default MBeanConstructorInfo derived by reflection.param - The default MBeanParameterInfo derived by reflection.sequence - The sequence number of the parameter considered 
        ("0" for the first parameter, "1" for the second parameter,
        etc...).
protected java.lang.String getDescription(MBeanOperationInfo info)
getDescription((MBeanFeatureInfo) info).
info - The default MBeanOperationInfo derived by reflection.
protected int getImpact(MBeanOperationInfo info)
info.getImpact().
info - The default MBeanOperationInfo derived by reflection.
protected java.lang.String getParameterName(MBeanOperationInfo op,
                                            MBeanParameterInfo param,
                                            int sequence)
param.getName().
op - The default MBeanOperationInfo derived by reflection.param - The default MBeanParameterInfo derived by reflection.sequence - The sequence number of the parameter considered 
        ("0" for the first parameter, "1" for the second parameter,
        etc...).
protected java.lang.String getDescription(MBeanOperationInfo op,
                                          MBeanParameterInfo param,
                                          int sequence)
param.getDescription().
op - The default MBeanOperationInfo derived by reflection.param - The default MBeanParameterInfo derived by reflection.sequence - The sequence number of the parameter considered 
        ("0" for the first parameter, "1" for the second parameter,
        etc...).
protected MBeanConstructorInfo[] getConstructors(MBeanConstructorInfo[] ctors,
                                                 java.lang.Object impl)
null if the wrapped
 implementation is not this. Indeed, if the wrapped
 implementation is not this object itself, it will not be possible
 to recreate a wrapped implementation by calling the implementation 
 constructors through MBeanServer.createMBean(...).
ctors - The default MBeanConstructorInfo[] derived by reflection.impl - The wrapped implementation. If null is
        passed, the wrapped implementation is ignored and 
        ctors is returned.
protected MBeanInfo getCachedMBeanInfo()
Subclasses may redefine this method in order to implement their
 own caching policy.  The default implementation stores one
 MBeanInfo object per instance.
cacheMBeanInfo(MBeanInfo)protected void cacheMBeanInfo(MBeanInfo info)
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 getMBeanInfo() is called) or
 sharing a unique MBeanInfo object when several
 StandardMBean instances have equal MBeanInfo values.
info - the new MBeanInfo to cache.  Any
 previously cached value is discarded.  This parameter may be
 null, in which case there is no new cached value.| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.