org.springframework.jmx.export.assembler

类 MetadataMBeanInfoAssembler

java.lang.Object

org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler

org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler

org.springframework.jmx.export.assembler.MetadataMBeanInfoAssembler

所有已实现的接口:

org.springframework.beans.factory.InitializingBean, AutodetectCapableMBeanInfoAssembler, MBeanInfoAssembler

public class MetadataMBeanInfoAssembler
extends AbstractReflectiveMBeanInfoAssembler
implements AutodetectCapableMBeanInfoAssembler, org.springframework.beans.factory.InitializingBean

Implementation of the MBeanInfoAssembler interface that reads the management interface information from source level metadata.

Uses the JmxAttributeSource strategy interface, so that metadata can be read using any supported implementation. Out of the box, Spring provides an implementation based on annotations: AnnotationJmxAttributeSource.

从以下版本开始:

1.2

作者:

Rob Harrop, Juergen Hoeller, Jennifer Hickey

另请参阅:

setAttributeSource(org.springframework.jmx.export.metadata.JmxAttributeSource), AnnotationJmxAttributeSource

字段概要

从类继承的字段 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

构造器概要

构造器

构造器和说明
MetadataMBeanInfoAssembler() Create a new MetadataMBeanInfoAssembler which needs to be configured through the setAttributeSource(org.springframework.jmx.export.metadata.JmxAttributeSource) method.
MetadataMBeanInfoAssembler(JmxAttributeSource attributeSource) Create a new MetadataMBeanInfoAssembler for the given JmxAttributeSource.

方法概要

限定符和类型	方法和说明
void	afterPropertiesSet()
protected void	checkManagedBean(Object managedBean) Throws an IllegalArgumentException if it encounters a JDK dynamic proxy.
protected String	getAttributeDescription(PropertyDescriptor propertyDescriptor, String beanKey) Creates a description for the attribute corresponding to this property descriptor.
protected String	getDescription(Object managedBean, String beanKey) Reads managed resource description from the source level metadata.
protected ModelMBeanNotificationInfo[]	getNotificationInfo(Object managedBean, String beanKey) Reads the ManagedNotification metadata from the Class of the managed resource and generates and returns the corresponding ModelMBeanNotificationInfo metadata.
protected String	getOperationDescription(Method method, String beanKey) Retrieves the description for the supplied Method from the metadata.
protected MBeanParameterInfo[]	getOperationParameters(Method method, String beanKey) Reads MBeanParameterInfo from the ManagedOperationParameter attributes attached to a method.
boolean	includeBean(Class<?> beanClass, String beanName) Used for autodetection of beans.
protected boolean	includeOperation(Method method, String beanKey) Votes on the inclusion of an operation.
protected boolean	includeReadAttribute(Method method, String beanKey) Vote on the inclusion of an attribute accessor.
protected boolean	includeWriteAttribute(Method method, String beanKey) Votes on the inclusion of an attribute mutator.
protected void	populateAttributeDescriptor(Descriptor desc, Method getter, Method setter, String beanKey) Adds descriptor fields from the ManagedAttribute attribute or the ManagedMetric attribute to the attribute descriptor.
protected void	populateMBeanDescriptor(Descriptor desc, Object managedBean, String beanKey) Adds descriptor fields from the ManagedResource attribute to the MBean descriptor.
protected void	populateOperationDescriptor(Descriptor desc, Method method, String beanKey) Adds descriptor fields from the ManagedAttribute attribute to the attribute descriptor.
void	setAttributeSource(JmxAttributeSource attributeSource) Set the JmxAttributeSource implementation to use for reading the metadata from the bean class.

从类继承的方法 org.springframework.jmx.export.assembler.AbstractReflectiveMBeanInfoAssembler

applyCurrencyTimeLimit, applyDefaultCurrencyTimeLimit, createModelMBeanOperationInfo, getAttributeInfo, getClassForDescriptor, getDefaultCurrencyTimeLimit, getOperationInfo, getParameterNameDiscoverer, isExposeClassDescriptor, isUseStrictCasing, setDefaultCurrencyTimeLimit, setExposeClassDescriptor, setParameterNameDiscoverer, setUseStrictCasing

从类继承的方法 org.springframework.jmx.export.assembler.AbstractMBeanInfoAssembler

getClassName, getClassToExpose, getClassToExpose, getConstructorInfo, getMBeanInfo, getTargetClass

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.springframework.jmx.export.assembler.MBeanInfoAssembler

getMBeanInfo

构造器详细资料

MetadataMBeanInfoAssembler

public MetadataMBeanInfoAssembler()

Create a new MetadataMBeanInfoAssembler which needs to be configured through the setAttributeSource(org.springframework.jmx.export.metadata.JmxAttributeSource) method.

MetadataMBeanInfoAssembler

public MetadataMBeanInfoAssembler(JmxAttributeSource attributeSource)

Create a new MetadataMBeanInfoAssembler for the given JmxAttributeSource.

参数:

attributeSource - the JmxAttributeSource to use

方法详细资料

setAttributeSource

public void setAttributeSource(JmxAttributeSource attributeSource)

Set the JmxAttributeSource implementation to use for reading the metadata from the bean class.

另请参阅:

AnnotationJmxAttributeSource

afterPropertiesSet

public void afterPropertiesSet()

指定者:

afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean

checkManagedBean

protected void checkManagedBean(Object managedBean)
                         throws IllegalArgumentException

Throws an IllegalArgumentException if it encounters a JDK dynamic proxy. Metadata can only be read from target classes and CGLIB proxies!

覆盖:

checkManagedBean 在类中 AbstractMBeanInfoAssembler

参数:

managedBean - the bean that will be exposed (might be an AOP proxy)

抛出:

IllegalArgumentException - the bean is not valid for exposure

includeBean

public boolean includeBean(Class<?> beanClass,
                           String beanName)

Used for autodetection of beans. Checks to see if the bean's class has a ManagedResource attribute. If so it will add it list of included beans.

指定者:

includeBean 在接口中 AutodetectCapableMBeanInfoAssembler

参数:

beanClass - the class of the bean

beanName - the name of the bean in the bean factory

includeReadAttribute

protected boolean includeReadAttribute(Method method,
                                       String beanKey)

Vote on the inclusion of an attribute accessor.

指定者:

includeReadAttribute 在类中 AbstractReflectiveMBeanInfoAssembler

参数:

method - the accessor method

beanKey - the key associated with the MBean in the beans map

返回:

whether the method has the appropriate metadata

includeWriteAttribute

protected boolean includeWriteAttribute(Method method,
                                        String beanKey)

Votes on the inclusion of an attribute mutator.

指定者:

includeWriteAttribute 在类中 AbstractReflectiveMBeanInfoAssembler

参数:

method - the mutator method

beanKey - the key associated with the MBean in the beans map

返回:

whether the method has the appropriate metadata

includeOperation

protected boolean includeOperation(Method method,
                                   String beanKey)

Votes on the inclusion of an operation.

指定者:

includeOperation 在类中 AbstractReflectiveMBeanInfoAssembler

参数:

method - the operation method

beanKey - the key associated with the MBean in the beans map

返回:

whether the method has the appropriate metadata

getDescription

protected String getDescription(Object managedBean,
                                String beanKey)

Reads managed resource description from the source level metadata. Returns an empty String if no description can be found.

覆盖:

getDescription 在类中 AbstractMBeanInfoAssembler

参数:

managedBean - the bean instance (might be an AOP proxy)

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

getAttributeDescription

protected String getAttributeDescription(PropertyDescriptor propertyDescriptor,
                                         String beanKey)

Creates a description for the attribute corresponding to this property descriptor. Attempts to create the description using metadata from either the getter or setter attributes, otherwise uses the property name.

覆盖:

getAttributeDescription 在类中 AbstractReflectiveMBeanInfoAssembler

参数:

propertyDescriptor - the PropertyDescriptor for the attribute

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

返回:

the description for the attribute

getOperationDescription

protected String getOperationDescription(Method method,
                                         String beanKey)

Retrieves the description for the supplied Method from the metadata. Uses the method name is no description is present in the metadata.

覆盖:

getOperationDescription 在类中 AbstractReflectiveMBeanInfoAssembler

参数:

method - the operation method

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

返回:

the description for the operation

getOperationParameters

protected MBeanParameterInfo[] getOperationParameters(Method method,
                                                      String beanKey)

Reads MBeanParameterInfo from the ManagedOperationParameter attributes attached to a method. Returns an empty array of MBeanParameterInfo if no attributes are found.

覆盖:

getOperationParameters 在类中 AbstractReflectiveMBeanInfoAssembler

参数:

method - the Method to get the parameter information for

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

返回:

the MBeanParameterInfo array

getNotificationInfo

protected ModelMBeanNotificationInfo[] getNotificationInfo(Object managedBean,
                                                           String beanKey)

Reads the ManagedNotification metadata from the Class of the managed resource and generates and returns the corresponding ModelMBeanNotificationInfo metadata.

覆盖:

getNotificationInfo 在类中 AbstractMBeanInfoAssembler

参数:

managedBean - the bean instance (might be an AOP proxy)

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

返回:

the notification metadata

populateMBeanDescriptor

protected void populateMBeanDescriptor(Descriptor desc,
                                       Object managedBean,
                                       String beanKey)

Adds descriptor fields from the ManagedResource attribute to the MBean descriptor. Specifically, adds the currencyTimeLimit, persistPolicy, persistPeriod, persistLocation and persistName descriptor fields if they are present in the metadata.

覆盖:

populateMBeanDescriptor 在类中 AbstractReflectiveMBeanInfoAssembler

参数:

desc - the Descriptor for the MBean resource.

managedBean - the bean instance (might be an AOP proxy)

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

另请参阅:

AbstractReflectiveMBeanInfoAssembler.setDefaultCurrencyTimeLimit(Integer), AbstractReflectiveMBeanInfoAssembler.applyDefaultCurrencyTimeLimit(javax.management.Descriptor)

populateAttributeDescriptor

protected void populateAttributeDescriptor(Descriptor desc,
                                           @Nullable
                                           Method getter,
                                           @Nullable
                                           Method setter,
                                           String beanKey)

Adds descriptor fields from the ManagedAttribute attribute or the ManagedMetric attribute to the attribute descriptor.

覆盖:

populateAttributeDescriptor 在类中 AbstractReflectiveMBeanInfoAssembler

参数:

desc - the attribute descriptor

getter - the accessor method for the attribute

setter - the mutator method for the attribute

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

另请参阅:

AbstractReflectiveMBeanInfoAssembler.setDefaultCurrencyTimeLimit(Integer), AbstractReflectiveMBeanInfoAssembler.applyDefaultCurrencyTimeLimit(javax.management.Descriptor)

populateOperationDescriptor

protected void populateOperationDescriptor(Descriptor desc,
                                           Method method,
                                           String beanKey)

Adds descriptor fields from the ManagedAttribute attribute to the attribute descriptor. Specifically, adds the currencyTimeLimit descriptor field if it is present in the metadata.

覆盖:

populateOperationDescriptor 在类中 AbstractReflectiveMBeanInfoAssembler

参数:

desc - the operation descriptor

method - the method corresponding to the operation

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

另请参阅:

AbstractReflectiveMBeanInfoAssembler.setDefaultCurrencyTimeLimit(Integer), AbstractReflectiveMBeanInfoAssembler.applyDefaultCurrencyTimeLimit(javax.management.Descriptor)