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

INT-3950: Fix Aggregator documentation

Browse Source 
JIRA: https://jira.spring.io/browse/INT-3950

Previously there was a mention of the `MessageGroupStore.expireMessageGroup(groupId)` which just doesn't existing
in the Framework and never has been there.

* Fix the documentation for the existing `MessageGroupStore.expireMessageGroups(timeout)`.
Although the mention there of `Control Bus` requires to have `@ManagedOperation` on the method.

* Add `@ManagedOperation` for the `MessageGroupStore.expireMessageGroups(timeout)` and confirm with the test-case: `AggregatorWithMessageStoreParserTests`
* Fix the same docs in the XSD for `<aggregator>`
* Fix other typos in the `aggregator.adoc` and `resequencer.adoc`
This commit is contained in:
Artem Bilan
2016-02-05 11:08:14 -05:00
parent 6d4bc8eefa
commit 7628cc5439
8 changed files with 27 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/reference/asciidoc/aggregator.adoc
View File

@@ -356,13 +356,13 @@ _Optional_, by default a volatile in-memory store.
<8> Indicates that expired messages should be aggregated and sent to the 'output-channel' or 'replyChannel' once their containing `MessageGroup` is expired (see `MessageGroupStore.expireMessageGroups(long)`).
One way of expiring `MessageGroup` s is by configuring a `MessageGroupStoreReaper`.
However `MessageGroup` s can alternatively be expired by simply calling `MessageGroupStore.expireMessageGroup(groupId)`.
However `MessageGroup` s can alternatively be expired by simply calling `MessageGroupStore.expireMessageGroups(timeout)`.
That could be accomplished via a Control Bus operation or by simply invoking that method if you have a reference to the `MessageGroupStore` instance.
Otherwise by itself this attribute has no behavior.
It only serves as an indicator of what to do (discard or send to the output/reply channel) with Messages that are still in the `MessageGroup` that is about to be expired.
_Optional_.
_Default - 'false'_.
*NOTE:* This attribute is more properly 'send-partial-result-on-timeout' because the group may not actually expire if
_Default - false_.
*NOTE:* This attribute is more properly `send-partial-result-on-timeout` because the group may not actually expire if
`expire-groups-upon-timeout` is set to `false`.
@@ -381,8 +381,7 @@ _Optional_.
<10> A reference to a bean that implements the message correlation (grouping) algorithm.
The bean can be an implementation of the `CorrelationStrategy` interface or a POJO.
In the latter case the correlation-strategy-method attribute must be defined as well.
_Optional (by default, the aggregator will use
the `IntegrationMessageHeaderAccessor.CORRELATION_ID` header) _.
_Optional (by default, the aggregator will use the `IntegrationMessageHeaderAccessor.CORRELATION_ID` header)_.

3
src/reference/asciidoc/resequencer.adoc
View File

@@ -96,8 +96,7 @@ _Optional_.
<9> A reference to a bean that implements the message correlation (grouping) algorithm.
The bean can be an implementation of the `CorrelationStrategy` interface or a POJO.
In the latter case the correlation-strategy-method attribute must be defined as well.
_Optional (by default, the aggregator will use
the `IntegrationMessageHeaderAccessor.CORRELATION_ID` header) _.
_Optional (by default, the aggregator will use the `IntegrationMessageHeaderAccessor.CORRELATION_ID` header)_.