From 0268a68b63bb789a28fd18e5888d2afaa785818a Mon Sep 17 00:00:00 2001 From: Artem Bilan Date: Thu, 9 Jun 2016 19:05:51 -0400 Subject: [PATCH] INT-4004: Improve MessageStore Docs JIRA: https://jira.spring.io/browse/INT-4004 --- .../integration/jdbc/JdbcMessageStore.java | 10 ++++++---- .../jdbc/store/JdbcChannelMessageStore.java | 9 +++++---- src/reference/asciidoc/message-store.adoc | 4 ++-- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/JdbcMessageStore.java b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/JdbcMessageStore.java index 8fdb67f4a7..fe079d3e6c 100644 --- a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/JdbcMessageStore.java +++ b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/JdbcMessageStore.java @@ -69,12 +69,14 @@ import org.springframework.util.StringUtils; * Implementation of {@link MessageStore} using a relational database via JDBC. SQL scripts to create the necessary * tables are packaged as org/springframework/integration/jdbc/schema-*.sql, where * is the * target database type. - * - * Notice: Starting with Spring Integration 3.0, this class will move to package: - * org.springframework.integration.jdbc.store. - * + *

+ * Notice: Starting with Spring Integration 5.0, this class will move to package: + * {@code org.springframework.integration.jdbc.store}. + *

* If you intend backing a {@link MessageChannel} using a JDBC-based Message Store, * please consider using the channel-specific {@link JdbcChannelMessageStore} instead. + * This implementation is intended for correlation components (e.g. {@code }), + * {@code } and similar. * * @author Dave Syer * @author Oleg Zhurakousky diff --git a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/store/JdbcChannelMessageStore.java b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/store/JdbcChannelMessageStore.java index d7115c11c1..41d2c2f9cb 100644 --- a/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/store/JdbcChannelMessageStore.java +++ b/spring-integration-jdbc/src/main/java/org/springframework/integration/jdbc/store/JdbcChannelMessageStore.java @@ -85,10 +85,11 @@ import org.springframework.util.StringUtils; * As such, the {@link JdbcChannelMessageStore} uses database specific SQL queries. *

*

- * Contrary to the {@link JdbcMessageStore}, this implementation uses one single - * database table only. The SQL scripts to create the necessary table are packaged - * under org/springframework/integration/jdbc/messagestore/channel/schema-*.sql, - * where * denotes the target database type. + * Contrary to the {@link JdbcMessageStore}, this implementation uses a single database table, + * optimized to operate like a queue. + * The SQL scripts for creating the table are packaged + * under {@code org/springframework/integration/jdbc/messagestore/channel/schema-*.sql}, + * where {@code *} denotes the target database type. *

* * @author Gunnar Hillert diff --git a/src/reference/asciidoc/message-store.adoc b/src/reference/asciidoc/message-store.adoc index e02acc71d8..73cc48bad2 100644 --- a/src/reference/asciidoc/message-store.adoc +++ b/src/reference/asciidoc/message-store.adoc @@ -10,7 +10,7 @@ RDBMS). Spring Integration provides support for the _Message Store_ pattern by a) defining a `org.springframework.integration.store.MessageStore` strategy interface, b) providing several implementations of this interface, and c) exposing a `message-store` attribute on all components that have the capability to buffer messages so that you can inject any instance that implements the `MessageStore` interface. -Details on how to configure a specific _Message Store_ implementation and/or how to inject a `MessageStore` implementation into a specific buffering component are described throughout the manual (see the specific component, such as _QueueChannel_, _Aggregator_, _Resequencer_ etc.), but here are a couple of samples to give you an idea: +Details on how to configure a specific _Message Store_ implementation and/or how to inject a `MessageStore` implementation into a specific buffering component are described throughout the manual (see the specific component, such as <>, <>, <> etc.), but here are a couple of samples to give you an idea: QueueChannel [source,xml] @@ -62,7 +62,7 @@ For more information, refer to the <>. _Spring Integration 4.0_ introduced two new interfaces `ChannelMessageStore` - to implement operations specific for `QueueChannel` s, `PriorityCapableChannelMessageStore` - to mark `MessageStore` implementation to be used for `PriorityChannel` s and to provide _priority_ order for persisted Messages. The real behaviour depends on implementation. -The Framework provides these implementations, which can be used as a persistent `MessageStore` for `PriorityChannel`: +The Framework provides these implementations, which can be used as a persistent `MessageStore` for `QueueChannel` and `PriorityChannel`: * <> * <>