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 theJmxAttributeSource
interface 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 ManagedAttribute
getManagedAttribute(Method method)
Implementations should return an instance ofManagedAttribute
if the suppliedMethod
has the corresponding metadata.ManagedMetric
getManagedMetric(Method method)
Implementations should return an instance ofManagedMetric
if the suppliedMethod
has the corresponding metadata.ManagedNotification[]
getManagedNotifications(Class<?> clazz)
Implementations should return an array ofManagedNotifications
if the supplied theClass
has the corresponding metadata.ManagedOperation
getManagedOperation(Method method)
Implementations should return an instance ofManagedOperation
if the suppliedMethod
has the corresponding metadata.ManagedOperationParameter[]
getManagedOperationParameters(Method method)
Implementations should return an array ofManagedOperationParameter
if the suppliedMethod
has the corresponding metadata.ManagedResource
getManagedResource(Class<?> beanClass)
Implementations should return an instance ofManagedResource
if the suppliedClass
has the appropriate metadata.void
setBeanFactory(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:BeanFactoryAware
Callback 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:
setBeanFactory
in 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:JmxAttributeSource
Implementations should return an instance ofManagedResource
if the suppliedClass
has the appropriate metadata. Otherwise should returnnull
.- Specified by:
getManagedResource
in interfaceJmxAttributeSource
- Parameters:
beanClass
- the class to read the attribute data from- Returns:
- the attribute, or
null
if not found - Throws:
InvalidMetadataException
- in case of invalid attributes
getManagedAttribute
public ManagedAttribute getManagedAttribute(Method method) throws InvalidMetadataException
Description copied from interface:JmxAttributeSource
Implementations should return an instance ofManagedAttribute
if the suppliedMethod
has the corresponding metadata. Otherwise should returnnull
.- Specified by:
getManagedAttribute
in interfaceJmxAttributeSource
- Parameters:
method
- the method to read the attribute data from- Returns:
- the attribute, or
null
if not found - Throws:
InvalidMetadataException
- in case of invalid attributes
getManagedMetric
public ManagedMetric getManagedMetric(Method method) throws InvalidMetadataException
Description copied from interface:JmxAttributeSource
Implementations should return an instance ofManagedMetric
if the suppliedMethod
has the corresponding metadata. Otherwise should returnnull
.- Specified by:
getManagedMetric
in interfaceJmxAttributeSource
- Parameters:
method
- the method to read the attribute data from- Returns:
- the metric, or
null
if not found - Throws:
InvalidMetadataException
- in case of invalid attributes
getManagedOperation
public ManagedOperation getManagedOperation(Method method) throws InvalidMetadataException
Description copied from interface:JmxAttributeSource
Implementations should return an instance ofManagedOperation
if the suppliedMethod
has the corresponding metadata. Otherwise should returnnull
.- Specified by:
getManagedOperation
in interfaceJmxAttributeSource
- Parameters:
method
- the method to read the attribute data from- Returns:
- the attribute, or
null
if not found - Throws:
InvalidMetadataException
- in case of invalid attributes
getManagedOperationParameters
public ManagedOperationParameter[] getManagedOperationParameters(Method method) throws InvalidMetadataException
Description copied from interface:JmxAttributeSource
Implementations should return an array ofManagedOperationParameter
if the suppliedMethod
has the corresponding metadata. Otherwise should return an empty array if no metadata is found.- Specified by:
getManagedOperationParameters
in interfaceJmxAttributeSource
- Parameters:
method
- theMethod
to 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:JmxAttributeSource
Implementations should return an array ofManagedNotifications
if the supplied theClass
has the corresponding metadata. Otherwise should return an empty array.- Specified by:
getManagedNotifications
in interfaceJmxAttributeSource
- Parameters:
clazz
- theClass
to read the metadata from- Returns:
- the notification information
- Throws:
InvalidMetadataException
- in the case of invalid metadata