Documentation updates

build-spring-integration/resources/changelog.txt

@@ -4,3 +4,32 @@ SPRING INTEGRATION CHANGELOG
 Changes in version 1.0 M1 (Jan 23, 2008)
 ----------------------------------------
 
+This is the initial release of Spring Integration.
+
+The following are the key messaging components defined in this release:
+  org.springframework.integration.message.Message
+  org.springframework.integration.channel.MessageChannel
+  org.springframework.integration.endpoint.MessageEndpoint
+  org.springframework.integration.handler.MessageHandler
+  org.springframework.integration.bus.MessageBus
+
+The following adapters are also available in this release:
+  org.springframework.integration.adapter.event.ApplicationEventSourceAdapter
+  org.springframework.integration.adapter.event.ApplicationEventTargetAdapter
+  org.springframework.integration.adapter.file.FileSourceAdapter
+  org.springframework.integration.adapter.file.FileTargetAdapter
+  org.springframework.integration.adapter.jms.JmsMessageDrivenSourceAdapter
+  org.springframework.integration.adapter.jms.JmsPollingSourceAdapter
+  org.springframework.integration.adapter.jms.JmsTargetAdapter
+  org.springframework.integration.adapter.stream.ByteStreamSourceAdapter
+  org.springframework.integration.adapter.stream.ByteStreamTargetAdapter
+  org.springframework.integration.adapter.stream.CharacterStreamSourceAdapter
+  org.springframework.integration.adapter.stream.CharacterStreamTargetAdapter
+
+Many of these components and adapters may be configured with either XML namespace
+support or annotations. Some additional components may be configured with annotations,
+such as: @Router, @Splitter, @Publisher, and @Subscriber.
+
+Please consult the documentation located within the 'docs/reference' directory of this
+release for more information and also visit the official Spring Integration home at:
+http://www.springframework.org/spring-integration

build-spring-integration/resources/readme.txt

@@ -1,2 +1,32 @@
 SPRING INTEGRATION 1.0 M1 (JAN 23 2008)
 ---------------------------------------
+
+This is the initial release of Spring Integration.
+
+The following are the key messaging components defined in this release:
+  org.springframework.integration.message.Message
+  org.springframework.integration.channel.MessageChannel
+  org.springframework.integration.endpoint.MessageEndpoint
+  org.springframework.integration.handler.MessageHandler
+  org.springframework.integration.bus.MessageBus
+
+The following adapters are also available in this release:
+  org.springframework.integration.adapter.event.ApplicationEventSourceAdapter
+  org.springframework.integration.adapter.event.ApplicationEventTargetAdapter
+  org.springframework.integration.adapter.file.FileSourceAdapter
+  org.springframework.integration.adapter.file.FileTargetAdapter
+  org.springframework.integration.adapter.jms.JmsMessageDrivenSourceAdapter
+  org.springframework.integration.adapter.jms.JmsPollingSourceAdapter
+  org.springframework.integration.adapter.jms.JmsTargetAdapter
+  org.springframework.integration.adapter.stream.ByteStreamSourceAdapter
+  org.springframework.integration.adapter.stream.ByteStreamTargetAdapter
+  org.springframework.integration.adapter.stream.CharacterStreamSourceAdapter
+  org.springframework.integration.adapter.stream.CharacterStreamTargetAdapter
+
+Many of these components and adapters may be configured with either XML namespace
+support or annotations. Some additional components may be configured with annotations,
+such as: @Router, @Splitter, @Publisher, and @Subscriber.
+
+Please consult the documentation located within the 'docs/reference' directory of this
+release for more information and also visit the official Spring Integration home at:
+http://www.springframework.org/spring-integration

spring-integration-reference/reference/src/adapters.xml

@@ -10,7 +10,7 @@
       system or component to send-to and/or receive-from a <interfacename>MessageChannel</interfacename>. Within
       Spring Integration, there is a distinction between <emphasis>source adapters</emphasis> and <emphasis>target
       adapters</emphasis>. In the 1.0 Milestone 1 release, Spring Integration includes adapters for JMS, Files,
-      Streams, Spring ApplicationEvents, as well as general purpose Method-invoking adapters.
+      Streams, and Spring ApplicationEvents.
     </para>
   </section>
 
@@ -51,9 +51,10 @@
 </bean>]]></programlisting>
     </para>
     <para>
-      In both cases, Spring's <interfacename>MessageConverter</interfacename> strategy is used to convert the JMS
-      message into a plain Java object, and then Spring Integration's <interfacename>MessageMapper</interfacename>
-      strategy is used to convert from the plain object to a <interfacename>Message</interfacename>.
+      For both source adapter types, Spring's <interfacename>MessageConverter</interfacename> strategy is used to
+      convert the JMS message into a plain Java object, and then Spring Integration's
+      <interfacename>MessageMapper</interfacename> strategy is used to convert from the plain object to a
+      <interfacename>Message</interfacename>.
     </para>
     <para>
       The <classname>JmsTargetAdapter</classname> is a <interfacename>MessageHandler</interfacename> implementation
@@ -63,4 +64,61 @@
       adapter with Spring Integration's namespace support.
     </para>
   </section>
+  <section id="adapters-file">
+    <title>File Adapters</title>
+    <para>
+      The <classname>FileSourceAdapter</classname> extends the generic <classname>PollingSourceAdapter</classname>
+      (just as the polling JMS adapter does). It requires the following constructor arguments:
+      <programlisting>public FileSourceAdapter(File directory, MessageChannel channel, int period)</programlisting>
+      Optional properties include 'initialDelay' and 'maxMessagesPerTask'.
+    </para>
+    <para>
+      The <classname>FileTargetAdapter</classname> constructor only requires the 'directory' argument. The target
+      adapter also accepts an implementation of the <interfacename>FileNameGenerator</interfacename> strategy that
+      defines the following method: <programlisting>String generateFileName(Message message)</programlisting>
+    </para>
+    <para>
+      As with the JMS adapters, the most convenient way to configure File adapters is with the namespace support. For
+      examples, see <xref linkend="namespace-adapters"/>.
+    </para>
+  </section>
+  <section id="adapters-stream">
+    <title>Stream Adapters</title>
+    <para>
+      Spring Integration also provides adapters for streams. Both <classname>ByteStreamSourceAdapter</classname> and
+      <classname>CharacterStreamSourceAdapter</classname> extend the <classname>PolllingSourceAdapter</classname> so
+      that the polling period can be configured, and the Message Bus can automatically detect and schedule them. Both
+      require an <classname>InputStream</classname> as the single constructor argument. The
+      <classname>ByteStreamSourceAdapter</classname> also accepts the 'bytesPerMessage' property to determine how many
+      bytes it will attempt to read into each <interfacename>Message</interfacename>.
+    </para>
+    <para>
+      For target streams, there are also two implementations: <classname>ByteStreamTargetAdapter</classname> and
+      <classname>CharacterStreamTargetAdapter</classname>. Each defines a constructor that requires an
+      <classname>OutputStream</classname>, and each provides a second constructor that adds the optional
+      'bufferSize' property. Since both of these ultimately implement the <interfacename>MessageHandler</interfacename>
+      interface, they can be referenced from an endpoint configuration as will be described in more detail in
+      <xref linkend="namespace-endpoint"/>.
+    </para>
+  </section>
+  <section id="adapters-applicationevents">
+    <title>ApplicationEvent Adapters</title>
+    <para>
+      Spring <classname>ApplicationEvents</classname> can also be integrated as either a source or target for Spring
+      Integration message channels. To receive the events and send to a channel, simply define an instance of Spring
+      Integration's <classname>ApplicationEventSourceAdapter</classname> (as with all source adapters, if a
+      <classname>MessageBus</classname> is defined, it will automatically detect the event source adapter). The
+      <classname>ApplicationEventSourceAdapter</classname> implements Spring's
+      <interfacename>ApplicationListener</interfacename> interface. By default it will pass all received events as
+      Spring Integration Messages. To limit based on the type of event, configure the list of event types that you
+      want to receive with the 'eventTypes' property.
+    </para>
+    <para>
+      To send Spring <classname>ApplicationEvents</classname>, register an instance of the
+      <classname>ApplicationEventTargetAdapter</classname> class as the handler of an endpoint (such configuration
+      will be described in detail in <xref linkend="namespace-endpoint"/>). This adapter implements Spring's
+      <interfacename>ApplicationEventPublisherAware</interfacename> and thus acts as a bridge between Spring
+      Integration <classname>Messages</classname> and <classname>ApplicationEvents</classname>.
+    </para>
+  </section>
 </chapter>

spring-integration-reference/reference/src/overview.xml

@@ -105,8 +105,10 @@
       <para>
         A Message Channel represents the "pipe" of a pipes-and-filters architecture. Producers send Messages to
         a MessageChannel, and consumers receive Messages from a MessageChannel. The send and receive methods both come
-        in two forms: one that blocks indefinitely and one that accepts a timeout. For an immediate return, specify a
-        timeout value of 0.
+        in two forms: one that blocks indefinitely and one that accepts a timeout (for an immediate return, specify a
+        timeout value of 0). There are two main types of channels: <emphasis>Point-to-Point</emphasis> channels where
+        typically a single consumer will receive the Message and <emphasis>Publish-Subscribe</emphasis> channels where
+        all subscribers should receive the Message.
       </para>
     </section>
     <section id="overview-components-endpoint">
@@ -122,6 +124,26 @@
         <xref linkend="api-messagehandler"/>.
       </para>
     </section>
+    <section id="overview-component-router">
+      <title>Message Router</title>
+      <para>
+        A Message Router is a particular type of endpoint that is capable of receiving a Message and then deciding what
+        channel or channels should receive the Message next. Typically the decision is based upon the Message's content
+        and/or metadata. A Message Router is often used as a dynamic alternative to configuring the input and output
+        channels for an endpoint.
+      </para>
+    </section>
+    <section id="overview-component-channeladapter">
+      <title>Channel Adapter</title>
+      <para>
+        A Channel Adapter is used to connect components to a Message Channel when those components are not themselves
+        Message Endpoints. These adapters provide a mechanism for connecting to external systems, such as JMS queues
+        or a File system. Channel Adapters may be configured for input and/or output. An input (source) adapter will
+        receive (or poll for) data, convert that data to a Message, and then send that Message to its Message Channel.
+        An output (target) adapter is simply another type of Message Endpoint, but when it receives a Message, it will
+        convert it to the target's expected type and then "send" it (publish to a JMS queue, write to a File, etc.).
+      </para>
+    </section>
     <section id="overview-component-bus">
       <title>Message Bus</title>
       <para>