MethodExclusionMBeanInfoAssembler

Class Overview

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.

Summary

[Expand] Inherited Constants

From class org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler int ATTRIBUTE_OPERATION_VISIBILITY Lowest visibility, used for operations that correspond to accessors or mutators for attributes. String FIELD_CLASS Constant identifier for the class field in a JMX Descriptor. String FIELD_CURRENCY_TIME_LIMIT Constant identifier for the currency time limit field in a JMX Descriptor. String FIELD_DEFAULT Constant identifier for the default field in a JMX Descriptor. String FIELD_DISPLAY_NAME Constant identifier for the displayName field in a JMX Descriptor. String FIELD_GET_METHOD Identifies a getter method in a JMX Descriptor. String FIELD_LOG Constant identifier for the log field in a JMX Descriptor. String FIELD_LOG_FILE Constant identifier for the logfile field in a JMX Descriptor. String FIELD_METRIC_CATEGORY Constant identifier for the custom metricCategory field in a JMX Descriptor. String FIELD_METRIC_TYPE Constant identifier for the metricType field in a JMX Descriptor. String FIELD_PERSIST_LOCATION Constant identifier for the persistLocation field in a JMX Descriptor. String FIELD_PERSIST_NAME Constant identifier for the persistName field in a JMX Descriptor. String FIELD_PERSIST_PERIOD Constant identifier for the persistPeriod field in a JMX Descriptor. String FIELD_PERSIST_POLICY Constant identifier for the persistPolicy field in a JMX Descriptor. String FIELD_ROLE Constant identifier for the role field in a JMX Descriptor. String FIELD_SET_METHOD Identifies a setter method in a JMX Descriptor. String FIELD_UNITS Constant identifier for the units field in a JMX Descriptor. String FIELD_VISIBILITY Constant identifier for the visibility field in a JMX Descriptor. String ROLE_GETTER Constant identifier for the getter role field value in a JMX Descriptor. String ROLE_OPERATION Identifies an operation (method) in a JMX Descriptor. String ROLE_SETTER Constant identifier for the setter role field value in a JMX Descriptor.

[Expand] Inherited Methods
From class org.springframework.jmx.export.assembler.AbstractConfigurableMBeanInfoAssembler ModelMBeanNotificationInfo[] getNotificationInfo(Object managedBean, String beanKey) Get the notification metadata for the MBean resource. void setNotificationInfoMappings(Map<String, Object> notificationInfoMappings) void setNotificationInfos(ManagedNotification[] notificationInfos)
From class org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler void applyCurrencyTimeLimit(Descriptor desc, int currencyTimeLimit) Apply the given JMX "currencyTimeLimit" value to the given descriptor. final void applyDefaultCurrencyTimeLimit(Descriptor desc) Set the currencyTimeLimit field to the specified "defaultCurrencyTimeLimit", if any (by default none). ModelMBeanOperationInfo createModelMBeanOperationInfo(Method method, String name, String beanKey) Creates an instance of ModelMBeanOperationInfo for the given method. String getAttributeDescription(PropertyDescriptor propertyDescriptor, String beanKey) Get the description for a particular attribute. ModelMBeanAttributeInfo[] getAttributeInfo(Object managedBean, String beanKey) Iterate through all properties on the MBean class and gives subclasses the chance to vote on the inclusion of both the accessor and mutator. Class getClassForDescriptor(Object managedBean) Return the class to be used for the JMX descriptor field "class". Integer getDefaultCurrencyTimeLimit() Return default value for the JMX field "currencyTimeLimit", if any. String getOperationDescription(Method method, String beanKey) Get the description for a particular operation. ModelMBeanOperationInfo[] getOperationInfo(Object managedBean, String beanKey) Iterate through all methods on the MBean class and gives subclasses the chance to vote on their inclusion. MBeanParameterInfo[] getOperationParameters(Method method, String beanKey) Create parameter info for the given method. abstract boolean includeOperation(Method method, String beanKey) Allows subclasses to vote on the inclusion of a particular operation. abstract boolean includeReadAttribute(Method method, String beanKey) Allows subclasses to vote on the inclusion of a particular attribute accessor. abstract boolean includeWriteAttribute(Method method, String beanKey) Allows subclasses to vote on the inclusion of a particular attribute mutator. boolean isExposeClassDescriptor() Return whether to expose the JMX descriptor field "class" for managed operations. boolean isUseStrictCasing() Return whether strict casing for attributes is enabled. void populateAttributeDescriptor(Descriptor desc, Method getter, Method setter, String beanKey) Allows subclasses to add extra fields to the Descriptor for a particular attribute. void populateMBeanDescriptor(Descriptor descriptor, Object managedBean, String beanKey) Allows subclasses to add extra fields to the Descriptor for an MBean. void populateOperationDescriptor(Descriptor desc, Method method, String beanKey) Allows subclasses to add extra fields to the Descriptor for a particular operation. void setDefaultCurrencyTimeLimit(Integer defaultCurrencyTimeLimit) Set the default for the JMX field "currencyTimeLimit". void setExposeClassDescriptor(boolean exposeClassDescriptor) Set whether to expose the JMX descriptor field "class" for managed operations. void setUseStrictCasing(boolean useStrictCasing) Set whether to use strict casing for attributes.
From class org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler void checkManagedBean(Object managedBean) Check the given bean instance, throwing an IllegalArgumentException if it is not eligible for exposure with this assembler. abstract ModelMBeanAttributeInfo[] getAttributeInfo(Object managedBean, String beanKey) Get the attribute metadata for the MBean resource. String getClassName(Object managedBean, String beanKey) Get the class name of the MBean resource. Class<?> getClassToExpose(Object managedBean) Return the class or interface to expose for the given bean. Class<?> getClassToExpose(Class<?> beanClass) Return the class or interface to expose for the given bean class. ModelMBeanConstructorInfo[] getConstructorInfo(Object managedBean, String beanKey) Get the constructor metadata for the MBean resource. String getDescription(Object managedBean, String beanKey) Get the description of the MBean resource. ModelMBeanInfo getMBeanInfo(Object managedBean, String beanKey) Create an instance of the ModelMBeanInfoSupport class supplied with all JMX implementations and populates the metadata through calls to the subclass. ModelMBeanNotificationInfo[] getNotificationInfo(Object managedBean, String beanKey) Get the notification metadata for the MBean resource. abstract ModelMBeanOperationInfo[] getOperationInfo(Object managedBean, String beanKey) Get the operation metadata for the MBean resource. Class getTargetClass(Object managedBean) Return the actual bean class of the given bean instance. void populateMBeanDescriptor(Descriptor descriptor, Object managedBean, String beanKey) Called after the ModelMBeanInfo instance has been constructed but before it is passed to the MBeanExporter.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.jmx.export.assembler.MBeanInfoAssembler abstract ModelMBeanInfo getMBeanInfo(Object managedBean, String beanKey) Create the ModelMBeanInfo for the given managed resource.