StandardMBean (JBoss/JMX API) - JBoss 4.0.1 sp1 jmx API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

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

public class StandardMBean
extends Object
implements DynamicMBean

A helper class to allow standard mbeans greater control over their management interface.

Extending this class actually makes the mbean a dynamic mbean, but with the convenience of a standard mbean.

Version:: $Revision: 1.8 $
Author:: Adrian Brock., Thomas Diesler.

Constructor Summary

protected StandardMBean(Class mbeanInterface)
          Construct a DynamicMBean from this object and the passed management interface class.

StandardMBean(Object implementation, Class mbeanInterface)
          Construct a DynamicMBean from the given implementation object and the passed management interface class.

Method Summary

protected void cacheMBeanInfo(MBeanInfo info)
          Sets the cached mbean info

Object getAttribute(String attribute)
          Returns the value of the attribute with the name matching the passed string.

AttributeList getAttributes(String[] attributes)
          Returns the values of the attributes with names matching the passed string array.

protected MBeanInfo getCachedMBeanInfo()
          Retrieve the cached mbean info

protected String getClassName(MBeanInfo info)
          Retrieve the class name of the mbean

protected MBeanConstructorInfo[] getConstructors(MBeanConstructorInfo[] constructors, Object implementation)
          Retrieve the constructors

protected String getDescription(MBeanAttributeInfo info)
          Retrieve the description of the mbean attribute

protected String getDescription(MBeanConstructorInfo info)
          Retrieve the description of the mbean constructor

protected String getDescription(MBeanConstructorInfo info, MBeanParameterInfo param, int sequence)
          Retrieve the description of the mbean constructor parameter

protected String getDescription(MBeanFeatureInfo info)
          Retrieve the description of the mbean feature

protected String getDescription(MBeanInfo info)
          Retrieve the description of the mbean

protected String getDescription(MBeanOperationInfo info)
          Retrieve the description of the mbean operation

protected String getDescription(MBeanOperationInfo info, MBeanParameterInfo param, int sequence)
          Retrieve the description of the mbean operation parameter

protected int getImpact(MBeanOperationInfo info)
          Retrieve the impact of the mbean operation

Object getImplementation()
          Retrieve the implementation object

Class getImplementationClass()
          Retrieve the implementation class

MBeanInfo getMBeanInfo()
          Returns the management interface that describes this dynamic resource.

Class getMBeanInterface()
          Retrieve the management interface

protected String getParameterName(MBeanConstructorInfo info, MBeanParameterInfo param, int sequence)
          Retrieve the parameter name for a constructor

protected String getParameterName(MBeanOperationInfo info, MBeanParameterInfo param, int sequence)
          Retrieve the parameter name for an operation

Object invoke(String actionName, Object[] params, String[] signature)
          Invokes a resource operation.

void setAttribute(Attribute attribute)
          Sets the value of an attribute.

AttributeList setAttributes(AttributeList attributes)
          Sets the values of the attributes passed as an AttributeList of name and new value pairs.

void setImplementation(Object implementation)
          Replace the implementation object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardMBean

public StandardMBean(Object implementation,
                     Class mbeanInterface)
              throws NotCompliantMBeanException

Construct a DynamicMBean from the given implementation object and the passed management interface class.
Parameters:: implementation - the object implementing the mbean; mbeanInterface - the management interface of the mbean
Throws:: IllegalArgumentException - for a null implementation; NotCompliantMBeanException - if the management interface does not follow the JMX design patterns or the implementation does not implement the interface

StandardMBean

protected StandardMBean(Class mbeanInterface)
                 throws NotCompliantMBeanException

Construct a DynamicMBean from this object and the passed management interface class.

Used in subclassing

Parameters:

mbeanInterface - the management interface of the mbean

Throws:

NotCompliantMBeanException - if the management interface does not follow the JMX design patterns or this does not implement the interface

Method Detail

getImplementation

public Object getImplementation()

Retrieve the implementation object

Returns:: the implementation

setImplementation

public void setImplementation(Object implementation)
                       throws NotCompliantMBeanException

Replace the implementation object

Parameters:: implementation - the new implementation
Throws:: IllegalArgumentException - for a null parameter; NotCompliantMBeanException - if the new implementation does not implement the interface supplied at construction

getImplementationClass

public Class getImplementationClass()

Retrieve the implementation class

Returns:: the class of the implementation

getMBeanInterface

public final Class getMBeanInterface()

Retrieve the management interface

Returns:: the management interface