Go to file
Sam Brannen 1af6480217 Revise reference documentation for Spring JMX annotations
This commit revises the reference documentation for Spring JMX
annotations 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. 😉

Closes gh-33466
2024-09-02 18:18:10 +02:00
.github Merge branch '6.1.x' 2024-08-09 15:52:35 +02:00
buildSrc Disable class data sharing (CDS) for tests 2024-08-07 18:08:03 +03:00
framework-api Fix warning in doc generation 2024-07-23 15:06:59 +02:00
framework-bom Guard against new Spring modules in ApiDiff task 2022-07-28 10:51:53 +02:00
framework-docs Revise reference documentation for Spring JMX annotations 2024-09-02 18:18:10 +02:00
framework-platform Upgrade to JUnit 5.11 2024-08-15 18:15:15 +02:00
gradle Merge branch '6.1.x' 2024-08-07 18:26:13 +03:00
integration-tests Merge branch '6.1.x' 2024-07-15 11:49:47 +02:00
spring-aop Polishing 2024-08-29 17:02:08 +02:00
spring-aspects Harmonize NoUniqueBeanDefinitionException message 2024-08-02 16:24:43 +02:00
spring-beans Invoke init/destroy/SpEL methods via public types whenever possible 2024-08-22 14:35:21 +02:00
spring-context Revise reference documentation for Spring JMX annotations 2024-09-02 18:18:10 +02:00
spring-context-indexer Polish 2024-01-17 18:41:15 +01:00
spring-context-support Allow setting filename for inline elements in MimeMessageHelper 2024-07-31 11:39:16 +02:00
spring-core Add Javadoc since for ReflectionHints.registerForInterfaces() 2024-09-02 16:21:35 +02:00
spring-core-test Merge branch '6.1.x' 2024-04-23 15:34:49 +02:00
spring-expression Invoke init/destroy/SpEL methods via public types whenever possible 2024-08-22 14:35:21 +02:00
spring-instrument Ensure all packages declare package-info.java with null-safety annotations 2023-03-10 17:33:52 +01:00
spring-jcl Log4jLog re-resolves ExtendedLogger on deserialization 2023-11-09 11:46:22 +01:00
spring-jdbc Use new features from JUnit Jupiter 5.11 2024-08-16 13:48:19 +02:00
spring-jms Use new features from JUnit Jupiter 5.11 2024-08-16 13:48:19 +02:00
spring-messaging Polishing in HTTP interface argument resolvers 2024-08-12 21:01:03 +03:00
spring-orm Stop referring to old Spring versions in Javadoc 2024-07-01 17:50:52 +02:00
spring-oxm Merge branch '6.1.x' 2024-07-26 16:41:13 +03:00
spring-r2dbc Add DatabaseClient bind variant for list of parameters 2024-07-29 14:07:15 +02:00
spring-test Merge branch '6.1.x' 2024-08-30 21:23:29 +02:00
spring-tx Enforce non-null value in requiredSingleResult/requiredUniqueResult 2024-08-05 15:53:17 +02:00
spring-web Update Content-Length if body changed by client interceptor 2024-09-02 16:19:26 +02:00
spring-webflux Merge branch '6.1.x' 2024-08-28 18:59:47 +03:00
spring-webmvc Merge branch '6.1.x' 2024-08-31 12:04:29 +02:00
spring-websocket Refine executor description in WebSocketMessageBrokerStats 2024-07-12 17:35:35 +01:00
src Merge branch '6.1.x' 2024-08-18 13:04:21 +02:00
.editorconfig Add EditorConfig 2017-06-12 08:07:54 +02:00
.gitattributes Ensure line endings for binary files are not modified in Git 2019-10-18 11:56:18 +02:00
.gitignore Modernize Antora Build 2024-05-22 10:20:20 +02:00
.sdkmanrc Upgrade to Java 17.0.12 2024-08-04 09:34:13 +02:00
CONTRIBUTING.md Update code-of-conduct email 2024-06-10 10:48:06 +01:00
LICENSE.txt Add LICENSE.txt file 2019-08-20 22:01:12 +02:00
README.md Merge branch '6.1.x' 2024-06-10 10:48:49 +01:00
SECURITY.md Mention JAR signing key in SECURITY.md 2023-03-17 22:32:33 +01:00
build.gradle Merge branch '6.1.x' 2024-07-24 11:45:49 +02:00
gradle.properties Next development version (v6.1.13-SNAPSHOT) 2024-08-14 13:27:42 +02:00
gradlew Upgrade to Gradle 8.9 2024-07-14 11:21:52 +02:00
gradlew.bat Upgrade to Gradle 8.9 2024-07-14 11:21:52 +02:00
import-into-eclipse.md Remove Groovy from "Eclipse/STS Project Import Guide" 2022-01-21 11:27:09 +01:00
import-into-idea.md Fix links in Javadoc and reference docs 2022-09-14 17:00:11 +02:00
settings.gradle Fix build warnings 2024-04-30 19:10:31 +02:00
update_copyright_headers.sh Use correct Kotlin file extension in update_copyright_headers.sh 2023-02-19 13:41:36 +01:00

README.md

Spring Framework Build Status Revved up by Develocity

This is the home of the Spring Framework: the foundation for all Spring projects. Collectively the Spring Framework and the family of Spring projects are often referred to simply as "Spring".

Spring provides everything required beyond the Java programming language for creating enterprise applications for a wide range of scenarios and architectures. Please read the Overview section of the reference documentation for a more complete introduction.

Code of Conduct

This project is governed by the Spring Code of Conduct. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to spring-code-of-conduct@spring.io.

Access to Binaries

For access to artifacts or a distribution zip, see the Spring Framework Artifacts wiki page.

Documentation

The Spring Framework maintains reference documentation (published and source), GitHub wiki pages, and an API reference. There are also guides and tutorials across Spring projects.

Micro-Benchmarks

See the Micro-Benchmarks wiki page.

Build from Source

See the Build from Source wiki page and the CONTRIBUTING.md file.

Continuous Integration Builds

Information regarding CI builds can be found in the Spring Framework Concourse pipeline documentation.

Stay in Touch

Follow @SpringCentral, @SpringFramework, and its team members on 𝕏. In-depth articles can be found at The Spring Blog, and releases are announced via our releases feed.

License

The Spring Framework is released under version 2.0 of the Apache License.