You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@synapse.apache.org by ru...@apache.org on 2010/12/03 05:07:30 UTC
svn commit: r1041684 [3/3] - in /synapse/branches/2.0:
modules/core/src/test/resources/synapse-config/
modules/packaging/package-archetype/src/main/resources/archetype-resources/repository/conf/
repository/conf/sample/ repository/conf/sample/resources/...
Modified: synapse/branches/2.0/src/site/xdoc/Synapse_Samples.xml
URL: http://svn.apache.org/viewvc/synapse/branches/2.0/src/site/xdoc/Synapse_Samples.xml?rev=1041684&r1=1041683&r2=1041684&view=diff
==============================================================================
--- synapse/branches/2.0/src/site/xdoc/Synapse_Samples.xml (original)
+++ synapse/branches/2.0/src/site/xdoc/Synapse_Samples.xml Fri Dec 3 04:07:27 2010
@@ -76,7 +76,9 @@
<li>
<a href="#Sample12">Sample 12: One way messaging / fireAndForget through Synapse</a></li>
<li>
-<a href="#Sample13">Sample 13: Dual channel invocation through Synapse</a></li></ul></li>
+<a href="#Sample13">Sample 13: Dual channel invocation through Synapse</a></li>
+<li>
+<a href="#Sample13">Sample 14: Sequences and Endpoints as local registry items</a></li></ul></li>
<li>
<a href="#Endpoints">Advanced mediations with endpoints</a>
<ul>
@@ -104,7 +106,9 @@
<li>
<a href="#Sample100">Sample 100: Using WS-Security for outgoing messages</a></li>
<li>
-<a href="#Sample101">Sample 101: Reliable message exchange between Synapse and the back-end server using WS-ReliableMessaging</a></li></ul></li>
+<a href="#Sample101">Sample 101: Reliable message exchange between Synapse and the back-end server using WS-ReliableMessaging 1.0</a></li>
+<li>
+<a href="#Sample101">Sample 102: Reliable message exchange between Synapse and the back-end server using WS-ReliableMessaging 1.1</a></li></ul></li>
<li>
<a href="#ProxyServices">Synapse Proxy service samples</a>
<ul>
@@ -303,17 +307,19 @@
<a name="MediationSamples" id="MediationSamples">Message Mediation Samples</a> </h1>
<div class="section"><h2>
<a name="Sample0" id="Sample0">Sample 0: Introduction to Synapse</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <!-- log all attributes of messages passing through -->
+ <log level="full"/>
+
+ <!-- Send the message to implicit destination -->
+ <send/>
+ </sequence>
- <sequence name="main">
- <!-- log all attributes of messages passing through -->
- <log level="full"/>
-
- <!-- Send the message to implicit destination -->
- <send/>
- <sequence/>
-
-</definitions></pre>
+</definitions></pre>
<p>
<strong>Objective: Introduction to Synapse. Shows how a message could be made to pass through Synapse </strong>
<strong>and logged before it is delivered to its ultimate receiver.</strong> </p>
@@ -340,18 +346,26 @@
<p>You will see the exact same behaviour as per the previous example when you run this scenario. However this time the difference is at the client, as it sends the message to the WS-Addressing 'To' address http://localhost:9000/services/SimpleStockQuoteService, but the transport specifies Synapse as the HTTP proxy. </p>
<div class="section"><h2>
<a name="Sample1" id="Sample1">Sample 1: Simple content based routing (CBR) of messages</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <!-- filtering of messages with XPath and regex matches -->
- <filter source="get-property('To')" regex=".*/StockQuote.*">
- <send>
- <endpoint>
- <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
- </endpoint>
- </send>
- <drop/>
- </filter>
- <send/>
-</definitions> </pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <!-- filtering of messages with XPath and regex matches -->
+ <filter source="get-property('To')" regex=".*/StockQuote.*">
+ <then>
+ <send>
+ <endpoint>
+ <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
+ </endpoint>
+ </send>
+ <drop/>
+ </then>
+ </filter>
+ <send/>
+ </sequence>
+
+</definitions> </pre>
<p>
<strong>Objective: Introduction to simple content based routing. Shows how a message could be made to pass through Synapse using the Dumb Client mode, where Synapse acts as a gateway to accept all messages and then perform mediation and routing based on message properties or content.</strong> </p>
<p>
@@ -371,34 +385,36 @@ mediator forwards the response back to t
<div class="section"><h2>
<a name="Sample2" id="Sample2">Sample 2: CBR with the Switch-case mediator, using message properties</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <switch source="//m0:getQuote/m0:request/m0:symbol" xmlns:m0="http://services.samples">
- <case regex="IBM">
- <!-- the property mediator sets a local property on the *current* message -->
- <property name="symbol" value="Great stock - IBM"/>
- </case>
- <case regex="MSFT">
- <property name="symbol" value="Are you sure? - MSFT"/>
- </case>
- <default>
- <!-- it is possible to assign the result of an XPath expression as well -->
- <property name="symbol"
- expression="fn:concat('Normal Stock - ', //m0:getQuote/m0:request/m0:symbol)"
- xmlns:m0="http://services.samples"/>
- </default>
- </switch>
-
- <log level="custom">
- <!-- the get-property() XPath extension function allows the lookup of local message properties
- as well as properties from the Axis2 or Transport contexts (i.e. transport headers) -->
- <property name="symbol" expression="get-property('symbol')"/>
- <!-- the get-property() function supports the implicit message headers To/From/Action/FaultTo/ReplyTo -->
- <property name="epr" expression="get-property('To')"/>
- </log>
-
- <!-- Send the messages where they are destined to (i.e. the 'To' EPR of the message) -->
- <send/>
-</definitions></pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <switch source="//m0:getQuote/m0:request/m0:symbol" xmlns:m0="http://services.samples">
+ <case regex="IBM">
+ <!-- the property mediator sets a local property on the *current* message -->
+ <property name="symbol" value="Great stock - IBM"/>
+ </case>
+ <case regex="MSFT">
+ <property name="symbol" value="Are you sure? - MSFT"/>
+ </case>
+ <default>
+ <!-- it is possible to assign the result of an XPath expression as well -->
+ <property name="symbol" expression="fn:concat('Normal Stock - ', //m0:getQuote/m0:request/m0:symbol)"/>
+ </default>
+ </switch>
+ <log level="custom">
+ <!-- the get-property() XPath extension function allows the lookup of local message properties
+ as well as properties from the Axis2 or Transport contexts (i.e. transport headers) -->
+ <property name="symbol" expression="get-property('symbol')"/>
+ <!-- the get-property() function supports the implicit message headers To/From/Action/FaultTo/ReplyTo -->
+ <property name="epr" expression="get-property('To')"/>
+ </log>
+ <!-- Send the messages where they are destined to (i.e. the 'To' EPR of the message) -->
+ <send/>
+ </sequence>
+
+</definitions></pre>
<p>
<strong>Objective: Introduce switch-case mediator and writing and reading of local properties set on a message instance</strong> </p>
<p>
@@ -412,38 +428,40 @@ mediator forwards the response back to t
<pre xml:space="preserve"> INFO LogMediator - symbol = Are you sure? - MSFT, epr = http://localhost:9000/axis2/services/SimpleStockQuoteService</pre>
<div class="section"><h2>
<a name="Sample3" id="Sample3">Sample 3: Local Registry entry definitions, reusable endpoints and sequences</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <!-- define a string resource entry to the local registry -->
- <localEntry key="version">0.1</localEntry>
- <!-- define a reuseable endpoint definition -->
- <endpoint name="simple">
- <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
- </endpoint>
-
- <!-- define a reusable sequence -->
- <sequence name="stockquote">
- <!-- log the message using the custom log level. illustrates custom properties for log -->
- <log level="custom">
- <property name="Text" value="Sending quote request"/>
- <property name="version" expression="get-property('version')"/>
- <property name="direction" expression="get-property('direction')"/>
- </log>
- <!-- send message to real endpoint referenced by key "simple" endpoint definition -->
- <send>
- <endpoint key="simple"/>
- </send>
- </sequence>
-
- <sequence name="main">
- <in>
- <property name="direction" value="incoming"/>
- <sequence key="stockquote"/>
- </in>
- <out>
- <send/>
- </out>
- </sequence>
-</definitions></pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+ <!-- define a string resource entry to the local registry -->
+ <localEntry key="version">0.1</localEntry>
+ <!-- define a reuseable endpoint definition -->
+ <endpoint name="simple">
+ <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
+ </endpoint>
+
+ <!-- define a reusable sequence -->
+ <sequence name="stockquote">
+ <!-- log the message using the custom log level. illustrates custom properties for log -->
+ <log level="custom">
+ <property name="Text" value="Sending quote request"/>
+ <property name="version" expression="get-property('version')"/>
+ <property name="direction" expression="get-property('direction')"/>
+ </log>
+ <!-- send message to real endpoint referenced by key "simple" endpoint definition -->
+ <send>
+ <endpoint key="simple"/>
+ </send>
+ </sequence>
+
+ <sequence name="main">
+ <in>
+ <property name="direction" value="incoming"/>
+ <sequence key="stockquote"/>
+ </in>
+ <out>
+ <send/>
+ </out>
+ </sequence>
+</definitions></pre>
<p>
<strong>Objective: Illustrates local registry entry definitions, reusable endpoints and sequences</strong> </p>
<p>
@@ -461,60 +479,62 @@ mediator forwards the response back to t
[HttpServerWorker-1] DEBUG AddressEndpoint - Sending To: http://localhost:9000/services/SimpleStockQuoteService </pre>
<div class="section"><h2>
<a name="Sample4" id="Sample4">Sample 4: Introduction to error handling</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
-
- <!-- the default fault handling sequence used by Synapse - named 'fault' -->
- <sequence name="fault">
- <log level="custom">
- <property name="text" value="An unexpected error occured"/>
- <property name="message" expression="get-property('ERROR_MESSAGE')"/>
- </log>
- <drop/>
- </sequence>
-
- <sequence name="sunErrorHandler">
- <log level="custom">
- <property name="text" value="An unexpected error occured for stock SUN"/>
- <property name="message" expression="get-property('ERROR_MESSAGE')"/>
- </log>
- <drop/>
- </sequence>
-
- <!-- default message handling sequence used by Synapse - named 'main' -->
- <sequence name="main">
- <in>
- <switch source="//m0:getQuote/m0:request/m0:symbol" xmlns:m0="http://services.samples">
- <case regex="IBM">
- <send>
- <endpoint>
- <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
- </endpoint>
- </send>
- </case>
- <case regex="MSFT">
- <send>
- <endpoint key="bogus"/>
- </send>
- </case>
- <case regex="SUN">
- <sequence key="sunSequence"/>
- </case>
- </switch>
- <drop/>
- </in>
-
- <out>
- <send/>
- </out>
- </sequence>
-
- <sequence name="sunSequence" onError="sunErrorHandler">
- <send>
- <endpoint key="sunPort"/>
- </send>
- </sequence>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <!-- the default fault handling sequence used by Synapse - named 'fault' -->
+ <sequence name="fault">
+ <log level="custom">
+ <property name="text" value="An unexpected error occured"/>
+ <property name="message" expression="get-property('ERROR_MESSAGE')"/>
+ </log>
+ <drop/>
+ </sequence>
+
+ <sequence name="sunErrorHandler">
+ <log level="custom">
+ <property name="text" value="An unexpected error occured for stock SUN"/>
+ <property name="message" expression="get-property('ERROR_MESSAGE')"/>
+ <!--<property name="detail" expression="get-property('ERROR_DETAIL')"/>-->
+ </log>
+ <drop/>
+ </sequence>
+
+ <sequence name="main">
+ <in>
+ <switch xmlns:m0="http://services.samples" source="//m0:getQuote/m0:request/m0:symbol">
+ <case regex="IBM">
+ <send>
+ <endpoint>
+ <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
+ </endpoint>
+ </send>
+ </case>
+ <case regex="MSFT">
+ <send>
+ <endpoint key="bogus"/>
+ </send>
+ </case>
+ <case regex="SUN">
+ <sequence key="sunSequence"/>
+ </case>
+ </switch>
+ <drop/>
+ </in>
+
+ <out>
+ <send/>
+ </out>
+ </sequence>
+
+ <sequence name="sunSequence" onError="sunErrorHandler">
+ <send>
+ <endpoint key="sunPort"/>
+ </send>
+ </sequence>
-</definitions> </pre>
+</definitions></pre>
<p>
<strong>Objective: Introduction to error handling with the 'fault' sequence</strong> </p>
<p>
@@ -544,40 +564,45 @@ mediator forwards the response back to t
[HttpServerWorker-1] INFO LogMediator text = An unexpected error occured for stock SUN, message = Couldn't find the endpoint with the key : sunPort</pre>
<div class="section"><h2>
<a name="Sample5" id="Sample5">Sample 5: Creating SOAP fault messages and changing the direction of a message</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="myFaultHandler">
+ <makefault response="true">
+ <code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" value="tns:Receiver"/>
+ <reason expression="get-property('ERROR_MESSAGE')"/>
+ </makefault>
+ <send/>
+ </sequence>
+
+ <sequence name="main" onError="myFaultHandler">
+ <in>
+ <switch xmlns:m0="http://services.samples" source="//m0:getQuote/m0:request/m0:symbol">
+ <case regex="MSFT">
+ <send>
+ <endpoint>
+ <address uri="http://bogus:9000/services/NonExistentStockQuoteService"/>
+ </endpoint>
+ </send>
+ </case>
+ <case regex="SUN">
+ <send>
+ <endpoint>
+ <address uri="http://localhost:9009/services/NonExistentStockQuoteService"/>
+ </endpoint>
+ </send>
+ </case>
+ </switch>
+ <drop/>
+ </in>
+
+ <out>
+ <send/>
+ </out>
+ </sequence>
- <sequence name="myFaultHandler">
- <makefault response="true">
- <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
- <reason expression="get-property('ERROR_MESSAGE')"/>
- </makefault>
- <send/>
- </sequence>
-
- <sequence name="main" onError="myFaultHandler">
- <in>
- <switch source="//m0:getQuote/m0:request/m0:symbol"
- xmlns:m0="http://services.samples/xsd">
- <case regex="MSFT">
- <send>
- <endpoint><address uri="http://bogus:9000/services/NonExistentStockQuoteService"/></endpoint>
- </send>
- </case>
- <case regex="SUN">
- <send>
- <endpoint><address uri="http://localhost:9009/services/NonExistentStockQuoteService"/></endpoint>
- </send>
- </case>
- </switch>
- <drop/>
- </in>
-
- <out>
- <send/>
- </out>
- </sequence>
-
-</definitions></pre>
+</definitions></pre>
<p>
<strong>Objective: Makefault mediator and sending back error responses </strong> </p>
<p>
@@ -596,12 +621,18 @@ mediator forwards the response back to t
<faultstring>java.net.ConnectException: Connection refused</faultstring><detail /></soapenv:Fault></pre>
<div class="section"><h2>
<a name="Sample6" id="Sample6">Sample 6: Manipulating SOAP headers, and filtering incoming and outgoing messages</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <in>
- <header name="To" value="http://localhost:9000/services/SimpleStockQuoteService"/>
- </in>
- <send/>
-</definitions></pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <in>
+ <header name="To" value="http://localhost:9000/services/SimpleStockQuoteService"/>
+ </in>
+ <send/>
+ </sequence>
+
+</definitions></pre>
<p>
<strong>Objective: Introduction to header, in (out) mediators</strong> </p>
<p>
@@ -612,44 +643,47 @@ mediator forwards the response back to t
<pre xml:space="preserve">ant stockquote -Dtrpurl=http://localhost:8280/</pre>
<div class="section"><h2>
<a name="Sample7" id="Sample7">Sample 7: Introduction to local Registry entries and using Schema validation</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <in>
+ <validate>
+ <schema key="validate_schema"/>
+ <on-fail>
+ <!-- if the request does not validate againt schema throw a fault -->
+ <makefault response="true">
+ <code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" value="tns:Receiver"/>
+ <reason value="Invalid custom quote request"/>
+ </makefault>
+ </on-fail>
+ </validate>
+ </in>
+ <send/>
+ </sequence>
+
+ <localEntry key="validate_schema">
+ <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+ xmlns="http://services.samples" elementFormDefault="qualified"
+ attributeFormDefault="unqualified" targetNamespace="http://services.samples">
+ <xs:element name="getQuote">
+ <xs:complexType>
+ <xs:sequence>
+ <xs:element name="request">
+ <xs:complexType>
+ <xs:sequence>
+ <xs:element name="stocksymbol" type="xs:string"/>
+ </xs:sequence>
+ </xs:complexType>
+ </xs:element>
+ </xs:sequence>
+ </xs:complexType>
+ </xs:element>
+ </xs:schema>
+ </localEntry>
- <localEntry key="validate_schema">
- <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
- xmlns="http://services.samples" elementFormDefault="qualified"
- attributeFormDefault="unqualified"
- targetNamespace="http://services.samples">
- <xs:element name="getQuote">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="request">
- <xs:complexType>
- <xs:sequence>
- <xs:element name="stocksymbol" type="xs:string"/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- </xs:schema>
- </localEntry>
-
- <in>
- <validate>
- <schema key="validate_schema"/>
- <on-fail>
- <!-- if the request does not validate againt schema throw a fault -->
- <makefault response="true">
- <code value="tns:Receiver"
- xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
- <reason value="Invalid custom quote request"/>
- </makefault>
- </on-fail>
- </validate>
- </in>
- <send/>
-</definitions> </pre>
+</definitions></pre>
<p>
<strong>Objective: Introduction to local (static) registry entries and the validate mediator</strong> </p>
<p>
@@ -662,30 +696,35 @@ mediator forwards the response back to t
<pre xml:space="preserve">ant stockquote -Daddurl=http://localhost:9000/services/SimpleStockQuoteService -Dtrpurl=http://localhost:8280/</pre>
<div class="section"><h2>
<a name="Sample8" id="Sample8">Sample 8: Introduction to static and dynamic registry resources, and using XSLT transformations</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <!-- the SimpleURLRegistry allows access to a URL based registry (e.g. file:/// or http://) -->
+ <registry provider="org.apache.synapse.registry.url.SimpleURLRegistry">
+ <!-- the root property of the simple URL registry helps resolve a resource URL as root + key -->
+ <parameter name="root">file:repository/conf/sample/resources/</parameter>
+ <!-- all resources loaded from the URL registry would be cached for this number of milli seconds -->
+ <parameter name="cachableDuration">15000</parameter>
+ </registry>
+
+ <!-- define the request processing XSLT resource as a static URL source -->
+ <localEntry key="xslt-key-req" src="file:repository/conf/sample/resources/transform/transform.xslt"/>
+
+ <sequence name="main">
+ <in>
+ <!-- transform the custom quote request into a standard quote requst expected by the service -->
+ <xslt key="xslt-key-req"/>
+ </in>
+ <out>
+ <!-- transform the standard response back into the custom format the client expects -->
+ <!-- the key is looked up in the remote registry and loaded as a 'dynamic' registry resource -->
+ <xslt key="transform/transform_back.xslt"/>
+ </out>
+ <send/>
+ </sequence>
- <!-- the SimpleURLRegistry allows access to a URL based registry (e.g. file:/// or http://) -->
- <registry provider="org.apache.synapse.registry.url.SimpleURLRegistry">
- <!-- the root property of the simple URL registry helps resolve a resource URL as root + key -->
- <parameter name="root">file:./repository/conf/sample/resources/</parameter>
- <!-- all resources loaded from the URL registry would be cached for this number of milli seconds -->
- <parameter name="cachableDuration">15000</parameter>
- </registry>
-
- <!-- define the request processing XSLT resource as a static URL source -->
- <localEntry key="xslt-key-req" src="file:repository/conf/sample/resources/transform/transform.xslt"/>
-
- <in>
- <!-- transform the custom quote request into a standard quote requst expected by the service -->
- <xslt key="xslt-key-req"/>
- </in>
- <out>
- <!-- transform the standard response back into the custom format the client expects -->
- <!-- the key is looked up in the remote registry and loaded as a 'dynamic' registry resource -->
- <xslt key="transform/transform_back.xslt"/>
- </out>
- <send/>
-</definitions></pre>
+</definitions></pre>
<p>
<strong>Objective: Introduction to static and dynamic registry resources and the XSLT mediator</strong> </p>
<p>
@@ -713,16 +752,20 @@ mediator forwards the response back to t
<p>Thus the SimpleURLRegistry allows resource to be cached, and updates detected so that the changes could be reloaded without restarting the Synapse instance. </p>
<div class="section"><h2>
<a name="Sample9" id="Sample9">Sample 9: Introduction to dynamic sequences with the Registry</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <registry provider="org.apache.synapse.registry.url.SimpleURLRegistry">
- <parameter name="root">file:./repository/conf/sample/resources/</parameter>
- <parameter name="cachableDuration">15000</parameter>
- </registry>
-
- <sequence name="main">
- <sequence key="sequence/dynamic_seq_1.xml"/>
- </sequence>
-</definitions> </pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <registry provider="org.apache.synapse.registry.url.SimpleURLRegistry">
+ <parameter name="root">file:./repository/conf/sample/resources/</parameter>
+ <parameter name="cachableDuration">15000</parameter>
+ </registry>
+
+ <sequence name="main">
+ <sequence key="sequence/dynamic_seq_1.xml"/>
+ </sequence>
+
+</definitions></pre>
<p>
<strong>Objective: Introduction to dynamic sequences with a registry</strong> </p>
<p>
@@ -746,22 +789,31 @@ mediator forwards the response back to t
<p>The cache timeout could be tuned appropriately by configuring the URL registry to suit the environment and the needs. </p>
<div class="section"><h2>
<a name="Sample10" id="Sample10">Sample 10: Introduction to dynamic endpoints with the Registry</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <registry provider="org.apache.synapse.registry.url.SimpleURLRegistry">
+ <parameter name="root">file:repository/conf/sample/resources/</parameter>
+ <parameter name="cachableDuration">15000</parameter>
+ </registry>
+
+ <sequence name="foo">
+ <sequence key="xxx"/>
+ </sequence>
+
+ <sequence name="main">
+ <in>
+ <send>
+ <endpoint key="endpoint/dynamic_endpt_1.xml"/>
+ </send>
+ </in>
+ <out>
+ <send/>
+ </out>
+ </sequence>
- <registry provider="org.apache.synapse.registry.url.SimpleURLRegistry">
- <parameter name="root">file:repository/conf/sample/resources/</parameter>
- <parameter name="cachableDuration">15000</parameter>
- </registry>
-
- <in>
- <send>
- <endpoint key="endpoint/dynamic_endpt_1.xml"/>
- </send>
- </in>
- <out>
- <send/>
- </out>
-</definitions> </pre>
+</definitions></pre>
<p>
<strong>Objective: Introduction to dynamic endpoints with the Registry</strong> </p>
<p>
@@ -775,12 +827,16 @@ mediator forwards the response back to t
<p>Now edit the repository/conf/sample/resources/endpoint/dynamic_endpt_1.xml definition and update the address to "http://localhost:9001/services/SimpleStockQuoteService". After the cached value expires, the Registry loads the new definition of the endpoint, and then the messages can be seen being routed to the second sample Axis2 server on HTTP port 9001. </p>
<div class="section"><h2>
<a name="Sample11" id="Sample11">Sample 11: A full registry based configuration, and sharing a configuration between multiple instances</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <registry provider="org.apache.synapse.registry.url.SimpleURLRegistry">
- <parameter name="root">file:./repository/conf/sample/resources/</parameter>
- <parameter name="cachableDuration">15000</parameter>
- </registry>
-</definitions> </pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <registry provider="org.apache.synapse.registry.url.SimpleURLRegistry">
+ <parameter name="root">file:./repository/conf/sample/resources/</parameter>
+ <parameter name="cachableDuration">15000</parameter>
+ </registry>
+
+</definitions></pre>
<p>
<strong>Objective: A full registry based configuration</strong> </p>
<p>
@@ -792,13 +848,19 @@ mediator forwards the response back to t
<pre xml:space="preserve">ant stockquote -Daddurl=http://localhost:9000/services/SimpleStockQuoteService -Dtrpurl=http://localhost:8280/</pre>
<pre xml:space="preserve">[HttpServerWorker-1] INFO LogMediator - message = This is a dynamic Synapse configuration</pre>
<p>The actual synapse.xml loaded is: </p>
-<pre xml:space="preserve"><!-- a registry based Synapse configuration -->
-<definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <log level="custom">
- <property name="message" value="This is a dynamic Synapse configuration $$$"/>
- </log>
- <send/>
-</definitions></pre>
+<pre xml:space="preserve"><!-- a registry based Synapse configuration -->
+<definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <log level="custom">
+ <property name="message" value="This is a dynamic Synapse configuration"/>
+ </log>
+ <send/>
+ </sequence>
+
+</definitions></pre>
<div class="section"><h2>
<a name="Sample12" id="Sample12">Sample 12: One way messaging / fireAndForget through Synapse</a></h2></div>
<p>
@@ -825,22 +887,69 @@ mediator forwards the response back to t
Standard dual channel :: Stock price = $57.16686934968289</pre>
<p>If you send your client request through TCPmon, you will notice that Synapse replies to the client with a HTTP 202 acknowledgment when you send the request and the communication between Synapse and the server happens on a single channel and then you get the response back from Synapse to the clients callback in a different channel (which cannot be observed through TCPmon) </p>
<p>Also you could see the wsa:Reply-To header being something like http://localhost:8200/axis2/services/anonService2 which implies that the reply is being on a different channel listening on the port 8200. Please note that it is required to engage addressing when using the dual channel invocation because it requires the wsa:Reply-To header. </p>
+<div class="section"><h2>
+<a name="Sample14" id="Sample14">Sample 14: Sequences and Endpoints as local registry items</a></h2></div>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <localEntry key="local-enrty-ep-key"
+ src="file:repository/conf/sample/resources/endpoint/dynamic_endpt_1.xml"/>
+
+ <localEntry key="local-enrty-sequence-key">
+ <sequence name="dynamic_sequence">
+ <log level="custom">
+ <property name="message" value="*** Test Message 1 ***"/>
+ </log>
+ </sequence>
+ </localEntry>
+
+ <sequence name="main">
+ <in>
+ <sequence key="local-enrty-sequence-key"/>
+ <send>
+ <endpoint key="local-enrty-ep-key"/>
+ </send>
+ </in>
+ <out>
+ <send/>
+ </out>
+ </sequence>
+
+</definitions></pre>
+<p>
+<strong>Objective: Sequence and Endpoints as local registry entries</strong> </p>
+<p>
+<strong>Prerequisites:</strong>
+<br/> Start the Synapse configuration numbered 14: i.e. synapse -sample 14
+<br/> Start the Axis2 server and deploy the SimpleStockQuoteService if not already done </p>
+<p>This example shows sequences and endpoints fetched from local registry. Thus it is possible to have endpoints sequences as local registry entries including file entries.
+Execute the following command to see the sample working, where you will be able to see the log statement from the fetched sequence from the local entry and the endpoint will be fetched from the specified file at runtime and be cached in the system</p>
+<pre xml:space="preserve">ant stockquote -Dtrpurl=http://localhost:8280/</pre>
<h1>
<a name="Endpoints" id="Endpoints">Advanced mediations with endpoints</a> </h1>
<div class="section"><h2>
<a name="Sample50" id="Sample50">Sample 50: POX to SOAP conversion</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <!-- filtering of messages with XPath and regex matches -->
- <filter source="get-property('To')" regex=".*/StockQuote.*">
- <send>
- <endpoint>
- <address uri="http://localhost:9000/services/SimpleStockQuoteService" format="soap11"/>
- </endpoint>
- </send>
- <drop/>
- </filter>
- <send/>
-</definitions> </pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <!-- filtering of messages with XPath and regex matches -->
+ <filter source="get-property('To')" regex=".*/StockQuote.*">
+ <then>
+ <send>
+ <endpoint>
+ <address uri="http://localhost:9000/services/SimpleStockQuoteService" format="soap11"/>
+ </endpoint>
+ </send>
+ <drop/>
+ </then>
+ </filter>
+ <send/>
+ </sequence>
+
+</definitions></pre>
<p>
<strong>Objective: POX to SOAP conversion</strong> </p>
<p>
@@ -865,35 +974,51 @@ Transfer-Encoding: chunked
</m0:getQuote>0</pre>
<div class="section"><h2>
<a name="Sample51" id="Sample51">Sample 51: MTOM and SwA optimizations and request/response correlation</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <in>
- <filter source="get-property('Action')" regex="urn:uploadFileUsingMTOM">
- <property name="example" value="mtom"/>
- <send>
- <endpoint>
- <address uri="http://localhost:9000/services/MTOMSwASampleService" optimize="mtom"/>
- </endpoint>
- </send>
- </filter>
- <filter source="get-property('Action')" regex="urn:uploadFileUsingSwA">
- <property name="example" value="swa"/>
- <send>
- <endpoint>
- <address uri="http://localhost:9000/services/MTOMSwASampleService" optimize="swa"/>
- </endpoint>
- </send>
- </filter>
- </in>
- <out>
- <filter source="get-property('example')" regex="mtom">
- <property name="enableMTOM" value="true" scope="axis2"/>
- </filter>
- <filter source="get-property('example')" regex="swa">
- <property name="enableSwA" value="true" scope="axis2"/>
- </filter>
- <send/>
- </out>
-</definitions></pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <in>
+ <filter source="get-property('Action')" regex="urn:uploadFileUsingMTOM">
+ <then>
+ <property name="example" value="mtom"/>
+ <send>
+ <endpoint>
+ <address uri="http://localhost:9000/services/MTOMSwASampleService"
+ optimize="mtom"/>
+ </endpoint>
+ </send>
+ </then>
+ </filter>
+ <filter source="get-property('Action')" regex="urn:uploadFileUsingSwA">
+ <then>
+ <property name="example" value="swa"/>
+ <send>
+ <endpoint>
+ <address uri="http://localhost:9000/services/MTOMSwASampleService"
+ optimize="swa"/>
+ </endpoint>
+ </send>
+ </then>
+ </filter>
+ </in>
+ <out>
+ <filter source="get-property('example')" regex="mtom">
+ <then>
+ <property name="enableMTOM" value="true" scope="axis2"/>
+ </then>
+ </filter>
+ <filter source="get-property('example')" regex="swa">
+ <then>
+ <property name="enableSwA" value="true" scope="axis2"/>
+ </then>
+ </filter>
+ <send/>
+ </out>
+ </sequence>
+
+</definitions></pre>
<p>
<strong>Objective: MTOM and SwA optimizations and request/response correlation</strong> </p>
<p>
@@ -973,52 +1098,54 @@ Content-ID:
<urn:uuid:15FD2DA2584A32BF7C1177414169826>22800GIF89a... << binary content >></pre>
<div class="section"><h2>
<a name="Sample52" id="Sample52">Sample 52: Session less load balancing between 3 endpoints</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main" onError="errorHandler">
+ <in>
+ <send>
+ <endpoint>
+ <loadbalance>
+ <endpoint>
+ <address uri="http://localhost:9001/services/LBService1">
+ <enableAddressing/>
+ <suspendDurationOnFailure>60</suspendDurationOnFailure>
+ </address>
+ </endpoint>
+ <endpoint>
+ <address uri="http://localhost:9002/services/LBService1">
+ <enableAddressing/>
+ <suspendDurationOnFailure>60</suspendDurationOnFailure>
+ </address>
+ </endpoint>
+ <endpoint>
+ <address uri="http://localhost:9003/services/LBService1">
+ <enableAddressing/>
+ <suspendDurationOnFailure>60</suspendDurationOnFailure>
+ </address>
+ </endpoint>
+ </loadbalance>
+ </endpoint>
+ </send>
+ <drop/>
+ </in>
+
+ <out>
+ <!-- Send the messages where they have been sent (i.e. implicit To EPR) -->
+ <send/>
+ </out>
+ </sequence>
+
+ <sequence name="errorHandler">
+ <makefault response="true">
+ <code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" value="tns:Receiver"/>
+ <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
+ </makefault>
+ <send/>
+ </sequence>
- <sequence name="main" onError="errorHandler">
- <in>
- <send>
- <endpoint>
- <loadbalance>
- <endpoint>
- <address uri="http://localhost:9001/services/LBService1">
- <enableAddressing/>
- <suspendDurationOnFailure>60</suspendDurationOnFailure>
- </address>
- </endpoint>
- <endpoint>
- <address uri="http://localhost:9002/services/LBService1">
- <enableAddressing/>
- <suspendDurationOnFailure>60</suspendDurationOnFailure>
- </address>
- </endpoint>
- <endpoint>
- <address uri="http://localhost:9003/services/LBService1">
- <enableAddressing/>
- <suspendDurationOnFailure>60</suspendDurationOnFailure>
- </address>
- </endpoint>
- </loadbalance>
- </endpoint>
- </send>
- <drop/>
- </in>
-
- <out>
- <!-- Send the messages where they have been sent (i.e. implicit To EPR) -->
- <send/>
- </out>
- </sequence>
-
- <sequence name="errorHandler">
- <makefault response="true">
- <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
- <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
- </makefault>
- <send/>
- </sequence>
-
-</definitions></pre>
+</definitions></pre>
<p>
<strong>Objective: Demonstrate the simple load balancing among a set of endpoints</strong> </p>
<p>
@@ -1054,52 +1181,54 @@ Content-ID:
<p>Now restart MyServer1. You can observe that requests will be again sent to all three servers roughly after 60 seconds. This is because we have specified <suspendDurationOnFailure> as 60 seconds in the configuration. Therefore, load balance endpoint will suspend any failed child endpoint only for 60 seconds after detecting the failure. </p>
<div class="section"><h2>
<a name="Sample53" id="Sample53">Sample 53: Failover sending among 3 endpoints</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
-
- <sequence name="main" onError="errorHandler">
- <in>
- <send>
- <endpoint>
- <failover>
- <endpoint>
- <address uri="http://localhost:9001/services/LBService1">
- <enableAddressing/>
- <suspendDurationOnFailure>60</suspendDurationOnFailure>
- </address>
- </endpoint>
- <endpoint>
- <address uri="http://localhost:9002/services/LBService1">
- <enableAddressing/>
- <suspendDurationOnFailure>60</suspendDurationOnFailure>
- </address>
- </endpoint>
- <endpoint>
- <address uri="http://localhost:9003/services/LBService1">
- <enableAddressing/>
- <suspendDurationOnFailure>60</suspendDurationOnFailure>
- </address>
- </endpoint>
- </failover>
- </endpoint>
- </send>
- <drop/>
- </in>
-
- <out>
- <!-- Send the messages where they have been sent (i.e. implicit To EPR) -->
- <send/>
- </out>
- </sequence>
-
- <sequence name="errorHandler">
- <makefault response="true">
- <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
- <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
- </makefault>
- <send/>
- </sequence>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main" onError="errorHandler">
+ <in>
+ <send>
+ <endpoint>
+ <failover>
+ <endpoint>
+ <address uri="http://localhost:9001/services/LBService1">
+ <enableAddressing/>
+ <suspendDurationOnFailure>60</suspendDurationOnFailure>
+ </address>
+ </endpoint>
+ <endpoint>
+ <address uri="http://localhost:9002/services/LBService1">
+ <enableAddressing/>
+ <suspendDurationOnFailure>60</suspendDurationOnFailure>
+ </address>
+ </endpoint>
+ <endpoint>
+ <address uri="http://localhost:9003/services/LBService1">
+ <enableAddressing/>
+ <suspendDurationOnFailure>60</suspendDurationOnFailure>
+ </address>
+ </endpoint>
+ </failover>
+ </endpoint>
+ </send>
+ <drop/>
+ </in>
+
+ <out>
+ <!-- Send the messages where they have been sent (i.e. implicit To EPR) -->
+ <send/>
+ </out>
+ </sequence>
+
+ <sequence name="errorHandler">
+ <makefault response="true">
+ <code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" value="tns:Receiver"/>
+ <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
+ </makefault>
+ <send/>
+ </sequence>
-</definitions></pre>
+</definitions></pre>
<p>
<strong>Objective: Demonstrate the failover sending</strong> </p>
<p>
@@ -1123,54 +1252,55 @@ Content-ID:
<p>Once a server is detected as failed, it will be added to the active servers list again after 60 seconds (specified in <suspendDurationOnFailure> in the configuration). Therefore, if you have restarted any of the stopped servers and have shutdown all other servers, messages will be directed to the newly started server. </p>
<div class="section"><h2>
<a name="Sample54" id="Sample54">Sample 54: Session affinity load balancing between 3 endpoints</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
-
- <sequence name="main" onError="errorHandler">
- <in>
- <send>
- <endpoint>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main" onError="errorHandler">
+ <in>
+ <send>
+ <endpoint>
<!-- specify the session as the simple client session provided by Synapse for
- testing purpose -->
-
- <strong><session type="simpleClientSession"/></strong>
-
- <loadbalance>
- <endpoint>
- <address uri="http://localhost:9001/services/LBService1">
- <enableAddressing/>
- </address>
- </endpoint>
- <endpoint>
- <address uri="http://localhost:9002/services/LBService1">
- <enableAddressing/>
- </address>
- </endpoint>
- <endpoint>
- <address uri="http://localhost:9003/services/LBService1">
- <enableAddressing/>
- </address>
- </endpoint>
- </loadbalance>
- </endpoint>
- </send>
- <drop/>
- </in>
-
- <out>
- <!-- Send the messages where they have been sent (i.e. implicit To EPR) -->
- <send/>
- </out>
- </sequence>
-
- <sequence name="errorHandler">
- <makefault response="true">
- <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
- <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
- </makefault>
- <send/>
- </sequence>
+ testing purpose -->
+ <session type="simpleClientSession"/>
+
+ <loadbalance>
+ <endpoint>
+ <address uri="http://localhost:9001/services/LBService1">
+ <enableAddressing/>
+ </address>
+ </endpoint>
+ <endpoint>
+ <address uri="http://localhost:9002/services/LBService1">
+ <enableAddressing/>
+ </address>
+ </endpoint>
+ <endpoint>
+ <address uri="http://localhost:9003/services/LBService1">
+ <enableAddressing/>
+ </address>
+ </endpoint>
+ </loadbalance>
+ </endpoint>
+ </send>
+ <drop/>
+ </in>
+
+ <out>
+ <!-- Send the messages where they have been sent (i.e. implicit To EPR) -->
+ <send/>
+ </out>
+ </sequence>
+
+ <sequence name="errorHandler">
+ <makefault response="true">
+ <code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" value="tns:Receiver"/>
+ <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
+ </makefault>
+ <send/>
+ </sequence>
-</definitions></pre>
+</definitions></pre>
<p>
<strong>Objective: Demonstrate the loadbalancing with session affinity using client initiated sessions</strong> </p>
<p>
@@ -1195,67 +1325,68 @@ Content-ID:
<p>You can see that session number 0 is always directed to the server named MyServer1. That means session number 0 is bound to MyServer1. Similarly session 1 and 2 are bound to MyServer3 and MyServer2 respectively. </p>
<div class="section"><h2>
<a name="Sample55" id="Sample55">Sample 55: Session affinity load balancing between fail over endpoints</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
-
- <sequence name="main" onError="errorHandler">
- <in>
- <send>
- <endpoint>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main" onError="errorHandler">
+ <in>
+ <send>
+ <endpoint>
<!-- specify the session as the simple client session provided by Synapse for
- testing purpose -->
-
- <strong><session type="simpleClientSession"/></strong>
-
- <loadbalance>
- <endpoint>
- <failover>
- <endpoint>
- <address uri="http://localhost:9001/services/LBService1">
- <enableAddressing/>
- </address>
- </endpoint>
- <endpoint>
- <address uri="http://localhost:9002/services/LBService1">
- <enableAddressing/>
- </address>
- </endpoint>
- </failover>
- </endpoint>
- <endpoint>
- <failover>
- <endpoint>
- <address uri="http://localhost:9003/services/LBService1">
- <enableAddressing/>
- </address>
- </endpoint>
- <endpoint>
- <address uri="http://localhost:9004/services/LBService1">
- <enableAddressing/>
- </address>
- </endpoint>
- </failover>
- </endpoint>
- </loadbalance>
- </endpoint>
- </send>
- <drop/>
- </in>
-
- <out>
- <!-- Send the messages where they have been sent (i.e. implicit To EPR) -->
- <send/>
- </out>
- </sequence>
-
- <sequence name="errorHandler">
- <makefault response="true">
- <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
- <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
- </makefault>
- <send/>
- </sequence>
+ testing purpose -->
+ <session type="simpleClientSession"/>
+
+ <loadbalance>
+ <endpoint>
+ <failover>
+ <endpoint>
+ <address uri="http://localhost:9001/services/LBService1">
+ <enableAddressing/>
+ </address>
+ </endpoint>
+ <endpoint>
+ <address uri="http://localhost:9002/services/LBService1">
+ <enableAddressing/>
+ </address>
+ </endpoint>
+ </failover>
+ </endpoint>
+ <endpoint>
+ <failover>
+ <endpoint>
+ <address uri="http://localhost:9003/services/LBService1">
+ <enableAddressing/>
+ </address>
+ </endpoint>
+ <endpoint>
+ <address uri="http://localhost:9004/services/LBService1">
+ <enableAddressing/>
+ </address>
+ </endpoint>
+ </failover>
+ </endpoint>
+ </loadbalance>
+ </endpoint>
+ </send>
+ <drop/>
+ </in>
+
+ <out>
+ <!-- Send the messages where they have been sent (i.e. implicit To EPR) -->
+ <send/>
+ </out>
+ </sequence>
+
+ <sequence name="errorHandler">
+ <makefault response="true">
+ <code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" value="tns:Receiver"/>
+ <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
+ </makefault>
+ <send/>
+ </sequence>
-</definitions></pre>
+</definitions></pre>
<p>
<strong>Objective: Demonstrate the session affinity based load balancing with failover capability</strong> </p>
<p>
@@ -1293,26 +1424,28 @@ Content-ID:
...</pre>
<div class="section"><h2>
<a name="Sample56" id="Sample56">Sample 56: WSDL endpoint</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
-
- <sequence name="main">
- <in>
- <send>
- <!-- get epr from the given wsdl -->
- <endpoint>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <in>
+ <send>
+ <!-- get epr from the given wsdl -->
+ <endpoint>
<wsdl uri="file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl"
service="SimpleStockQuoteService"
- port="SimpleStockQuoteServiceHttpSoap11Endpoint"/>
- </endpoint>
- </send>
- </in>
-
- <out>
- <send/>
- </out>
- </sequence>
+ port="SimpleStockQuoteServiceHttpSoap11Endpoint"/>
+ </endpoint>
+ </send>
+ </in>
+
+ <out>
+ <send/>
+ </out>
+ </sequence>
-</definitions></pre>
+</definitions></pre>
<p>
<strong>Objective: Demonstrate the use of WSDL endpoints</strong> </p>
<p>
@@ -1334,40 +1467,41 @@ Content-ID:
<p>Client will print the quote price for IBM received from the server running on port 9000. Observe the Axis2 console and the Synapse console to verify this behavior. </p>
<div class="section"><h2>
<a name="Sample57" id="Sample57">Sample 57: Dynamic load balancing between 3 nodes</a></h2></div>
-<pre xml:space="preserve">
-<definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
-
- <sequence name="main" onError="errorHandler">
- <in>
- <send>
- <endpoint name="dynamicLB">
- <dynamicLoadbalance failover="true"
- algorithm="org.apache.synapse.endpoints.algorithms.RoundRobin">
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main" onError="errorHandler">
+ <in>
+ <send>
+ <endpoint name="dynamicLB">
+ <dynamicLoadbalance failover="true"
+ algorithm="org.apache.synapse.endpoints.algorithms.RoundRobin">
<membershipHandler
- class="org.apache.synapse.core.axis2.Axis2LoadBalanceMembershipHandler">
- <property name="applicationDomain" value="apache.axis2.app.domain"/>
- </membershipHandler>
- </dynamicLoadbalance>
- </endpoint>
- </send>
- <drop/>
- </in>
-
- <out>
- <send/>
- </out>
- </sequence>
-
- <sequence name="errorHandler">
- <makefault response="true">
- <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
- <eason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
- </makefault>
- <send/>
- </sequence>
+ class="org.apache.synapse.core.axis2.Axis2LoadBalanceMembershipHandler">
+ <property name="applicationDomain" value="apache.axis2.app.domain"/>
+ </membershipHandler>
+ </dynamicLoadbalance>
+ </endpoint>
+ </send>
+ <drop/>
+ </in>
+
+ <out>
+ <!-- Send the messages where they have been sent (i.e. implicit To EPR) -->
+ <send/>
+ </out>
+ </sequence>
+
+ <sequence name="errorHandler">
+ <makefault response="true">
+ <code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" value="tns:Receiver"/>
+ <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
+ </makefault>
+ <send/>
+ </sequence>
-</definitions>
-</pre>
+</definitions></pre>
<p>
<strong>Objective: Demonstrate the simple dynamic load balancing among a set of nodes</strong> </p>
<p>
@@ -1404,38 +1538,39 @@ Content-ID:
<p>Now restart MyServer1. You can observe that requests will be again sent to all three servers. </p>
<div class="section"><h2>
<a name="Sample58" id="Sample58">Sample 58: Static load balancing between 3 nodes</a></h2></div>
-<pre xml:space="preserve">
-<definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
-
- <sequence name="main" onError="errorHandler">
- <in>
- <send>
- <endpoint>
- <loadbalance failover="true">
- <member hostName="127.0.0.1" httpPort="9001" httpsPort="9005"/>
- <member hostName="127.0.0.1" httpPort="9002" httpsPort="9006"/>
- <member hostName="127.0.0.1" httpPort="9003" httpsPort="9007"/>
- </loadbalance>
- </endpoint>
- </send>
- <drop/>
- </in>
-
- <out>
- <send/>
- </out>
- </sequence>
-
- <sequence name="errorHandler">
- <makefault response="true">
- <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
- <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
- </makefault>
- <send/>
- </sequence>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main" onError="errorHandler">
+ <in>
+ <send>
+ <endpoint>
+ <loadbalance failover="true">
+ <member hostName="127.0.0.1" httpPort="9001" httpsPort="9005"/>
+ <member hostName="127.0.0.1" httpPort="9002" httpsPort="9006"/>
+ <member hostName="127.0.0.1" httpPort="9003" httpsPort="9007"/>
+ </loadbalance>
+ </endpoint>
+ </send>
+ <drop/>
+ </in>
+
+ <out>
+ <!-- Send the messages where they have been sent (i.e. implicit To EPR) -->
+ <send/>
+ </out>
+ </sequence>
+
+ <sequence name="errorHandler">
+ <makefault response="true">
+ <code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" value="tns:Receiver"/>
+ <reason value="COULDN'T SEND THE MESSAGE TO THE SERVER."/>
+ </makefault>
+ <send/>
+ </sequence>
-</definitions>
-</pre>
+</definitions></pre>
<p>
<strong>Objective: Demonstrate the simple static load balancing among a set of nodes</strong> </p>
<p>
@@ -1473,24 +1608,28 @@ Content-ID:
<a name="MessageMediationQoS" id="MessageMediationQoS">Quality of Service addition or deduction samples in message mediation</a> </h1>
<div class="section"><h2>
<a name="Sample100" id="Sample100">Sample 100: Using WS-Security for outgoing messages</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <localEntry key="sec_policy" src="file:repository/conf/sample/resources/policy/policy_3.xml"/>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <localEntry key="sec_policy" src="file:repository/conf/sample/resources/policy/policy_3.xml"/>
+
+ <sequence name="main">
+ <in>
+ <send>
+ <endpoint name="secure">
+ <address uri="http://localhost:9000/services/SecureStockQuoteService">
+ <enableSec policy="sec_policy"/>
+ </address>
+ </endpoint>
+ </send>
+ </in>
+ <out>
+ <send/>
+ </out>
+ </sequence>
- <in>
- <send>
- <endpoint name="secure">
- <address uri="http://localhost:9000/services/SecureStockQuoteService">
- <enableSec policy="sec_policy"/>
- </address>
- </endpoint>
- </send>
- </in>
- <out>
- <header name="wsse:Security" action="remove"
- xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"/>
- <send/>
- </out>
-</definitions></pre>
+</definitions></pre>
<p>
<strong>Objective: Connecting to endpoints with WS-Security for outgoing messages</strong> </p>
<p>
@@ -1549,29 +1688,29 @@ User-Agent: Synapse-HttpComponents-NIO
<div class="section"><h2>
<a name="Sample101" id="Sample101">Sample 101: Reliable message exchange between Synapse and the back-end server using WS-ReliableMessaging</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
-
- <in>
- <RMSequence single="true" version="1.0"/>
- <send>
- <endpoint name="reliable">
- <address uri="http://localhost:9000/services/ReliableStockQuoteService">
- <enableRM/>
- <enableAddressing/>
- </address>
- </endpoint>
- </send>
- </in>
- <out>
- <header name="wsrm:SequenceAcknowledgement" action="remove"
- xmlns:wsrm="http://schemas.xmlsoap.org/ws/2005/02/rm"/>
- <header name="wsrm:Sequence" action="remove"
- xmlns:wsrm="http://schemas.xmlsoap.org/ws/2005/02/rm"/>
- <send/>
- </out>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <in>
+ <RMSequence single="true" version="1.0"/>
+ <send>
+ <endpoint name="reliable">
+ <address uri="http://localhost:9000/services/ReliableStockQuoteService">
+ <enableRM/>
+ <enableAddressing/>
+ </address>
+ </endpoint>
+ </send>
+ </in>
+ <out>
+ <send/>
+ </out>
+ </sequence>
-</definitions></pre>
-<strong>Objective: Demonstrate the message exchange between Synapse and the server using WS-ReliableMessaging (WS-RM)</strong>
+</definitions></pre>
+<strong>Objective: Demonstrate the message exchange between Synapse and the server using WS-ReliableMessaging (WS-RM) - 1.0</strong>
<p>
<strong>Prerequisites:</strong>
<br/>Deploy the ReliableStockQuoteService in the sample Axis2 server by switching to the samples/axis2Server/src/ReliableStockQuoteService directory and running the command 'ant'.
@@ -1689,24 +1828,54 @@ User-Agent: Synapse-HttpComponents-NIO
</soapenv:Body>
</soapenv:Envelope></pre>
<p>Note that although each of above messages are separate SOAP messages, in most cases they will be exchanged in a single socket connection as HTTP Keep-Alive header is used. </p>
+<div class="section"><h2>
+<a name="Sample102" id="Sample102">Sample 102: Reliable message exchange between Synapse and the back-end server using WS-ReliableMessaging</a></h2></div>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <sequence name="main">
+ <in>
+ <RMSequence single="true" version="1.1"/>
+ <send>
+ <endpoint name="reliable">
+ <address uri="http://localhost:9000/services/ReliableStockQuoteService">
+ <enableRM/>
+ <enableAddressing/>
+ </address>
+ </endpoint>
+ </send>
+ </in>
+ <out>
+ <send/>
+ </out>
+ </sequence>
+
+</definitions></pre>
+<strong>Objective: Demonstrate the message exchange between Synapse and the server using WS-ReliableMessaging (WS-RM) - 1.1</strong>
+<p>This sample is as same as the previous one except it uses WS-RM 1.1 version where as the previous sample is using the RM version 1.0</p>
<h1>
<a name="ProxyServices" id="ProxyServices">Synapse Proxy service samples</a> </h1>
<div class="section"><h2>
<a name="Sample150" id="Sample150">Sample 150: Introduction to proxy services</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <proxy name="StockQuoteProxy">
- <target>
- <endpoint>
- <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
- </endpoint>
- <outSequence>
- <send/>
- </outSequence>
- </target>
- <publishWSDL uri="file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl"/>
- </proxy>
-</definitions></pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <proxy name="StockQuoteProxy">
+ <target>
+ <endpoint>
+ <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
+ </endpoint>
+ <outSequence>
+ <send/>
+ </outSequence>
+ </target>
+ <publishWSDL uri="file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl"/>
+ </proxy>
+
+</definitions></pre>
<p>
<strong>Objective: Introduction to Synapse proxy services</strong> </p>
<p>
@@ -1719,31 +1888,41 @@ User-Agent: Synapse-HttpComponents-NIO
<p>An 'inSequence' or 'endpoint' or both of these would decide how the message would be handled after the proxy service receives the message. In the above example, the request received is forwarded to the sample service hosted on Axis2. The 'outSequence' defines how the response is handled before it is sent back to the client. By default, a proxy service is exposed over all transports configured for Synapse, unless these are specifically mentioned through the 'transports' attribute. </p>
<div class="section"><h2>
<a name="Sample151" id="Sample151">Sample 151: Custom sequences and endpoints with proxy services</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <localEntry key="proxy_wsdl"
+ src="file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl"/>
+
+ <endpoint name="proxy_2_endpoint">
+ <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
+ </endpoint>
+
+ <sequence name="proxy_1">
+ <send>
+ <endpoint>
+ <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
+ </endpoint>
+ </send>
+ </sequence>
+
+ <sequence name="out">
+ <send/>
+ </sequence>
+
+ <proxy name="StockQuoteProxy1">
+ <target inSequence="proxy_1" outSequence="out"/>
+ < publishWSDL key="proxy_wsdl"/>
+ <
+ /proxy>
+
+ < proxy name="StockQuoteProxy2">
+ <target endpoint="proxy_2_endpoint" outSequence="out"/>
+ <publishWSDL key="proxy_wsdl"/>
+ </proxy>
- <sequence name="proxy_1">
- <send>
- <endpoint><address uri="http://localhost:9000/services/SimpleStockQuoteService"/></endpoint>
- </send>
- </sequence>
- <sequence name="out">
- <send/>
- </sequence>
- <endpoint name="proxy_2_endpoint">
- <address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
- </endpoint>
- <localEntry key="proxy_wsdl" src="file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl"/>
-
- <proxy name="StockQuoteProxy1">
- <publishWSDL key="proxy_wsdl"/>
- <target inSequence="proxy_1" outSequence="out"/>
- </proxy>
-
- <proxy name="StockQuoteProxy2">
- <publishWSDL key="proxy_wsdl"/>
- <target endpoint="proxy_2_endpoint" outSequence="out"/>
- </proxy>
-</definitions></pre>
+</definitions></pre>
<p>
<strong>Objective: Using custom sequences and endpoints for message mediation with proxy services</strong> </p>
<p>
@@ -1757,19 +1936,23 @@ User-Agent: Synapse-HttpComponents-NIO
<br/>ant stockquote -Daddurl=http://localhost:8280/services/StockQuoteProxy2</pre>
<div class="section"><h2>
<a name="Sample152" id="Sample152">Sample 152: Switching transports and message format from SOAP to REST/POX</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <proxy name="StockQuoteProxy" transports="https">
- <target>
- <endpoint>
- <address uri="http://localhost:9000/services/SimpleStockQuoteService" format="pox"/>
- </endpoint>
- <outSequence>
- <send/>
- </outSequence>
- </target>
- <publishWSDL uri="file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl"/>
- </proxy>
-</definitions></pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://ws.apache.org/ns/synapse http://synapse.apache.org/ns/2010/04/configuration/synapse_config.xsd">
+
+ <proxy name="StockQuoteProxy" transports="https">
+ <target>
+ <endpoint>
+ <address uri="http://localhost:9000/services/SimpleStockQuoteService" format="pox"/>
+ </endpoint>
+ <outSequence>
+ <send/>
+ </outSequence>
+ </target>
+ <publishWSDL uri="file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl"/>
+ </proxy>
+
+</definitions></pre>
<p>
<strong>Objective: Switching transports and message format from SOAP to REST/POX</strong> </p>
<p>
@@ -1825,24 +2008,28 @@ Connection: Keep-Alive
<div class="section"><h2>
<a name="Sample153" id="Sample153">Sample 153: Routing the messages arrived to a proxy service without processing the security headers</a></h2></div>
-<pre xml:space="preserve"><definitions xmlns="http://synapse.apache.org/ns/2010/04/configuraiton">
- <proxy name="StockQuoteProxy">
- <target>
- <inSequence>
- <property name="preserveProcessedHeaders" value="true"/>
- <send>
- <endpoint>
- <address uri="http://localhost:9000/services/SecureStockQuoteService"/>
- </endpoint>
- </send>
- </inSequence>
- <outSequence>
- <send/>
- </outSequence>
- </target>
- <publishWSDL uri="file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl"/>
- </proxy>
-</definitions></pre>
+<pre xml:space="preserve"><definitions xmlns="http://ws.apache.org/ns/synapse"
[... 4262 lines stripped ...]