Skip to content

Commit 44dfd1f

Browse files
committed
Merge branch '3.3.x'
Closes gh-41615
2 parents e725aa6 + 2199a31 commit 44dfd1f

28 files changed

+86
-86
lines changed

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/actuator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In a standalone application, the Actuator HTTP port defaults to the same as the
1313
To make the application listen on a different port, set the external property: configprop:management.server.port[].
1414
To listen on a completely different network address (such as when you have an internal network for management and an external one for user applications), you can also set `management.server.address` to a valid IP address to which the server is able to bind.
1515

16-
For more detail, see the xref:api:java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.html[`ManagementServerProperties`] source code and xref:reference:actuator/monitoring.adoc#actuator.monitoring.customizing-management-server-port[Customizing the Management Server Port] in the "`Production-Ready Features`" section.
16+
For more detail, see the javadoc:org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties[] source code and xref:reference:actuator/monitoring.adoc#actuator.monitoring.customizing-management-server-port[Customizing the Management Server Port] in the "`Production-Ready Features`" section.
1717

1818

1919

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/application.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This section includes topics relating directly to Spring Boot applications.
88
[[howto.application.failure-analyzer]]
99
== Create Your Own FailureAnalyzer
1010

11-
xref:api:java/org/springframework/boot/diagnostics/FailureAnalyzer.html[`FailureAnalyzer`] is a great way to intercept an exception on startup and turn it into a human-readable message, wrapped in a xref:api:java/org/springframework/boot/diagnostics/FailureAnalysis.html[`FailureAnalysis`].
11+
javadoc:org.springframework.boot.diagnostics.FailureAnalyzer[] is a great way to intercept an exception on startup and turn it into a human-readable message, wrapped in a javadoc:org.springframework.boot.diagnostics.FailureAnalysis[].
1212
Spring Boot provides such an analyzer for application-context-related exceptions, JSR-303 validations, and more.
1313
You can also create your own.
1414

@@ -46,7 +46,7 @@ When reading the code, remember the following rules of thumb:
4646
Pay special attention to the `+@Conditional*+` annotations to find out what features they enable and when.
4747
Add `--debug` to the command line or the System property `-Ddebug` to get a log on the console of all the auto-configuration decisions that were made in your app.
4848
In a running application with actuator enabled, look at the `conditions` endpoint (`/actuator/conditions` or the JMX equivalent) for the same information.
49-
* Look for classes that are `@ConfigurationProperties` (such as xref:api:java/org/springframework/boot/autoconfigure/web/ServerProperties.html[`ServerProperties`]) and read from there the available external configuration options.
49+
* Look for classes that are `@ConfigurationProperties` (such as javadoc:org.springframework.boot.autoconfigure.web.ServerProperties[]) and read from there the available external configuration options.
5050
The `@ConfigurationProperties` annotation has a `name` attribute that acts as a prefix to external properties.
5151
Thus, `ServerProperties` has `prefix="server"` and its configuration properties are `server.port`, `server.address`, and others.
5252
In a running application with actuator enabled, look at the `configprops` endpoint.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/batch.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ If you do so and want two transaction managers, remember to mark the other one a
3434

3535
Spring Batch auto-configuration is enabled by adding `spring-boot-starter-batch` to your application's classpath.
3636

37-
If a single `Job` bean is found in the application context, it is executed on startup (see xref:api:java/org/springframework/boot/autoconfigure/batch/JobLauncherApplicationRunner.html[`JobLauncherApplicationRunner`] for details).
37+
If a single `Job` bean is found in the application context, it is executed on startup (see javadoc:org.springframework.boot.autoconfigure.batch.JobLauncherApplicationRunner[] for details).
3838
If multiple `Job` beans are found, the job that should be executed must be specified using configprop:spring.batch.job.name[].
3939

4040
To disable running a `Job` found in the application context, set the configprop:spring.batch.job.enabled[] to `false`.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/data-initialization.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,16 +126,16 @@ spring:
126126
----
127127

128128
Rather than using `db/migration`, the preceding configuration sets the directory to use according to the type of the database (such as `db/migration/mysql` for MySQL).
129-
The list of supported databases is available in xref:api:java/org/springframework/boot/jdbc/DatabaseDriver.html[`DatabaseDriver`].
129+
The list of supported databases is available in javadoc:org.springframework.boot.jdbc.DatabaseDriver[].
130130

131131
Migrations can also be written in Java.
132132
Flyway will be auto-configured with any beans that implement `JavaMigration`.
133133

134-
xref:api:java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.html[`FlywayProperties`] provides most of Flyway's settings and a small set of additional properties that can be used to disable the migrations or switch off the location checking.
134+
javadoc:org.springframework.boot.autoconfigure.flyway.FlywayProperties[] provides most of Flyway's settings and a small set of additional properties that can be used to disable the migrations or switch off the location checking.
135135
If you need more control over the configuration, consider registering a `FlywayConfigurationCustomizer` bean.
136136

137137
Spring Boot calls `Flyway.migrate()` to perform the database migration.
138-
If you would like more control, provide a `@Bean` that implements xref:api:java/org/springframework/boot/autoconfigure/flyway/FlywayMigrationStrategy.html[`FlywayMigrationStrategy`].
138+
If you would like more control, provide a `@Bean` that implements javadoc:org.springframework.boot.autoconfigure.flyway.FlywayMigrationStrategy[].
139139

140140
Flyway supports SQL and Java https://documentation.red-gate.com/fd/callback-concept-184127466.html[callbacks].
141141
To use SQL-based callbacks, place the callback scripts in the `classpath:db/migration` directory.
@@ -189,7 +189,7 @@ Alternatively, you can use Liquibase's native `DataSource` by setting `spring.li
189189
Setting either `spring.liquibase.url` or `spring.liquibase.user` is sufficient to cause Liquibase to use its own `DataSource`.
190190
If any of the three properties has not been set, the value of its equivalent `spring.datasource` property will be used.
191191

192-
See xref:api:java/org/springframework/boot/autoconfigure/liquibase/LiquibaseProperties.html[`LiquibaseProperties`] for details about available settings such as contexts, the default schema, and others.
192+
See javadoc:org.springframework.boot.autoconfigure.liquibase.LiquibaseProperties[] for details about available settings such as contexts, the default schema, and others.
193193

194194
You can also use a `Customizer<Liquibase>` bean if you want to customize the `Liquibase` instance before it is being used.
195195

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/cloud.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ include-code::MyBean[]
100100

101101
All Cloud Foundry properties are prefixed with `vcap`.
102102
You can use `vcap` properties to access application information (such as the public URL of the application) and service information (such as database credentials).
103-
See the xref:api:java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.html[`CloudFoundryVcapEnvironmentPostProcessor`] API documentation for complete details.
103+
See the javadoc:org.springframework.boot.cloud.CloudFoundryVcapEnvironmentPostProcessor[] API documentation for complete details.
104104

105105
TIP: The https://github.com/pivotal-cf/java-cfenv/[Java CFEnv] project is a better fit for tasks such as configuring a DataSource.
106106

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/webserver.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Thanks to relaxed binding of `Environment` values, you can also use configprop:s
8282

8383
To switch off the HTTP endpoints completely but still create a `WebApplicationContext`, use `server.port=-1` (doing so is sometimes useful for testing).
8484

85-
For more details, see xref:reference:web/servlet.adoc#web.servlet.embedded-container.customizing[Customizing Embedded Servlet Containers] in the '`Spring Boot Features`' section, or the xref:api:java/org/springframework/boot/autoconfigure/web/ServerProperties.html[`ServerProperties`] class.
85+
For more details, see xref:reference:web/servlet.adoc#web.servlet.embedded-container.customizing[Customizing Embedded Servlet Containers] in the '`Spring Boot Features`' section, or the javadoc:org.springframework.boot.autoconfigure.web.ServerProperties[] class.
8686

8787

8888

@@ -148,7 +148,7 @@ You can configure this behavior by setting the configprop:server.compression.mim
148148
== Configure SSL
149149

150150
SSL can be configured declaratively by setting the various `+server.ssl.*+` properties, typically in `application.properties` or `application.yaml`.
151-
See xref:api:java/org/springframework/boot/web/server/Ssl.html[`Ssl`] for details of all of the supported properties.
151+
See javadoc:org.springframework.boot.web.server.Ssl[] for details of all of the supported properties.
152152

153153
The following example shows setting SSL properties using a Java KeyStore file:
154154

@@ -300,7 +300,7 @@ The `server.{asterisk}` namespace is quite useful here, and it includes namespac
300300
See the list of xref:appendix:application-properties/index.adoc[].
301301

302302
The previous sections covered already many common use cases, such as compression, SSL or HTTP/2.
303-
However, if a configuration key does not exist for your use case, you should then look at xref:api:java/org/springframework/boot/web/server/WebServerFactoryCustomizer.html[`WebServerFactoryCustomizer`].
303+
However, if a configuration key does not exist for your use case, you should then look at javadoc:org.springframework.boot.web.server.WebServerFactoryCustomizer[].
304304
You can declare such a component and get access to the server factory relevant to your choice: you should select the variant for the chosen Server (Tomcat, Jetty, Reactor Netty, Undertow) and the chosen web stack (servlet or reactive).
305305

306306
The example below is for Tomcat with the `spring-boot-starter-web` (servlet stack):
@@ -465,7 +465,7 @@ You can use them in your application by setting configprop:server.forward-header
465465
TIP: If you are using Tomcat and terminating SSL at the proxy, configprop:server.tomcat.redirect-context-root[] should be set to `false`.
466466
This allows the `X-Forwarded-Proto` header to be honored before any redirects are performed.
467467

468-
NOTE: If your application runs xref:api:java/org/springframework/boot/cloud/CloudPlatform.html#enum-constant-summary[in a supported Cloud Platform], the configprop:server.forward-headers-strategy[] property defaults to `NATIVE`.
468+
NOTE: If your application runs javadoc:org.springframework.boot.cloud.CloudPlatform#enum-constant-summary[in a supported Cloud Platform], the configprop:server.forward-headers-strategy[] property defaults to `NATIVE`.
469469
In all other instances, it defaults to `NONE`.
470470

471471

0 commit comments

Comments
 (0)