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/12/22 22:01:02 UTC
svn commit: r1222449 - in /synapse/branches/2.1/src/site/xdoc: ./ userguide/
userguide/samples/setup/
Author: hiranya
Date: Thu Dec 22 21:01:01 2011
New Revision: 1222449
URL: http://svn.apache.org/viewvc?rev=1222449&view=rev
Log:
Content update
Modified:
synapse/branches/2.1/src/site/xdoc/index.xml
synapse/branches/2.1/src/site/xdoc/userguide/config.xml
synapse/branches/2.1/src/site/xdoc/userguide/deployment.xml
synapse/branches/2.1/src/site/xdoc/userguide/faq.xml
synapse/branches/2.1/src/site/xdoc/userguide/quick_start.xml
synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/db.xml
synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/fix.xml
synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/index.xml
synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/jms.xml
synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/mail.xml
synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/script.xml
synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/tcp_udp.xml
synapse/branches/2.1/src/site/xdoc/userguide/upgrading.xml
Modified: synapse/branches/2.1/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/index.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/index.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/index.xml Thu Dec 22 21:01:01 2011
@@ -111,7 +111,7 @@
</p>
<img src="images/synapse-arch.png"/>
<p>
- Synapse uses the Apache Axis2 as the underlying Web Services engine. Therefore it
+ Synapse uses Apache Axis2 as the underlying Web Services engine. Therefore it
has outstanding support for Web Services and related standards such as SOAP and
WSDL. Tried and tested Axis2 modules like Apache Rampart and Apache Sandesha2 can be
used with Synapse with no configuration overhead. Using such external modules,
Modified: synapse/branches/2.1/src/site/xdoc/userguide/config.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/config.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/config.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/config.xml Thu Dec 22 21:01:01 2011
@@ -23,9 +23,30 @@
<title>Apache Synapse - Configuration Language Guide</title>
</properties>
<body>
+ <section name="Introduction" id="Intro">
+ <p>
+ Apache Synapse loads its configuration from a set of XML files. This enables the
+ user to easily hand edit the configuration, maintain backups and even include the
+ entire configuration in a version control system for easier management and control.
+ For an example one may check-in all Synapse configuration files into a version
+ control system such as Subversion and easily move the configuration files from
+ development, through QA, staging and into production.
+ </p>
+ <p>
+ All the configuration files related to Synapse are housed in the repository/conf/synapse-config
+ directory of the Synapse installation. Synapse is also capable of loading certain
+ configuration elements (eg: sequences, endpoints) from an external SOA registry.
+ When using a registry to store fragments of the configuration, some configuration
+ elements such as endpoints can be updated dynamically while Synapse is executing.
+ </p>
+ <p>
+ This article describes the hierarchy of XML files from which Synapse reads its
+ configuration. It describes the high level structure of the file set and the XML
+ syntax used to configure various elements in Synapse.
+ </p>
+ </section>
<section name="Contents">
<ul>
- <li><a href="#Intro">Introduction</a></li>
<li>
<a href="#SynapseConfig">Synapse Configuration</a>
<ul>
@@ -75,28 +96,6 @@
<li><a href="#StoresConfig">Message Stores and Processors Configuration</a></li>
</ul>
</section>
- <section name="Introduction" id="Intro">
- <p>
- Apache Synapse loads its configuration from a set of XML files. This enables the
- user to easily hand edit the configuration, maintain backups and even include the
- entire configuration in a version control system for easier management and control.
- For an example one may check-in all Synapse configuration files into a version
- control system such as Subversion and easily move the configuration files from
- development, through QA, staging and into production.
- </p>
- <p>
- All the configuration files related to Synapse are housed in the repository/conf/synapse-config
- directory of the Synapse installation. Synapse is also capable of loading certain
- configuration elements (eg: sequences, endpoints) from an external SOA registry.
- When using a registry to store fragments of the configuration, some configuration
- elements such as endpoints can be updated dynamically while Synapse is executing.
- </p>
- <p>
- This article describes the hierarchy of XML files from which Synapse reads its
- configuration. It describes the high level structure of the file set and the XML
- syntax used to configure various elements in Synapse.
- </p>
- </section>
<section name="The Synapse Configuration" id="SynapseConfig">
<p>
A typical Synapse configuration is comprised of sequences, endpoints, proxy services
Modified: synapse/branches/2.1/src/site/xdoc/userguide/deployment.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/deployment.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/deployment.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/deployment.xml Thu Dec 22 21:01:01 2011
@@ -23,6 +23,14 @@
<title>Apache Synapse - Deployment Guide</title>
</properties>
<body>
+ <section name="Deployment Guide">
+ <p>
+ This article explains the various approaches that can be taken to deploy an
+ Apache Synapse server instance. It provides information on each deployment
+ option along with their software requirements and steps that need to be carried
+ out.
+ </p>
+ </section>
<section name="Contents">
<ul>
<li>
Modified: synapse/branches/2.1/src/site/xdoc/userguide/faq.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/faq.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/faq.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/faq.xml Thu Dec 22 21:01:01 2011
@@ -27,9 +27,6 @@
Welcome to Apache Synapse FAQs.
</p>
</section>
-
-
-
<section name="General(GeneralApache Synapse questions - Non technical)">
<ol>
Modified: synapse/branches/2.1/src/site/xdoc/userguide/quick_start.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/quick_start.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/quick_start.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/quick_start.xml Thu Dec 22 21:01:01 2011
@@ -23,7 +23,7 @@
<title>Apache Synapse - Quick Start Guide</title>
</properties>
<body>
- <section name="Apache Synapse Quick Start Guide">
+ <section name="Quick Start Guide">
<p>
Welcome to Apache Synapse quick start guide. This tutorial demonstrates two
sample applications covering the fundamental usage scenarios of Synapse, namely
Modified: synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/db.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/db.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/db.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/db.xml Thu Dec 22 21:01:01 2011
@@ -23,6 +23,13 @@
<title>Apache Synapse - Database Setup Guide</title>
</properties>
<body>
+ <section name="Database Setup Guide">
+ <p>
+ This document explains how to setup a database and some data sources as required
+ by the samples. Most samples require an Apache Derby installation whereas a few
+ would require a MySQL setup.
+ </p>
+ </section>
<section name="Contents">
<ul>
<li><a href="#intro">Introduction</a></li>
Modified: synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/fix.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/fix.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/fix.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/fix.xml Thu Dec 22 21:01:01 2011
@@ -23,6 +23,14 @@
<title>Apache Synapse - FIX Setup Guide</title>
</properties>
<body>
+ <section name="FIX Setup Guide">
+ <p>
+ This document explains how to setup the FIX transport sender and listener
+ in Synapse as required by the samples. Further it describes how to setup the
+ sample FIX applications (Executor and Banzai) which are essential for trying
+ out the FIX samples.
+ </p>
+ </section>
<section name="Contents">
<ul>
<li><a href="#intro">Introduction</a></li>
Modified: synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/index.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/index.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/index.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/index.xml Thu Dec 22 21:01:01 2011
@@ -382,6 +382,8 @@ ant jmsclient -Djms_type=binary -Djms_de
<li><a href="fix.html">FIX 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="script.html">Script Setup Guide</a></li>
+ <li><a href="mail.html">E-Mail Setup Guide</a></li>
</ul>
</section>
</body>
Modified: synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/jms.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/jms.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/jms.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/jms.xml Thu Dec 22 21:01:01 2011
@@ -23,6 +23,13 @@
<title>Apache Synapse - JMS Setup Guide</title>
</properties>
<body>
+ <section name="JMS Setup Guide">
+ <p>
+ This document explains how to setup the JMS transport sender and listener
+ as required by the samples. An Apache ActiveMQ instance is used as the JMS
+ provider for the samples.
+ </p>
+ </section>
<section name="Contents">
<ul>
<li><a href="#intro">Introduction</a></li>
Modified: synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/mail.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/mail.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/mail.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/mail.xml Thu Dec 22 21:01:01 2011
@@ -13,10 +13,15 @@
<document>
<properties>
- <title>Apache Synapse - Script Setup Guide</title>
+ <title>Apache Synapse - E-Mail Setup Guide</title>
</properties>
<body>
-
+ <section name="E-Mail Setup Guide">
+ <p>
+ This document explains how to setup the mail transport sender and listener
+ as required by the samples.
+ </p>
+ </section>
<section name="Contents">
<ul>
<li>
Modified: synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/script.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/script.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/script.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/script.xml Thu Dec 22 21:01:01 2011
@@ -16,7 +16,14 @@
<title>Apache Synapse - Script Setup Guide</title>
</properties>
<body>
-
+ <section name="Script Setup Guide">
+ <p>
+ Apache Synapse ships with a set of scripting samples. This document explains
+ how to setup the necessary script engines for these samples. In addition this
+ guide describes how to setup the JSON message builder and formatter for JSON
+ mediation samples.
+ </p>
+ </section>
<section name="Contents">
<ul>
<li>
Modified: synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/tcp_udp.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/tcp_udp.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/tcp_udp.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/samples/setup/tcp_udp.xml Thu Dec 22 21:01:01 2011
@@ -23,6 +23,12 @@
<title>Apache Synapse - TCP/UDP Setup Guide</title>
</properties>
<body>
+ <section name="TCP/UDP Setup Guide">
+ <p>
+ This document explains how to setup the transport sender and listener
+ for TCP/UDP transports required by the samples.
+ </p>
+ </section>
<section name="Contents">
<ul>
<li><a href="#intro">Introduction</a></li>
Modified: synapse/branches/2.1/src/site/xdoc/userguide/upgrading.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/src/site/xdoc/userguide/upgrading.xml?rev=1222449&r1=1222448&r2=1222449&view=diff
==============================================================================
--- synapse/branches/2.1/src/site/xdoc/userguide/upgrading.xml (original)
+++ synapse/branches/2.1/src/site/xdoc/userguide/upgrading.xml Thu Dec 22 21:01:01 2011
@@ -24,7 +24,15 @@
<title>Apache Synapse - Upgrading to the Latest Version</title>
</properties>
<body>
- <section name="Content">
+ <section name="Upgrading to the Latest Version">
+ <p>
+ If you are using an older version of Synapse (1.x) and now looking to migrate to
+ the latest versions (2.x) this document would be a good starting point. This
+ article provides information on steps that need to be carried out to smoothly
+ migrate from an older release of Synapse to the latest version.
+ </p>
+ </section>
+ <section name="Contents">
<ul>
<li>
<a href="#General_comments">General comments</a>