INT-1863 added support for message removal from the MessageStore to ClaimCheckOutTransformer. Updated documentation.

This commit is contained in:
Oleg Zhurakousky
2011-04-15 16:08:54 -04:00
parent fea200997a
commit 6abadb134c
6 changed files with 88 additions and 3 deletions

View File

@@ -69,6 +69,20 @@
querying the Message store for a Message identified by the provided Claim Check. It then sends the newly checked-out Message to the
<code>output-channel</code>.
</para>
<para><emphasis>Claim Once</emphasis></para>
<para>
There are scenarios when a particular message must be claimed only once. Take the airplane luggage check-in/out process.
Checking-in your luggage on the departure and and then claiming it on the arrival is a classic example of such scenario.
Once the luggage was claimed it can no longer be claimed again without further check-in. To accommodate such cases we
introduced <code>remove-message</code> boolean attribute on <code>claim-check-out</code> transformer. This attribute is
set to <code>false</code> by default, however if set to <code>true</code>, the claimed Message will also be removed
from the MessageStore and can no longer be claimed again.
<programlisting language="xml"><![CDATA[<claim-check-out id="checkout"
input-channel="checkoutChannel"
message-store="testMessageStore"
output-channel="output"
remove-message="true"/>]]></programlisting>
</para>
</section>
<para>
Although we rarely care about the details of the claim checks as long as they work, it is still worth knowing that