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.
92 lines
4.9 KiB
XML
92 lines
4.9 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="stream"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<title>Stream Support</title>
|
|
|
|
<section id="stream-intro">
|
|
<title>Introduction</title>
|
|
<para>
|
|
In many cases application data is obtained from a stream. It is <emphasis>not</emphasis> recommended to send a reference to a Stream as a message payload to a consumer. Instead messages are created from data that is read from an input stream and message payloads are written to an output stream one by one.
|
|
</para>
|
|
</section>
|
|
|
|
<section id="stream-reading">
|
|
<title>Reading from streams</title>
|
|
<para>
|
|
Spring Integration provides two adapters for streams. Both <classname>ByteStreamReadingMessageSource</classname> and
|
|
<classname>CharacterStreamReadingMessageSource</classname> implement <interfacename>MessageSource</interfacename>.
|
|
By configuring one of these within a channel-adapter element, the polling period can be configured,
|
|
and the Message Bus can automatically detect and schedule them. The byte stream version requires an
|
|
<classname>InputStream</classname>, and the character stream version requires a <classname>Reader</classname> as
|
|
the single constructor argument. The <classname>ByteStreamReadingMessageSource</classname> also accepts the 'bytesPerMessage'
|
|
property to determine how many bytes it will attempt to read into each <interfacename>Message</interfacename>. The
|
|
default value is 1024
|
|
<programlisting language="xml"><![CDATA[<bean class="org.springframework.integration.stream.ByteStreamReadingMessageSource">
|
|
<constructor-arg ref="someInputStream"/>
|
|
<property name="bytesPerMessage" value="2048"/>
|
|
</bean>
|
|
|
|
<bean class="org.springframework.integration.stream.CharacterStreamReadingMessageSource">
|
|
<constructor-arg ref="someReader"/>
|
|
</bean>]]>
|
|
</programlisting>
|
|
</para>
|
|
</section>
|
|
|
|
<section id="stream-writing">
|
|
<title>Writing to streams</title>
|
|
<para>
|
|
For target streams, there are also two implementations: <classname>ByteStreamWritingMessageHandler</classname> and
|
|
<classname>CharacterStreamWritingMessageHandler</classname>. Each requires a single constructor argument -
|
|
<classname>OutputStream</classname> for byte streams or <classname>Writer</classname> for character streams,
|
|
and each provides a second constructor that adds the optional 'bufferSize'. Since both of these
|
|
ultimately implement the <interfacename>MessageHandler</interfacename> interface, they can be referenced from a
|
|
<emphasis>channel-adapter</emphasis> configuration as described in more detail in
|
|
<xref linkend="channel-adapter"/>.
|
|
<programlisting language="xml"><![CDATA[<bean class="org.springframework.integration.stream.ByteStreamWritingMessageHandler">
|
|
<constructor-arg ref="someOutputStream"/>
|
|
<constructor-arg value="1024"/>
|
|
</bean>
|
|
|
|
<bean class="org.springframework.integration.stream.CharacterStreamWritingMessageHandler">
|
|
<constructor-arg ref="someWriter"/>
|
|
</bean>]]>
|
|
</programlisting>
|
|
</para>
|
|
</section>
|
|
|
|
|
|
|
|
<section id="stream-namespace">
|
|
<title>Stream namespace support</title>
|
|
<para>
|
|
To reduce the configuration needed for stream related channel adapters there is a namespace defined. The following schema locations are needed to use it.
|
|
<programlisting language="xml"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
|
|
<beans:beans xmlns:int-stream="http://www.springframework.org/schema/integration/stream"
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xmlns:beans="http://www.springframework.org/schema/beans"
|
|
xsi:schemaLocation="http://www.springframework.org/schema/beans
|
|
http://www.springframework.org/schema/beans/spring-beans.xsd
|
|
http://www.springframework.org/schema/integration/stream
|
|
http://www.springframework.org/schema/integration/stream/spring-integration-stream.xsd">]]></programlisting>
|
|
</para>
|
|
<para>
|
|
To configure the inbound channel adapter the following code snippet shows the different configuration options that are supported.
|
|
<programlisting language="xml"><![CDATA[<int-stream:stdin-channel-adapter id="adapterWithDefaultCharset"/>
|
|
|
|
<int-stream:stdin-channel-adapter id="adapterWithProvidedCharset" charset="UTF-8"/>]]></programlisting>
|
|
</para>
|
|
<para>
|
|
To configure the outbound channel adapter you can use the namespace support as well. The following code snippet shows the different configuration for an outbound channel adapters.
|
|
<programlisting language="xml"><![CDATA[<int-stream:stdout-channel-adapter id="stdoutAdapterWithDefaultCharset" channel="testChannel"/>
|
|
|
|
<int-stream:stdout-channel-adapter id="stdoutAdapterWithProvidedCharset" charset="UTF-8" channel="testChannel"/>
|
|
|
|
<int-stream:stderr-channel-adapter id="stderrAdapter" channel="testChannel"/>
|
|
|
|
<int-stream:stdout-channel-adapter id="newlineAdapter" append-newline="true" channel="testChannel"/>
|
|
]]></programlisting>
|
|
</para>
|
|
</section>
|
|
</chapter>
|