Skip to content

Commit 0f1e9aa

Browse files
committed
Some docs clean up; prepare for release
1 parent 996daca commit 0f1e9aa

File tree

6 files changed

+47
-29
lines changed

6 files changed

+47
-29
lines changed

build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,9 @@ ext {
102102
springDataVersion = project.hasProperty('springDataVersion') ? project.springDataVersion : '2021.0.1'
103103
springKafkaVersion = '2.7.1'
104104
springRetryVersion = '1.3.1'
105-
springSecurityVersion = project.hasProperty('springSecurityVersion') ? project.springSecurityVersion : '5.5.0-SNAPSHOT'
105+
springSecurityVersion = project.hasProperty('springSecurityVersion') ? project.springSecurityVersion : '5.5.0'
106106
springVersion = project.hasProperty('springVersion') ? project.springVersion : '5.3.7'
107-
springWsVersion = '3.1.0-SNAPSHOT'
107+
springWsVersion = '3.1.0'
108108
tomcatVersion = '9.0.46'
109109
xmlUnitVersion = '2.8.2'
110110
xstreamVersion = '1.4.17'
@@ -342,7 +342,7 @@ configure(javaProjects) { subproject ->
342342

343343
checkstyle {
344344
configDirectory.set(rootProject.file('src/checkstyle'))
345-
toolVersion = project.hasProperty('checkstyleVersion') ? project.checkstyleVersion : '8.41.1'
345+
toolVersion = project.hasProperty('checkstyleVersion') ? project.checkstyleVersion : '8.42'
346346
}
347347

348348
jar {

src/reference/asciidoc/codec.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ See the https://docs.spring.io/spring-integration/api/org/springframework/integr
2929
==== `CodecMessageConverter`
3030

3131
Certain endpoints (such as TCP and Redis) have no concept of message headers.
32-
They support the use of a `MessageConverter`, and the `CodecMessageConverter` can be used to convert a message to or from a `byte[]` for
33-
transmission.
32+
They support the use of a `MessageConverter`, and the `CodecMessageConverter` can be used to convert a message to or from a `byte[]` for transmission.
3433

3534
See the https://docs.spring.io/spring-integration/api/org/springframework/integration/codec/CodecMessageConverter.html[Javadoc] for more information.
3635

src/reference/asciidoc/kafka.adoc

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,27 @@
44
=== Overview
55

66
Spring Integration for Apache Kafka is based on the https://projects.spring.io/spring-kafka/[Spring for Apache Kafka project].
7+
8+
You need to include this dependency into your project:
9+
10+
====
11+
[source, xml, subs="normal", role="primary"]
12+
.Maven
13+
----
14+
<dependency>
15+
<groupId>org.springframework.integration</groupId>
16+
<artifactId>spring-integration-kafka</artifactId>
17+
<version>{project-version}</version>
18+
</dependency>
19+
----
20+
21+
[source, groovy, subs="normal", role="secondary"]
22+
.Gradle
23+
----
24+
compile "org.springframework.integration:spring-integration-kafka:{project-version}"
25+
----
26+
====
27+
728
It provides the following components:
829

930
* <<kafka-outbound>>
@@ -373,7 +394,7 @@ Refer to the javadocs for available properties.
373394

374395
[[max-poll-records]]
375396
By default, `max.poll.records` must be either explicitly set in the consumer factory, or it will be forced to 1 if the consumer factory is a `DefaultKafkaConsumerFactory`.
376-
Starting with version 3.2, you can set the property `allowMultiFetch` to `true` to override this behavior.
397+
You can set the property `allowMultiFetch` to `true` to override this behavior.
377398

378399
IMPORTANT: You must poll the consumer within `max.poll.interval.ms` to avoid a rebalance.
379400
If you set `allowMultiFetch` to `true` you must process all the retrieved records, and poll again, within `max.poll.interval.ms`.
@@ -663,7 +684,7 @@ public IntegrationFlow flowWithPollable(KafkaTemplate<Integer, String> template,
663684
664685
return IntegrationFlows.from(...)
665686
...
666-
.channel(Kafka.pollableChannel(template, source, "someTopic3").greoupId("group3"))
687+
.channel(Kafka.pollableChannel(template, source, "someTopic3").groupId("group3"))
667688
.handle(..., e -> e.poller(...))
668689
...
669690
.get();

src/reference/asciidoc/mail.adoc

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This section describes how to work with mail messages in Spring Integration.
66
You need to include this dependency into your project:
77

88
====
9+
[source, xml, subs="normal", role="primary"]
910
.Maven
10-
[source, xml, subs="normal"]
1111
----
1212
<dependency>
1313
<groupId>org.springframework.integration</groupId>
@@ -16,8 +16,8 @@ You need to include this dependency into your project:
1616
</dependency>
1717
----
1818
19+
[source, groovy, subs="normal", role="secondary"]
1920
.Gradle
20-
[source, groovy, subs="normal"]
2121
----
2222
compile "org.springframework.integration:spring-integration-mail:{project-version}"
2323
----
@@ -177,38 +177,37 @@ To change this behavior and receive a `Multipart` object payload, set `embeddedP
177177
For content types that are unknown to the `DataHandler`, the contents are rendered as a `byte[]` with a `contentType` header of `application/octet-stream`.
178178

179179
When you do not provide a header mapper, the message payload is the `MimeMessage` presented by `javax.mail`.
180-
The framework provides a `MailToStringTransformer` that you can use to convert the message by using a strategy to convert the mail contents to a `String`.
181-
This is also available by using the XML namespace, as the following example shows:
180+
The framework provides a `MailToStringTransformer` that you can use to convert the message by using a strategy to convert the mail contents to a `String`:
182181

183182
====
184-
[source, xml]
183+
[source, java, role="primary"]
184+
.Java DSL
185185
----
186-
<int-mail:mail-to-string-transformer ... >
186+
...
187+
.transform(Mail.toStringTransformer())
188+
...
187189
----
188-
====
189-
190-
The following example does the same thing with Java configuration:
191-
192-
====
193-
[source, java]
190+
[source, java, role="secondary"]
191+
.Java
194192
----
195193
@Bean
196194
@Transformer(inputChannel="...", outputChannel="...")
197195
public Transformer transformer() {
198196
return new MailToStringTransformer();
199197
}
200198
----
201-
====
202-
203-
The following example does the same thing with the Java DSL:
204-
205-
====
206-
[source, java]
199+
[source, kotlin, role="secondary"]
200+
.Kotlin
207201
----
208202
...
209-
.transform(Mail.toStringTransformer())
203+
transform(Mail.toStringTransformer())
210204
...
211205
----
206+
[source, xml, role="secondary"]
207+
.XML
208+
----
209+
<int-mail:mail-to-string-transformer ... >
210+
----
212211
====
213212

214213
Starting with version 4.3, the transformer handles embedded `Part` instances (as well as `Multipart` instances, which were handled previously).

src/reference/asciidoc/meta-data-store.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ The following example shows how to configure a 'PropertiesPersistingMetadataStor
3232
class="org.springframework.integration.metadata.PropertiesPersistingMetadataStore"/>
3333
----
3434

35-
Alternatively, you can provide your own implementation of the `MetadataStore` interface (for example,
36-
`JdbcMetadataStore`) and configure it as a bean in the application context.
35+
Alternatively, you can provide your own implementation of the `MetadataStore` interface (for example, `JdbcMetadataStore`) and configure it as a bean in the application context.
3736

3837
Starting with version 4.0, `SimpleMetadataStore`, `PropertiesPersistingMetadataStore`, and `RedisMetadataStore` implement `ConcurrentMetadataStore`.
3938
These provide for atomic updates and can be used across multiple component or application instances.

src/reference/asciidoc/samples.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -578,7 +578,7 @@ The following listing configures the `xpath-router` that routes the messages:
578578
====
579579
[source,xml]
580580
----
581-
<si-xml:xpath-router id="instockRouter" input-channel="orderRoutingChannel" resolution-required="true">
581+
<si-xml:xpath-router id="inStockRouter" input-channel="orderRoutingChannel" resolution-required="true">
582582
<si-xml:xpath-expression expression="/orderNs:orderItem/@in-stock" namespace-map="orderNamespaceMap" />
583583
<si-xml:mapping value="true" channel="warehouseDispatchChannel"/>
584584
<si-xml:mapping value="false" channel="outOfStockChannel"/>

0 commit comments

Comments
 (0)