More updates to the aggregator

This commit is contained in:
Marius Bogoevici
2008-10-19 05:12:38 +00:00
parent d518214736
commit d160b5dbb3

View File

@@ -164,57 +164,57 @@
it:</para>
<programlisting>&lt;aggregator id="completelyDefinedAggregator" <co
id="???" />
input-channel="completelyDefinedAggregatorInput" <co id="???" />
output-channel="outputChannel" <co id="???" />
discard-channel="discardChannel" <co id="???" />
ref="aggregatorBean" <co id="???" />
method="add" <co id="???" />
completion-strategy="completionStrategy" <co id="???" />
completion-strategy-method="checkCompleteness" <co id="???" />
timeout="42" <co id="???" />
send-partial-result-on-timeout="true" <co id="???" />
reaper-interval="135" <co id="???" />
tracked-correlation-id-capacity="99" <co id="???" />
send-timeout="86420000" /&gt; <co id="???" /></programlisting>
id="aggxml1" />
input-channel="completelyDefinedAggregatorInput" <co id="aggxml2" />
output-channel="outputChannel" <co id="aggxml3" />
discard-channel="discardChannel" <co id="aggxml4" />
ref="aggregatorBean" <co id="aggxml5" />
method="add" <co id="aggxml6" />
completion-strategy="completionStrategy" <co id="aggxml7" />
completion-strategy-method="checkCompleteness" <co id="aggxml8" />
timeout="42" <co id="aggxml9" />
send-partial-result-on-timeout="true" <co id="aggxml10" />
reaper-interval="135" <co id="aggxml11" />
tracked-correlation-id-capacity="99" <co id="aggxml12" />
send-timeout="86420000" /&gt; <co id="aggxml13" /></programlisting>
<calloutlist>
<callout arearefs="???">
<callout arearefs="aggxml1">
<para>The id of the aggregator is
<emphasis>optional</emphasis>.</para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml2">
<para>The input channel of the aggregator.
<emphasis>Required</emphasis>.</para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml3">
<para>The channel where the aggregator will send the aggregation
results. <emphasis>Required</emphasis>.</para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml4">
<para>The channel where the aggregator will send the messages that
timed out (if <code>send-partial-results-on-timeout</code> is
<emphasis>true</emphasis>. <emphasis>Optional</emphasis>.</para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml5">
<para>A reference to a bean defined in the application context. The
bean must either extend <code>AbstractMessageAggregator</code> or be
a POJO. In the latter case the <code>method</code> attribute must be
defined as well. <emphasis>Required</emphasis>.</para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml6">
<para>A method defined on the bean referenced by <code>ref</code>,
<emphasis><emphasis>that implements the message aggregation
algorithm.</emphasis> Optional, with restrictions (see
above).</emphasis></para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml7">
<para>A reference to a bean that implements the decision algorithm
as to whether a given message group is complete. The bean can be an
implementation of the CompletionStrategy interface or a POJO. In the
@@ -222,38 +222,38 @@
defined as well. Optional.</para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml8">
<para>A method defined on the bean referenced by
<code>completion-strategy</code>, <emphasis><emphasis>that
implements the completion decision algorithm.</emphasis> Optional,
with restrictions (see above).</emphasis> Optional.</para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml9">
<para>The timeout for aggregating messages (counted from the arrival
of the first message). Optional.</para>
</callout>
<callout arearefs="???">
<callout arch="" arearefs="aggxml10">
<para>Whether upon the expiration of the timeout, the aggregator
shall try to aggregate the already arrived messages.
<emphasis>Optional (false by default)</emphasis>.</para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml11" condition="">
<para>The interval (in milliseconds) at which a reaper task is
executed, checking if there are any timed out groups.
Optional.</para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml12">
<para>The capacity of the correlation id tracker. Remembers the
already processed correlation ids, preventing the formation of new
groups for messages that arrive after their group has been already
processed (aggregated or discarded). Optional.</para>
</callout>
<callout arearefs="???">
<callout arearefs="aggxml13">
<para>The timeout for sending out messages. Optional.</para>
</callout>
</calloutlist>