Spring Framework 6.1.4 · org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler

Field Summary

Modifier and Type	Field and Description
protected static final int	ATTRIBUTE_OPERATION_VISIBILITY Lowest visibility, used for operations that correspond to accessors or mutators for attributes.
private Integer	defaultCurrencyTimeLimit Default value for the JMX field "currencyTimeLimit".
private boolean	exposeClassDescriptor
protected static final String	FIELD_CLASS Constant identifier for the class field in a JMX `Descriptor`.
protected static final String	FIELD_CURRENCY_TIME_LIMIT Constant identifier for the currency time limit field in a JMX `Descriptor`.
protected static final String	FIELD_DEFAULT Constant identifier for the default field in a JMX `Descriptor`.
protected static final String	FIELD_DISPLAY_NAME Constant identifier for the displayName field in a JMX `Descriptor`.
protected static final String	FIELD_GET_METHOD Identifies a getter method in a JMX `Descriptor`.
protected static final String	FIELD_LOG Constant identifier for the log field in a JMX `Descriptor`.
protected static final String	FIELD_LOG_FILE Constant identifier for the logfile field in a JMX `Descriptor`.
protected static final String	FIELD_METRIC_CATEGORY Constant identifier for the custom metricCategory field in a JMX `Descriptor`.
protected static final String	FIELD_METRIC_TYPE Constant identifier for the metricType field in a JMX `Descriptor`.
protected static final String	FIELD_PERSIST_LOCATION Constant identifier for the persistLocation field in a JMX `Descriptor`.
protected static final String	FIELD_PERSIST_NAME Constant identifier for the persistName field in a JMX `Descriptor`.
protected static final String	FIELD_PERSIST_PERIOD Constant identifier for the persistPeriod field in a JMX `Descriptor`.
protected static final String	FIELD_PERSIST_POLICY Constant identifier for the persistPolicy field in a JMX `Descriptor`.
protected static final String	FIELD_ROLE Constant identifier for the role field in a JMX `Descriptor`.
protected static final String	FIELD_SET_METHOD Identifies a setter method in a JMX `Descriptor`.
protected static final String	FIELD_UNITS Constant identifier for the units field in a JMX `Descriptor`.
protected static final String	FIELD_VISIBILITY Constant identifier for the visibility field in a JMX `Descriptor`.
private ParameterNameDiscoverer	parameterNameDiscoverer
protected static final String	ROLE_GETTER Constant identifier for the getter role field value in a JMX `Descriptor`.
protected static final String	ROLE_OPERATION Identifies an operation (method) in a JMX `Descriptor`.
protected static final String	ROLE_SETTER Constant identifier for the setter role field value in a JMX `Descriptor`.
private boolean	useStrictCasing Indicates whether strict casing is being used for attributes.

Constructor Summary

Access	Constructor and Description
public	AbstractReflectiveMBeanInfoAssembler()

Method Summary

Modifier and Type	Method and Description
protected void	applyCurrencyTimeLimit(Descriptor the JMX attribute or operation descriptor desc, int the "currencyTimeLimit" value to apply currencyTimeLimit) Apply the given JMX "currencyTimeLimit" value to the given descriptor.
protected final void	applyDefaultCurrencyTimeLimit(Descriptor the JMX attribute or operation descriptor desc) Set the `currencyTimeLimit` field to the specified "defaultCurrencyTimeLimit", if any (by default none).
protected ModelMBeanOperationInfo	Returns: the `ModelMBeanOperationInfo` createModelMBeanOperationInfo(Method the `Method` to create a `ModelMBeanOperationInfo` for method, String the logical name for the operation (method name or property name); not used by the default implementation but possibly by subclasses name, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Creates an instance of `ModelMBeanOperationInfo` for the given method.
protected String	Returns: the description for the attribute getAttributeDescription(PropertyDescriptor the PropertyDescriptor for the attribute propertyDescriptor, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Get the description for a particular attribute.
protected ModelMBeanAttributeInfo[]	Returns: the attribute metadata getAttributeInfo(Object the bean instance (might be an AOP proxy) managedBean, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Implements abstract org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler.getAttributeInfo. Iterate through all properties on the MBean class and gives subclasses the chance to vote on the inclusion of both the accessor and mutator.
protected Class<?>	Returns: the class to expose in the descriptor field "class" getClassForDescriptor(Object the bean instance (might be an AOP proxy) managedBean) Return the class to be used for the JMX descriptor field "class".
protected Integer	getDefaultCurrencyTimeLimit() Return default value for the JMX field "currencyTimeLimit", if any.
protected String	Returns: the description for the operation getOperationDescription(Method the operation method method, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Get the description for a particular operation.
protected ModelMBeanOperationInfo[]	Returns: the operation metadata getOperationInfo(Object the bean instance (might be an AOP proxy) managedBean, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Implements abstract org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler.getOperationInfo. Iterate through all methods on the MBean class and gives subclasses the chance to vote on their inclusion.
protected MBeanParameterInfo[]	Returns: the `MBeanParameterInfo` array getOperationParameters(Method the `Method` to get the parameter information for method, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Create parameter info for the given method.
protected ParameterNameDiscoverer	getParameterNameDiscoverer() Return the ParameterNameDiscoverer to use for resolving method parameter names if needed (may be `null` in order to skip parameter detection).
protected abstract boolean	Returns: whether the operation should be included in the management interface includeOperation(Method the operation method method, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Allows subclasses to vote on the inclusion of a particular operation.
protected abstract boolean	Returns: `true` if the accessor should be included in the management interface, otherwise `false` includeReadAttribute(Method the accessor `Method` method, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Allows subclasses to vote on the inclusion of a particular attribute accessor.
protected abstract boolean	Returns: `true` if the mutator should be included in the management interface, otherwise `false` includeWriteAttribute(Method the mutator `Method`. method, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Allows subclasses to vote on the inclusion of a particular attribute mutator.
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 the attribute descriptor desc, Method the accessor method for the attribute getter, Method the mutator method for the attribute setter, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Allows subclasses to add extra fields to the `Descriptor` for a particular attribute.
protected void	populateMBeanDescriptor(Descriptor the `Descriptor` for the MBean resource. descriptor, Object the bean instance (might be an AOP proxy) managedBean, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Overrides org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler.populateMBeanDescriptor. Allows subclasses to add extra fields to the `Descriptor` for an MBean.
protected void	populateOperationDescriptor(Descriptor the operation descriptor desc, Method the method corresponding to the operation method, String the key associated with the MBean in the beans map of the `MBeanExporter` beanKey) Allows subclasses to add extra fields to the `Descriptor` for a particular operation.
public void	setDefaultCurrencyTimeLimit(Integer defaultCurrencyTimeLimit) Set the default for the JMX field "currencyTimeLimit".
public void	setExposeClassDescriptor(boolean exposeClassDescriptor) Set whether to expose the JMX descriptor field "class" for managed operations.
public void	setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer) Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (e.g. for parameter names of MBean operation methods).
public void	setUseStrictCasing(boolean useStrictCasing) Set whether to use strict casing for attributes.

Inherited from org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler:: checkManagedBean getClassName getClassToExpose getClassToExpose getConstructorInfo getDescription getMBeanInfo getNotificationInfo getTargetClass

Field Detail

ATTRIBUTE_OPERATION_VISIBILITY back to summary

ATTRIBUTE_OPERATION_VISIBILITY	back to summary
protected static final int ATTRIBUTE_OPERATION_VISIBILITY Lowest visibility, used for operations that correspond to accessors or mutators for attributes. See Also `FIELD_VISIBILITY`

protected static final int ATTRIBUTE_OPERATION_VISIBILITY

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

See Also: FIELD_VISIBILITY

defaultCurrencyTimeLimit	back to summary
private Integer defaultCurrencyTimeLimit Default value for the JMX field "currencyTimeLimit". Annotations @Nullable

exposeClassDescriptor	back to summary
private boolean exposeClassDescriptor

FIELD_CLASS	back to summary
protected static final String FIELD_CLASS Constant identifier for the class field in a JMX `Descriptor`.

FIELD_CURRENCY_TIME_LIMIT	back to summary
protected static final String FIELD_CURRENCY_TIME_LIMIT Constant identifier for the currency time limit field in a JMX `Descriptor`.

FIELD_DEFAULT	back to summary
protected static final String FIELD_DEFAULT Constant identifier for the default field in a JMX `Descriptor`.

FIELD_DISPLAY_NAME	back to summary
protected static final String FIELD_DISPLAY_NAME Constant identifier for the displayName field in a JMX `Descriptor`.

FIELD_GET_METHOD	back to summary
protected static final String FIELD_GET_METHOD Identifies a getter method in a JMX `Descriptor`.

FIELD_LOG	back to summary
protected static final String FIELD_LOG Constant identifier for the log field in a JMX `Descriptor`.

FIELD_LOG_FILE	back to summary
protected static final String FIELD_LOG_FILE Constant identifier for the logfile field in a JMX `Descriptor`.

FIELD_METRIC_CATEGORY	back to summary
protected static final String FIELD_METRIC_CATEGORY Constant identifier for the custom metricCategory field in a JMX `Descriptor`.

FIELD_METRIC_TYPE	back to summary
protected static final String FIELD_METRIC_TYPE Constant identifier for the metricType field in a JMX `Descriptor`.

FIELD_PERSIST_LOCATION	back to summary
protected static final String FIELD_PERSIST_LOCATION Constant identifier for the persistLocation field in a JMX `Descriptor`.

FIELD_PERSIST_NAME	back to summary
protected static final String FIELD_PERSIST_NAME Constant identifier for the persistName field in a JMX `Descriptor`.

FIELD_PERSIST_PERIOD	back to summary
protected static final String FIELD_PERSIST_PERIOD Constant identifier for the persistPeriod field in a JMX `Descriptor`.

FIELD_PERSIST_POLICY	back to summary
protected static final String FIELD_PERSIST_POLICY Constant identifier for the persistPolicy field in a JMX `Descriptor`.

FIELD_ROLE	back to summary
protected static final String FIELD_ROLE Constant identifier for the role field in a JMX `Descriptor`.

FIELD_SET_METHOD	back to summary
protected static final String FIELD_SET_METHOD Identifies a setter method in a JMX `Descriptor`.

FIELD_UNITS	back to summary
protected static final String FIELD_UNITS Constant identifier for the units field in a JMX `Descriptor`.

FIELD_VISIBILITY	back to summary
protected static final String FIELD_VISIBILITY Constant identifier for the visibility field in a JMX `Descriptor`.

parameterNameDiscoverer	back to summary
private ParameterNameDiscoverer parameterNameDiscoverer Annotations @Nullable

ROLE_GETTER	back to summary
protected static final String ROLE_GETTER Constant identifier for the getter role field value in a JMX `Descriptor`.

ROLE_OPERATION	back to summary
protected static final String ROLE_OPERATION Identifies an operation (method) in a JMX `Descriptor`.

ROLE_SETTER	back to summary
protected static final String ROLE_SETTER Constant identifier for the setter role field value in a JMX `Descriptor`.

useStrictCasing	back to summary
private boolean useStrictCasing Indicates whether strict casing is being used for attributes.

Constructor Detail

AbstractReflectiveMBeanInfoAssembler	back to summary
public AbstractReflectiveMBeanInfoAssembler()

Method Detail

applyCurrencyTimeLimit back to summary

applyCurrencyTimeLimit	back to summary
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:Descriptor the JMX attribute or operation descriptor currencyTimeLimit:int the "currencyTimeLimit" value to apply See Also `setDefaultCurrencyTimeLimit(Integer)`, `applyDefaultCurrencyTimeLimit(javax.management.Descriptor)`

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:Descriptor: the JMX attribute or operation descriptor
currencyTimeLimit:int: the "currencyTimeLimit" value to apply

applyDefaultCurrencyTimeLimit back to summary

applyDefaultCurrencyTimeLimit	back to summary
protected final void applyDefaultCurrencyTimeLimit(Descriptor desc) Set the `currencyTimeLimit` field to the specified "defaultCurrencyTimeLimit", if any (by default none). Parameters desc:Descriptor the JMX attribute or operation descriptor See Also `setDefaultCurrencyTimeLimit(Integer)`

protected final void applyDefaultCurrencyTimeLimit(Descriptor desc)

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

Parameters

desc:Descriptor: the JMX attribute or operation descriptor

See Also

setDefaultCurrencyTimeLimit(Integer)

createModelMBeanOperationInfo back to summary

createModelMBeanOperationInfo	back to summary
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:Method the `Method` to create a `ModelMBeanOperationInfo` for name:String the logical name for the operation (method name or property name); not used by the default implementation but possibly by subclasses beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` Returns:ModelMBeanOperationInfo the `ModelMBeanOperationInfo`

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:Method: the Method to create a ModelMBeanOperationInfo for
name:String: the logical name for the operation (method name or property name); not used by the default implementation but possibly by subclasses
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

Returns:ModelMBeanOperationInfo

the ModelMBeanOperationInfo

getAttributeDescription back to summary

getAttributeDescription	back to summary
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:PropertyDescriptor the PropertyDescriptor for the attribute beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` Returns:String the description for the attribute

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:PropertyDescriptor: the PropertyDescriptor for the attribute
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

Returns:String

the description for the attribute

getAttributeInfo back to summary

getAttributeInfo	back to summary
protected ModelMBeanAttributeInfo[] getAttributeInfo(Object managedBean, String beanKey) throws JMException Implements abstract org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler.getAttributeInfo. 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:Object the bean instance (might be an AOP proxy) beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` Returns:ModelMBeanAttributeInfo[] the attribute metadata Annotations @Override Exceptions JMException: in case of errors See Also `populateAttributeDescriptor`

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

Implements abstract org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler.getAttributeInfo.

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:Object: the bean instance (might be an AOP proxy)
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

Returns:ModelMBeanAttributeInfo[]

the attribute metadata

Annotations

@Override

Exceptions

JMException:: in case of errors

See Also

populateAttributeDescriptor

getClassForDescriptor back to summary

getClassForDescriptor	back to summary
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:Object the bean instance (might be an AOP proxy) Returns:Class<?> the class to expose in the descriptor field "class" See Also `setExposeClassDescriptor`, `getClassToExpose(Class)`, `org.springframework.aop.framework.AopProxyUtils#proxiedUserInterfaces(Object)`

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:Object: the bean instance (might be an AOP proxy)

Returns:Class<?>

the class to expose in the descriptor field "class"

getDefaultCurrencyTimeLimit	back to summary
protected Integer getDefaultCurrencyTimeLimit() Return default value for the JMX field "currencyTimeLimit", if any. Annotations @Nullable

getDefaultCurrencyTimeLimit

back to summary

protected Integer getDefaultCurrencyTimeLimit()

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

Annotations

@Nullable

getOperationDescription back to summary

getOperationDescription	back to summary
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:Method the operation method beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` Returns:String the description for the operation

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:Method: the operation method
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

Returns:String

the description for the operation

getOperationInfo back to summary

getOperationInfo	back to summary
protected ModelMBeanOperationInfo[] getOperationInfo(Object managedBean, String beanKey) Implements abstract org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler.getOperationInfo. 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 included in the management interface, then the corresponding operation is exposed with the "role" descriptor field set to the appropriate value. Parameters managedBean:Object the bean instance (might be an AOP proxy) beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` Returns:ModelMBeanOperationInfo[] the operation metadata Annotations @Override See Also `populateOperationDescriptor`

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

Implements abstract org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler.getOperationInfo.

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 included in the management interface, then the corresponding operation is exposed with the "role" descriptor field set to the appropriate value.

Parameters

managedBean:Object: the bean instance (might be an AOP proxy)
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

Returns:ModelMBeanOperationInfo[]

the operation metadata

Annotations

@Override

See Also

populateOperationDescriptor

getOperationParameters back to summary

getOperationParameters	back to summary
protected MBeanParameterInfo[] getOperationParameters(Method method, String beanKey) Create parameter info for the given method. The default implementation returns an empty array of `MBeanParameterInfo`. Parameters method:Method the `Method` to get the parameter information for beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` Returns:MBeanParameterInfo[] the `MBeanParameterInfo` array

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

Create parameter info for the given method.

The default implementation returns an empty array of MBeanParameterInfo.

Parameters

method:Method: the Method to get the parameter information for
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

Returns:MBeanParameterInfo[]

the MBeanParameterInfo array

getParameterNameDiscoverer back to summary

getParameterNameDiscoverer	back to summary
protected ParameterNameDiscoverer getParameterNameDiscoverer() Return the ParameterNameDiscoverer to use for resolving method parameter names if needed (may be `null` in order to skip parameter detection). Annotations @Nullable

protected ParameterNameDiscoverer getParameterNameDiscoverer()

Return the ParameterNameDiscoverer to use for resolving method parameter names if needed (may be null in order to skip parameter detection).

Annotations

@Nullable

includeOperation back to summary

includeOperation	back to summary
protected abstract boolean includeOperation(Method method, String beanKey) Allows subclasses to vote on the inclusion of a particular operation. Parameters method:Method the operation method beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` Returns:boolean whether the operation should be included in the management interface

protected abstract boolean includeOperation(Method method, String beanKey)

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

Parameters

method:Method: the operation method
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

Returns:boolean

whether the operation should be included in the management interface

includeReadAttribute back to summary

includeReadAttribute	back to summary
protected abstract boolean includeReadAttribute(Method method, String beanKey) Allows subclasses to vote on the inclusion of a particular attribute accessor. Parameters method:Method the accessor `Method` beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` Returns:boolean `true` if the accessor should be included in the management interface, otherwise `false`

protected abstract boolean includeReadAttribute(Method method, String beanKey)

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

Parameters

method:Method: the accessor Method
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

Returns:boolean

true if the accessor should be included in the management interface, otherwise false

includeWriteAttribute back to summary

includeWriteAttribute	back to summary
protected abstract boolean includeWriteAttribute(Method method, String beanKey) Allows subclasses to vote on the inclusion of a particular attribute mutator. Parameters method:Method the mutator `Method`. beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` Returns:boolean `true` if the mutator 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:Method: the mutator Method.
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

Returns:boolean

true if the mutator should be included in the management interface, otherwise false

isExposeClassDescriptor	back to summary
protected boolean isExposeClassDescriptor() Return whether to expose the JMX descriptor field "class" for managed operations.

isUseStrictCasing	back to summary
protected boolean isUseStrictCasing() Return whether strict casing for attributes is enabled.

populateAttributeDescriptor back to summary

populateAttributeDescriptor	back to summary
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:Descriptor the attribute descriptor getter:Method the accessor method for the attribute setter:Method the mutator method for the attribute beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` See Also `setDefaultCurrencyTimeLimit(Integer)`, `applyDefaultCurrencyTimeLimit(javax.management.Descriptor)`

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:Descriptor: the attribute descriptor
getter:Method: the accessor method for the attribute
setter:Method: the mutator method for the attribute
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

populateMBeanDescriptor back to summary

populateMBeanDescriptor	back to summary
protected void populateMBeanDescriptor(Descriptor descriptor, Object managedBean, String beanKey) Overrides org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler.populateMBeanDescriptor. 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:Descriptor the `Descriptor` for the MBean resource. managedBean:Object the bean instance (might be an AOP proxy) beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` Annotations @Override See Also `setDefaultCurrencyTimeLimit(Integer)`, `applyDefaultCurrencyTimeLimit(javax.management.Descriptor)`

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

Overrides org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler.populateMBeanDescriptor.

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:Descriptor: the Descriptor for the MBean resource.
managedBean:Object: the bean instance (might be an AOP proxy)
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

Annotations

@Override

populateOperationDescriptor back to summary

populateOperationDescriptor	back to summary
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:Descriptor the operation descriptor method:Method the method corresponding to the operation beanKey:String the key associated with the MBean in the beans map of the `MBeanExporter` See Also `setDefaultCurrencyTimeLimit(Integer)`, `applyDefaultCurrencyTimeLimit(javax.management.Descriptor)`

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:Descriptor: the operation descriptor
method:Method: the method corresponding to the operation
beanKey:String: the key associated with the MBean in the beans map of the MBeanExporter

setDefaultCurrencyTimeLimit back to summary

setDefaultCurrencyTimeLimit	back to summary
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 `org.springframework.jmx.export.metadata.AbstractJmxAttribute#setCurrencyTimeLimit`, `applyCurrencyTimeLimit(javax.management.Descriptor, int)`

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: org.springframework.jmx.export.metadata.AbstractJmxAttribute#setCurrencyTimeLimit, applyCurrencyTimeLimit(javax.management.Descriptor, int)

setExposeClassDescriptor back to summary

setExposeClassDescriptor	back to summary
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 `getClassForDescriptor(Object)`

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: getClassForDescriptor(Object)

setParameterNameDiscoverer back to summary

public void setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer)

Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (e.g. for parameter names of MBean operation methods).

Default is a DefaultParameterNameDiscoverer.

setUseStrictCasing back to summary

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.

public abstract Class AbstractReflectiveMBeanInfoAssembler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail