-
Couldn't load subscription status.
- Fork 38.8k
Closed
Labels
in: coreIssues in core modules (aop, beans, core, context, expression)Issues in core modules (aop, beans, core, context, expression)type: documentationA documentation taskA documentation task
Milestone
Description
The reference documentation for Spring JMX annotations is in need of a revision for various reasons including, but not limited to, the following.
- Type names such as
ManagedResourceare often ambiguous, especially when discussing an annotation like@ManagedResourceinstead oforg.springframework.jmx.export.metadata.ManagedResourcewhich is a class. AnnotationTestBeanimplementsIJmxTestBean, even though an annotated MBean is not required to implement any interfaces, and in fact the example is meant to demonstrate that an annotated POJO suffices.@ManagedOperationParameterannotations are unnecessarily declared in the@ManagedOperationParameterscontainer.- The documentation sometimes refers to
JmxTestBeanwhen it should instead refer toAnnotationTestBean. - Inconsistent and confusing wording for annotation attributes, properties, managed attributes, etc.
- The tables refer to "source-level metadata types/parameters" when they should refer to Spring JMX annotations and their attributes.
- The annotation and attribute tables have inconsistent ordering and naming for column headers.
@ManagedNotificationand@ManagedMetricare not mentioned.- The
AutodetectCapableMBeanInfoAssemblerexample is broken since it uses the non-annotatedJmxTestBeaninstead of theAnnotationTestBean.
As a side note, the JmxTestBean in our test suite still contains XDoclet "annotations" which can be safely removed. 😉
Metadata
Metadata
Assignees
Labels
in: coreIssues in core modules (aop, beans, core, context, expression)Issues in core modules (aop, beans, core, context, expression)type: documentationA documentation taskA documentation task