Package com.tangosol.net.management

Class AnnotatedStandardEmitterMBean

java.lang.Object

javax.management.StandardMBean

javax.management.StandardEmitterMBean

com.tangosol.net.management.AnnotatedStandardEmitterMBean

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, NotificationBroadcaster, NotificationEmitter

public class AnnotatedStandardEmitterMBean
extends StandardEmitterMBean

AnnotatedStandardEmitterMBean is an extension of a StandardEmitterMBean that uses the Description and Notification annotations to describe the MBean and any attributes, operations and notifications it declares.

The implementation of this class is basically identical to the AnnotatedStandardMBean class.

Since:

Coherence 12.1.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AnnotatedStandardEmitterMBean.SilentEmitter	A silent NotificationEmitter implementation for all NotificationEmitter methods except getNotificationInfo().

Constructor Summary

Constructors

Constructor	Description
AnnotatedStandardEmitterMBean(T impl, Class<T> clzIface)	Make a DynamicMBean out of the MBean implementation, using the specified mbeanInterface class.

Method Summary

Modifier and Type	Method	Description
protected String	getDescription(MBeanAttributeInfo info)	Retrieve a description for a particular attribute by finding a Description annotation on the getter method for the attribute.
protected String	getDescription(MBeanInfo info)	Retrieve the description for the MBean from the MBean interface annotation.
protected String	getDescription(MBeanOperationInfo info)	Retrieve a description for the particular MBeanOperationInfo by finding a Description annotation on the corresponding operation.
MBeanNotificationInfo[]	getNotificationInfo()
protected String	getParameterName(MBeanOperationInfo op, 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.StandardEmitterMBean

addNotificationListener, removeNotificationListener, removeNotificationListener, sendNotification

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedStandardEmitterMBean

public AnnotatedStandardEmitterMBean(T impl,
                                     Class<T> clzIface)
                              throws NotCompliantMBeanException

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

Type Parameters:

T - the type of the MBean implementation

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:

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 String getDescription(MBeanInfo info)

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

Overrides:

getDescription in class StandardMBean

Parameters:

info - the MBeanInfo for the MBean

Returns:

the MBean description

getDescription

protected String getDescription(MBeanOperationInfo info)

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

Overrides:

getDescription in class StandardMBean

Parameters:

info - the MBeanOperationInfo

Returns:

the description for an operation

getDescription

protected String getDescription(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 StandardMBean

Parameters:

info - the MBeanAttributeInfo for the attribute

Returns:

the description for an attribute

getParameterName

protected String getParameterName(MBeanOperationInfo op,
                                  MBeanParameterInfo param,
                                  int iParam)

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

Overrides:

getParameterName in class 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.

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

Specified by:

getNotificationInfo in interface NotificationBroadcaster

Overrides:

getNotificationInfo in class StandardEmitterMBean