javax.management
Interface DynamicMBean

All Known Implementing Classes:
StandardMBean

public interface DynamicMBean

Represents a management bean that provides a dynamic interface. Users of a DynamicMBean may retrieve information about its attributes at runtime and use this information to dynamically obtain the corresponding values of these attributes.

Since:
1.5

Method Summary
 Object getAttribute(String name)
          Obtains the value of the specified attribute of the management bean.
 AttributeList getAttributes(String[] names)
          Obtains the values of each of the specified attributes of the management bean.
 MBeanInfo getMBeanInfo()
          Returns an information object which lists the attributes and actions associated with the management bean.
 Object invoke(String name, Object[] params, String[] signature)
          Invokes the specified action on the management bean using the supplied parameters.
 void setAttribute(Attribute attribute)
          Sets the value of the specified attribute of the management bean.
 AttributeList setAttributes(AttributeList attributes)
          Sets the value of each of the specified attributes to that supplied by the Attribute object.
 

Method Detail

getAttribute

Object getAttribute(String name)
                    throws AttributeNotFoundException,
                           MBeanException,
                           ReflectionException
Obtains the value of the specified attribute of the management bean. The management bean should perform a lookup for the named attribute, and return its value by calling the appropriate getter method, if possible.

Parameters:
name - the name of the attribute to retrieve.
Returns:
the value of the specified attribute.
Throws:
AttributeNotFoundException - if the name does not correspond to an attribute of the bean.
MBeanException - if retrieving the attribute causes the bean to throw an exception (which becomes the cause of this exception).
ReflectionException - if an exception occurred in trying to use the reflection interface to lookup the attribute. The thrown exception is the cause of this exception.
See Also:
#setAttribute(String)

getAttributes

AttributeList getAttributes(String[] names)
Obtains the values of each of the specified attributes of the management bean. The returned list includes those attributes that were retrieved and their corresponding values.

Parameters:
names - the names of the attributes to retrieve.
Returns:
a list of the retrieved attributes.
See Also:
setAttributes(AttributeList)

getMBeanInfo

MBeanInfo getMBeanInfo()
Returns an information object which lists the attributes and actions associated with the management bean.

Returns:
a description of the management bean, including all exposed attributes and actions.

invoke

Object invoke(String name,
              Object[] params,
              String[] signature)
              throws MBeanException,
                     ReflectionException
Invokes the specified action on the management bean using the supplied parameters. The signature of the action is specified by a String array, which lists the classes corresponding to each parameter. The class loader used to load these classes is the same as that used for loading the management bean itself.

Parameters:
name - the name of the action to invoke.
params - the parameters used to call the action.
signature - the signature of the action.
Returns:
the return value of the action.
Throws:
MBeanException - if the action throws an exception. The thrown exception is the cause of this exception.
ReflectionException - if an exception occurred in trying to use the reflection interface to invoke the action. The thrown exception is the cause of this exception.

setAttribute

void setAttribute(Attribute attribute)
                  throws AttributeNotFoundException,
                         InvalidAttributeValueException,
                         MBeanException,
                         ReflectionException
Sets the value of the specified attribute of the management bean. The management bean should perform a lookup for the named attribute, and sets its value using the associated setter method, if possible.

Parameters:
attribute - the attribute to set.
Throws:
AttributeNotFoundException - if the attribute does not correspond to an attribute of the bean.
InvalidAttributeValueException - if the value is invalid for this particular attribute of the bean.
MBeanException - if setting the attribute causes the bean to throw an exception (which becomes the cause of this exception).
ReflectionException - if an exception occurred in trying to use the reflection interface to lookup the attribute. The thrown exception is the cause of this exception.
See Also:
getAttribute(String)

setAttributes

AttributeList setAttributes(AttributeList attributes)
Sets the value of each of the specified attributes to that supplied by the Attribute object. The returned list contains the attributes that were set and their new values.

Parameters:
attributes - the attributes to set.
Returns:
a list of the changed attributes.
See Also:
#getAttributes(AttributeList)