spring-framework / org.springframework.jmx.export.metadata / JmxAttributeSource

JmxAttributeSource

interface JmxAttributeSource

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

Author
Rob Harrop

Author
Jennifer Hickey

Since
1.2

See Also
org.springframework.jmx.export.assembler.MetadataMBeanInfoAssembler#setAttributeSourceorg.springframework.jmx.export.MBeanExporter#setAssembler

Functions

getManagedAttribute

abstract fun getManagedAttribute(method: Method): ManagedAttribute

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

getManagedMetric

abstract fun getManagedMetric(method: Method): ManagedMetric

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

getManagedNotifications

abstract fun getManagedNotifications(clazz: Class<*>): Array<ManagedNotification>

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

getManagedOperation

abstract fun getManagedOperation(method: Method): ManagedOperation

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

getManagedOperationParameters

abstract fun getManagedOperationParameters(method: Method): Array<ManagedOperationParameter>

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.

getManagedResource

abstract fun getManagedResource(clazz: Class<*>): ManagedResource

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

Inheritors

AnnotationJmxAttributeSource

open class AnnotationJmxAttributeSource : JmxAttributeSource, BeanFactoryAware

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