Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

INT-1577 restructured documentation to be consistent with Spring-core and EIP documentation

Browse Source
This commit is contained in:
Oleg Zhurakousky
2010-11-02 12:07:56 -04:00
parent 3061aaa08d
commit 01dbe1916e
25 changed files with 109 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/src/reference/docbook/aggregator.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="aggregator"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="aggregator"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Aggregator</title>
@@ -622,4 +622,4 @@
the @MessageEndpoint is defined on the class, detected automatically
through classpath scanning.</para>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/bridge.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="bridge"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="bridge"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Messaging Bridge</title>
@@ -56,4 +56,4 @@
</note>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/chain.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="chain"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="chain"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Message Handler Chain</title>
@@ -111,4 +111,4 @@ When light version of &lt;gateway&gt; element is defined in the chain SI will co
</para>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/channel-adapter.xml
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="channel-adapter">
<section id="channel-adapter">
<title>Channel Adapter</title>
<para>
A Channel Adapter is a Message Endpoint that enables connecting a single sender or receiver to a Message Channel.
@@ -75,4 +75,4 @@
</para>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/channel.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="channel"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="channel"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Message Channels</title>
<para>
@@ -599,4 +599,4 @@ public Message<?> receive(final PollableChannel<?> channel) { ... }]]></programl
</note>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/delayer.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="delayer"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="delayer"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Delayer</title>
@@ -58,4 +58,4 @@
</para>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/endpoint.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="endpoint"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="endpoint"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Message Endpoints</title>
<para>
@@ -346,4 +346,4 @@ any transaction configuration essentially allowing you to enhance the behavior o
to - <emphasis>Section 25 - Task Execution and Scheduling</emphasis> of Spring reference manual.
</para>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/filter.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="filter"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="filter"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Filter</title>
@@ -128,4 +128,4 @@
to be treated as Message Channel names by a router component.</note>
</para>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/gateway.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="gateway"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="gateway"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Inbound Messaging Gateways</title>
@@ -251,4 +251,4 @@ For a more detailed example, please refer to the <emphasis>async-gateway</emphas
</para>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/groovy.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="groovy"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="groovy"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Groovy support</title>
<para>
@@ -69,4 +69,4 @@ You see that script could be included inline or via <code>location</code> attrib
</section>
</chapter>
</section>

62
docs/src/reference/docbook/index.xml
View File

@@ -63,67 +63,19 @@
</partintro>
<xi:include href="./overview.xml"/>
</part>
<part id="spring-integration-core-messaging">
<title>Core Messaging</title>
<partintro id="spring-integration-core-msg">
<para>Core Messaging TODO</para>
</partintro>
<part id="spring-integration-channels">
<title>Messaging Channels</title>
<partintro id="spring-integration-ch">
<para>Message Channels TODO</para>
</partintro>
<xi:include href="./channel.xml"/>
<xi:include href="./channel-adapter.xml"/>
<xi:include href="./bridge.xml"/>
</part>
<part id="spring-integration-message-construction">
<title>Messaging Construction</title>
<partintro id="spring-integration-msg-cnstrct">
<para>Message Construction TODO</para>
</partintro>
<xi:include href="./message.xml"/>
</part>
<part id="spring-integration-routing">
<title>Messaging Routing</title>
<partintro id="spring-integration-rt">
<para>Message Routing TODO</para>
</partintro>
<xi:include href="./router.xml"/>
<xi:include href="./filter.xml"/>
<xi:include href="./splitter.xml"/>
<xi:include href="./aggregator.xml"/>
<xi:include href="./resequencer.xml"/>
<xi:include href="./chain.xml"/>
</part>
<part id="spring-integration-transformation">
<title>Messaging Transformation</title>
<partintro id="spring-integration-xfmr">
<para>Message Transformation TODO</para>
</partintro>
<xi:include href="./transformer.xml"/>
</part>
<part id="spring-integration-endpoint">
<title>Messaging Endpoints</title>
<partintro id="spring-integration-endpts">
<para>Message Endpoints TODO</para>
</partintro>
<xi:include href="./endpoint.xml"/>
<xi:include href="./gateway.xml"/>
<xi:include href="./service-activator.xml"/>
<xi:include href="./delayer.xml"/>
<xi:include href="./groovy.xml"/>
</part>
<part id="spring-integration-management">
<title>System Management</title>
<partintro id="spring-integration-mgm">
<para>Message Endpoints TODO</para>
</partintro>
<xi:include href="./message-history.xml"/>
<xi:include href="./jmx.xml"/>
</part>
<xi:include href="./messaging-channels.xml"/>
<xi:include href="./message-construction.xml"/>
<xi:include href="./message-routing.xml"/>
<xi:include href="./message-transformation.xml"/>
<xi:include href="./messaging-endpoints.xml"/>
<xi:include href="./system-management.xml"/>
</part>
<part id="spring-integration-adapters">
<title>Integration Adapters</title>

4
docs/src/reference/docbook/jmx.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="jmx"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="jmx"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>JMX Support</title>
@@ -187,4 +187,4 @@
foundation is available, however, we will be able to extend the attributes
and operations that are being exposed.</para>
</section>
</chapter>
</section>

9
docs/src/reference/docbook/message-construction.xml Normal file
View File

@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="messaging-construction-chapter"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Message Construction</title>
<xi:include href="./message.xml"/>
</chapter>

4
docs/src/reference/docbook/message-history.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="message-history"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="message-history"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Message History</title>
<para>
@@ -61,4 +61,4 @@ assertEquals("sampleChain", chainHistory.get("name"));]]></programlisting>
be changed once written. Every attempt will end in exception.
</note>
</section>
</chapter>
</section>

14
docs/src/reference/docbook/message-routing.xml Normal file
View File

@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="messaging-routing-chapter"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Message Routing</title>
<xi:include href="./router.xml"/>
<xi:include href="./filter.xml"/>
<xi:include href="./splitter.xml"/>
<xi:include href="./aggregator.xml"/>
<xi:include href="./resequencer.xml"/>
<xi:include href="./chain.xml"/>
</chapter>

9
docs/src/reference/docbook/message-transformation.xml Normal file
View File

@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="messaging-transformation-chapter"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Message Transformation</title>
<xi:include href="./transformer.xml"/>
</chapter>

4
docs/src/reference/docbook/message.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="message"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="message"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Message</title>
<para>
@@ -219,4 +219,4 @@ assertEquals(MessagePriority.HIGHEST, anotherMessage.getHeaders().getPriority())
</para>
</section>
</chapter>
</section>

11
docs/src/reference/docbook/messaging-channels.xml Normal file
View File

@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="messaging-channels-section"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Messaging Channels</title>
<xi:include href="./channel.xml"/>
<xi:include href="./channel-adapter.xml"/>
<xi:include href="./bridge.xml"/>
</chapter>

13
docs/src/reference/docbook/messaging-endpoints.xml Normal file
View File

@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="messaging-endpoints-chapter"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Messaging Endpoints</title>
<xi:include href="./endpoint.xml"/>
<xi:include href="./gateway.xml"/>
<xi:include href="./service-activator.xml"/>
<xi:include href="./delayer.xml"/>
<xi:include href="./groovy.xml"/>
</chapter>

4
docs/src/reference/docbook/resequencer.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="resequencer"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="resequencer"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Resequencer</title>
@@ -123,4 +123,4 @@
Since there is no custom behavior to be implemented in Java classes for resequencers, there is no annotation support for it.
</note>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/router.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="router"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="router"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Router</title>
@@ -402,4 +402,4 @@ public List&lt;String&gt; route(@Header("orderStatus") OrderStatus status)</prog
</para>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/service-activator.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="service-activator"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="service-activator"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Service Activator</title>
@@ -68,4 +68,4 @@
</note>
</section>
</chapter>
</section>

4
docs/src/reference/docbook/splitter.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="splitter"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="splitter"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Splitter</title>
@@ -154,4 +154,4 @@ List&lt;LineItem&gt; extractItems(Order order) {
}</programlisting></para>
</section>
</chapter>
</section>

10
docs/src/reference/docbook/system-management.xml Normal file
View File

@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="system-management-chapter"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>System Management</title>
<xi:include href="./message-history.xml"/>
<xi:include href="./jmx.xml"/>
</chapter>

4
docs/src/reference/docbook/transformer.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="transformer"
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="transformer"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Transformer</title>
@@ -180,4 +180,4 @@ Order generateOrder(String productId, @Header("customerName") String customer) {
</para>
</section>
</chapter>
</section>