javax.management

Interface DynamicMBean

Known Implementing Classes:
BeanImpl, ClassLoadingMXBeanImpl, CompilationMXBeanImpl, GarbageCollectorMXBeanImpl, MemoryManagerMXBeanImpl, MemoryMXBeanImpl, MemoryPoolMXBeanImpl, OperatingSystemMXBeanImpl, RuntimeMXBeanImpl, StandardMBean, ThreadMXBeanImpl

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 Details

getAttribute

public 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

public 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.

getMBeanInfo

public 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

public 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

public 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.

setAttributes

public 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)

DynamicMBean.java -- A management bean with a dynamic interface. Copyright (C) 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.