Skip navigation links

Oracle® Coherence Java API Reference
Release 3.7.0.0

E18683-01


com.tangosol.net.management
Class AnnotatedStandardMBean

java.lang.Object
  extended by javax.management.StandardMBean
      extended by 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
protected AnnotatedStandardMBean(java.lang.Class clzMBeanIfc)
          Make a DynamicMBean using the specified mbeanInterface class.
  AnnotatedStandardMBean(java.lang.Object impl, java.lang.Class clzMBeanIfc)
          Make a DynamicMBean out of the object implementation, using the specified mbeanInterface class.

 

Method Summary
protected  java.lang.String getDescription(javax.management.MBeanAttributeInfo info)
          Retrieves a description for the particular MBeanAttributeInfo by finding a Description annotation on the getter method for the attribute, if not found on the getter attribute, the setter method will be checked.
protected  java.lang.String getDescription(javax.management.MBeanInfo info)
          Returns the description for the MBean interface.
protected  java.lang.String getDescription(javax.management.MBeanOperationInfo op)
          Retrieves a description for the particular {MBeanOperationInfo} by finding a Description annotation on the operation.
protected  java.lang.String getParameterName(javax.management.MBeanOperationInfo op, javax.management.MBeanParameterInfo param, int iParam)
          

 

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 clzMBeanIfc)
                       throws javax.management.NotCompliantMBeanException
Make a DynamicMBean out of the object implementation, using the specified mbeanInterface class.
Parameters:
impl - The implementation of this MBean
clzMBeanIfc - The Management Interface exported by this 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 this does not implement the specified interface.

AnnotatedStandardMBean

protected AnnotatedStandardMBean(java.lang.Class clzMBeanIfc)
                          throws javax.management.NotCompliantMBeanException
Make a DynamicMBean using the specified mbeanInterface class. This constructor is meant to be used by derived classes implementing the specified interface.
Parameters:
clzMBeanIfc - the Management Interface exported by this MBean
Throws:
javax.management.NotCompliantMBeanException - if the mbeanInterface does not follow JMX design patterns for Management Interfaces, or if this class does not implement the specified interface.

Method Detail

getDescription

protected java.lang.String getDescription(javax.management.MBeanOperationInfo op)
Retrieves a description for the particular {MBeanOperationInfo} by finding a Description annotation on the operation.
Overrides:
getDescription in class javax.management.StandardMBean
Parameters:
op - the MBeanOperationInfo
Returns:
the description for an operation

getDescription

protected java.lang.String getDescription(javax.management.MBeanAttributeInfo info)
Retrieves a description for the particular MBeanAttributeInfo by finding a Description annotation on the getter method for the attribute, if not found on the getter attribute, the setter method will be checked.
Overrides:
getDescription in class javax.management.StandardMBean
Parameters:
info - the MBeanAttributeInfo
Returns:
the description for an attribute

getDescription

protected java.lang.String getDescription(javax.management.MBeanInfo info)
Returns the description for the MBean interface.
Overrides:
getDescription in class javax.management.StandardMBean
Parameters:
info - the MBeanInfo describing the parameter
Returns:
the description

getParameterName

protected java.lang.String getParameterName(javax.management.MBeanOperationInfo op,
                                            javax.management.MBeanParameterInfo param,
                                            int iParam)
Overrides:
getParameterName in class javax.management.StandardMBean

Skip navigation links

Oracle® Coherence Java API Reference
Release 3.7.0.0

E18683-01


Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.