f30da932e8
This is a significant update to the build system, including the changes listed below. README.md has been updated with instructions on the most important day-to-day commands. - Eliminate buildSrc submodule In favor of using the new bundlor and docbook-reference plugins. The net effect is a large reduction in number of lines of build code. Common docbook resources, stylesheets, etc are stored directly in the docbook plugin. This means that --recursive is no longer required when cloning and there will never be a need to use `git submodule` commands. README files have been updated to reflect. Use of the new bundlor plugin also means the removal of template.mf files from the source tree in favor of an inline approach. See build.gradle for details. Bundlor 'import templates' are built up programmatically and kept physically close to gradle dependency declarations, leading to more convenience when changing these values and hopefully fewer errors / version inconsistencies over time. Certain tests depended on the presence of template.mf files, all of which have recently been removed from the source tree in favor of the new bundlor plugin which allows for inlining bundlor configuration within the Gradle build script. These tests now create temp files using the java.io.File API instead. - Upgrade to Gradle 1.0-milestone-6 The m6 release is significantly faster when resolving dependencies and has a number of valuable new features over the earlier m3 version. Review the release notes for Gradle 1.0-milestone-6 online for full details. - Switch to repo.springsource.org repository Previously the project build declared as many repositories as necessary to resolve all project dependencies. Now depending on a single 'virtual repository' defined within the SpringSource Artifactory instance at http://repo.springsource.org. Currently, the virtual repository in use is 'libs-milestone', which allows for the resolution of all "milestone-or-better" versions of all S2 and third-party dependencies. Should snapshot dependencies become required, this value may be changed from 'libs-milestone' to 'libs-snapshot'. To build only against GA releases, change the value to 'libs-release'. - New build plan(s) Spring Integration build plans have been updated to use the Artifactory Bamboo plugin and publish to repo.springsource.org. Build plans have names like 2.1.x to reflect the version under development, not necessarily the name of the branch, as this may change over time and across major releases. - Improve release process As mentioned above, Spring Integration will now use the Artifactory Bamboo plugin to publish releases and also use Artifactory's support for pushing builds directly into Maven Central via oss.sonatype.org. Generate poms that contain all necessary fields for onboarding at Maven central (scm, developers, organization, licenses, etc). Generate -source and -javadoc poms to comply with Maven Central onboarding rules (and for general good practice anyway). Generation of PGP signatures, sha1 and md5 checksums are all handled automatically by Artifactory. These are also requirements for automated entry into Maven Central. - Remove source-level pom generation Automatic generation of Maven poms suitable for use in building Spring Integration is no longer supported. Generation and publication of poms for the purpose of dependency management remains supported. Sonar support has to date depended on these poms, but will be switched over to use the Gradle Sonar plugin shortly. - Eliminate docs subproject Move docs/src to the root of the project and eliminate docs as a formal subproject. This simplifies the build in a number of ways, including removing the need for distinguishing between 'subprojects' and 'javaprojects' as well as allowing users to build both 'api' and 'reference' docs without qualifying with a ':docs' prefix. Also rename the src/info directory to src/dist to better reflect that these files are packaged with the distribution. For example, the readme.txt there is really the distribution readme, distinct from the README.md at the root of the project which is for building from source, etc.
127 lines
5.0 KiB
XML
127 lines
5.0 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="resequencer"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<title>Resequencer</title>
|
|
|
|
<section>
|
|
<title>Introduction</title>
|
|
|
|
<para>Related to the Aggregator, albeit different from a functional
|
|
standpoint, is the Resequencer.</para>
|
|
</section>
|
|
|
|
<section id="resequencer-functionality">
|
|
<title>Functionality</title>
|
|
|
|
<para>The Resequencer works in a similar way to the Aggregator, in the
|
|
sense that it uses the CORRELATION_ID to store messages in groups, the
|
|
difference being that the Resequencer does not process the messages in any
|
|
way. It simply releases them in the order of their SEQUENCE_NUMBER header
|
|
values.</para>
|
|
|
|
<para>With respect to that, the user might opt to release all messages at
|
|
once (after the whole sequence, according to the SEQUENCE_SIZE, has been
|
|
released), or as soon as a valid sequence is available.</para>
|
|
</section>
|
|
|
|
<section>
|
|
<title>Configuring a Resequencer</title>
|
|
|
|
<para>Configuring a resequencer requires only including the appropriate
|
|
element in XML.</para>
|
|
|
|
<para>A sample resequencer configuration is shown below.</para>
|
|
|
|
<programlisting language="xml"><![CDATA[<int:channel id="inputChannel"/>
|
|
|
|
<int:channel id="outputChannel"/>
|
|
|
|
<int:resequencer id="completelyDefinedResequencer" ]]><co id="resxml1-co"
|
|
linkends="resxml1" /><![CDATA[
|
|
input-channel="inputChannel" ]]><co id="resxml2-co" linkends="resxml2" /><![CDATA[
|
|
output-channel="outputChannel" ]]><co id="resxml3-co" linkends="resxml3" /><![CDATA[
|
|
discard-channel="discardChannel" ]]><co id="resxml4-co" linkends="resxml4" /><![CDATA[
|
|
release-partial-sequences="true" ]]><co id="resxml5-co" linkends="resxml5" /><![CDATA[
|
|
message-store="messageStore" ]]><co id="resxml6-co" linkends="resxml6" /><![CDATA[
|
|
send-partial-result-on-expiry="true" ]]><co id="resxml7-co"
|
|
linkends="resxml7" /><![CDATA[
|
|
send-timeout="86420000" ]]><co id="resxml10-co" linkends="resxml10" /><![CDATA[ /> ]]></programlisting>
|
|
|
|
<para><calloutlist>
|
|
<callout arearefs="resxml1-co" id="resxml1">
|
|
<para>The id of the resequencer is
|
|
<emphasis>optional</emphasis>.</para>
|
|
</callout>
|
|
|
|
<callout arearefs="resxml2-co" id="resxml2">
|
|
<para>The input channel of the resequencer.
|
|
<emphasis>Required</emphasis>.</para>
|
|
</callout>
|
|
|
|
<callout arearefs="resxml3-co" id="resxml3">
|
|
<para>The channel to which the resequencer will send the reordered
|
|
messages. <emphasis>Optional</emphasis>.</para>
|
|
</callout>
|
|
|
|
<callout arearefs="resxml4-co" id="resxml4">
|
|
<para>The channel to which the resequencer will send the messages that
|
|
timed out (if <code>send-partial-result-on-timeout</code> is
|
|
<emphasis>false)</emphasis>. <emphasis>Optional</emphasis>.</para>
|
|
</callout>
|
|
|
|
<callout arearefs="resxml5-co" id="resxml5">
|
|
|
|
|
|
<para>Whether to send out ordered sequences as soon as they are
|
|
available, or only after the whole message group arrives.
|
|
<emphasis>Optional (false by default)</emphasis>.</para>
|
|
|
|
If this flag is not specified (so a complete sequence is defined by the sequence headers) then it may make sense to provide a custom
|
|
|
|
<interfacename>Comparator</interfacename>
|
|
|
|
to be used to order the messages when sending (use the XML attribute
|
|
|
|
<literal>comparator</literal>
|
|
|
|
to point to a bean definition). If
|
|
|
|
<literal>release-partial-sequences</literal>
|
|
|
|
is true then there is no way with a custom comparator to define a partial sequence. To do that you would have to provide a
|
|
|
|
<literal>release-strategy</literal>
|
|
|
|
(also a reference to another bean definition, either a POJO or a
|
|
|
|
<interfacename>ReleaseStrategy</interfacename>
|
|
|
|
).
|
|
</callout>
|
|
|
|
<callout arearefs="resxml6-co" id="resxml6">
|
|
<para>A reference to a <code>MessageGroupStore</code> that can be
|
|
used to store groups of messages under their correlation key until
|
|
they are complete. <emphasis>Optional</emphasis> with default a
|
|
volatile in-memory store.</para>
|
|
</callout>
|
|
|
|
<callout arearefs="resxml7-co" id="resxml7">
|
|
<para>Whether, upon the expiration of the group, the ordered group
|
|
should be sent out (even if some of the messages are missing).
|
|
<emphasis>Optional (false by default)</emphasis>. See <xref
|
|
linkend="reaper" />.</para>
|
|
</callout>
|
|
|
|
<callout arearefs="resxml10-co" id="resxml10">
|
|
<para>The timeout for sending out messages.
|
|
<emphasis>Optional</emphasis>.</para>
|
|
</callout>
|
|
</calloutlist></para>
|
|
|
|
<note>
|
|
Since there is no custom behavior to be implemented in Java classes for resequencers, there is no annotation support for it.
|
|
</note>
|
|
</section>
|
|
</section>
|