Some docs clean up; prepare for release

This commit is contained in:
Artem Bilan
2021-05-18 13:53:45 -04:00
parent 996daca228
commit 0f1e9aaf2b
6 changed files with 47 additions and 29 deletions

View File

@@ -102,9 +102,9 @@ ext {
springDataVersion = project.hasProperty('springDataVersion') ? project.springDataVersion : '2021.0.1'
springKafkaVersion = '2.7.1'
springRetryVersion = '1.3.1'
springSecurityVersion = project.hasProperty('springSecurityVersion') ? project.springSecurityVersion : '5.5.0-SNAPSHOT'
springSecurityVersion = project.hasProperty('springSecurityVersion') ? project.springSecurityVersion : '5.5.0'
springVersion = project.hasProperty('springVersion') ? project.springVersion : '5.3.7'
springWsVersion = '3.1.0-SNAPSHOT'
springWsVersion = '3.1.0'
tomcatVersion = '9.0.46'
xmlUnitVersion = '2.8.2'
xstreamVersion = '1.4.17'
@@ -342,7 +342,7 @@ configure(javaProjects) { subproject ->
checkstyle {
configDirectory.set(rootProject.file('src/checkstyle'))
toolVersion = project.hasProperty('checkstyleVersion') ? project.checkstyleVersion : '8.41.1'
toolVersion = project.hasProperty('checkstyleVersion') ? project.checkstyleVersion : '8.42'
}
jar {

View File

@@ -29,8 +29,7 @@ See the https://docs.spring.io/spring-integration/api/org/springframework/integr
==== `CodecMessageConverter`
Certain endpoints (such as TCP and Redis) have no concept of message headers.
They support the use of a `MessageConverter`, and the `CodecMessageConverter` can be used to convert a message to or from a `byte[]` for
transmission.
They support the use of a `MessageConverter`, and the `CodecMessageConverter` can be used to convert a message to or from a `byte[]` for transmission.
See the https://docs.spring.io/spring-integration/api/org/springframework/integration/codec/CodecMessageConverter.html[Javadoc] for more information.

View File

@@ -4,6 +4,27 @@
=== Overview
Spring Integration for Apache Kafka is based on the https://projects.spring.io/spring-kafka/[Spring for Apache Kafka project].
You need to include this dependency into your project:
====
[source, xml, subs="normal", role="primary"]
.Maven
----
<dependency>
<groupId>org.springframework.integration</groupId>
<artifactId>spring-integration-kafka</artifactId>
<version>{project-version}</version>
</dependency>
----
[source, groovy, subs="normal", role="secondary"]
.Gradle
----
compile "org.springframework.integration:spring-integration-kafka:{project-version}"
----
====
It provides the following components:
* <<kafka-outbound>>
@@ -373,7 +394,7 @@ Refer to the javadocs for available properties.
[[max-poll-records]]
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`.
Starting with version 3.2, you can set the property `allowMultiFetch` to `true` to override this behavior.
You can set the property `allowMultiFetch` to `true` to override this behavior.
IMPORTANT: You must poll the consumer within `max.poll.interval.ms` to avoid a rebalance.
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,
return IntegrationFlows.from(...)
...
.channel(Kafka.pollableChannel(template, source, "someTopic3").greoupId("group3"))
.channel(Kafka.pollableChannel(template, source, "someTopic3").groupId("group3"))
.handle(..., e -> e.poller(...))
...
.get();

View File

@@ -6,8 +6,8 @@ This section describes how to work with mail messages in Spring Integration.
You need to include this dependency into your project:
====
[source, xml, subs="normal", role="primary"]
.Maven
[source, xml, subs="normal"]
----
<dependency>
<groupId>org.springframework.integration</groupId>
@@ -16,8 +16,8 @@ You need to include this dependency into your project:
</dependency>
----
[source, groovy, subs="normal", role="secondary"]
.Gradle
[source, groovy, subs="normal"]
----
compile "org.springframework.integration:spring-integration-mail:{project-version}"
----
@@ -177,20 +177,18 @@ To change this behavior and receive a `Multipart` object payload, set `embeddedP
For content types that are unknown to the `DataHandler`, the contents are rendered as a `byte[]` with a `contentType` header of `application/octet-stream`.
When you do not provide a header mapper, the message payload is the `MimeMessage` presented by `javax.mail`.
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`.
This is also available by using the XML namespace, as the following example shows:
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`:
====
[source, xml]
[source, java, role="primary"]
.Java DSL
----
<int-mail:mail-to-string-transformer ... >
...
.transform(Mail.toStringTransformer())
...
----
====
The following example does the same thing with Java configuration:
====
[source, java]
[source, java, role="secondary"]
.Java
----
@Bean
@Transformer(inputChannel="...", outputChannel="...")
@@ -198,17 +196,18 @@ public Transformer transformer() {
return new MailToStringTransformer();
}
----
====
The following example does the same thing with the Java DSL:
====
[source, java]
[source, kotlin, role="secondary"]
.Kotlin
----
...
.transform(Mail.toStringTransformer())
transform(Mail.toStringTransformer())
...
----
[source, xml, role="secondary"]
.XML
----
<int-mail:mail-to-string-transformer ... >
----
====
Starting with version 4.3, the transformer handles embedded `Part` instances (as well as `Multipart` instances, which were handled previously).

View File

@@ -32,8 +32,7 @@ The following example shows how to configure a 'PropertiesPersistingMetadataStor
class="org.springframework.integration.metadata.PropertiesPersistingMetadataStore"/>
----
Alternatively, you can provide your own implementation of the `MetadataStore` interface (for example,
`JdbcMetadataStore`) and configure it as a bean in the application context.
Alternatively, you can provide your own implementation of the `MetadataStore` interface (for example, `JdbcMetadataStore`) and configure it as a bean in the application context.
Starting with version 4.0, `SimpleMetadataStore`, `PropertiesPersistingMetadataStore`, and `RedisMetadataStore` implement `ConcurrentMetadataStore`.
These provide for atomic updates and can be used across multiple component or application instances.

View File

@@ -578,7 +578,7 @@ The following listing configures the `xpath-router` that routes the messages:
====
[source,xml]
----
<si-xml:xpath-router id="instockRouter" input-channel="orderRoutingChannel" resolution-required="true">
<si-xml:xpath-router id="inStockRouter" input-channel="orderRoutingChannel" resolution-required="true">
<si-xml:xpath-expression expression="/orderNs:orderItem/@in-stock" namespace-map="orderNamespaceMap" />
<si-xml:mapping value="true" channel="warehouseDispatchChannel"/>
<si-xml:mapping value="false" channel="outOfStockChannel"/>