com.lightbend.akka.diagnostics.mbean

Class AnnotatedStandardMXBean

java.lang.Object

javax.management.StandardMBean

com.lightbend.akka.diagnostics.mbean.AnnotatedStandardMXBean

All Implemented Interfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration

public class AnnotatedStandardMXBean
extends javax.management.StandardMBean

INTERNAL API Copied from http://actimem.com/java/jmx-annotations/ which source code is licensed under the Apache License, Version 2.0. The StandardMBean falls short with providing meaningful descriptions and parameter names. This class reads those things from Description and Name annotations of the MBean interface class and methods. Usage: mbeanServer.registerMBean(new AnnotatedStandardMXBean(mbeanImpl, SomeMBean.class), name);

Constructor Summary

Constructors

Constructor and Description
AnnotatedStandardMXBean(T implementation, java.lang.Class<T> mbeanInterface)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getDescription(javax.management.MBeanAttributeInfo info) Returns the description of an Attribute
protected java.lang.String	getDescription(javax.management.MBeanInfo beanInfo)
protected java.lang.String	getDescription(javax.management.MBeanOperationInfo op) Returns the description of an operation
protected java.lang.String	getDescription(javax.management.MBeanOperationInfo op, javax.management.MBeanParameterInfo param, int paramNo) Returns the description of a parameter
protected java.lang.String	getParameterName(javax.management.MBeanOperationInfo op, javax.management.MBeanParameterInfo param, int paramNo) Returns the name of a parameter

Methods inherited from class javax.management.StandardMBean

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotatedStandardMXBean

public AnnotatedStandardMXBean(T implementation,
                               java.lang.Class<T> mbeanInterface)
                        throws javax.management.NotCompliantMBeanException

Parameters:

implementation - the MBean implementation

mbeanInterface - the MBean interface that is annotated with Description and Name.

Throws:

javax.management.NotCompliantMBeanException

Method Detail

getDescription

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

Overrides:

getDescription in class javax.management.StandardMBean

getDescription

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

Returns the description of an Attribute

Overrides:

getDescription in class javax.management.StandardMBean

getDescription

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

Returns the description of an operation

Overrides:

getDescription in class javax.management.StandardMBean

getDescription

protected java.lang.String getDescription(javax.management.MBeanOperationInfo op,
                                          javax.management.MBeanParameterInfo param,
                                          int paramNo)

Returns the description of a parameter

Overrides:

getDescription in class javax.management.StandardMBean

getParameterName

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

Returns the name of a parameter

Overrides:

getParameterName in class javax.management.StandardMBean