spring-framework / org.springframework.jmx.export.assembler / MethodExclusionMBeanInfoAssembler

MethodExclusionMBeanInfoAssembler

open class MethodExclusionMBeanInfoAssembler : AbstractConfigurableMBeanInfoAssembler

AbstractReflectiveMBeanInfoAssembler subclass that allows method names to be explicitly excluded as MBean operations and attributes.

Any method not explicitly excluded from the management interface will be exposed to JMX. JavaBean getters and setters will automatically be exposed as JMX attributes.

You can supply an array of method names via the ignoredMethods 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 ignoredMethodMappings property.

If you specify values for both ignoredMethodMappings and ignoredMethods, 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 ignoredMethods.

Author
Rob Harrop

Author
Seth Ladd

Since
1.2.5

See Also
#setIgnoredMethods#setIgnoredMethodMappingsInterfaceBasedMBeanInfoAssemblerSimpleReflectiveMBeanInfoAssemblerMethodNameBasedMBeanInfoAssemblerorg.springframework.jmx.export.MBeanExporter

Constructors

<init>

MethodExclusionMBeanInfoAssembler()

AbstractReflectiveMBeanInfoAssembler subclass that allows method names to be explicitly excluded as MBean operations and attributes.

Any method not explicitly excluded from the management interface will be exposed to JMX. JavaBean getters and setters will automatically be exposed as JMX attributes.

You can supply an array of method names via the ignoredMethods 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 ignoredMethodMappings property.

If you specify values for both ignoredMethodMappings and ignoredMethods, 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 ignoredMethods.

Functions

setIgnoredMethodMappings

open fun setIgnoredMethodMappings(mappings: Properties): Unit

Set the mappings of bean keys to a comma-separated list of method names.

These method names are ignored when creating the management interface.

The property key must match the bean key and the property value must match the list of method names. When searching for method names to ignore for a bean, Spring will check these mappings first.

setIgnoredMethods

open fun setIgnoredMethods(vararg ignoredMethodNames: String): Unit

Set the array of method names to be ignored when creating the management info.

These method names will be used for a bean if no entry corresponding to that bean is found in the ignoredMethodsMappings property.