Class AbstractReflectiveMBeanInfoAssembler

java.lang.Object
org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler
org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
All Implemented Interfaces:
MBeanInfoAssembler
Direct Known Subclasses:
AbstractConfigurableMBeanInfoAssembler, MetadataMBeanInfoAssembler
public abstract class AbstractReflectiveMBeanInfoAssembler extends AbstractMBeanInfoAssembler
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.

Since:
1.2
Author:
Rob Harrop, Juergen Hoeller, David Boden
See Also:

  • Field Details

  • Constructor Details

    • AbstractReflectiveMBeanInfoAssembler

      public AbstractReflectiveMBeanInfoAssembler()

  • Method Details

    • setDefaultCurrencyTimeLimit

      public void setDefaultCurrencyTimeLimit(@Nullable 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:

    • getDefaultCurrencyTimeLimit

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

    • setUseStrictCasing

      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.

    • isUseStrictCasing

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

    • setExposeClassDescriptor

      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:

    • isExposeClassDescriptor

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

    • setParameterNameDiscoverer

      public void setParameterNameDiscoverer(@Nullable ParameterNameDiscoverer parameterNameDiscoverer)
      Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (for example, for parameter names of MBean operation methods).

      Default is a DefaultParameterNameDiscoverer.

    • getParameterNameDiscoverer

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

    • getAttributeInfo

      protected ModelMBeanAttributeInfo[] getAttributeInfo(Object managedBean, String beanKey) throws JMException
      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.
      Specified by:
      getAttributeInfo in class AbstractMBeanInfoAssembler
      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:

    • getOperationInfo

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

    • createModelMBeanOperationInfo

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

    • getClassForDescriptor

      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:

    • includeReadAttribute

      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

    • includeWriteAttribute

      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

    • includeOperation

      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

    • getAttributeDescription

      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

    • getOperationDescription

      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

    • getOperationParameters

      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 - 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

    • populateMBeanDescriptor

      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).

      Overrides:
      populateMBeanDescriptor in class AbstractMBeanInfoAssembler
      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:

    • populateAttributeDescriptor

      protected void populateAttributeDescriptor(Descriptor desc, @Nullable Method getter, @Nullable 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:

    • populateOperationDescriptor

      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:

    • applyDefaultCurrencyTimeLimit

      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:

    • applyCurrencyTimeLimit

      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: