Skip navigation links

com.tangosol.net.management
Class AnnotatedStandardMBean

java.lang.Object
javax.management.StandardMBean
com.tangosol.net.management.AnnotatedStandardMBean

All Implemented Interfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration

public class AnnotatedStandardMBean

extends javax.management.StandardMBean

AnnotatedStandardMBean is an extension of a StandardMBean that uses the Description annotation for describing the attributes, operations and the bean on the designated MBean interface.

This class is an extended version of the implementation from Eamon McManus's java.net article

Since:

Coherence 3.7

Author:

cf 2010.12.10

Constructor Summary

AnnotatedStandardMBean(java.lang.Object impl, java.lang.Class clzIface)
Make a DynamicMBean out of the MBean implementation, using the specified mbeanInterface class.

Method Summary

protected java.lang.String	getDescription(javax.management.MBeanAttributeInfo info) Retrieve a description for a particular attribute by finding a Description annotation on the getter method for the attribute.
protected java.lang.String	getDescription(javax.management.MBeanInfo info) Retrieve the description for the MBean from the MBean interface annotation.
protected java.lang.String	getDescription(javax.management.MBeanOperationInfo info) Retrieve a description for the particular MBeanOperationInfo by finding a Description annotation on the corresponding operation.
protected java.lang.String	getParameterName(javax.management.MBeanOperationInfo op, javax.management.MBeanParameterInfo param, int iParam) Retrieve the parameter name for the specified parameter by finding a Description annotation on the operation.

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Constructor Detail

AnnotatedStandardMBean

public AnnotatedStandardMBean(java.lang.Object impl,
                              java.lang.Class clzIface)
                       throws javax.management.NotCompliantMBeanException

Make a DynamicMBean out of the MBean implementation, using the specified mbeanInterface class.

Parameters:

impl - the implementation of the MBean

clzIface - the Management Interface implemented by the MBean's implementation. If null, then this object will use standard JMX design pattern to determine the management interface associated with the given implementation

Throws:

javax.management.NotCompliantMBeanException - if the mbeanInterface does not follow JMX design patterns for Management Interfaces, or if the provided implementation does not implement the specified interface

Method Detail

getDescription

protected java.lang.String getDescription(javax.management.MBeanInfo info)

Retrieve the description for the MBean from the MBean interface annotation.

Overrides:

getDescription in class javax.management.StandardMBean

Parameters:

info - the MBeanInfo for the MBean

Returns:

the MBean description

getDescription

protected java.lang.String getDescription(javax.management.MBeanOperationInfo info)

Retrieve a description for the particular MBeanOperationInfo by finding a Description annotation on the corresponding operation.

Overrides:

getDescription in class javax.management.StandardMBean

Parameters:

info - the MBeanOperationInfo

Returns:

the description for an operation

getDescription

protected java.lang.String getDescription(javax.management.MBeanAttributeInfo info)

Retrieve a description for a particular attribute by finding a Description annotation on the getter method for the attribute. If a description is not found on the getter method, the setter will be checked.

Overrides:

getDescription in class javax.management.StandardMBean

Parameters:

info - the MBeanAttributeInfo for the attribute

Returns:

the description for an attribute

getParameterName

protected java.lang.String getParameterName(javax.management.MBeanOperationInfo op,
                                            javax.management.MBeanParameterInfo param,
                                            int iParam)

Retrieve the parameter name for the specified parameter by finding a Description annotation on the operation.

Overrides:

getParameterName in class javax.management.StandardMBean

Parameters:

op - the MBeanOperationInfo for the op

param - the MBeanParameterInfo} for the parameter

iParam - zero-based sequence number of the parameter

Returns:

the name to use for the given MBeanParameterInfo.

Skip navigation links