You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@synapse.apache.org by ka...@apache.org on 2011/12/23 12:55:09 UTC
svn commit: r1222651 [1/14] - in /synapse/branches/2.1: ./
modules/distribution/ modules/distribution/src/main/assembly/
modules/documentation/ modules/documentation/src/
modules/documentation/src/site/ modules/documentation/src/site/resources/
modules...
Author: kasun
Date: Fri Dec 23 11:55:05 2011
New Revision: 1222651
URL: http://svn.apache.org/viewvc?rev=1222651&view=rev
Log:
adding documentation
Added:
synapse/branches/2.1/modules/documentation/
synapse/branches/2.1/modules/documentation/pom.xml
synapse/branches/2.1/modules/documentation/src/
synapse/branches/2.1/modules/documentation/src/site/
synapse/branches/2.1/modules/documentation/src/site/resources/
synapse/branches/2.1/modules/documentation/src/site/resources/css/
synapse/branches/2.1/modules/documentation/src/site/resources/css/site.css
synapse/branches/2.1/modules/documentation/src/site/resources/images/
synapse/branches/2.1/modules/documentation/src/site/resources/images/footer-back.png (with props)
synapse/branches/2.1/modules/documentation/src/site/resources/images/page-back.png (with props)
synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-arch.png (with props)
synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-flow.png (with props)
synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-logo.png (with props)
synapse/branches/2.1/modules/documentation/src/site/site.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/
synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/
synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/best-practices.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/developer-guide.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/release-process.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/download.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/history.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/index.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/config.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/deployment.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/extending.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/faq.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/installation.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/mediators.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/quick_start.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample0.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample1.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample10.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample100.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample101.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample102.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample11.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample12.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample13.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample14.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample150.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample151.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample152.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample153.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample154.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample155.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample156.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample157.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample158.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample2.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample200.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample201.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample202.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample250.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample251.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample252.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample253.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample254.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample255.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample256.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample257.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample258.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample259.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample260.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample261.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample262.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample263.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample264.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample265.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample266.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample3.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample300.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample350.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample351.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample352.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample353.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample354.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample360.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample361.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample362.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample363.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample364.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample370.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample371.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample372.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample380.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample381.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample390.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample391.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample4.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample400.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample410.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample420.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample430.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample450.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample451.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample452.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample460.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample5.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample50.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample500.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample501.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample502.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample51.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample52.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample53.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample54.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample55.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample56.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample57.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample58.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample6.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample600.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample601.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample650.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample651.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample652.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample7.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample700.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample750.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample8.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample800.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/sample9.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/setup/
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/setup/db.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/setup/fix.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/setup/index.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/setup/jms.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/setup/mail.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/setup/script.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/setup/tcp_udp.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/samples/template.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/transports.xml
synapse/branches/2.1/modules/documentation/src/site/xdoc/userguide/upgrading.xml
Removed:
synapse/branches/2.1/src/
Modified:
synapse/branches/2.1/modules/distribution/pom.xml
synapse/branches/2.1/modules/distribution/src/main/assembly/bin.xml
synapse/branches/2.1/pom.xml
Modified: synapse/branches/2.1/modules/distribution/pom.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/distribution/pom.xml?rev=1222651&r1=1222650&r2=1222651&view=diff
==============================================================================
--- synapse/branches/2.1/modules/distribution/pom.xml (original)
+++ synapse/branches/2.1/modules/distribution/pom.xml Fri Dec 23 11:55:05 2011
@@ -163,6 +163,11 @@
<classifier>jars</classifier>
<type>zip</type>
</dependency>
+ <dependency>
+ <groupId>org.apache.synapse</groupId>
+ <artifactId>documentation</artifactId>
+ <version>${pom.version}</version>
+ </dependency>
</dependencies>
<repositories>
Modified: synapse/branches/2.1/modules/distribution/src/main/assembly/bin.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/distribution/src/main/assembly/bin.xml?rev=1222651&r1=1222650&r2=1222651&view=diff
==============================================================================
--- synapse/branches/2.1/modules/distribution/src/main/assembly/bin.xml (original)
+++ synapse/branches/2.1/modules/distribution/src/main/assembly/bin.xml Fri Dec 23 11:55:05 2011
@@ -131,14 +131,14 @@
<outputDirectory>synapse-${synapse.version}/bin/native</outputDirectory>
<fileMode>755</fileMode>
</fileSet>
- <fileSet>
+ <!--fileSet>
<directory>../../src/site/resources/images</directory>
<outputDirectory>synapse-${synapse.version}/docs/images</outputDirectory>
</fileSet>
<fileSet>
<directory>../../src/site/resources/logos</directory>
<outputDirectory>synapse-${synapse.version}/docs/logos</outputDirectory>
- </fileSet>
+ </fileSet-->
<fileSet>
<directory>../../modules/samples/services</directory>
<outputDirectory>synapse-${synapse.version}/samples/axis2Server/src</outputDirectory>
@@ -166,6 +166,11 @@
</includes>
<fileMode>755</fileMode>
</fileSet>
+ <fileSet>
+ <directory>../../modules/documentation/target/site/</directory>
+ <outputDirectory>synapse-${synapse.version}/docs</outputDirectory>
+
+ </fileSet>
<!--<fileSet>-->
<!--<directory>target/javadoc</directory>-->
@@ -190,7 +195,7 @@
<!--</fileSet>-->
</fileSets>
<files>
- <file>
+ <!--file>
<source>../../src/site/xdoc/Synapse_Configuration_Language.xml</source>
<outputDirectory>synapse-${synapse.version}/docs</outputDirectory>
<destName>Synapse_Configuration_Language.html</destName>
@@ -214,7 +219,7 @@
<source>../../src/site/xdoc/Synapse_Extending.xml</source>
<outputDirectory>synapse-${synapse.version}/docs</outputDirectory>
<destName>Synapse_Extending.html</destName>
- </file>
+ </file-->
<file>
<source>.empty</source>
<outputDirectory>synapse-${synapse.version}/work/temp/sampleClient</outputDirectory>
Added: synapse/branches/2.1/modules/documentation/pom.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/pom.xml?rev=1222651&view=auto
==============================================================================
--- synapse/branches/2.1/modules/documentation/pom.xml (added)
+++ synapse/branches/2.1/modules/documentation/pom.xml Fri Dec 23 11:55:05 2011
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ 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.
+ -->
+
+<project
+ xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.synapse</groupId>
+ <artifactId>Apache-Synapse</artifactId>
+ <version>2.1.0</version>
+ <relativePath>../../pom.xml</relativePath>
+ </parent>
+
+ <groupId>org.apache.synapse</groupId>
+ <artifactId>documentation</artifactId>
+
+ <name>Apache Synapse - Extensions</name>
+ <description>Apache Synapse - Extensions</description>
+ <packaging>pom</packaging>
+
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>2.1</version>
+ </plugin>
+ </plugins>
+ </build>
+
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <inherited>false</inherited>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.1</version>
+ <configuration>
+ <links>
+ <link>http://java.sun.com/j2se/1.5.0/docs/api/</link>
+ <link>http://java.sun.com/j2ee/1.4/docs/api/</link>
+ <link>http://jaxen.codehaus.org/apidocs/</link>
+ <link>http://ws.apache.org/commons/axiom/apidocs/</link>
+ <link>http://ws.apache.org/axis2/1_5_1/api/</link>
+ </links>
+ <aggregate>true</aggregate>
+ </configuration>
+ </plugin>
+ <plugin>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>2.1</version>
+ <inherited>false</inherited>
+ </plugin>
+ <plugin>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <version>2.1.1</version>
+ <configuration>
+ <!-- These features are disabled since they cause "mvn site" to hang -->
+ <dependencyLocationsEnabled>false</dependencyLocationsEnabled>
+ <dependencyDetailsEnabled>false</dependencyDetailsEnabled>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
+
+ <properties>
+ <spring.version>1.2.8</spring.version>
+ </properties>
+</project>
Added: synapse/branches/2.1/modules/documentation/src/site/resources/css/site.css
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/resources/css/site.css?rev=1222651&view=auto
==============================================================================
--- synapse/branches/2.1/modules/documentation/src/site/resources/css/site.css (added)
+++ synapse/branches/2.1/modules/documentation/src/site/resources/css/site.css Fri Dec 23 11:55:05 2011
@@ -0,0 +1,212 @@
+@import url(http://fonts.googleapis.com/css?family=Buenard);
+body, p, div, ul, li, a, tr, td,th{
+ font-family: 'Buenard', serif;
+ font-size:15px;
+}
+body{
+ border-top:solid 5px #000;
+ padding-bottom:0px;
+ background:transparent url(../images/page-back.png) no-repeat right 5px;
+}
+h2{
+ background-color:transparent;
+ border:none;
+ font-size:30px;
+ color:#171515;
+ /*text-shadow:-1px -1px 2px #ADA9A9;*/
+ margin:3px 0px;
+}
+h3{
+ background-color:transparent;
+ border:none;
+ font-size:25px;
+ color:#171515;
+ /*text-shadow:-1px -1px 2px #ADA9A9;*/
+ margin:3px 0px;
+}
+div#contentBox h4{
+ margin:3px 0px;
+ font-size:15px;
+ color: #666666;
+ font-weight:bold;
+ border:none;
+ padding:0;
+ background-color:transparent;
+}
+div#contentBox h5{
+ margin:3px 0px;
+ font-size:15px;
+}
+div#contentBox{
+ padding-top:10px;
+}
+p,li{
+ line-height:25px;
+}
+#bannerLeft{
+ text-align:right;
+ position:absolute;
+ right:270px;
+ top:30px;
+ color:#4c4c4c;
+}
+#banner{
+ height:90px;
+ background:transparent url(../images/synapse-logo.png) no-repeat left top;
+}
+#footer{
+ background:transparent url(../images/footer-back.png) repeat-x left top;
+ color:#fff;
+ font-size:11px;
+ height:80px;
+ padding:10px;
+ text-align:center;
+ margin:0px 0px !important;
+ border-top:solid 5px #000;
+}
+.xright{
+ float:none;
+}
+#breadcrumbs{
+ background-image: -webkit-gradient(linear, left top, left bottom, from(#c2c2c2), to(#d7d7d7)); /* mozilla - FF3.6+ */
+ background-image: -moz-linear-gradient(top, #c2c2c2 0%, #d7d7d7 100%); /* IE 5.5 - 7 */
+ filter:progid:DXImageTransform.Microsoft.Gradient(GradientType=0,StartColorStr='#c2c2c2',EndColorStr='#d7d7d7'); /* IE8 */
+ -ms-filter: progid: DXImageTransform . Microsoft . gradient(gradientType = 0, startColor = '#c2c2c2', endColoStr = '#d7d7d7'); /*Transparent back */
+
+ /*Rounded corners */
+ -moz-border-radius: 3px;
+ border-radius: 3px;
+ border: solid 1px #888888;
+
+ /*The shadow */
+ -moz-box-shadow: 3px 3px 2px #ddd;
+ -webkit-box-shadow: 3px 3px 2px #ddd;
+ box-shadow: 3px 3px 2px #ddd;
+
+ color:#707070;
+
+ margin:0px 20px;
+ padding:5px;
+
+ /*text-shadow: -1px -1px 2px #918D8D;*/
+}
+#leftColumn{
+ margin:20px 20px;
+
+
+ background-color:#e9e9e9;
+
+ /*Rounded corners */
+ -moz-border-radius: 3px;
+ border-radius: 3px;
+
+ /*The shadow */
+ -moz-box-shadow: 3px 3px 2px #ddd;
+ -webkit-box-shadow: 3px 3px 2px #ddd;
+ box-shadow: 3px 3px 2px #ddd;
+
+ width:250px;
+}
+#navcolumn strong{
+ color:#ff6800;
+ font-size:13px;
+}
+#navcolumn h5{
+ color:#2b2b2b;
+ font-weight:bold;
+ font-size:20px;
+}
+#navcolumn li{
+ margin:10px 0px;
+}
+#navcolumn li a{
+ font-size:13px;
+}
+#bodyColumn{
+ margin-left:300px;
+}
+#bodyColumn ul li{
+ margin-bottom:10px;
+}
+table.bodyTable {
+ border-left: solid 1px #468aa6;
+ border-top: solid 1px #468aa6;
+ border-collapse: collapse;
+}
+
+table.bodyTable th {
+ background-image: -webkit-gradient(linear, left top, left bottom, from(#56aed2), to(#417f98));
+ background-image: -moz-linear-gradient(top, #56aed2 0%, #417f98 100%);
+ filter: progid:DXImageTransform.Microsoft.gradient(gradientType = 0, startColor = 0, endColorStr = #417f98);
+ -ms-filter: progid:DXImageTransform.Microsoft.gradient(gradientType = 0, startColor = 0, endColoStr = #417f98);
+ color: #fff;
+ font-size: 15px;
+ text-align: left;
+ padding: 3px;
+
+ border-right: solid 1px #468aa6;
+ border-bottom: solid 1px #468aa6;
+}
+
+table.bodyTable td {
+ border-right: solid 1px #468aa6;
+ border-bottom: solid 1px #468aa6;
+ margin: 0px;
+ padding: 3px;
+}
+table.bodyTable tr:nth-child(even) {background: #ccdde1}
+table.bodyTable tr:nth-child(odd) {background: #FFF}
+
+/*div#contentBox > div:first-child p:first-letter{
+ font-weight:bold;
+ font-size:40px;
+}*/
+
+
+
+/* Pre defined styles */
+
+.consoleOutput {
+ overflow: auto;
+ white-space: pre;
+ border: 1px dashed #3c78b5;
+ font-size: 11px;
+ font-family: Courier;
+ margin: 10px;
+ line-height: 13px;
+ background-color: #f0f0f0;
+ border-bottom: 1px dashed #3c78b5;
+ padding: 3px;
+ border-style: solid;
+}
+
+.xmlConf {
+ overflow: auto;
+ white-space: pre;
+ border: 1px dashed #3c78b5;
+ font-size: 11px;
+ font-family: Courier;
+ margin: 10px;
+ line-height: 25px;
+ background-color: #f0f0f0;
+ border-bottom: 1px dashed #3c78b5;
+ padding: 3px;
+ border-style: solid;
+}
+
+.command {
+ overflow: auto;
+ border: 1px dashed #3c78b5;
+ text-align: left;
+ background-color: #f0f0f0;
+ padding: 3px;
+ font-size: 11px;
+ font-family: Courier;
+ margin: 10px;
+ line-height: 13px;
+}
+.xmlConf a {
+ font-size:13px;
+ line-height:20px;
+ font-family: Courier;
+}
\ No newline at end of file
Added: synapse/branches/2.1/modules/documentation/src/site/resources/images/footer-back.png
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/resources/images/footer-back.png?rev=1222651&view=auto
==============================================================================
Binary file - no diff available.
Propchange: synapse/branches/2.1/modules/documentation/src/site/resources/images/footer-back.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: synapse/branches/2.1/modules/documentation/src/site/resources/images/page-back.png
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/resources/images/page-back.png?rev=1222651&view=auto
==============================================================================
Binary file - no diff available.
Propchange: synapse/branches/2.1/modules/documentation/src/site/resources/images/page-back.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-arch.png
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-arch.png?rev=1222651&view=auto
==============================================================================
Binary file - no diff available.
Propchange: synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-arch.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-flow.png
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-flow.png?rev=1222651&view=auto
==============================================================================
Binary file - no diff available.
Propchange: synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-flow.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-logo.png
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-logo.png?rev=1222651&view=auto
==============================================================================
Binary file - no diff available.
Propchange: synapse/branches/2.1/modules/documentation/src/site/resources/images/synapse-logo.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: synapse/branches/2.1/modules/documentation/src/site/site.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/site.xml?rev=1222651&view=auto
==============================================================================
--- synapse/branches/2.1/modules/documentation/src/site/site.xml (added)
+++ synapse/branches/2.1/modules/documentation/src/site/site.xml Fri Dec 23 11:55:05 2011
@@ -0,0 +1,72 @@
+<?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.
+ -->
+
+<project name="Apache Synapse">
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-default-skin</artifactId>
+ <version>1.0</version>
+ </skin>
+ <body>
+ <menu name="Main Menu">
+ <item name="Home" href="index.html"/>
+ <item name="Download" href="download.html"/>
+ <item name="History" href="history.html"/>
+ <item name="License" href="http://www.apache.org/licenses/LICENSE-2.0"/>
+ <item name="Thanks" href="http://www.apache.org/foundation/thanks.html"/>
+ <item name="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html"/>
+ <item name="Security" href="http://www.apache.org/security/"/>
+ </menu>
+ <menu name="Documentation">
+ <item name="Installation Guide" href="userguide/installation.html"/>
+ <item name="Quick Start Guide" href="userguide/quick_start.html"/>
+ <item name="Samples Setup Guide" href="userguide/samples/setup/index.html"/>
+ <item name="Samples Catalog" href="userguide/samples.html"/>
+ <item name="Configuration Language" href="userguide/config.html"/>
+ <item name="Mediators Catalog" href="userguide/mediators.html"/>
+ <item name="Transports Catalog" href="userguide/transports.html"/>
+ <item name="Extending Synapse" href="userguide/extending.html"/>
+ <item name="Upgrading" href="userguide/upgrading.html"/>
+ <item name="Deployment" href="userguide/deployment.html"/>
+ <item name="Javadocs" href="apidocs/"/>
+ <item name="FAQ" href="userguide/faq.html"/>
+ </menu>
+ <menu name="Developer Resources">
+ <item name="Developer Guide " href="dev/developer-guide.html"/>
+ <item name="Development Best Practices" href="dev/best-practices.html"/>
+ <item name="Release Process" href="dev/release-process.html"/>
+ </menu>
+ <menu name="Project Details">
+ <item name="Overview" href="project-info.html"/>
+ <item name="Mailing Lists" href="mail-lists.html"/>
+ <item name="Source Repository" href="source-repository.html"/>
+ <item name="Issue Tracking" href="issue-tracking.html"/>
+ <item name="Dependencies" href="dependencies.html"/>
+ <item name="Project Team" href="team-list.html"/>
+ <item name="Project Summary" href="project-summary.html"/>
+ </menu>
+ <menu name="Previous Releases">
+ <item name="Version 2.0" href="2_0/index.html"/>
+ <item name="Version 1.1.1" href="1_1_1/content.html"/>
+ <item name="Version 1.1" href="1_1/content.html"/>
+ <item name="Version 1.0" href="1_0/content.html"/>
+ </menu>
+ </body>
+</project>
Added: synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/best-practices.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/best-practices.xml?rev=1222651&view=auto
==============================================================================
--- synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/best-practices.xml (added)
+++ synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/best-practices.xml Fri Dec 23 11:55:05 2011
@@ -0,0 +1,147 @@
+<?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 - Development Best Practices</title>
+ </properties>
+ <body>
+ <section name="Development Best Practices">
+ <p>
+ This document explains the best practices and conventions that should be followed
+ when writing code, documentation and samples for Apache Synapse. It is mainly
+ intended for Synapse committers who directly commit code into the Synapse code base.
+ It is also a useful resource for potential contributors who are willing to
+ write code for Synapse.
+ </p>
+ <p>
+ Committers are highly encouraged to follow the guidelines mentioned in this document
+ whenever adding a new source file to the code base or when modifying an existing source
+ file. Same best practices should be followed when committing a patch provided by
+ a contributor.
+ </p>
+ <p>
+ This document is a work in progress. We will continue to make this more detailed
+ and comprehensive as we go along. So stay tuned for updates.
+ </p>
+ <subsection name="Contents">
+ <ul>
+ <li><a href="#Code">Writing Code</a></li>
+ <li><a href="#Docs">Writing Samples and Documentation</a></li>
+ </ul>
+ </subsection>
+ </section>
+ <section name="Writing Code" id="Code">
+ <ul>
+ <li>
+ We follow the standard
+ <a href="http://www.oracle.com/technetwork/java/codeconvtoc-136057.html">Java coding conventions</a>
+ published by Sun/Oracle. Please stick to these standards whenever writing code
+ for Synapse.
+ </li>
+ <li>
+ The maximum number of characters in a single line should not exceed 100. Please
+ configure your IDE to properly enforce this restriction on all source files.
+ </li>
+ <li>
+ All source files should contain the following license header at the top.<br/>
+ <div class="xmlConf">/*
+ * 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.
+ */</div>
+ </li>
+ <li>
+ Pay attention to indentation and proper spacing between code blocks.
+ </li>
+ <li>
+ Each Java source file should have a introductory Javadoc comment describing its
+ main purposes and features.
+ </li>
+ <li>
+ Every public method should have a Javadoc comment describing its purpose and
+ behavior. When writing Javadoc comments for methods, input arguments, return
+ values and checked exceptions should also be clearly explained.
+ </li>
+ <li>
+ Use meaningful names for all classes, interfaces, methods and variables. Pay
+ attention to spellings. Code should be easier to follow and understand.
+ </li>
+ <li>
+ Feel free to include comments within the code to explain non-trivial logic.
+ </li>
+ <li>
+ When removing a public method or an API, first deprecate the relevant operations
+ by applying the proper Javadoc annotations. Actual removal of the operation
+ should be done after some time, in a future release.
+ </li>
+ <li>
+ Write test cases for each new feature and bug fix implemented in the code base.
+ Test cases make it easier to check for regressions and keep the code base
+ healthy at all times.
+ </li>
+ </ul>
+ </section>
+ <section name="Writing Samples and Documentation" id="Docs">
+ <ul>
+ <li>
+ All documentation files and samples should we well-formed XML documents.
+ </li>
+ <li>
+ We use the <a href="http://maven.apache.org/maven-1.x/plugins/xdoc/">Maven XDoc plugin</a>
+ to generate Synapse documentation and website. Please take some time to go through
+ the documentation of the XDoc plugin and learn and its features. In pariculay,
+ you should learn the <a href="http://maven.apache.org/doxia/references/xdoc-format.html">XDoc documentation format</a>
+ and use the standard XDoc tags over HTML whenever possible.
+ </li>
+ <li>
+ Any XML code samples included in the documentation should be properly HTML
+ encoded and indented. Such code samples should go in a HTML 'div' section withe
+ the class 'xmlConf'.
+ <div class="xmlConf"><div class="xmlConf">
+ ... Encoded XML content ...
+</div></div>
+ </li>
+ <li>
+ Attempt to keep each line shorter than 100 characters. This is bit tricky to
+ enforce when writing XML/HTML content. But try to stick to the rule whenever
+ possible.
+ </li>
+ <li>
+ Add navigation links wherever possible. When describing a particular feature
+ add a link to the relevant sample.
+ </li>
+ </ul>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/developer-guide.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/developer-guide.xml?rev=1222651&view=auto
==============================================================================
--- synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/developer-guide.xml (added)
+++ synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/developer-guide.xml Fri Dec 23 11:55:05 2011
@@ -0,0 +1,269 @@
+<?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 - Developer Guide</title>
+ </properties>
+ <body>
+ <section name="Developer Guide">
+ <p>
+ Welcome to Apache Synapse Developer Guide. This document is a starting point for
+ anyone who's willing to write code for Synapse and make contributions. We welcome
+ several different types of contributions such as ideas, new features, bug fixes,
+ documentation and samples. This guide strives to provide information on how you can
+ get the Synapse source code, how to setup the development environment and how to
+ make contributions. Further it provides instructions on how to get in touch with the
+ other developers, how to report issues and how to keep track of development activities.
+ </p>
+ <p>
+ If you are an experienced Synapse developer or already a committer
+ for Synapse, this document might still contain useful information on setting up
+ your working copy of the source code and committing code changes. So feel free to
+ read all the way through.
+ </p>
+ </section>
+ <section name="Contents">
+ <ul>
+ <li>
+ <a href="#subversion">Interacting with the Code Base Using Subversion</a>
+ <ul>
+ <li><a href="#checkout">Checking Out the Source</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#maven">Interacting with the Build System Using Apache Maven</a>
+ <ul>
+ <li><a href="#building">Building from Source</a></li>
+ <li><a href="#environment">Setting Up the Development Environment</a></li>
+ <li><a href="#integration">Integration Tests</a></li>
+ <li><a href="#testdebug">Debugging Tests</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#debug">Debugging the Synapse Server</a>
+ </li>
+ <li>
+ <a href="#issues">Reporting Issues</a>
+ </li>
+ <li>
+ <a href="#contrib">Making Contributions</a>
+ </li>
+ </ul>
+ </section>
+ <section name="Interacting with the Code Base Using Subversion" id="subversion">
+ <p>
+ Synapse code base is maintained in a Subversion repository. Therefore anybody willing
+ to go through the Synapse source code in the development trunk and make contributions
+ should use a Subversion client to interact with the Synapse code base. To learn more
+ about using Subversion or to download the latest client distributions, please visit
+ the <a href="http://subversion.apache.org">Apache Subversion project website</a>.
+ Developers on Unix/Linux based systems may use the command line based SVN client,
+ while the developers on Windows platform can use an appropriate client application
+ like <a href="http://tortoisesvn.net/">TortoiseSVN</a>.
+ </p>
+ <p>
+ Some useful information on using the Apache Software Foundation's source code
+ repositories can be found among the ASF
+ <a href="http://www.apache.org/dev/version-control.html">developer documentation</a>.
+ </p>
+ <subsection name="Checking Out the Source" id="checkout">
+ <p>
+ Synapse development trunk is where all the latest development work takes place.
+ This is located at
+ <a href="http://svn.apache.org/repos/asf/synapse/trunk/java/">http://svn.apache.org/repos/asf/synapse/trunk/java/</a>.
+ Any developer with a Subversion client should be able to checkout the latest
+ source from this SVN location but only Synapse committers are allowed to actually
+ commit source code. Synapse committers should access the above SVN location over
+ HTTPS and provide the ASF committer credentials to checkout and commit source
+ code. Please refer the <a href="../source-repository.html">source repository guide</a>
+ for more details on checking out the source code from the above repository.
+ </p>
+ <p>
+ Once you have checked out the source code, you can update your working copy by
+ running the 'svn update' command. This will checkout the modifications since the
+ last checkout/update and bring your local working copy to the latest revision.
+ </p>
+ <p>
+ If you want to browse the source code of an older release of Synapse or want
+ to implement a patch for a past release, you may checkout the relevant source
+ tree from one of the available SVN
+ <a href="http://svn.apache.org/repos/asf/synapse/tags/">tags</a>.
+ </p>
+ </subsection>
+ </section>
+ <section name="Interacting with the Build System Using Apache Maven" id="maven">
+ <p>
+ Synapse build system is based on Apache Maven. Either Maven2 or Maven3 can be used to
+ build Apache Synapse from source. For information about downloading, installing, and
+ configuring Maven, please go through
+ <a class="externalLink" href="http://maven.apache.org">Maven project website</a>.
+ </p>
+ <subsection name="Building from Source" id="building">
+ <p>
+ To build all the modules and the Synapse binary distribution, go to
+ the root of the Synapse source tree and execute the following Maven command.
+ </p>
+ <div class="command">mvn clean install</div>
+ <p>
+ This will fetch all the required dependencies, compile the source, run the tests
+ and build the Synapse modules and the binary pack. Please note that building
+ with tests takes time. To build without the tests, use the following Maven
+ command.
+ </p>
+ <div class="command">mvn clean install -Dmaven.test.skip=true</div>
+ <p>
+ Developers and committers making changes to the Synapse code base are highly
+ recommended to always build the source 'WITH' the tests. This will ensure that
+ changes do not introduce any obvious regression errors. However running all the
+ tests does not guarantee that a particular change will not introduce any
+ regressions. Therefore care must be exercised whenever making changes to the
+ existing code.
+ </p>
+ <p>
+ Synapse source tree is organized into several modules. If required you can build
+ only a selected module by going into the appropriate module and executing one
+ of the above build commands.
+ </p>
+ </subsection>
+ <subsection name="Setting Up the Development Environment" id="environment">
+ <p>
+ Apache Synapse development can be based on a number of tools ranging from simple
+ command line tools like Vim and Emacs to full fledged Java IDEs like Eclipse,
+ IntelliJ Idea and Netbeans. If Eclipse or Idea is used to develop code for
+ Synapse, Maven can be used to build the necessary project artifacts.
+ </p>
+ <p>
+ Simply run the following commands to generate the project artifacts and then
+ use your IDE to open up the Synapse code base as a Java project.
+ </p>
+ <div class="command">For Idea: mvn idea:idea
+For Eclipse: mvn eclipse:eclipse</div>
+ </subsection>
+ <subsection name="Integration Tests" id="integration">
+ <p>
+ Starting from Synapse 2.1, a suite of integration tests are included in the
+ Synapse code base. These tests automate various samples included in the Synapse
+ binary distribution and provide a convenient way to sanity check a Synapse
+ distribution and find any regressions. If you build the source tree from the root
+ without skipping the test cases, these integration tests will be executed by
+ Maven as a part of the build process. If you just need to run the integration
+ tests simply go into the modules/integration directory in the source tree and
+ run the usual Maven build command.
+ </p>
+ <p>
+ Synapse integration test suite uses the Maven Surefire plugin. Therefore all
+ tests will generate a report which will be available in the
+ modules/integration/target/surefire-reports directory. If you ever encounter
+ a failure while running the integration tests, this is the first place to check.
+ </p>
+ <p>
+ You can pass additional parameters to the Synapse integration test framework and
+ limit the number of tests executed by Maven. For an example if you simply want
+ to run sample 10 in the integration test framework, run the following command.
+ </p>
+ <div class="command">mvn clean install -Dtests=10</div>
+ <p>
+ You can also run a list of known samples as an integration test.
+ </p>
+ <div class="command">mvn clean install -Dtests=10,11,12</div>
+ <p>
+ Synapse samples are categorized into several sections. If needed you can run all
+ the samples in a particular section.
+ </p>
+ <div class="command">mvn clean install -Dsuite=proxy</div>
+ <div class="command">mvn clean install -Dsuite=endpoint</div>
+ <p>
+ Following values can be passed in as the value of the 'suite' parameter.
+ </p>
+ <ul>
+ <li>message</li>
+ <li>endpoint</li>
+ <li>qos</li>
+ <li>proxy</li>
+ <li>tasks</li>
+ <li>advanced</li>
+ </ul>
+ </subsection>
+ <subsection name="Debugging Tests" id="testdebug">
+ <p>
+ Maven allows you to remote debug tests at build time. To make use of this
+ feature simply run the Maven build command with the -Dmaven.surefire.debug
+ flag.
+ </p>
+ <div class="command">mvn clean install -Dmaven.surefire.debug</div>
+ <p>
+ This will open up port 5005 for remote debugging and you can use your IDE to
+ connect to that port and remote debug the test source (or even Synapse source).
+ </p>
+ </subsection>
+ </section>
+ <section name="Debugging the Synapse Server" id="debug">
+ <p>
+ If you are running the Synapse binary distribution and wants to debug the server
+ to fix some issue, simply start the server with the -xdebug option.
+ </p>
+ <div class="command">sh synapse.sh -xdebug</div>
+ <p>
+ This will open up port 8000 for remote debugging. Now you can connect to the server
+ from your IDE and remote debug it against the source code. If you want to debug a
+ message flow in Synapse, it's recommended to place some break points in the
+ org.apache.synapse.core.axis2.SynapseMessageReceiver and org.apache.synapse.core.axis2.ProxyServiceMessageReceiver
+ classes.
+ </p>
+ </section>
+ <section name="Reporting Issues" id="issues">
+ <p>
+ Please report all issues in the <a href="../issue-tracking.html">Synapse JIRA</a>.
+ You can also create JIRA issues for any suggestions, improvements and new features
+ you have in mind. If you wish to further discuss some idea with the rest of the
+ Synapse community, please write to the appropriate <a href="../mail-lists.html">mailing lists</a>.
+ </p>
+ <p>
+ You are also encouraged to comment on other issues in the Synapse JIRA, ask questions
+ and if possible make code/documentation contributions.
+ </p>
+ </section>
+ <section name="Making Contributions" id="contrib">
+ <p>
+ If you have implemented a new feature, fixed some bug in the code or written a new
+ sample, we'll be more than happy to review it and include it in the Synapse code
+ base for everyone's benefit. If you are interested in contributing your work to Synapse,
+ please create an issue in the JIRA system first. Then you can attach your workings to
+ the JIRA issue as a patch.
+ </p>
+ <p>
+ To create a patch file out of your work simply run the 'svn diff' command.
+ </p>
+ <div class="command">svn diff > FixForIssue123.patch</div>
+ <p>
+ If you added any new files as a part of your work you should first run the 'svn add'
+ command on them before creating the patch file. Otherwise they won't be included
+ in the generated patch.
+ </p>
+ <p>
+ Once the patch file has been created, attach it to the relevant JIRA issue and make
+ sure to grant the ASF permission to use your patch in ASF development activities.
+ One of the committers will review your work and provide feedback through the JIRA. If
+ all is well, the patch will eventually go into the Synapse development trunk.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/release-process.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/release-process.xml?rev=1222651&view=auto
==============================================================================
--- synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/release-process.xml (added)
+++ synapse/branches/2.1/modules/documentation/src/site/xdoc/dev/release-process.xml Fri Dec 23 11:55:05 2011
@@ -0,0 +1,53 @@
+<?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 - Release Process</title>
+ </properties>
+ <body>
+ <section name="Release Process">
+ <p>
+ We follow the standard <a href="http://www.apache.org/dev/release-publishing.html">ASF release process</a>.
+ One of the committers would volunteer to play the release manager role for a given
+ release. A few days will be spent on stabilizing the Synapse development trunk,
+ improving its documentation and test coverage. When the code base is in a satisfactory
+ state a release branch would be created under
+ <a href="https://svn.apache.org/repos/asf/synapse/branches">https://svn.apache.org/repos/asf/synapse/branches</a>.
+ </p>
+ <p>
+ From this point onwards all committers will switch to the newly created development
+ branch. It is highly recommended to ensure that all the changes done on the development
+ branch are also checked into the main development branch. Open JIRA issues will be
+ reviewed and rearranged accordingly. Many of the issues will get resolved during this
+ process and the remaining few will be accordingly prioritized and scheduled for a
+ future release. The unit tests and integration tests will be used extensively during
+ this critical period to keep the development branch in its most stable form.
+ </p>
+ <p>
+ Finally the release manager would trigger the release build, sign the generated artifacts
+ and host them on people.apache.org for review. A release vote will be called urging
+ all those interested to review the packs and provide feedback. Upon receiving the
+ necessary number of votes, a release tag will be created and the release artifacts will
+ be uploaded to the appropriate servers for distribution.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: synapse/branches/2.1/modules/documentation/src/site/xdoc/download.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/xdoc/download.xml?rev=1222651&view=auto
==============================================================================
--- synapse/branches/2.1/modules/documentation/src/site/xdoc/download.xml (added)
+++ synapse/branches/2.1/modules/documentation/src/site/xdoc/download.xml Fri Dec 23 11:55:05 2011
@@ -0,0 +1,72 @@
+<?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 - Downloads</title>
+ </properties>
+ <body>
+ <section name="Download Latest Stable Release">
+ <p>
+ The latest stable release of Apache Synapse is 2.1. It is highly recommended
+ to use the latest stable release so that you can use our newest features
+ while benefiting from all the recent bug fixes and improvements.
+ </p>
+ <table>
+ <tr>
+ <th>Version</th>
+ <th>Release Date</th>
+ </tr>
+ <tr>
+ <td><a href="download/2.1/download.cgi">2.1</a></td>
+ <td>22-Dec-2011</td>
+ </tr>
+ </table>
+ </section>
+ <section name="Download Previous Releases">
+ <table>
+ <tr>
+ <th>Version</th>
+ <th>Release Date</th>
+ </tr>
+ <tr>
+ <td><a href="download/2.0.0/download.cgi">2.0.0</a></td>
+ <td>30-Nov-2010</td>
+ </tr>
+ <tr>
+ <td><a href="download/1.2/download.cgi">1.2</a></td>
+ <td>9-Jun-2008</td>
+ </tr>
+ <tr>
+ <td><a href="download/1.1.1/download.cgi">1.1.1</a></td>
+ <td>28-Jan-2008</td>
+ </tr>
+ <tr>
+ <td><a href="download/1.1/download.cgi">1.1</a></td>
+ <td>12-Nov-2007</td>
+ </tr>
+ <tr>
+ <td><a href="download/2.0.0/download.cgi">1.0</a></td>
+ <td>08-Jun-2007</td>
+ </tr>
+ </table>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: synapse/branches/2.1/modules/documentation/src/site/xdoc/history.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/xdoc/history.xml?rev=1222651&view=auto
==============================================================================
--- synapse/branches/2.1/modules/documentation/src/site/xdoc/history.xml (added)
+++ synapse/branches/2.1/modules/documentation/src/site/xdoc/history.xml Fri Dec 23 11:55:05 2011
@@ -0,0 +1,63 @@
+<?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 - Down the Memory Lane</title>
+ </properties>
+ <body>
+ <section name="History of Synapse">
+ <p>
+ Synapse started out as an Apache Incubator project co-proposed by a number of
+ companies. The real key starting point was a face-to-face meeting held in the
+ Bay Area in September 2005 hosted at Infravio's offices. In that meeting the
+ overall approach for Synapse was hammered out, and then we set out to coding.
+ </p>
+ <p>
+ The first real usable build followed early in January 2006. Known as M1, this was a
+ real runnable release, but only providing very simple functionality. Other releases
+ throughout 2006 lead to the 0.90 release in December 2006, and in December 2006, the
+ Board voted to approve Synapse as a graduate from the Incubator and a member of the
+ Web Services project. The namespace URL (http://ws.apache.org/ns/synapse) used in
+ the Synapse configuration language is a remnant from our Apache Web Services heritage.
+ </p>
+ <p>
+ A year later, in December 2007, Synapse became an Apache top level project (TLP),
+ and since then has released 3 versions.
+ </p>
+ <p>
+ Here are some more interesting resources that show the growth and development
+ of Synapse from its humble beginnings.
+ </p>
+ <ul>
+ <li><a href="http://wiki.apache.org/incubator/SynapseProposal">Project proposal</a></li>
+ <li><a href="http://markmail.org/message/ac27hfeyvj4bbgde">What's available in Synapse M1?</a></li>
+ <li><a href="http://markmail.org/message/ueoox6fgpu5zwsrn">1.1 release announcement</a></li>
+ <li><a href="http://markmail.org/message/7wuu2jfsk2qfwhdp">1.1.1 release announcement</a></li>
+ <li><a href="http://markmail.org/message/od5si63jdjhj3mhc">1.2 release announcement</a></li>
+ <li><a href="http://apache-synapse.blogspot.com/">Old Apache Synapse blog</a></li>
+ <li><a href="http://www.slideshare.net/pizak/fast-soa-with-apache-synapse">Synapse at ApacheCon EU 2008</a></li>
+ <li><a href="http://www.slideshare.net/guest60ed0b/aceu2009-synapse-scalability-availability">Synapse at ApacheCon EU 2009</a></li>
+ <li><a href="http://www.slideshare.net/hiranya911/introduction-to-apache-synapse">Synapse at Apache Asia Roadshow 2009</a></li>
+ <li><a href="http://en.wikipedia.org/wiki/Apache_Synapse">Synapse on Wikipedia</a></li>
+ </ul>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: synapse/branches/2.1/modules/documentation/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.1/modules/documentation/src/site/xdoc/index.xml?rev=1222651&view=auto
==============================================================================
--- synapse/branches/2.1/modules/documentation/src/site/xdoc/index.xml (added)
+++ synapse/branches/2.1/modules/documentation/src/site/xdoc/index.xml Fri Dec 23 11:55:05 2011
@@ -0,0 +1,137 @@
+<?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 - The Lightweight ESB</title>
+ </properties>
+ <body>
+ <section name="Apache Synapse Enterprise Service Bus (ESB)">
+ <p>
+ Apache Synapse is a lightweight and high-performance Enterprise Service Bus (ESB).
+ Powered by a fast and asynchronous mediation engine, Apache Synapse provides
+ exceptional support for XML, Web Services and REST. In addition to XML and SOAP,
+ Apache Synapse supports several other content interchange formats, such as plain
+ text, binary, Hessian and JSON. The wide range of transport adapters available for
+ Synapse, enables it to communicate over many application and transport layer
+ protocols. As of now, Apache Synapse supports HTTP/S, Mail (POP3, IMAP, SMTP),
+ JMS, TCP, UDP, VFS, SMS, XMPP and FIX.
+ </p>
+ <p>
+ Apache Synapse is free and open source software distributed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache Software License 2.0</a>.
+ The latest version of Synaspe is <a href="download/2.1/download.cgi">v2.1</a>.
+ This release comes with a horde of new features, bug fixes, performance and
+ stability improvements.
+ </p>
+ </section>
+ <section name="New in Version 2.1">
+ <ul>
+ <li>
+ Support for creating and managing REST APIs with URL patterns and URI templates
+ </li>
+ <li>
+ Define sequences and endpoints as templates and reuse seamlessly across the
+ whole configuration
+ </li>
+ <li>
+ Payload factory mediator for constructing custom XML payloads
+ </li>
+ <li>
+ Recipient list endpoint
+ </li>
+ <li>
+ HTTPD like access logging capability in the NHTTP transport
+ </li>
+ <li>
+ Message stores and message processors for implementing complex integration
+ patterns and advanced messaging scenarios
+ </li>
+ <li>
+ Receiving sequence support in the send mediator to make service chaining
+ easier
+ </li>
+ <li>
+ Conditional router mediator for implementing complex routing scenarios with
+ many conditions and rules
+ </li>
+ </ul>
+ </section>
+ <section name="Key Features">
+ <ul>
+ <li>Proxy services - facilitating transport, interface (WSDL/Schema/Policy),
+ message format (SOAP 1.1/1.2, POX/REST, Text, Binary), QoS (WS-Addressing/
+ WS-Security/WS-RM) and optimization switching (MTOM/SwA)</li>
+ <li>Non-blocking HTTP/S transports for fast HTTP interactions and support for
+ thousands of concurrent connections</li>
+ <li>VFS transport for file manipulation and interaction with FTP, SFTP, CIFS
+ and WEBDAV</li>
+ <li>JMS support for binary, plain text, XML and SOAP payloads</li>
+ <li>Mail transport with extensive support for POP3, IMAP and SMTP</li>
+ <li>Support for industry driven <a href="http://www.fixprotocol.org/">Financial
+ Information eXchange (FIX)</a> protocol</li>
+ <li>Built-in Registry/Repository, facilitating dynamic reloading of the
+ configuration and associated resources (e.g. XSLTs, XSD, JS, ..)</li>
+ <li>Built-in support for scheduling tasks using the
+ <a target="_blank" href="http://www.opensymphony.com/quartz">Quartz</a> scheduler</li>
+ <li>Load-balancing (with or without sticky sessions) and fail-over routing</li>
+ <li>Support for many Web Services standards including WS-Addressing, WS-Security
+ and WS-Reliable Messaging</li>
+ <li>Policy based message throttling and caching (with special support for clustered
+ environments)</li>
+ <li>Message splitting and aggregation</li>
+ <li>Database lookup and update support with database connection pooling</li>
+ <li>Fine grained statistics collection over sequences, endpoints and proxy services</li>
+ <li>JMX monitoring and management</li>
+ <li>Easily extendable with Java, Spring, or BSF Scripting languages (Javascript,
+ Ruby, Groovy, etc.)</li>
+ </ul>
+ </section>
+ <section name="High Level Architecture">
+ <p>
+ Apache Synapse is designed to be lightweight and fast. The non-blocking HTTP
+ transport, the multi-threaded mediation engine and the streaming XML infoset combine
+ to ensure that Synapse can mediate very high volumes of messages through the service
+ bus with minimum delay and resource usage. Synapse also comes with comprehensive
+ logging capabilities, statistics collection and JMX monitoring support which are
+ crucial in production deployments.
+ </p>
+ <img src="images/synapse-arch.png"/>
+ <p>
+ 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,
+ Apache Synapse supports a range of Web Services standards including WS-Security and
+ WS-Reliable Messaging. Synapse also makes use of the Axis2 clustering framework to
+ provide enterprise grade clustering support.
+ </p>
+ <p>
+ Synapse is configured using a simple, XML-based configuration language. The
+ configuration language and the related functional components are designed with SOA
+ best practices in mind. It is trivial to store configuration fragments in an external
+ SOA registry and import them to the mediation engine on demand. Synapse ships with a
+ large collection of mediators that can be used to implement even the most complex
+ enterprise integration scenarios. If necessary, the mediation engine can be extended
+ by developing custom mediators using Java or your favorite scripting language.
+ </p>
+ </section>
+ </body>
+</document>