|
SolarMetric Kodo JDO 3.2.4 generated on January 7 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.solarmetric.manage.jmx.mx4j.AbstractDynamicMBean
Utility class that allow the user to easily write DynamicMBeans.
By extending this class, the developer does not have to implement the methods
of the DynamicMBean interface, but
has instead to provide only the metadata (by overriding few methods) and the
implementation (by implementing the methods) of the MBean itself.
The methods to override that provides metadata information are usually the
following:
createMBeanAttributeInfo
, if the MBeans has manageable
attributes createMBeanOperationInfo
, if the MBeans has manageable
operations createMBeanNotificationInfo
, if the MBeans has manageable
notifications createMBeanConstructorInfo
, if the MBeans has manageable
constructors getMBeanDescription
public class SimpleDynamic extends AbstractDynamicMBean { protected MBeanAttributeInfo[] createMBeanAttributeInfo() { return new MBeanAttributeInfo[] { new MBeanAttributeInfo("Name", String.class.getName(), "The name", true, true, false) }; } protected String getMBeanDescription() { return "A simple DynamicMBean"; } public String getName() { ... } public void setName(String name) { ... } }It is responsibility of the developer to specify the metadata and implement the methods specified by the metadata, that will be invoked via reflection by the AbstractDynamicMBean class. For this reason, the methods belonging to the MBean implementation (in the case above
getName()
and setName(...)
)
must be public.
Constructor Summary | |
protected |
AbstractDynamicMBean()
Only subclasses can create a new instance of an AbstractDynamicMBean. |
Method Summary | |
protected javax.management.MBeanAttributeInfo[] |
createMBeanAttributeInfo()
To be overridden to return metadata information about manageable attributes. |
protected javax.management.MBeanConstructorInfo[] |
createMBeanConstructorInfo()
To be overridden to return metadata information about manageable constructors. |
protected javax.management.MBeanInfo |
createMBeanInfo()
Creates the MBeanInfo for this instance, calling in succession factory methods that the user can override. |
protected javax.management.MBeanNotificationInfo[] |
createMBeanNotificationInfo()
To be overridden to return metadata information about manageable notifications. |
protected javax.management.MBeanOperationInfo[] |
createMBeanOperationInfo()
To be overridden to return metadata information about manageable operations. |
protected Method |
findMethod(Class cls,
String name,
Class[] params)
Returns the (public) method with the given name and signature on the given class. |
Object |
getAttribute(String attribute)
Returns the value of the manageable attribute, as specified by the DynamicMBean interface. |
javax.management.AttributeList |
getAttributes(String[] attributes)
Returns the manageable attributes, as specified by the DynamicMBean interface. |
protected String |
getMBeanClassName()
To be overridden to return metadata information about the class name of this MBean; by default returns this class' name. |
protected String |
getMBeanDescription()
To be overridden to return metadata information about the description of this MBean. |
javax.management.MBeanInfo |
getMBeanInfo()
Returns the MBeaInfo, as specified by the DynamicMBean interface; the default implementation caches the value returned by createMBeanInfo() (that is thus called only once). |
protected Object |
getResource()
Returns the resource object on which invoke attribute's getters, attribute's setters and operation's methods |
protected Object |
invoke(String name,
Class[] params,
Object[] args)
Looks up the method to call on the object set as resource (see setResource(java.lang.Object) ) and invokes it. |
Object |
invoke(String method,
Object[] arguments,
String[] params)
Returns the value of the manageable operation as specified by the DynamicMBean interface |
protected Object |
invokeMethod(Method method,
Object resource,
Object[] args)
Invokes the given method on the given resource object with the given arguments. |
void |
setAttribute(javax.management.Attribute attribute)
Sets the value of the manageable attribute, as specified by the DynamicMBean interface. |
javax.management.AttributeList |
setAttributes(javax.management.AttributeList attributes)
Sets the manageable attributes, as specified by the DynamicMBean interface. |
protected void |
setMBeanInfo(javax.management.MBeanInfo info)
Sets the MBeanInfo object cached by this instance. |
void |
setResource(Object resource)
Specifies the resource object on which invoke attribute's getters, attribute's setters and operation's methods. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected AbstractDynamicMBean()
createMBeanConstructorInfo()
Method Detail |
public Object getAttribute(String attribute) throws javax.management.AttributeNotFoundException, javax.management.MBeanException, javax.management.ReflectionException
getAttribute
in interface javax.management.DynamicMBean
createMBeanAttributeInfo()
public javax.management.AttributeList getAttributes(String[] attributes)
getAttributes
in interface javax.management.DynamicMBean
public javax.management.MBeanInfo getMBeanInfo()
createMBeanInfo()
(that is thus called only once).getMBeanInfo
in interface javax.management.DynamicMBean
createMBeanInfo()
,
setMBeanInfo(javax.management.MBeanInfo)
public Object invoke(String method, Object[] arguments, String[] params) throws javax.management.MBeanException, javax.management.ReflectionException
invoke
in interface javax.management.DynamicMBean
createMBeanOperationInfo()
public void setAttribute(javax.management.Attribute attribute) throws javax.management.AttributeNotFoundException, javax.management.InvalidAttributeValueException, javax.management.MBeanException, javax.management.ReflectionException
setAttribute
in interface javax.management.DynamicMBean
createMBeanAttributeInfo()
public javax.management.AttributeList setAttributes(javax.management.AttributeList attributes)
setAttributes
in interface javax.management.DynamicMBean
protected Object invoke(String name, Class[] params, Object[] args) throws javax.management.InvalidAttributeValueException, javax.management.MBeanException, javax.management.ReflectionException
setResource(java.lang.Object)
) and invokes it.
If the resource object is not specified, defaults to 'this'.
The default implementation requires that the methods that implement
attribute and operation behavior
on the resource object are public, but it is possible to override this
behavior, and call
also private methods.findMethod(java.lang.Class, java.lang.String, java.lang.Class[])
,
invokeMethod(java.lang.reflect.Method, java.lang.Object, java.lang.Object[])
protected Method findMethod(Class cls, String name, Class[] params) throws NoSuchMethodException
invoke(String, Class[], Object[])
,
invokeMethod(java.lang.reflect.Method, java.lang.Object, java.lang.Object[])
protected Object invokeMethod(Method method, Object resource, Object[] args) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException
invoke(String, Class[], Object[])
,
findMethod(java.lang.Class, java.lang.String, java.lang.Class[])
protected Object getResource()
setResource(java.lang.Object)
public void setResource(Object resource)
getResource()
protected void setMBeanInfo(javax.management.MBeanInfo info)
getMBeanInfo()
protected javax.management.MBeanInfo createMBeanInfo()
createMBeanAttributeInfo()
createMBeanConstructorInfo()
createMBeanOperationInfo()
createMBeanNotificationInfo()
getMBeanClassName()
getMBeanDescription()
protected javax.management.MBeanAttributeInfo[] createMBeanAttributeInfo()
protected javax.management.MBeanConstructorInfo[] createMBeanConstructorInfo()
protected javax.management.MBeanOperationInfo[] createMBeanOperationInfo()
protected javax.management.MBeanNotificationInfo[] createMBeanNotificationInfo()
protected String getMBeanClassName()
protected String getMBeanDescription()
|
SolarMetric Kodo JDO 3.2.4 generated on January 7 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |