Class MethodNameBasedMBeanInfoAssembler

All Implemented Interfaces:
MBeanInfoAssembler

public class MethodNameBasedMBeanInfoAssembler extends AbstractConfigurableMBeanInfoAssembler
Subclass of AbstractReflectiveMBeanInfoAssembler that allows to specify method names to be exposed as MBean operations and attributes. JavaBean getters and setters will automatically be exposed as JMX attributes.

You can supply an array of method names via the managedMethods property. If you have multiple beans and you wish each bean to use a different set of method names, then you can map bean keys (that is the name used to pass the bean to the MBeanExporter) to a list of method names using the methodMappings property.

If you specify values for both methodMappings and managedMethods, Spring will attempt to find method names in the mappings first. If no method names for the bean are found, it will use the method names defined by managedMethods.

Since:
1.2
Author:
Juergen Hoeller
See Also:
  • Constructor Details

    • MethodNameBasedMBeanInfoAssembler

      public MethodNameBasedMBeanInfoAssembler()
  • Method Details

    • setManagedMethods

      public void setManagedMethods(String... methodNames)
      Set the array of method names to use for creating the management info. These method names will be used for a bean if no entry corresponding to that bean is found in the methodMappings property.
      Parameters:
      methodNames - an array of method names indicating the methods to use
      See Also:
    • setMethodMappings

      public void setMethodMappings(Properties mappings)
      Set the mappings of bean keys to a comma-separated list of method names. The property key should match the bean key and the property value should match the list of method names. When searching for method names for a bean, Spring will check these mappings first.
      Parameters:
      mappings - the mappings of bean keys to method names
    • includeReadAttribute

      protected boolean includeReadAttribute(Method method, String beanKey)
      Description copied from class: AbstractReflectiveMBeanInfoAssembler
      Allows subclasses to vote on the inclusion of a particular attribute accessor.
      Specified by:
      includeReadAttribute in class AbstractReflectiveMBeanInfoAssembler
      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 boolean includeWriteAttribute(Method method, String beanKey)
      Description copied from class: AbstractReflectiveMBeanInfoAssembler
      Allows subclasses to vote on the inclusion of a particular attribute mutator.
      Specified by:
      includeWriteAttribute in class AbstractReflectiveMBeanInfoAssembler
      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 boolean includeOperation(Method method, String beanKey)
      Description copied from class: AbstractReflectiveMBeanInfoAssembler
      Allows subclasses to vote on the inclusion of a particular operation.
      Specified by:
      includeOperation in class AbstractReflectiveMBeanInfoAssembler
      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
    • isMatch

      protected boolean isMatch(Method method, String beanKey)