Summary: Methods | [Expand All]
public interface

JmxAttributeSource

org.springframework.jmx.export.metadata.JmxAttributeSource
Known Indirect Subclasses

Class Overview

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

See Also

Summary

Public Methods
abstract ManagedAttribute getManagedAttribute(Method method)
Implementations should return an instance of ManagedAttribute if the supplied Method has the corresponding metadata.
abstract ManagedMetric getManagedMetric(Method method)
Implementations should return an instance of ManagedMetric if the supplied Method has the corresponding metadata.
abstract ManagedNotification[] getManagedNotifications(Class<?> clazz)
Implementations should return an array of ManagedNotifications if the supplied the Class has the corresponding metadata.
abstract ManagedOperation getManagedOperation(Method method)
Implementations should return an instance of ManagedOperation if the supplied Method has the corresponding metadata.
abstract ManagedOperationParameter[] getManagedOperationParameters(Method method)
Implementations should return an array of ManagedOperationParameter if the supplied Method has the corresponding metadata.
abstract ManagedResource getManagedResource(Class<?> clazz)
Implementations should return an instance of ManagedResource if the supplied Class has the appropriate metadata.

Public Methods

public abstract ManagedAttribute getManagedAttribute (Method method)

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

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

public abstract ManagedMetric getManagedMetric (Method method)

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

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

public abstract ManagedNotification[] getManagedNotifications (Class<?> clazz)

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

Parameters
clazz the Class to read the metadata from
Returns
  • the notification information
Throws
InvalidMetadataException in the case of invalid metadata

public abstract ManagedOperation getManagedOperation (Method method)

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

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

public abstract ManagedOperationParameter[] getManagedOperationParameters (Method method)

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.

Parameters
method the Method to read the metadata from
Returns
  • the parameter information.
Throws
InvalidMetadataException in the case of invalid attributes.

public abstract ManagedResource getManagedResource (Class<?> clazz)

Implementations should return an instance of ManagedResource if the supplied Class has the appropriate metadata. Otherwise should return null.

Parameters
clazz the class to read the attribute data from
Returns
  • the attribute, or null if not found
Throws
InvalidMetadataException in case of invalid attributes