Class AnnotationJmxAttributeSource
- java.lang.Object
- org.springframework.jmx.export.annotation.AnnotationJmxAttributeSource
- All Implemented Interfaces:
Aware,BeanFactoryAware,JmxAttributeSource
public class AnnotationJmxAttributeSource extends Object implements JmxAttributeSource, BeanFactoryAware
Implementation of theJmxAttributeSourceinterface that reads annotations and exposes the corresponding attributes.- Since:
- 1.2
- Author:
- Rob Harrop, Juergen Hoeller, Jennifer Hickey, Stephane Nicoll
- See Also:
ManagedResource,ManagedAttribute,ManagedOperation
Constructor Summary
Constructors Constructor Description AnnotationJmxAttributeSource()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ManagedAttributegetManagedAttribute(Method method)Implementations should return an instance ofManagedAttributeif the suppliedMethodhas the corresponding metadata.ManagedMetricgetManagedMetric(Method method)Implementations should return an instance ofManagedMetricif the suppliedMethodhas the corresponding metadata.ManagedNotification[]getManagedNotifications(Class<?> clazz)Implementations should return an array ofManagedNotificationsif the supplied theClasshas the corresponding metadata.ManagedOperationgetManagedOperation(Method method)Implementations should return an instance ofManagedOperationif the suppliedMethodhas the corresponding metadata.ManagedOperationParameter[]getManagedOperationParameters(Method method)Implementations should return an array ofManagedOperationParameterif the suppliedMethodhas the corresponding metadata.ManagedResourcegetManagedResource(Class<?> beanClass)Implementations should return an instance ofManagedResourceif the suppliedClasshas the appropriate metadata.voidsetBeanFactory(BeanFactory beanFactory)Callback that supplies the owning factory to a bean instance.
Constructor Detail
AnnotationJmxAttributeSource
public AnnotationJmxAttributeSource()
Method Detail
setBeanFactory
public void setBeanFactory(BeanFactory beanFactory)
Description copied from interface:BeanFactoryAwareCallback that supplies the owning factory to a bean instance.Invoked after the population of normal bean properties but before an initialization callback such as
InitializingBean.afterPropertiesSet()or a custom init-method.- Specified by:
setBeanFactoryin interfaceBeanFactoryAware- Parameters:
beanFactory- owning BeanFactory (nevernull). The bean can immediately call methods on the factory.- See Also:
BeanInitializationException
getManagedResource
public ManagedResource getManagedResource(Class<?> beanClass) throws InvalidMetadataException
Description copied from interface:JmxAttributeSourceImplementations should return an instance ofManagedResourceif the suppliedClasshas the appropriate metadata. Otherwise should returnnull.- Specified by:
getManagedResourcein interfaceJmxAttributeSource- Parameters:
beanClass- the class to read the attribute data from- Returns:
- the attribute, or
nullif not found - Throws:
InvalidMetadataException- in case of invalid attributes
getManagedAttribute
public ManagedAttribute getManagedAttribute(Method method) throws InvalidMetadataException
Description copied from interface:JmxAttributeSourceImplementations should return an instance ofManagedAttributeif the suppliedMethodhas the corresponding metadata. Otherwise should returnnull.- Specified by:
getManagedAttributein interfaceJmxAttributeSource- Parameters:
method- the method to read the attribute data from- Returns:
- the attribute, or
nullif not found - Throws:
InvalidMetadataException- in case of invalid attributes
getManagedMetric
public ManagedMetric getManagedMetric(Method method) throws InvalidMetadataException
Description copied from interface:JmxAttributeSourceImplementations should return an instance ofManagedMetricif the suppliedMethodhas the corresponding metadata. Otherwise should returnnull.- Specified by:
getManagedMetricin interfaceJmxAttributeSource- Parameters:
method- the method to read the attribute data from- Returns:
- the metric, or
nullif not found - Throws:
InvalidMetadataException- in case of invalid attributes
getManagedOperation
public ManagedOperation getManagedOperation(Method method) throws InvalidMetadataException
Description copied from interface:JmxAttributeSourceImplementations should return an instance ofManagedOperationif the suppliedMethodhas the corresponding metadata. Otherwise should returnnull.- Specified by:
getManagedOperationin interfaceJmxAttributeSource- Parameters:
method- the method to read the attribute data from- Returns:
- the attribute, or
nullif not found - Throws:
InvalidMetadataException- in case of invalid attributes
getManagedOperationParameters
public ManagedOperationParameter[] getManagedOperationParameters(Method method) throws InvalidMetadataException
Description copied from interface:JmxAttributeSourceImplementations should return an array ofManagedOperationParameterif the suppliedMethodhas the corresponding metadata. Otherwise should return an empty array if no metadata is found.- Specified by:
getManagedOperationParametersin interfaceJmxAttributeSource- Parameters:
method- theMethodto read the metadata from- Returns:
- the parameter information.
- Throws:
InvalidMetadataException- in the case of invalid attributes.
getManagedNotifications
public ManagedNotification[] getManagedNotifications(Class<?> clazz) throws InvalidMetadataException
Description copied from interface:JmxAttributeSourceImplementations should return an array ofManagedNotificationsif the supplied theClasshas the corresponding metadata. Otherwise should return an empty array.- Specified by:
getManagedNotificationsin interfaceJmxAttributeSource- Parameters:
clazz- theClassto read the metadata from- Returns:
- the notification information
- Throws:
InvalidMetadataException- in the case of invalid metadata