public abstract class

AbstractReflectiveMBeanInfoAssembler

extends AbstractMBeanInfoAssembler
java.lang.Object
   ↳ org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler
     ↳ org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Builds on the AbstractMBeanInfoAssembler superclass to add a basic algorithm for building metadata based on the reflective metadata of the MBean class.

The logic for creating MBean metadata from the reflective metadata is contained in this class, but this class makes no decisions as to which methods and properties are to be exposed. Instead it gives subclasses a chance to 'vote' on each property or method through the includeXXX methods.

Subclasses are also given the opportunity to populate attribute and operation metadata with additional descriptors once the metadata is assembled through the populateXXXDescriptor methods.

See Also

Summary

Constants
int ATTRIBUTE_OPERATION_VISIBILITY Lowest visibility, used for operations that correspond to accessors or mutators for attributes.
String FIELD_CLASS Constant identifier for the class field in a JMX Descriptor.
String FIELD_CURRENCY_TIME_LIMIT Constant identifier for the currency time limit field in a JMX Descriptor.
String FIELD_DEFAULT Constant identifier for the default field in a JMX Descriptor.
String FIELD_DISPLAY_NAME Constant identifier for the displayName field in a JMX Descriptor.
String FIELD_GET_METHOD Identifies a getter method in a JMX Descriptor.
String FIELD_LOG Constant identifier for the log field in a JMX Descriptor.
String FIELD_LOG_FILE Constant identifier for the logfile field in a JMX Descriptor.
String FIELD_METRIC_CATEGORY Constant identifier for the custom metricCategory field in a JMX Descriptor.
String FIELD_METRIC_TYPE Constant identifier for the metricType field in a JMX Descriptor.
String FIELD_PERSIST_LOCATION Constant identifier for the persistLocation field in a JMX Descriptor.
String FIELD_PERSIST_NAME Constant identifier for the persistName field in a JMX Descriptor.
String FIELD_PERSIST_PERIOD Constant identifier for the persistPeriod field in a JMX Descriptor.
String FIELD_PERSIST_POLICY Constant identifier for the persistPolicy field in a JMX Descriptor.
String FIELD_ROLE Constant identifier for the role field in a JMX Descriptor.
String FIELD_SET_METHOD Identifies a setter method in a JMX Descriptor.
String FIELD_UNITS Constant identifier for the units field in a JMX Descriptor.
String FIELD_VISIBILITY Constant identifier for the visibility field in a JMX Descriptor.
String ROLE_GETTER Constant identifier for the getter role field value in a JMX Descriptor.
String ROLE_OPERATION Identifies an operation (method) in a JMX Descriptor.
String ROLE_SETTER Constant identifier for the setter role field value in a JMX Descriptor.
Public Constructors
AbstractReflectiveMBeanInfoAssembler()
Public Methods
void setDefaultCurrencyTimeLimit(Integer defaultCurrencyTimeLimit)
Set the default for the JMX field "currencyTimeLimit".
void setExposeClassDescriptor(boolean exposeClassDescriptor)
Set whether to expose the JMX descriptor field "class" for managed operations.
void setUseStrictCasing(boolean useStrictCasing)
Set whether to use strict casing for attributes.
Protected Methods
void applyCurrencyTimeLimit(Descriptor desc, int currencyTimeLimit)
Apply the given JMX "currencyTimeLimit" value to the given descriptor.
final void applyDefaultCurrencyTimeLimit(Descriptor desc)
Set the currencyTimeLimit field to the specified "defaultCurrencyTimeLimit", if any (by default none).
ModelMBeanOperationInfo createModelMBeanOperationInfo(Method method, String name, String beanKey)
Creates an instance of ModelMBeanOperationInfo for the given method.
String getAttributeDescription(PropertyDescriptor propertyDescriptor, String beanKey)
Get the description for a particular attribute.
ModelMBeanAttributeInfo[] getAttributeInfo(Object managedBean, String beanKey)
Iterate through all properties on the MBean class and gives subclasses the chance to vote on the inclusion of both the accessor and mutator.
Class getClassForDescriptor(Object managedBean)
Return the class to be used for the JMX descriptor field "class".
Integer getDefaultCurrencyTimeLimit()
Return default value for the JMX field "currencyTimeLimit", if any.
String getOperationDescription(Method method, String beanKey)
Get the description for a particular operation.
ModelMBeanOperationInfo[] getOperationInfo(Object managedBean, String beanKey)
Iterate through all methods on the MBean class and gives subclasses the chance to vote on their inclusion.
MBeanParameterInfo[] getOperationParameters(Method method, String beanKey)
Create parameter info for the given method.
abstract boolean includeOperation(Method method, String beanKey)
Allows subclasses to vote on the inclusion of a particular operation.
abstract boolean includeReadAttribute(Method method, String beanKey)
Allows subclasses to vote on the inclusion of a particular attribute accessor.
abstract boolean includeWriteAttribute(Method method, String beanKey)
Allows subclasses to vote on the inclusion of a particular attribute mutator.
boolean isExposeClassDescriptor()
Return whether to expose the JMX descriptor field "class" for managed operations.
boolean isUseStrictCasing()
Return whether strict casing for attributes is enabled.
void populateAttributeDescriptor(Descriptor desc, Method getter, Method setter, String beanKey)
Allows subclasses to add extra fields to the Descriptor for a particular attribute.
void populateMBeanDescriptor(Descriptor descriptor, Object managedBean, String beanKey)
Allows subclasses to add extra fields to the Descriptor for an MBean.
void populateOperationDescriptor(Descriptor desc, Method method, String beanKey)
Allows subclasses to add extra fields to the Descriptor for a particular operation.
[Expand]
Inherited Methods
From class org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler
From class java.lang.Object
From interface org.springframework.jmx.export.assembler.MBeanInfoAssembler

Constants

protected static final int ATTRIBUTE_OPERATION_VISIBILITY

Lowest visibility, used for operations that correspond to accessors or mutators for attributes.

See Also
Constant Value: 4 (0x00000004)

protected static final String FIELD_CLASS

Constant identifier for the class field in a JMX Descriptor.

Constant Value: "class"

protected static final String FIELD_CURRENCY_TIME_LIMIT

Constant identifier for the currency time limit field in a JMX Descriptor.

Constant Value: "currencyTimeLimit"

protected static final String FIELD_DEFAULT

Constant identifier for the default field in a JMX Descriptor.

Constant Value: "default"

protected static final String FIELD_DISPLAY_NAME

Constant identifier for the displayName field in a JMX Descriptor.

Constant Value: "displayName"

protected static final String FIELD_GET_METHOD

Identifies a getter method in a JMX Descriptor.

Constant Value: "getMethod"

protected static final String FIELD_LOG

Constant identifier for the log field in a JMX Descriptor.

Constant Value: "log"

protected static final String FIELD_LOG_FILE

Constant identifier for the logfile field in a JMX Descriptor.

Constant Value: "logFile"

protected static final String FIELD_METRIC_CATEGORY

Constant identifier for the custom metricCategory field in a JMX Descriptor.

Constant Value: "metricCategory"

protected static final String FIELD_METRIC_TYPE

Constant identifier for the metricType field in a JMX Descriptor.

Constant Value: "metricType"

protected static final String FIELD_PERSIST_LOCATION

Constant identifier for the persistLocation field in a JMX Descriptor.

Constant Value: "persistLocation"

protected static final String FIELD_PERSIST_NAME

Constant identifier for the persistName field in a JMX Descriptor.

Constant Value: "persistName"

protected static final String FIELD_PERSIST_PERIOD

Constant identifier for the persistPeriod field in a JMX Descriptor.

Constant Value: "persistPeriod"

protected static final String FIELD_PERSIST_POLICY

Constant identifier for the persistPolicy field in a JMX Descriptor.

Constant Value: "persistPolicy"

protected static final String FIELD_ROLE

Constant identifier for the role field in a JMX Descriptor.

Constant Value: "role"

protected static final String FIELD_SET_METHOD

Identifies a setter method in a JMX Descriptor.

Constant Value: "setMethod"

protected static final String FIELD_UNITS

Constant identifier for the units field in a JMX Descriptor.

Constant Value: "units"

protected static final String FIELD_VISIBILITY

Constant identifier for the visibility field in a JMX Descriptor.

Constant Value: "visibility"

protected static final String ROLE_GETTER

Constant identifier for the getter role field value in a JMX Descriptor.

Constant Value: "getter"

protected static final String ROLE_OPERATION

Identifies an operation (method) in a JMX Descriptor.

Constant Value: "operation"

protected static final String ROLE_SETTER

Constant identifier for the setter role field value in a JMX Descriptor.

Constant Value: "setter"

Public Constructors

public AbstractReflectiveMBeanInfoAssembler ()

Public Methods

public void setDefaultCurrencyTimeLimit (Integer defaultCurrencyTimeLimit)

Set the default for the JMX field "currencyTimeLimit". The default will usually indicate to never cache attribute values.

Default is none, not explicitly setting that field, as recommended by the JMX 1.2 specification. This should result in "never cache" behavior, always reading attribute values freshly (which corresponds to a "currencyTimeLimit" of -1 in JMX 1.2).

However, some JMX implementations (that do not follow the JMX 1.2 spec in that respect) might require an explicit value to be set here to get "never cache" behavior: for example, JBoss 3.2.x.

Note that the "currencyTimeLimit" value can also be specified on a managed attribute or operation. The default value will apply if not overridden with a "currencyTimeLimit" value >= 0 there: a metadata "currencyTimeLimit" value of -1 indicates to use the default; a value of 0 indicates to "always cache" and will be translated to Integer.MAX_VALUE; a positive value indicates the number of cache seconds.

See Also

public void setExposeClassDescriptor (boolean exposeClassDescriptor)

Set whether to expose the JMX descriptor field "class" for managed operations. Default is "false", letting the JMX implementation determine the actual class through reflection.

Set this property to true for JMX implementations that require the "class" field to be specified, for example WebLogic's. In that case, Spring will expose the target class name there, in case of a plain bean instance or a CGLIB proxy. When encountering a JDK dynamic proxy, the first interface implemented by the proxy will be specified.

WARNING: Review your proxy definitions when exposing a JDK dynamic proxy through JMX, in particular with this property turned to true: the specified interface list should start with your management interface in this case, with all other interfaces following. In general, consider exposing your target bean directly or a CGLIB proxy for it instead.

See Also

public void setUseStrictCasing (boolean useStrictCasing)

Set whether to use strict casing for attributes. Enabled by default.

When using strict casing, a JavaBean property with a getter such as getFoo() translates to an attribute called Foo. With strict casing disabled, getFoo() would translate to just foo.

Protected Methods

protected void applyCurrencyTimeLimit (Descriptor desc, int currencyTimeLimit)

Apply the given JMX "currencyTimeLimit" value to the given descriptor.

The default implementation sets a value >0 as-is (as number of cache seconds), turns a value of 0 into Integer.MAX_VALUE ("always cache") and sets the "defaultCurrencyTimeLimit" (if any, indicating "never cache") in case of a value <0. This follows the recommendation in the JMX 1.2 specification.

Parameters
desc the JMX attribute or operation descriptor
currencyTimeLimit the "currencyTimeLimit" value to apply
See Also

protected final void applyDefaultCurrencyTimeLimit (Descriptor desc)

Set the currencyTimeLimit field to the specified "defaultCurrencyTimeLimit", if any (by default none).

Parameters
desc the JMX attribute or operation descriptor
See Also

protected ModelMBeanOperationInfo createModelMBeanOperationInfo (Method method, String name, String beanKey)

Creates an instance of ModelMBeanOperationInfo for the given method. Populates the parameter info for the operation.

Parameters
method the Method to create a ModelMBeanOperationInfo for
name the name for the operation info
beanKey the key associated with the MBean in the beans map of the MBeanExporter
Returns
  • the ModelMBeanOperationInfo

protected String getAttributeDescription (PropertyDescriptor propertyDescriptor, String beanKey)

Get the description for a particular attribute.

The default implementation returns a description for the operation that is the name of corresponding Method.

Parameters
propertyDescriptor the PropertyDescriptor for the attribute
beanKey the key associated with the MBean in the beans map of the MBeanExporter
Returns
  • the description for the attribute

protected ModelMBeanAttributeInfo[] getAttributeInfo (Object managedBean, String beanKey)

Iterate through all properties on the MBean class and gives subclasses the chance to vote on the inclusion of both the accessor and mutator. If a particular accessor or mutator is voted for inclusion, the appropriate metadata is assembled and passed to the subclass for descriptor population.

Parameters
managedBean the bean instance (might be an AOP proxy)
beanKey the key associated with the MBean in the beans map of the MBeanExporter
Returns
  • the attribute metadata
Throws
JMException in case of errors
See Also

protected Class getClassForDescriptor (Object managedBean)

Return the class to be used for the JMX descriptor field "class". Only applied when the "exposeClassDescriptor" property is "true".

The default implementation returns the first implemented interface for a JDK proxy, and the target class else.

Parameters
managedBean the bean instance (might be an AOP proxy)
Returns
  • the class to expose in the descriptor field "class"
See Also

protected Integer getDefaultCurrencyTimeLimit ()

Return default value for the JMX field "currencyTimeLimit", if any.

protected String getOperationDescription (Method method, String beanKey)

Get the description for a particular operation.

The default implementation returns a description for the operation that is the name of corresponding Method.

Parameters
method the operation method
beanKey the key associated with the MBean in the beans map of the MBeanExporter
Returns
  • the description for the operation

protected ModelMBeanOperationInfo[] getOperationInfo (Object managedBean, String beanKey)

Iterate through all methods on the MBean class and gives subclasses the chance to vote on their inclusion. If a particular method corresponds to the accessor or mutator of an attribute that is inclued in the managment interface, then the corresponding operation is exposed with the "role" descriptor field set to the appropriate value.

Parameters
managedBean the bean instance (might be an AOP proxy)
beanKey the key associated with the MBean in the beans map of the MBeanExporter
Returns
  • the operation metadata
See Also

protected MBeanParameterInfo[] getOperationParameters (Method method, String beanKey)

Create parameter info for the given method.

The default implementation returns an empty arry of MBeanParameterInfo.

Parameters
method the Method to get the parameter information for
beanKey the key associated with the MBean in the beans map of the MBeanExporter
Returns
  • the MBeanParameterInfo array

protected abstract boolean includeOperation (Method method, String beanKey)

Allows subclasses to vote on the inclusion of a particular operation.

Parameters
method the operation method
beanKey the key associated with the MBean in the beans map of the MBeanExporter
Returns
  • whether the operation should be included in the management interface

protected abstract boolean includeReadAttribute (Method method, String beanKey)

Allows subclasses to vote on the inclusion of a particular attribute accessor.

Parameters
method the accessor Method
beanKey the key associated with the MBean in the beans map of the MBeanExporter
Returns
  • true if the accessor should be included in the management interface, otherwise false

protected abstract boolean includeWriteAttribute (Method method, String beanKey)

Allows subclasses to vote on the inclusion of a particular attribute mutator.

Parameters
method the mutator Method.
beanKey the key associated with the MBean in the beans map of the MBeanExporter
Returns
  • true if the mutator should be included in the management interface, otherwise false

protected boolean isExposeClassDescriptor ()

Return whether to expose the JMX descriptor field "class" for managed operations.

protected boolean isUseStrictCasing ()

Return whether strict casing for attributes is enabled.

protected void populateAttributeDescriptor (Descriptor desc, Method getter, Method setter, String beanKey)

Allows subclasses to add extra fields to the Descriptor for a particular attribute.

The default implementation sets the currencyTimeLimit field to the specified "defaultCurrencyTimeLimit", if any (by default none).

Parameters
desc the attribute descriptor
getter the accessor method for the attribute
setter the mutator method for the attribute
beanKey the key associated with the MBean in the beans map of the MBeanExporter
See Also

protected void populateMBeanDescriptor (Descriptor descriptor, Object managedBean, String beanKey)

Allows subclasses to add extra fields to the Descriptor for an MBean.

The default implementation sets the currencyTimeLimit field to the specified "defaultCurrencyTimeLimit", if any (by default none).

Parameters
descriptor the Descriptor for the MBean resource.
managedBean the bean instance (might be an AOP proxy)
beanKey the key associated with the MBean in the beans map of the MBeanExporter
See Also

protected void populateOperationDescriptor (Descriptor desc, Method method, String beanKey)

Allows subclasses to add extra fields to the Descriptor for a particular operation.

The default implementation sets the currencyTimeLimit field to the specified "defaultCurrencyTimeLimit", if any (by default none).

Parameters
desc the operation descriptor
method the method corresponding to the operation
beanKey the key associated with the MBean in the beans map of the MBeanExporter
See Also