You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@synapse.apache.org by hi...@apache.org on 2011/01/02 15:24:10 UTC

svn commit: r1054413 - in /synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples: sample265.xml sample266.xml setup/db.xml setup/index.xml setup/tcp_udp.xml

Author: hiranya
Date: Sun Jan  2 14:24:10 2011
New Revision: 1054413

URL: http://svn.apache.org/viewvc?rev=1054413&view=rev
Log:
TCP/UDP transports

Added:
    synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/tcp_udp.xml
Modified:
    synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/sample265.xml
    synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/sample266.xml
    synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/db.xml
    synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/index.xml

Modified: synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/sample265.xml
URL: http://svn.apache.org/viewvc/synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/sample265.xml?rev=1054413&r1=1054412&r2=1054413&view=diff
==============================================================================
--- synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/sample265.xml (original)
+++ synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/sample265.xml Sun Jan  2 14:24:10 2011
@@ -52,8 +52,8 @@
                             Deploy the SimpleStockQuoteService in the sample Axis2 server and start Axis2
                         </li>
                         <li>
-                            Enable the TCP transport receiver for Synapse (refer TCP transport setup
-                            guide).
+                            Enable the TCP transport receiver for Synapse (refer
+                            <a href="setup/tcp_udp.html#tcp">TCP transport setup guide</a>).
                         </li>
                         <li>
                             Start Synapse using the configuration numbered 265 (repository/conf/sample/synapse_sample_265.xml)
@@ -63,8 +63,9 @@
                             </div>
                         </li>
                         <li>
-                            Enable the TCP transport sender for the sample Axis2 client (refer TCP transport
-                            setup guide for details).
+                            Enable the TCP transport sender for the sample Axis2 client (refer
+                            <a href="setup/tcp_udp.html#tcp">TCP transport setup guide</a> for
+                            details).
                         </li>
                     </ul>
                 </p>

Modified: synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/sample266.xml
URL: http://svn.apache.org/viewvc/synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/sample266.xml?rev=1054413&r1=1054412&r2=1054413&view=diff
==============================================================================
--- synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/sample266.xml (original)
+++ synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/sample266.xml Sun Jan  2 14:24:10 2011
@@ -54,8 +54,8 @@
                             Deploy the SimpleStockQuoteService in the sample Axis2 server and start Axis2
                         </li>
                         <li>
-                            Enable the UDP transport receiver for Synapse (refer UDP transport setup
-                            guide).
+                            Enable the UDP transport receiver for Synapse (refer
+                            <a href="setup/tcp_udp.html#udp">UDP transport setup guide</a>).
                         </li>
                         <li>
                             Start Synapse using the configuration numbered 266 (repository/conf/sample/synapse_sample_266.xml)
@@ -65,8 +65,9 @@
                             </div>
                         </li>
                         <li>
-                            Enable the UDP transport sender for the sample Axis2 client (refer UDP transport
-                            setup guide for details).
+                            Enable the UDP transport sender for the sample Axis2 client (refer
+                            <a href="setup/tcp_udp.html#udp">UDP transport setup guide</a> for
+                            details).
                         </li>
                     </ul>
                 </p>

Modified: synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/db.xml
URL: http://svn.apache.org/viewvc/synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/db.xml?rev=1054413&r1=1054412&r2=1054413&view=diff
==============================================================================
--- synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/db.xml (original)
+++ synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/db.xml Sun Jan  2 14:24:10 2011
@@ -39,7 +39,7 @@
                 Synapse using the dblookup and dbreport mediators. Synapse ships with a collection
                 of samples which demonstrates various aspects of dblookup, dbreport mediators and
                 database integration. This article describes how to setup the databases, sample
-                tables and JNDI data sources required to try these examples out.
+                tables and reusable data sources required to try these examples out.
             </p>
             <p>
                 Most samples assume Apache Derby is used as the database engine. And therefore this

Modified: synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/index.xml
URL: http://svn.apache.org/viewvc/synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/index.xml?rev=1054413&r1=1054412&r2=1054413&view=diff
==============================================================================
--- synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/index.xml (original)
+++ synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/index.xml Sun Jan  2 14:24:10 2011
@@ -380,10 +380,8 @@ ant jmsclient -Djms_type=binary -Djms_de
             <ul>
                 <li><a href="jms.html">JMS Setup Guide</a></li>
                 <li><a href="fix.html">FIX Setup Guide</a></li>
-                <li><a href="tcp.html">TCP Setup Guide</a></li>
-                <li><a href="udp.html">UDP Setup Guide</a></li>
+                <li><a href="tcp_udp.html">TCP/UDP Setup Guide</a></li>
                 <li><a href="db.html">Database Setup Guide</a></li>
-                <li><a href="ds.html">Datasource Setup Guide</a></li>
             </ul>
         </section>
     </body>

Added: synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/tcp_udp.xml
URL: http://svn.apache.org/viewvc/synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/tcp_udp.xml?rev=1054413&view=auto
==============================================================================
--- synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/tcp_udp.xml (added)
+++ synapse/trunk/scratch/hiranya/website/src/site/xdoc/userguide/samples/setup/tcp_udp.xml Sun Jan  2 14:24:10 2011
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!--
+  ~  Licensed to the Apache Software Foundation (ASF) under one
+  ~  or more contributor license agreements.  See the NOTICE file
+  ~  distributed with this work for additional information
+  ~  regarding copyright ownership.  The ASF licenses this file
+  ~  to you under the Apache License, Version 2.0 (the
+  ~  "License"); you may not use this file except in compliance
+  ~  with the License.  You may obtain a copy of the License at
+  ~
+  ~   http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~  Unless required by applicable law or agreed to in writing,
+  ~  software distributed under the License is distributed on an
+  ~   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  ~  KIND, either express or implied.  See the License for the
+  ~  specific language governing permissions and limitations
+  ~  under the License.
+  -->
+
+<document>
+    <properties>
+        <title>Apache Synapse - TCP/UDP Setup Guide</title>
+    </properties>
+    <body>
+        <section name="Contents">
+            <ul>
+                <li><a href="#intro">Introduction</a></li>
+                <li><a href="#tcp">Setting Up the TCP Transport</a></li>
+                <li><a href="#udp">Setting Up the UDP Transport</a></li>
+            </ul>
+        </section>
+        <section name="Introduction" id="intro">
+            <p>
+                Apache Synapse is capable of sending and receiving messages over raw TCP and UDP.
+                Any messages received over these transports can be mediated using the usual set of
+                mediators and can be forwarded over different protocols such as HTTP ans JMS. The
+                transport adapters for TCP and UDP are not available in the Synapse binary
+                distribution by default. This guide will help you to download and setup them in
+                Synapse ESB.
+            </p>
+        </section>
+        <section name="Setting Up the TCP Transport" id="tcp">
+            <p>
+                To enable the TCP transport for Synapse, first you need to download the Axis2 TCP
+                transport jar, and copy it to the 'lib' directory of Synapse. This library can be
+                downloaded from the <a href="http://ws.apache.org/commons/transport">WS-Commons Transports</a>
+                website. Then open up the axis2.xml file and uncomment the TCP transport receiver
+                and sender configurations.
+            </p>
+            <div class="xmlConf">&lt;transportReceiver name="tcp" class="org.apache.axis2.transport.tcp.TCPServer"&gt;
+    &lt;parameter name="port"&gt;6060&lt;/parameter&gt;
+&lt;/transportReceiver&gt;</div>
+            <div class="xmlConf">&lt;transportSender name="tcp" class="org.apache.axis2.transport.tcp.TCPTransportSender"/&gt;</div>
+            <p>
+                The above configuration enables Synapse to receive raw TCP messages on port 6060.
+                Since no application level headers are available on such requests, Synapse will be
+                solely depending on the addressing headers or the XML payload of the messages to
+                find the target service for TCP requests.
+            </p>
+            <p>
+                In some of the samples you will have to send raw TCP messages using the sample
+                Axis2 client. In that case you should enable the TCP transport sender for the
+                sample client. This can be done by uncommenting the following entry in the
+                samples/axis2Client/client_repo/conf/axis2.xml file.
+            </p>
+            <div class="xmlConf">&lt;transportSender name="tcp" class="org.apache.axis2.transport.tcp.TCPTransportSender"/&gt;</div>
+        </section>
+        <section name="Setting Up the UDP Transport" id="udp">
+            <p>
+                Enabling the UDP transport for Synapse is similar to enabling the TCP transport. You
+                should <a href="http://ws.apache.org/commons/transport">download</a> the Axis2 UDP
+                transport jar and copy it into 'lib' directory of Synapse. Then uncomment the
+                following entries in the repository/conf/axis2.xml file to enable the UDP listener
+                and sender.
+            </p>
+            <div class="xmlConf">&lt;transportReceiver name="udp" class="org.apache.axis2.transport.udp.UDPListener"/&gt;</div>
+            <div class="xmlConf">&lt;transportSender name="udp" class="org.apache.axis2.transport.udp.UDPSender"/&gt;</div>
+            <p>
+                To send UDP messages from the sample client, enable the UDP transport sender for the
+                client in samples/axis2Client/client_repo/conf/axis2.xml file.
+            </p>
+        </section>
+    </body>
+</document>
\ No newline at end of file