Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise reference documentation for Spring JMX annotations #33466

Closed
sbrannen opened this issue Sep 2, 2024 · 0 comments
Closed

Revise reference documentation for Spring JMX annotations #33466

sbrannen opened this issue Sep 2, 2024 · 0 comments
Assignees
Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Milestone

Comments

@sbrannen
Copy link
Member

sbrannen commented Sep 2, 2024

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 ManagedResource are often ambiguous, especially when discussing an annotation like @ManagedResource instead of org.springframework.jmx.export.metadata.ManagedResource which is a class.
  • AnnotationTestBean implements IJmxTestBean, 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.
  • @ManagedOperationParameter annotations are unnecessarily declared in the @ManagedOperationParameters container.
  • The documentation sometimes refers to JmxTestBean when it should instead refer to AnnotationTestBean.
  • 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.
  • @ManagedNotification and @ManagedMetric are not mentioned.
  • The AutodetectCapableMBeanInfoAssembler example is broken since it uses the non-annotated JmxTestBean instead of the AnnotationTestBean.

As a side note, the JmxTestBean in our test suite still contains XDoclet "annotations" which can be safely removed. 😉

@sbrannen sbrannen added type: documentation A documentation task in: core Issues in core modules (aop, beans, core, context, expression) labels Sep 2, 2024
@sbrannen sbrannen added this to the 6.2.0-RC1 milestone Sep 2, 2024
@sbrannen sbrannen self-assigned this Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

1 participant