Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename packages for code samples to match sections

Browse Source 
See gh-27132
This commit is contained in:
Madhura Bhave
2021-09-20 14:29:02 -07:00
parent ad8cb539ea
commit 7e257dc24c
83 changed files with 126 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator.adoc
View File

@@ -1,3 +1,4 @@
[[actuator]]
= Production-ready Features
include::attributes.adoc[]

26
spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/nosql.adoc
View File

@@ -38,7 +38,7 @@ The following listing shows an example of such a bean:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/redis/connecting/MyBean.java[]
include::{docs-java}/data/nosql/redis/connecting/MyBean.java[]
----
TIP: You can also register an arbitrary number of beans that implement `LettuceClientConfigurationBuilderCustomizer` for more advanced customizations.
@@ -66,7 +66,7 @@ The following example shows how to connect to a MongoDB database:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/mongodb/connecting/MyBean.java[]
include::{docs-java}/data/nosql/mongodb/connecting/MyBean.java[]
----
If you have defined your own `MongoClient`, it will be used to auto-configure a suitable `MongoDatabaseFactory`.
@@ -120,7 +120,7 @@ As with `JdbcTemplate`, Spring Boot auto-configures a bean for you to inject the
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/mongodb/template/MyBean.java[]
include::{docs-java}/data/nosql/mongodb/template/MyBean.java[]
----
See the {spring-data-mongodb-api}/core/MongoOperations.html[`MongoOperations` Javadoc] for complete details.
@@ -137,7 +137,7 @@ You could take the JPA example from earlier and, assuming that `City` is now a M
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/mongodb/repositories/CityRepository.java[]
include::{docs-java}/data/nosql/mongodb/repositories/CityRepository.java[]
----
TIP: You can customize document scanning locations by using the `@EntityScan` annotation.
@@ -182,7 +182,7 @@ The following example shows how to inject a Neo4j `Driver` that gives you access
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/neo4j/connecting/MyBean.java[]
include::{docs-java}/data/nosql/neo4j/connecting/MyBean.java[]
----
You can configure various aspects of the driver using `spring.neo4j.*` properties.
@@ -214,7 +214,7 @@ You could take the JPA example from earlier and define `City` as Spring Data Neo
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/neo4j/repositories/CityRepository.java[]
include::{docs-java}/data/nosql/neo4j/repositories/CityRepository.java[]
----
The `spring-boot-starter-data-neo4j` "`Starter`" enables the repository support as well as transaction management.
@@ -230,7 +230,7 @@ To enable transaction management, the following bean must be defined in your con
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/neo4j/repositories/MyNeo4jConfiguration.java[]
include::{docs-java}/data/nosql/neo4j/repositories/MyNeo4jConfiguration.java[]
----
====
@@ -251,7 +251,7 @@ The following example shows how to inject a Solr bean:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/solr/connecting/MyBean.java[]
include::{docs-java}/data/nosql/solr/connecting/MyBean.java[]
----
If you add your own `@Bean` of type `SolrClient`, it replaces the default.
@@ -343,7 +343,7 @@ as shown in the following example:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/elasticsearch/connectingusingspringdata/MyBean.java[]
include::{docs-java}/data/nosql/elasticsearch/connectingusingspringdata/MyBean.java[]
----
In the presence of `spring-data-elasticsearch` and the required dependencies for using a `WebClient` (typically `spring-boot-starter-webflux`), Spring Boot can also auto-configure a <<features#data.nosql.elasticsearch.connecting-using-rest.webclient,ReactiveElasticsearchClient>> and a `ReactiveElasticsearchTemplate` as beans.
@@ -436,7 +436,7 @@ The following code listing shows how to inject a Cassandra bean:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/cassandra/connecting/MyBean.java[]
include::{docs-java}/data/nosql/cassandra/connecting/MyBean.java[]
----
If you add your own `@Bean` of type `CassandraTemplate`, it replaces the default.
@@ -515,7 +515,7 @@ The following examples shows how to inject a `CouchbaseTemplate` bean:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/couchbase/repositories/MyBean.java[]
include::{docs-java}/data/nosql/couchbase/repositories/MyBean.java[]
----
There are a few beans that you can define in your own configuration to override those provided by the auto-configuration:
@@ -529,7 +529,7 @@ For instance, you can customize the converters to use, as follows:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/couchbase/repositories/MyCouchbaseConfiguration.java[]
include::{docs-java}/data/nosql/couchbase/repositories/MyCouchbaseConfiguration.java[]
----
@@ -576,7 +576,7 @@ You can also inject an auto-configured `LdapTemplate` instance as you would with
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/nosql/ldap/repositories/MyBean.java[]
include::{docs-java}/data/nosql/ldap/repositories/MyBean.java[]
----

20
spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc
View File

@@ -160,7 +160,7 @@ Spring's `JdbcTemplate` and `NamedParameterJdbcTemplate` classes are auto-config
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/sql/jdbctemplate/MyBean.java[]
include::{docs-java}/data/sql/jdbctemplate/MyBean.java[]
----
You can customize some properties of the template by using the `spring.jdbc.template.*` properties, as shown in the following example:
@@ -204,7 +204,7 @@ A typical entity class resembles the following example:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/sql/jpaandspringdata/entityclasses/City.java[]
include::{docs-java}/data/sql/jpaandspringdata/entityclasses/City.java[]
----
TIP: You can customize entity scanning locations by using the `@EntityScan` annotation.
@@ -227,7 +227,7 @@ The following example shows a typical Spring Data repository interface definitio
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/sql/jpaandspringdata/repositories/CityRepository.java[]
include::{docs-java}/data/sql/jpaandspringdata/repositories/CityRepository.java[]
----
Spring Data JPA repositories support three different modes of bootstrapping: default, deferred, and lazy.
@@ -255,7 +255,7 @@ To use Spring Data Envers, make sure your repository extends from `RevisionRepos
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/sql/jpaandspringdata/repositories/CountryRepository.java[]
include::{docs-java}/data/sql/jpaandspringdata/repositories/CountryRepository.java[]
----
NOTE: For more details, check the {spring-data-envers-doc}[Spring Data Envers reference documentation].
@@ -389,7 +389,7 @@ To use the `DSLContext`, you can inject it, as shown in the following example:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/sql/jooq/dslcontext/MyBean.java[tag=!method]
include::{docs-java}/data/sql/jooq/dslcontext/MyBean.java[tag=!method]
----
TIP: The jOOQ manual tends to use a variable named `create` to hold the `DSLContext`.
@@ -398,7 +398,7 @@ You can then use the `DSLContext` to construct your queries, as shown in the fol
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/sql/jooq/dslcontext/MyBean.java[tag=method]
include::{docs-java}/data/sql/jooq/dslcontext/MyBean.java[tag=method]
----
@@ -451,14 +451,14 @@ The following example shows how to manually override the database port while the
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/sql/r2dbc/MyR2dbcConfiguration.java[]
include::{docs-java}/data/sql/r2dbc/MyR2dbcConfiguration.java[]
----
The following examples show how to set some PostgreSQL connection options:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/sql/r2dbc/MyPostgresR2dbcConfiguration.java[]
include::{docs-java}/data/sql/r2dbc/MyPostgresR2dbcConfiguration.java[]
----
When a `ConnectionFactory` bean is available, the regular JDBC `DataSource` auto-configuration backs off.
@@ -495,7 +495,7 @@ A `DatabaseClient` bean is auto-configured, and you can `@Autowire` it directly
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/sql/r2dbc/usingdatabaseclient/MyBean.java[]
include::{docs-java}/data/sql/r2dbc/usingdatabaseclient/MyBean.java[]
----
@@ -515,7 +515,7 @@ The following example shows a typical Spring Data repository interface definitio
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/sql/r2dbc/repositories/CityRepository.java[]
include::{docs-java}/data/sql/r2dbc/repositories/CityRepository.java[]
----
TIP: We have barely scratched the surface of Spring Data R2DBC. For complete details, see the {spring-data-r2dbc-docs}[Spring Data R2DBC reference documentation].

8
spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/caching.adoc
View File

@@ -11,7 +11,7 @@ In a nutshell, to add caching to an operation of your service add the relevant a
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/caching/MyMathService.java[]
include::{docs-java}/io/caching/MyMathService.java[]
----
This example demonstrates the use of caching on a potentially costly operation.
@@ -61,7 +61,7 @@ The following example sets a flag to say that `null` values should be passed dow
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/caching/provider/MyCacheManagerConfiguration.java[]
include::{docs-java}/io/caching/provider/MyCacheManagerConfiguration.java[]
----
NOTE: In the preceding example, an auto-configured `ConcurrentMapCacheManager` is expected.
@@ -177,7 +177,7 @@ The following example shows a customizer that configures a specific entry expira
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/caching/provider/couchbase/MyCouchbaseCacheManagerConfiguration.java[]
include::{docs-java}/io/caching/provider/couchbase/MyCouchbaseCacheManagerConfiguration.java[]
----
@@ -208,7 +208,7 @@ The following example shows a customizer that configures a specific time to live
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/caching/provider/redis/MyRedisCacheManagerConfiguration.java[]
include::{docs-java}/io/caching/provider/redis/MyRedisCacheManagerConfiguration.java[]
----

6
spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/jta.adoc
View File

@@ -43,7 +43,7 @@ You can inject into your bean without needing to use any `@Qualifier`:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/jta/mixingxaandnonxaconnections/primary/MyBean.java[tag=*]
include::{docs-java}/io/jta/mixingxaandnonxaconnections/primary/MyBean.java[tag=*]
----
In some situations, you might want to process certain JMS messages by using a non-XA `ConnectionFactory`.
@@ -53,14 +53,14 @@ If you want to use a non-XA `ConnectionFactory`, you can the `nonXaJmsConnection
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/jta/mixingxaandnonxaconnections/nonxa/MyBean.java[tag=*]
include::{docs-java}/io/jta/mixingxaandnonxaconnections/nonxa/MyBean.java[tag=*]
----
For consistency, the `jmsConnectionFactory` bean is also provided by using the bean alias `xaJmsConnectionFactory`:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/jta/mixingxaandnonxaconnections/xa/MyBean.java[tag=*]
include::{docs-java}/io/jta/mixingxaandnonxaconnections/xa/MyBean.java[tag=*]
----

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/quartz.adoc
View File

@@ -52,5 +52,5 @@ Regular beans can also be injected in a similar manner, as shown in the followin
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/quartz/MySampleJob.java[]
include::{docs-java}/io/quartz/MySampleJob.java[]
----

8
spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/rest-client.adoc
View File

@@ -13,7 +13,7 @@ The following code shows a typical example:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/resttemplate/MyService.java[]
include::{docs-java}/io/restclient/resttemplate/MyService.java[]
----
TIP: `RestTemplateBuilder` includes a number of useful methods that can be used to quickly configure a `RestTemplate`.
@@ -35,7 +35,7 @@ The following example shows a customizer that configures the use of a proxy for
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/resttemplate/customization/MyRestTemplateCustomizer.java[]
include::{docs-java}/io/restclient/resttemplate/customization/MyRestTemplateCustomizer.java[]
----
Finally, you can also create your own `RestTemplateBuilder` bean.
@@ -44,7 +44,7 @@ The following example exposes a `RestTemplateBuilder` with what Spring Boot woul
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/resttemplate/customization/MyRestTemplateBuilderConfiguration.java[]
include::{docs-java}/io/restclient/resttemplate/customization/MyRestTemplateBuilderConfiguration.java[]
----
The most extreme (and rarely used) option is to create your own `RestTemplateBuilder` bean without using a configurer.
@@ -65,7 +65,7 @@ The following code shows a typical example:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/webclient/MyService.java[]
include::{docs-java}/io/restclient/webclient/MyService.java[]
----

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/validation.adoc
View File

@@ -8,7 +8,7 @@ For instance, the following service triggers the validation of the first argumen
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/validation/MyBean.java[]
include::{docs-java}/io/validation/MyBean.java[]
----
The application's `MessageSource` is used when resolving +`{parameters}`+ in constraint messages.

4
spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/webservices.adoc
View File

@@ -27,7 +27,7 @@ The following code shows a typical example:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/webservices/template/MyService.java[]
include::{docs-java}/io/webservices/template/MyService.java[]
----
By default, `WebServiceTemplateBuilder` detects a suitable HTTP-based `WebServiceMessageSender` using the available HTTP client libraries on the classpath.
@@ -35,5 +35,5 @@ You can also customize read and connection timeouts as follows:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/webservices/template/MyWebServiceTemplateConfiguration.java[]
include::{docs-java}/io/webservices/template/MyWebServiceTemplateConfiguration.java[]
----

8
spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/amqp.adoc
View File

@@ -51,7 +51,7 @@ Spring's `AmqpTemplate` and `AmqpAdmin` are auto-configured, and you can autowir
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/amqp/sending/MyBean.java[]
include::{docs-java}/messaging/amqp/sending/MyBean.java[]
----
NOTE: {spring-amqp-api}/rabbit/core/RabbitMessagingTemplate.html[`RabbitMessagingTemplate`] can be injected in a similar manner.
@@ -88,7 +88,7 @@ The following sample component creates a listener endpoint on the `someQueue` qu
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/amqp/receiving/MyBean.java[]
include::{docs-java}/messaging/amqp/receiving/MyBean.java[]
----
TIP: See {spring-amqp-api}/rabbit/annotation/EnableRabbit.html[the Javadoc of `@EnableRabbit`] for more details.
@@ -102,14 +102,14 @@ For instance, the following configuration class exposes another factory that use
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/amqp/receiving/custom/MyRabbitConfiguration.java[]
include::{docs-java}/messaging/amqp/receiving/custom/MyRabbitConfiguration.java[]
----
Then you can use the factory in any `@RabbitListener`-annotated method, as follows:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/amqp/receiving/custom/MyBean.java[]
include::{docs-java}/messaging/amqp/receiving/custom/MyBean.java[]
----
You can enable retries to handle situations where your listener throws an exception.

8
spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/jms.adoc
View File

@@ -128,7 +128,7 @@ Spring's `JmsTemplate` is auto-configured, and you can autowire it directly into
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/jms/sending/MyBean.java[]
include::{docs-java}/messaging/jms/sending/MyBean.java[]
----
NOTE: {spring-framework-api}/jms/core/JmsMessagingTemplate.html[`JmsMessagingTemplate`] can be injected in a similar manner.
@@ -153,7 +153,7 @@ The following component creates a listener endpoint on the `someQueue` destinati
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/jms/receiving/MyBean.java[]
include::{docs-java}/messaging/jms/receiving/MyBean.java[]
----
TIP: See {spring-framework-api}/jms/annotation/EnableJms.html[the Javadoc of `@EnableJms`] for more details.
@@ -164,12 +164,12 @@ For instance, the following example exposes another factory that uses a specific
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/jms/receiving/custom/MyJmsConfiguration.java[]
include::{docs-java}/messaging/jms/receiving/custom/MyJmsConfiguration.java[]
----
Then you can use the factory in any `@JmsListener`-annotated method as follows:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/jms/receiving/custom/MyBean.java[]
include::{docs-java}/messaging/jms/receiving/custom/MyBean.java[]
----

10
spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/kafka.adoc
View File

@@ -27,7 +27,7 @@ Spring's `KafkaTemplate` is auto-configured, and you can autowire it directly in
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/kafka/sending/MyBean.java[]
include::{docs-java}/messaging/kafka/sending/MyBean.java[]
----
NOTE: If the property configprop:spring.kafka.producer.transaction-id-prefix[] is defined, a `KafkaTransactionManager` is automatically configured.
@@ -44,7 +44,7 @@ The following component creates a listener endpoint on the `someTopic` topic:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/kafka/receiving/MyBean.java[]
include::{docs-java}/messaging/kafka/receiving/MyBean.java[]
----
If a `KafkaTransactionManager` bean is defined, it is automatically associated to the container factory.
@@ -73,7 +73,7 @@ To use the factory bean, wire `StreamsBuilder` into your `@Bean` as shown in the
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/kafka/streams/MyKafkaStreamsConfiguration.java[]
include::{docs-java}/messaging/kafka/streams/MyKafkaStreamsConfiguration.java[]
----
By default, the streams managed by the `StreamBuilder` object it creates are started automatically.
@@ -158,14 +158,14 @@ There are several ways to do that:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/kafka/embedded/property/MyTest.java[tag=*]
include::{docs-java}/messaging/kafka/embedded/property/MyTest.java[tag=*]
----
* Configure a property name on the `@EmbeddedKafka` annotation:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/messaging/kafka/embedded/annotation/MyTest.java[]
include::{docs-java}/messaging/kafka/embedded/annotation/MyTest.java[]
----
* Use a placeholder in configuration properties:

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/rsocket.adoc
View File

@@ -82,5 +82,5 @@ The following code shows a typical example:
[source,java,indent=0,subs="verbatim"]
----
include::{docs-java}/features/rsocket//requester/MyService.java[]
include::{docs-java}/messaging/rsocket/requester/MyService.java[]
----