Top Description Fields Constructors Methods
org.springframework.jmx.export.assembler

public Class MethodExclusionMBeanInfoAssembler

extends AbstractConfigurableMBeanInfoAssembler
Class Inheritance
Imports
java.lang.reflect.Method, java.util.Enumeration, .HashMap, .Map, .Properties, .Set, org.springframework.lang.Nullable, org.springframework.util.StringUtils
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.

Authors
Rob Harrop, Seth Ladd
Since
1.2.5
See Also
setIgnoredMethods, setIgnoredMethodMappings, InterfaceBasedMBeanInfoAssembler, SimpleReflectiveMBeanInfoAssembler, MethodNameBasedMBeanInfoAssembler, org.springframework.jmx.export.MBeanExporter

Field Summary

Modifier and TypeField and Description
private Map<String, Set<String>>
ignoredMethodMappings

private Set<String>
ignoredMethods

Constructor Summary

AccessConstructor and Description
public
MethodExclusionMBeanInfoAssembler()

Method Summary

Modifier and TypeMethod and Description
protected boolean
includeOperation(Method
the operation method
method, String
the key associated with the MBean in the beans map of the MBeanExporter
beanKey)

Implements abstract org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler.includeOperation.

Allows subclasses to vote on the inclusion of a particular operation.
protected boolean
includeReadAttribute(Method
the accessor Method
method, String
the key associated with the MBean in the beans map of the MBeanExporter
beanKey)

Implements abstract org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler.includeReadAttribute.

Allows subclasses to vote on the inclusion of a particular attribute accessor.
protected boolean
includeWriteAttribute(Method
the mutator Method.
method, String
the key associated with the MBean in the beans map of the MBeanExporter
beanKey)

Implements abstract org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler.includeWriteAttribute.

Allows subclasses to vote on the inclusion of a particular attribute mutator.
protected boolean
isNotIgnored(Method
the operation method
method, String
the key associated with the MBean in the beans map of the MBeanExporter
beanKey)

Determine whether the given method is supposed to be included, that is, not configured as to be ignored.

public void
setIgnoredMethodMappings(Properties mappings)

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

public void
setIgnoredMethods(String... ignoredMethodNames)

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

Inherited from org.springframework.jmx.export.assembler.AbstractConfigurableMBeanInfoAssembler:
getNotificationInfosetNotificationInfoMappingssetNotificationInfos

Field Detail

ignoredMethodMappingsback to summary
private Map<String, Set<String>> ignoredMethodMappings
Annotations
@Nullable
ignoredMethodsback to summary
private Set<String> ignoredMethods
Annotations
@Nullable

Constructor Detail

MethodExclusionMBeanInfoAssemblerback to summary
public MethodExclusionMBeanInfoAssembler()

Method Detail

includeOperationback to summary
protected boolean includeOperation(Method method, String beanKey)

Implements abstract org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler.includeOperation.

Doc from org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler.includeOperation.

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

Annotations
@Override
includeReadAttributeback to summary
protected boolean includeReadAttribute(Method method, String beanKey)

Implements abstract org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler.includeReadAttribute.

Doc from org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler.includeReadAttribute.

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

Annotations
@Override
includeWriteAttributeback to summary
protected boolean includeWriteAttribute(Method method, String beanKey)

Implements abstract org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler.includeWriteAttribute.

Doc from org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler.includeWriteAttribute.

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

Annotations
@Override
isNotIgnoredback to summary
protected boolean isNotIgnored(Method method, String beanKey)

Determine whether the given method is supposed to be included, that is, not configured as to be ignored.

Parameters
method:Method

the operation method

beanKey:String

the key associated with the MBean in the beans map of the MBeanExporter

setIgnoredMethodMappingsback to summary
public void setIgnoredMethodMappings(Properties mappings)

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.

setIgnoredMethodsback to summary
public void setIgnoredMethods(String... ignoredMethodNames)

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.

See Also
setIgnoredMethodMappings(java.util.Properties)