Skip to content

Commit 2c99e24

Browse files
committed
Fix many doc typos according to IDEA suggestions
1 parent af7e368 commit 2c99e24

File tree

183 files changed

+678
-712
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

183 files changed

+678
-712
lines changed

src/reference/antora/modules/ROOT/pages/aggregator.adoc

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

src/reference/antora/modules/ROOT/pages/amqp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Spring Integration provides channel adapters for receiving and sending messages by using the Advanced Message Queuing Protocol (AMQP).
55

6-
You need to include this dependency into your project:
6+
This dependency is required for the project:
77

88
[tabs]
99
======

src/reference/antora/modules/ROOT/pages/amqp/alternative-confirms-returns.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[[alternative-confirms-returns]]
22
= Alternative Mechanism for Publisher Confirms and Returns
33

4-
When the connection factory is configured for publisher confirms and returns, the sections above discuss the configuration of message channels to receive the confirms and returns asynchronously.
5-
Starting with version 5.4, there is an additional mechanism which is generally easier to use.
4+
When the connection factory is configured for publisher confirms and returns, the sections above discuss the configuration of message channels to receive the `confirms` and `returns` asynchronously.
5+
Starting with version 5.4, there is an additional mechanism that is generally easier to use.
66

7-
In this case, do not configure a `confirm-correlation-expression` or the confirm and return channels.
7+
In this case, do not configure a `confirm-correlation-expression` or the `confirm` and `return` channels.
88
Instead, add a `CorrelationData` instance in the `AmqpHeaders.PUBLISH_CONFIRM_CORRELATION` header; you can then wait for the result(s) later, by checking the state of the future in the `CorrelationData` instances for which you have sent messages.
99
The `returnedMessage` field will always be populated (if a message is returned) before the future is completed.
1010

@@ -27,5 +27,5 @@ catch { ... }
2727
----
2828

2929
To improve performance, you may wish to send multiple messages and wait for the confirmations later, rather than one-at-a-time.
30-
The returned message is the raw message after conversion; you can sub-class a `CorrelationData` with whatever additional data you need.
30+
The returned message is the raw message after conversion; you can subclass a `CorrelationData` with whatever additional data you need.
3131

src/reference/antora/modules/ROOT/pages/amqp/async-outbound-gateway.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,9 @@ By default, this is an empty `String`.
128128
Mutually exclusive with 'routing-key-expression'.
129129
Optional.
130130
<11> A SpEL expression that is evaluated to determine the routing-key to use when sending messages,
131-
with the message as the root object (for example, 'payload.key').
131+
with the message as the root object, (for example, `payload.key`).
132132
By default, this is an empty `String`.
133-
Mutually exclusive with 'routing-key'.
133+
Mutually exclusive with `routing-key`.
134134
Optional.
135135
<12> The default delivery mode for messages: `PERSISTENT` or `NON_PERSISTENT`.
136136
Overridden if the `header-mapper` sets the delivery mode.
@@ -170,7 +170,7 @@ Requires the underlying `AsyncRabbitTemplate` to have its `mandatory` property s
170170
Also see xref:amqp/alternative-confirms-returns.adoc[Alternative Mechanism for Publisher Confirms and Returns].
171171
Optional.
172172
<18> When set to `false`, the endpoint tries to connect to the broker during application context initialization.
173-
Doing so allows "`fail fast`" detection of bad configuration, by logging an error message if the broker is down.
173+
Doing so allows "`fail fast`" detection of bad configuration by logging an error message if the broker is down.
174174
When `true` (the default), the connection is established (if it does not already exist because some other component established
175175
it) when the first message is sent.
176176

src/reference/antora/modules/ROOT/pages/amqp/channels.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22
= AMQP-backed Message Channels
33

44
There are two message channel implementations available.
5-
One is point-to-point, and the other is publish-subscribe.
6-
Both of these channels provide a wide range of configuration attributes for the underlying `AmqpTemplate` and
7-
`SimpleMessageListenerContainer` (as shown earlier in this chapter for the channel adapters and gateways).
5+
One is `point-to-point`, and the other is `publish-subscribe`.
6+
Both of these channels provide a wide range of configuration attributes for the underlying `AmqpTemplate` and `SimpleMessageListenerContainer` (as shown earlier in this chapter for the channel adapters and gateways).
87
However, the examples we show here have minimal configuration.
98
Explore the XML schema to view the available attributes.
109

@@ -43,7 +42,7 @@ Note that, previously, `channel-transacted` was `true` by default.
4342
Now, by default, it is `false` for the `AbstractMessageListenerContainer`.
4443

4544
Prior to version 4.3, AMQP-backed channels only supported messages with `Serializable` payloads and headers.
46-
The entire message was converted (serialized) and sent to RabbitMQ.
45+
The entire message was converted, (serialized) and sent to RabbitMQ.
4746
Now, you can set the `extract-payload` attribute (or `setExtractPayload()` when using Java configuration) to `true`.
4847
When this flag is `true`, the message payload is converted and the headers are mapped, in a manner similar to when you use channel adapters.
4948
This arrangement lets AMQP-backed channels be used with non-serializable payloads (perhaps with another message converter, such as the `Jackson2JsonMessageConverter`).

src/reference/antora/modules/ROOT/pages/amqp/content-type-conversion-outbound.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,6 @@ There is now a property called `headersMappedLast` on the outbound channel adapt
5252
Setting this to `true` restores the behavior of overwriting the property added by the converter.
5353
5454
Starting with version 5.1.9, a similar `replyHeadersMappedLast` is provided for the `AmqpInboundGateway` when we produce a reply and would like to override headers populated by the converter.
55-
See its JavaDocs for more information.
55+
See its Javadocs for more information.
5656
====
5757

src/reference/antora/modules/ROOT/pages/amqp/conversion-inbound.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Inbound messages, arriving at the channel adapter or gateway, are converted to t
66
By default, a `SimpleMessageConverter` is used, which handles java serialization and text.
77
Headers are mapped using the `DefaultHeaderMapper.inboundMapper()` by default.
88
If a conversion error occurs, and there is no error channel defined, the exception is thrown to the container and handled by the listener container's error handler.
9-
The default error handler treats conversion errors as fatal and the message will be rejected (and routed to a dead-letter exchange, if the queue is so configured).
9+
The default error handler treats conversion errors as fatal, and the message will be rejected (and routed to a dead-letter exchange if the queue is so configured).
1010
If an error channel is defined, the `ErrorMessage` payload is a `ListenerExecutionFailedException` with properties `failedMessage` (the Spring AMQP message that could not be converted) and the `cause`.
1111
If the container `AcknowledgeMode` is `AUTO` (the default) and the error flow consumes the error without throwing an exception, the original message will be acknowledged.
1212
If the error flow throws an exception, the exception type, in conjunction with the container's error handler, will determine whether the message is requeued.

src/reference/antora/modules/ROOT/pages/amqp/inbound-channel-adapter.adoc

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,8 @@ XML::
9090
batch-size="" <25>
9191
consumers-per-queue <26>
9292
batch-mode="MESSAGES"/> <27>
93-
93+
----
94+
======
9495
<1> The unique ID for this adapter.
9596
Optional.
9697
<2> Message channel to which converted messages should be sent.
@@ -126,15 +127,15 @@ Optional (defaults to true).
126127
Optional.
127128
By default, only standard AMQP properties (such as `contentType`) are copied to Spring Integration `MessageHeaders`.
128129
Any user-defined headers within the AMQP `MessageProperties` are NOT copied to the message by the default `DefaultAmqpHeaderMapper`.
129-
Not allowed if 'request-header-names' is provided.
130+
Not allowed if `request-header-names` is provided.
130131
<12> Comma-separated list of the names of AMQP Headers to be mapped from the AMQP request into the `MessageHeaders`.
131132
This can only be provided if the 'header-mapper' reference is not provided.
132133
The values in this list can also be simple patterns to be matched against the header names (such as "\*" or "thing1*, thing2" or "*something").
133134
<13> Reference to the `AbstractMessageListenerContainer` to use for receiving AMQP Messages.
134135
If this attribute is provided, no other attribute related to the listener container configuration should be provided.
135136
In other words, by setting this reference, you must take full responsibility for the listener container configuration.
136137
The only exception is the `MessageListener` itself.
137-
Since that is actually the core responsibility of this channel adapter implementation, the referenced listener container must not already have its own `MessageListener`.
138+
Since that is actually the core responsibility of this channel adapter implementation, the referenced listener container must not yet have its own `MessageListener`.
138139
Optional.
139140
<14> The `MessageConverter` to use when receiving AMQP messages.
140141
Optional.
@@ -170,8 +171,7 @@ Optional (defaults to `DefaultTransactionAttribute`).
170171
The transaction manager works in conjunction with the `channel-transacted` attribute.
171172
If there is already a transaction in progress when the framework is sending or receiving a message and the `channelTransacted` flag is `true`, the commit or rollback of the messaging transaction is deferred until the end of the current transaction.
172173
If the `channelTransacted` flag is `false`, no transaction semantics apply to the messaging operation (it is auto-acked).
173-
For further information, see
174-
https://docs.spring.io/spring-amqp/reference/html/%255Freference.html#%5Ftransactions[Transactions with Spring AMQP].
174+
For further information, see https://docs.spring.io/spring-amqp/reference/html/%255Freference.html#%5Ftransactions[Transactions with Spring AMQP].
175175
Optional.
176176
<25> Tells the `SimpleMessageListenerContainer` how many messages to process in a single request.
177177
For best results, it should be less than or equal to the value set in `prefetch-count`.
@@ -183,8 +183,6 @@ See the https://docs.spring.io/spring-amqp/reference/html/[Spring AMQP Reference
183183
When set to `MESSAGES` (default), the payload is a `List<Message<?>>` where each message has headers mapped from the incoming AMQP `Message` and the payload is the converted `body`.
184184
When set to `EXTRACT_PAYLOADS`, the payload is a `List<?>` where the elements are converted from the AMQP `Message` body.
185185
`EXTRACT_PAYLOADS_WITH_HEADERS` is similar to `EXTRACT_PAYLOADS` but, in addition, the headers from each message are mapped from the `MessageProperties` into a `List<Map<String, Object>` at the corresponding index; the header name is `AmqpInboundChannelAdapter.CONSOLIDATED_HEADERS`.
186-
----
187-
======
188186

189187
[NOTE]
190188
.container

src/reference/antora/modules/ROOT/pages/amqp/inbound-gateway.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[amqp-inbound-gateway]]
22
= Inbound Gateway
33

4-
The inbound gateway supports all the attributes on the inbound channel adapter (except that 'channel' is replaced by 'request-channel'), plus some additional attributes.
4+
The inbound gateway supports all the attributes on the inbound channel adapter (except that `channel` is replaced by `request-channel`), plus some additional attributes.
55
The following listing shows the available attributes:
66

77
[tabs]

src/reference/antora/modules/ROOT/pages/amqp/message-headers.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Instead, this header is mapped to `amqp_receivedDeliveryMode`, which is not mapp
7272
Starting with version 4.3, patterns in the header mappings can be negated by preceding the pattern with `!`.
7373
Negated patterns get priority, so a list such as `STANDARD_REQUEST_HEADERS,thing1,ba*,!thing2,!thing3,qux,!thing1` does not map `thing1` (nor `thing2` nor `thing3`).
7474
The standard headers plus `bad` and `qux` are mapped.
75-
The negation technique can be useful for example to not map JSON type headers for incoming messages when a JSON deserialization logic is done in the receiver downstream different way.
75+
The negation technique can be useful, for example, to not map JSON type headers for incoming messages when a JSON deserialization logic is done in the receiver downstream a different way.
7676
For this purpose a `!json_*` pattern should be configured for header mapper of the inbound channel adapter/gateway.
7777

7878
IMPORTANT: If you have a user-defined header that begins with `!` that you do wish to map, you need to escape it with `\`, as follows: `STANDARD_REQUEST_HEADERS,\!myBangHeader`.
@@ -86,12 +86,12 @@ It is useful to populate the `messageId` property when message consumers are usi
8686
== The `contentType` Header
8787

8888
Unlike other headers, the `AmqpHeaders.CONTENT_TYPE` is not prefixed with `amqp_`; this allows transparent passing of the contentType header across different technologies.
89-
For example an inbound HTTP message sent to a RabbitMQ queue.
89+
For example, an inbound HTTP message sent to a RabbitMQ queue.
9090

91-
The `contentType` header is mapped to Spring AMQP's `MessageProperties.contentType` property and that is subsequently mapped to RabbitMQ's `content_type` property.
91+
The `contentType` header is mapped to Spring AMQP's `MessageProperties.contentType` property and that is subsequently mapped to RabbitMQ `content_type` property.
9292

9393
Prior to version 5.1, this header was also mapped as an entry in the `MessageProperties.headers` map; this was incorrect and, furthermore, the value could be wrong since the underlying Spring AMQP message converter might have changed the content type.
9494
Such a change would be reflected in the first-class `content_type` property, but not in the RabbitMQ headers map.
95-
Inbound mapping ignored the headers map value.
96-
`contentType` is no longer mapped to an entry in the headers map.
95+
Inbound mapping ignored the header map value.
96+
`contentType` is no longer mapped to an entry in the header map.
9797

0 commit comments

Comments
 (0)