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 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.
setIgnoredMethods(java.lang.String...),
setIgnoredMethodMappings(java.util.Properties),
InterfaceBasedMBeanInfoAssembler,
SimpleReflectiveMBeanInfoAssembler,
MethodNameBasedMBeanInfoAssembler,
MBeanExporterATTRIBUTE_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 and Description |
|---|
MethodExclusionMBeanInfoAssembler() |
| Modifier and Type | Method and 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.
|
getNotificationInfo, setNotificationInfoMappings, setNotificationInfosapplyCurrencyTimeLimit, applyDefaultCurrencyTimeLimit, createModelMBeanOperationInfo, getAttributeDescription, getAttributeInfo, getClassForDescriptor, getDefaultCurrencyTimeLimit, getOperationDescription, getOperationInfo, getOperationParameters, getParameterNameDiscoverer, isExposeClassDescriptor, isUseStrictCasing, populateAttributeDescriptor, populateMBeanDescriptor, populateOperationDescriptor, setDefaultCurrencyTimeLimit, setExposeClassDescriptor, setParameterNameDiscoverer, setUseStrictCasingcheckManagedBean, getClassName, getClassToExpose, getClassToExpose, getConstructorInfo, getDescription, getMBeanInfo, getTargetClasspublic void setIgnoredMethods(String... ignoredMethodNames)
These method names will be used for a bean if no entry corresponding to
that bean is found in the ignoredMethodsMappings property.
public void setIgnoredMethodMappings(Properties mappings)
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.
protected boolean includeReadAttribute(Method method, String beanKey)
AbstractReflectiveMBeanInfoAssemblerincludeReadAttribute in class AbstractReflectiveMBeanInfoAssemblermethod - the accessor MethodbeanKey - the key associated with the MBean in the beans map
of the MBeanExportertrue if the accessor should be included in the management interface,
otherwise falseprotected boolean includeWriteAttribute(Method method, String beanKey)
AbstractReflectiveMBeanInfoAssemblerincludeWriteAttribute in class AbstractReflectiveMBeanInfoAssemblermethod - the mutator Method.beanKey - the key associated with the MBean in the beans map
of the MBeanExportertrue if the mutator should be included in the management interface,
otherwise falseprotected boolean includeOperation(Method method, String beanKey)
AbstractReflectiveMBeanInfoAssemblerincludeOperation in class AbstractReflectiveMBeanInfoAssemblermethod - the operation methodbeanKey - the key associated with the MBean in the beans map
of the MBeanExporterprotected boolean isNotIgnored(Method method, String beanKey)
method - the operation methodbeanKey - the key associated with the MBean in the beans map
of the MBeanExporter