Package org.springframework.jmx.export.metadata

Interface JmxAttributeSource

All Known Implementing Classes:

AnnotationJmxAttributeSource

public interface JmxAttributeSource

Interface used by the MetadataMBeanInfoAssembler to read source-level metadata from a managed resource's class.

Since:

1.2

Author:

Rob Harrop, Jennifer Hickey

See Also:

• MetadataMBeanInfoAssembler.setAttributeSource(org.springframework.jmx.export.metadata.JmxAttributeSource)
• MBeanExporter.setAssembler(org.springframework.jmx.export.assembler.MBeanInfoAssembler)

Method Summary

Modifier and Type	Method	Description
@Nullable ManagedAttribute	getManagedAttribute(Method method)	Implementations should return an instance of ManagedAttribute if the supplied Method has the corresponding metadata.
@Nullable ManagedMetric	getManagedMetric(Method method)	Implementations should return an instance of ManagedMetric if the supplied Method has the corresponding metadata.
@Nullable ManagedNotification[]	getManagedNotifications(Class<?> clazz)	Implementations should return an array of ManagedNotifications if the supplied Class has the corresponding metadata.
@Nullable ManagedOperation	getManagedOperation(Method method)	Implementations should return an instance of ManagedOperation if the supplied Method has the corresponding metadata.
@Nullable ManagedOperationParameter[]	getManagedOperationParameters(Method method)	Implementations should return an array of ManagedOperationParameters if the supplied Method has the corresponding metadata.
@Nullable ManagedResource	getManagedResource(Class<?> clazz)	Implementations should return an instance of ManagedResource if the supplied Class has the corresponding metadata.

Method Details

getManagedResource

@Nullable ManagedResource getManagedResource(Class<?> clazz)
                                      throws InvalidMetadataException

Implementations should return an instance of ManagedResource if the supplied Class has the corresponding metadata.

Parameters:

clazz - the class to read the resource data from

Returns:

the resource, or null if not found

Throws:

InvalidMetadataException - in case of invalid metadata

getManagedAttribute

@Nullable ManagedAttribute getManagedAttribute(Method method)
                                        throws InvalidMetadataException

Implementations should return an instance of ManagedAttribute if the supplied Method has the corresponding metadata.

Parameters:

method - the method to read the attribute data from

Returns:

the attribute, or null if not found

Throws:

InvalidMetadataException - in case of invalid metadata

getManagedMetric

@Nullable ManagedMetric getManagedMetric(Method method)
                                  throws InvalidMetadataException

Implementations should return an instance of ManagedMetric if the supplied Method has the corresponding metadata.

Parameters:

method - the method to read the metric data from

Returns:

the metric, or null if not found

Throws:

InvalidMetadataException - in case of invalid metadata

getManagedOperation

@Nullable ManagedOperation getManagedOperation(Method method)
                                        throws InvalidMetadataException

Implementations should return an instance of ManagedOperation if the supplied Method has the corresponding metadata.

Parameters:

method - the method to read the operation data from

Returns:

the operation, or null if not found

Throws:

InvalidMetadataException - in case of invalid metadata

getManagedOperationParameters

@Nullable ManagedOperationParameter[] getManagedOperationParameters(Method method)
                                                             throws InvalidMetadataException

Implementations should return an array of ManagedOperationParameters if the supplied Method has the corresponding metadata.

Parameters:

method - the Method to read the metadata from

Returns:

the parameter information, or an empty array if no metadata is found

Throws:

InvalidMetadataException - in case of invalid metadata

getManagedNotifications

@Nullable ManagedNotification[] getManagedNotifications(Class<?> clazz)
                                                 throws InvalidMetadataException

Implementations should return an array of ManagedNotifications if the supplied Class has the corresponding metadata.

Parameters:

clazz - the Class to read the metadata from

Returns:

the notification information, or an empty array if no metadata is found

Throws:

InvalidMetadataException - in case of invalid metadata