Class MethodExclusionMBeanInfoAssembler
- java.lang.Object
- org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler
- org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
- org.springframework.jmx.export.assembler.AbstractConfigurableMBeanInfoAssembler
- org.springframework.jmx.export.assembler.MethodExclusionMBeanInfoAssembler
- All Implemented Interfaces:
MBeanInfoAssembler
public class MethodExclusionMBeanInfoAssembler extends 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 theMBeanExporter
) to a list of method names using theignoredMethodMappings
property.If you specify values for both
ignoredMethodMappings
andignoredMethods
, 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 byignoredMethods
.- Since:
- 1.2.5
- Author:
- Rob Harrop, Seth Ladd
- See Also:
setIgnoredMethods(java.lang.String...)
,setIgnoredMethodMappings(java.util.Properties)
,InterfaceBasedMBeanInfoAssembler
,SimpleReflectiveMBeanInfoAssembler
,MethodNameBasedMBeanInfoAssembler
,MBeanExporter
Field Summary
Fields inherited from class org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
ATTRIBUTE_OPERATION_VISIBILITY, FIELD_CLASS, FIELD_CURRENCY_TIME_LIMIT, FIELD_DEFAULT, FIELD_DISPLAY_NAME, FIELD_GET_METHOD, FIELD_LOG, FIELD_LOG_FILE, FIELD_METRIC_CATEGORY, FIELD_METRIC_TYPE, FIELD_PERSIST_LOCATION, FIELD_PERSIST_NAME, FIELD_PERSIST_PERIOD, FIELD_PERSIST_POLICY, FIELD_ROLE, FIELD_SET_METHOD, FIELD_UNITS, FIELD_VISIBILITY, ROLE_GETTER, ROLE_OPERATION, ROLE_SETTER
Constructor Summary
Constructors Constructor Description MethodExclusionMBeanInfoAssembler()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
includeOperation(Method method, String beanKey)
Allows subclasses to vote on the inclusion of a particular operation.protected boolean
includeReadAttribute(Method method, String beanKey)
Allows subclasses to vote on the inclusion of a particular attribute accessor.protected boolean
includeWriteAttribute(Method method, String beanKey)
Allows subclasses to vote on the inclusion of a particular attribute mutator.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.void
setIgnoredMethodMappings(Properties mappings)
Set the mappings of bean keys to a comma-separated list of method names.void
setIgnoredMethods(String... ignoredMethodNames)
Set the array of method names to be ignored when creating the management info.Methods inherited from class org.springframework.jmx.export.assembler.AbstractConfigurableMBeanInfoAssembler
getNotificationInfo, setNotificationInfoMappings, setNotificationInfos
Methods inherited from class org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler
applyCurrencyTimeLimit, applyDefaultCurrencyTimeLimit, createModelMBeanOperationInfo, getAttributeDescription, getAttributeInfo, getClassForDescriptor, getDefaultCurrencyTimeLimit, getOperationDescription, getOperationInfo, getOperationParameters, getParameterNameDiscoverer, isExposeClassDescriptor, isUseStrictCasing, populateAttributeDescriptor, populateMBeanDescriptor, populateOperationDescriptor, setDefaultCurrencyTimeLimit, setExposeClassDescriptor, setParameterNameDiscoverer, setUseStrictCasing
Methods inherited from class org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler
checkManagedBean, getClassName, getClassToExpose, getClassToExpose, getConstructorInfo, getDescription, getMBeanInfo, getTargetClass
Constructor Detail
MethodExclusionMBeanInfoAssembler
public MethodExclusionMBeanInfoAssembler()
Method Detail
setIgnoredMethods
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.
setIgnoredMethodMappings
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.
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 classAbstractReflectiveMBeanInfoAssembler
- Parameters:
method
- the accessorMethod
beanKey
- the key associated with the MBean in the beans map of theMBeanExporter
- Returns:
true
if the accessor should be included in the management interface, otherwisefalse
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 classAbstractReflectiveMBeanInfoAssembler
- Parameters:
method
- the mutatorMethod
.beanKey
- the key associated with the MBean in the beans map of theMBeanExporter
- Returns:
true
if the mutator should be included in the management interface, otherwisefalse
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 classAbstractReflectiveMBeanInfoAssembler
- Parameters:
method
- the operation methodbeanKey
- the key associated with the MBean in the beans map of theMBeanExporter
- Returns:
- whether the operation should be included in the management interface
isNotIgnored
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
- the operation methodbeanKey
- the key associated with the MBean in the beans map of theMBeanExporter