Spring Framework

org.springframework.jmx.export.annotation
Class AnnotationJmxAttributeSource

java.lang.Object
  extended by org.springframework.jmx.export.annotation.AnnotationJmxAttributeSource
All Implemented Interfaces:
JmxAttributeSource

public class AnnotationJmxAttributeSource
extends java.lang.Object
implements JmxAttributeSource

Implementation of the JmxAttributeSource interface that reads JDK 1.5+ annotations and exposes the corresponding attributes.

Since:
1.2
Author:
Rob Harrop, Juergen Hoeller, Jennifer Hickey
See Also:
ManagedResource, ManagedAttribute, ManagedOperation

Constructor Summary
AnnotationJmxAttributeSource()
           
 
Method Summary
 ManagedAttribute getManagedAttribute(java.lang.reflect.Method method)
          Implementations should return an instance of ManagedAttribute if the supplied Method has the corresponding metadata.
 ManagedMetric getManagedMetric(java.lang.reflect.Method method)
          Implementations should return an instance of ManagedMetric if the supplied Method has the corresponding metadata.
 ManagedNotification[] getManagedNotifications(java.lang.Class<?> clazz)
          Implementations should return an array of ManagedNotifications if the supplied the Class has the corresponding metadata.
 ManagedOperation getManagedOperation(java.lang.reflect.Method method)
          Implementations should return an instance of ManagedOperation if the supplied Method has the corresponding metadata.
 ManagedOperationParameter[] getManagedOperationParameters(java.lang.reflect.Method method)
          Implementations should return an array of ManagedOperationParameter if the supplied Method has the corresponding metadata.
 ManagedResource getManagedResource(java.lang.Class<?> beanClass)
          Implementations should return an instance of ManagedResource if the supplied Class has the appropriate metadata.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnnotationJmxAttributeSource

public AnnotationJmxAttributeSource()
Method Detail

getManagedResource

public ManagedResource getManagedResource(java.lang.Class<?> beanClass)
                                   throws InvalidMetadataException
Description copied from interface: JmxAttributeSource
Implementations should return an instance of ManagedResource if the supplied Class has the appropriate metadata. Otherwise should return null.

Specified by:
getManagedResource in interface JmxAttributeSource
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(java.lang.reflect.Method method)
                                     throws InvalidMetadataException
Description copied from interface: JmxAttributeSource
Implementations should return an instance of ManagedAttribute if the supplied Method has the corresponding metadata. Otherwise should return null.

Specified by:
getManagedAttribute in interface JmxAttributeSource
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(java.lang.reflect.Method method)
                               throws InvalidMetadataException
Description copied from interface: JmxAttributeSource
Implementations should return an instance of ManagedMetric if the supplied Method has the corresponding metadata. Otherwise should return null.

Specified by:
getManagedMetric in interface JmxAttributeSource
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(java.lang.reflect.Method method)
                                     throws InvalidMetadataException
Description copied from interface: JmxAttributeSource
Implementations should return an instance of ManagedOperation if the supplied Method has the corresponding metadata. Otherwise should return null.

Specified by:
getManagedOperation in interface JmxAttributeSource
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(java.lang.reflect.Method method)
                                                          throws InvalidMetadataException
Description copied from interface: JmxAttributeSource
Implementations should return an array of ManagedOperationParameter if the supplied Method has the corresponding metadata. Otherwise should return an empty array if no metadata is found.

Specified by:
getManagedOperationParameters in interface JmxAttributeSource
Parameters:
method - the Method to read the metadata from
Returns:
the parameter information.
Throws:
InvalidMetadataException - in the case of invalid attributes.

getManagedNotifications

public ManagedNotification[] getManagedNotifications(java.lang.Class<?> clazz)
                                              throws InvalidMetadataException
Description copied from interface: JmxAttributeSource
Implementations should return an array of ManagedNotifications if the supplied the Class has the corresponding metadata. Otherwise should return an empty array.

Specified by:
getManagedNotifications in interface JmxAttributeSource
Parameters:
clazz - the Class to read the metadata from
Returns:
the notification information
Throws:
InvalidMetadataException - in the case of invalid metadata

Spring Framework