You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@synapse.apache.org by as...@apache.org on 2006/07/18 14:05:12 UTC
svn commit: r423060 -
/incubator/synapse/trunk/java/xdocs/Synapse_Configuration_Language.html
Author: asankha
Date: Tue Jul 18 05:05:12 2006
New Revision: 423060
URL: http://svn.apache.org/viewvc?rev=423060&view=rev
Log:
fix formatting
Modified:
incubator/synapse/trunk/java/xdocs/Synapse_Configuration_Language.html
Modified: incubator/synapse/trunk/java/xdocs/Synapse_Configuration_Language.html
URL: http://svn.apache.org/viewvc/incubator/synapse/trunk/java/xdocs/Synapse_Configuration_Language.html?rev=423060&r1=423059&r2=423060&view=diff
==============================================================================
--- incubator/synapse/trunk/java/xdocs/Synapse_Configuration_Language.html (original)
+++ incubator/synapse/trunk/java/xdocs/Synapse_Configuration_Language.html Tue Jul 18 05:05:12 2006
@@ -6,8 +6,7 @@
<title>Synapse Configuration Language</title>
</head>
<body>
-<h1>Synapse Configuration Language<br>
-</h1>
+<h1>Synapse Configuration Language</h1>
<p>The Synapse configuration language is designed to support a
processing model where messages come into Synapse, are processed via
some number of mediators and then delivered to an endpoint somewhere.
@@ -17,7 +16,18 @@
for details). </p>
<h2>Overall Structure</h2>
<p>A Synapse configuration looks like the following at the top level: </p>
-<pre> <synapse><br> <definitions><br> (sequencedef | endpointdef | literalpropertydef | extensiondef)+<br> <definitions>?<br> <proxies><br> proxyservice+<br> </proxies>?<br> <rules><br> mediator+<br> </rules><br> </synapse><br>
+<pre> <synapse>
+ <definitions>
+ (sequencedef | endpointdef | literalpropertydef | extensiondef)+
+ <definitions>?
+ <proxies>
+ proxyservice+
+ </proxies>?
+ <rules>
+ mediator+
+ </rules>
+ </synapse>
+
</pre>
<h3>Definitions</h3>
<p>The <definitions> section defines reusable elements that can
@@ -32,7 +42,14 @@
switching etc. </p>
<p>A proxyservice token represents a <proxy> element which is
used to define a Synapse Proxy service. </p>
-<pre> <proxy name="string" [description="string"] [transports="(http|https|jms)+|all"]><br> <target sequence="name" | endpoint="name"/>? // default is main sequence<br> <wsdl url="url">?<br> <schema url="url">*<br> <policy url="url">*<br> <property name="string" value="string"/>*<br> </proxy><br>
+<pre> <proxy name="string" [description="string"] [transports="(http|https|jms)+|all"]>
+ <target sequence="name" | endpoint="name"/>? // default is main sequence
+ <wsdl url="url">?
+ <schema url="url">*
+ <policy url="url">*
+ <property name="string" value="string"/>*
+ </proxy>
+
</pre>
<p>A proxy service is created and exposed on the specified transports
through the underlying Axis2 instance, exposing service EPR's as per
@@ -50,14 +67,33 @@
<p>A sequencedef token represents a <sequence> element which is
used to define a named sequence of mediators that can be invoked later
by name as a sequence of mediators. </p>
-<pre> <sequence name="string"><br> mediator+<br> </sequence><br>
+<pre> <sequence name="string">
+ mediator+
+ </sequence>
+
</pre>
<h4>Endpoints</h4>
<p>An endpointdef token represents an <endpoint> element which is
used to give a logical name to an endpoint address. If the address is
not just a simple URL, then extensibility elements may be used to
indicate the address (i.e. to compute the address at runtime). </p>
-<pre> <endpoint name="string" [address="url"]><br><br> .. extensibility ..<br><br> <parameter name="OutflowSecurity"><br> ...<br> </parameter><br><br> <wsp:Policy xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"..<br> xmlns:wsrm="http://ws.apache.org/sandesha2/policy" wsu:Id="RMPolicy"><br> ...<br> </Policy><br><br> .. extensibility ..<br><br> </endpoint><br>
+<pre> <endpoint name="string" [address="url"]>
+
+ .. extensibility ..
+
+ <parameter name="OutflowSecurity">
+ ...
+ </parameter>
+
+ <wsp:Policy xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"..
+ xmlns:wsrm="http://ws.apache.org/sandesha2/policy" wsu:Id="RMPolicy">
+ ...
+ </Policy>
+
+ .. extensibility ..
+
+ </endpoint>
+
</pre>
<p>An Axis2 Parameter element within an endpoint definition with the
name " OutflowSecurity"
@@ -93,7 +129,8 @@
<h4>Properties</h4>
<p>The token literalpropertydef refers to a <set-property>
element as follows: </p>
-<pre> <set-property name="string" value="string"/><br>
+<pre> <set-property name="string" value="string"/>
+
</pre>
<p>which is used to set a global property with a constant value. </p>
<p>These properties are top level properties which are set globally for
@@ -101,7 +138,8 @@
extension XPath function called "synapse:get-property(prop-name)". </p>
<h3>Mediators</h3>
<p>A mediator token refers to any of the following tokens: </p>
-<pre>send | drop | log | makefault | transform | header | filter | switch | class | validate | setproperty | sequenceref | in | out <br>
+<pre>send | drop | log | makefault | transform | header | filter |
+ switch | class | validate | setproperty | sequenceref | in | out
</pre>
<p>In addition to the above, Synapse will be able to load mediators via
the J2SE Service Provider model. Mediator extensions must implement the
@@ -121,27 +159,43 @@
<p>In the simplest case, the place to send the message to is implicit
in the message (via a property of the message itself)- that is
indicated by the following: </p>
-<pre> <send/><br>
+<pre> <send/>
+
</pre>
<p>If the message is to be sent to one or more endpoints, then the
following is used: </p>
-<pre> <send><br> (endpointref | endpoint)+<br> </send><br>
+<pre> <send>
+ (endpointref | endpoint)+
+ </send>
+
</pre>
<p>where the endpointref token refers to the following: </p>
-<pre> <endpoint ref="name"/><br>
+<pre> <endpoint ref="name"/>
+
</pre>
<p>and the endpoint token refers to an anonymous endpoint defined
inline: </p>
-<pre> <endpoint address="url"/><br>
+<pre> <endpoint address="url"/>
+
</pre>
<p>If the message is to be sent to an endpoint selected by load
balancing across a set of endpoints, then it is indicated by the
following: </p>
-<pre> <send><br> <load-balance algorithm="uri"><br> (endpointref | endpoint)+<br> </load-balance><br> </send><br>
+<pre> <send>
+ <load-balance algorithm="uri">
+ (endpointref | endpoint)+
+ </load-balance>
+ </send>
+
</pre>
<p>Similarly, if the message is to be sent to an endpoint with failover
semantics, then it is indicated by the following: </p>
-<pre> <send><br> <failover><br> (endpointref | endpoint)+<br> </failover><br> </send><br>
+<pre> <send>
+ <failover>
+ (endpointref | endpoint)+
+ </failover>
+ </send>
+
</pre>
<p>Once the <send> mediator executes, further processing of the
current message stops. </p>
@@ -150,14 +204,18 @@
<h4>Drop</h4>
<p>The drop token refers to a <drop> element which is used to
drop a message: </p>
-<pre> <drop/><br>
+<pre> <drop/>
+
</pre>
<p>Once the <drop> mediator executes, further processing of the
current message stops. </p>
<h4>Log</h4>
<p>The log token refers to a <log> element which may be used to
log messages being mediated: </p>
-<pre> <log [level="string"] [seperator="string"]><br> <property name="string" (value="literal" | expression="xpath")/>*<br> </log><br>
+<pre> <log [level="string"] [seperator="string"]>
+ <property name="string" (value="literal" | expression="xpath")/>*
+ </log>
+
</pre>
<p>The optional level attribute selects a pre-defined subset of
properties to be logged. e.g. simple = To, From, WSAction, SOAPAction,
@@ -175,7 +233,14 @@
logged. The default seperator is the ',' comma. </p>
<h4>Transforms</h4>
<h5>Faults</h5>
-<pre> <makefault [version="soap11|soap12"]><br> <code (value="literal" | expression="xpath")/><br> <reason (value="literal" | expression="xpath")><br> <node>?<br> <role>?<br> <detail>?<br> </makefault><br>
+<pre> <makefault [version="soap11|soap12"]>
+ <code (value="literal" | expression="xpath")/>
+ <reason (value="literal" | expression="xpath")>
+ <node>?
+ <role>?
+ <detail>?
+ </makefault>
+
</pre>
<p>The <makefault> mediator transforms the current message into a
fault message, but does NOT send it. The <send> mediator needs to
@@ -184,7 +249,10 @@
header existed on the original message, else it is set it to the
"replyTo" of the original message. </p>
<h5>XSLT/XQuery</h5>
-<pre> <transform xslt|xquery="url" [source="xpath"]><br> <property name="string" (value="literal" | expression="xpath")/>*<br> </transform><br>
+<pre> <transform xslt|xquery="url" [source="xpath"]>
+ <property name="string" (value="literal" | expression="xpath")/>*
+ </transform>
+
</pre>
<p>The <transform> mediator applies the specified XSLT or XQuery
transformation to the given element. If the source element is not
@@ -193,7 +261,9 @@
through the <property> elements. </p>
<p>Note: Synapse does not currently support XQuery transformations </p>
<h5>Headers</h5>
-<pre> <header name="qname" (value="literal" | expression="xpath") [action="set"]/><br> <header name="qname" action="remove"/><br>
+<pre> <header name="qname" (value="literal" | expression="xpath") [action="set"]/>
+ <header name="qname" action="remove"/>
+
</pre>
<p>The <header> mediator sets or removes a specified header from
the current soap message. Currently the set header only supports simple
@@ -203,7 +273,10 @@
remove the header. If omitted, it defaults to a set-header. </p>
<h4>Selection</h4>
<h5>Filters</h5>
-<pre> <filter (source="xpath" regex="string") | xpath="xpath"><br> mediator+<br> </filter><br>
+<pre> <filter (source="xpath" regex="string") | xpath="xpath">
+ mediator+
+ </filter>
+
</pre>
<p>The <filter> mediator either test the given xpath expression
as a boolean expression, or match the evaluation result of a source
@@ -211,14 +284,27 @@
succeeds, the filter mediator will execute the enclosed mediators in
sequence. </p>
<h5>Switch</h5>
-<pre> <switch source="xpath"><br> <case regex="string"><br> mediator+<br> </case>+<br> <default><br> mediator+<br> </default>?<br> </switch><br>
+<pre> <switch source="xpath">
+ <case regex="string">
+ mediator+
+ </case>+
+ <default>
+ mediator+
+ </default>?
+ </switch>
+
</pre>
<p>The <switch> mediator will evaluate the given source xpath
expression into its string value, and match it against the given
regular expressions. If the specified cases does not match and a
default case exists, it will be executed. </p>
<h4>Validation</h4>
-<pre> <validate schema="url" [source="xpath"]><br> <on-fail><br> mediator+<br> </on-fail><br> </validate><br>
+<pre> <validate schema="url" [source="xpath"]>
+ <on-fail>
+ mediator+
+ </on-fail>
+ </validate>
+
</pre>
<p>The <validate> mediator validates the result of the evaluation
of the source xpath expression, against the schema specified. If the
@@ -229,7 +315,8 @@
2.8.0 parser, it is bundled with the Synapse extensions, so that the
Synapse core will remain simple and lightweight. </p>
<h4>Properties</h4>
-<pre> <set-property name="string" (value="literal" | expression="xpath")/><br>
+<pre> <set-property name="string" (value="literal" | expression="xpath")/>
+
</pre>
<p>The setproperty token refers to a <set-property> element which
is a mediator that has no direct impact on the message but rather on
@@ -238,7 +325,10 @@
later retrieved through the synapse:get-property(prop-name) extension
function. </p>
<h4>Class Mediators</h4>
-<pre> <class name="class-name"><br> <property name="string" (value="literal" | expression="xpath")/>*<br> </class> <br>
+<pre> <class name="class-name">
+ <property name="string" (value="literal" | expression="xpath")/>*
+ </class>
+
</pre>
<p>The class mediator creates an instance of the specified class and
sets it as a mediator. The class must implement the
@@ -246,7 +336,8 @@
specified, the corresponding setter methods are invoked on the class.
However, Synapse will only support String properties. </p>
<h4>Reusing Sequences</h4>
-<pre> <sequence ref="name"/><br>
+<pre> <sequence ref="name"/>
+
</pre>
<p>A sequenceref token refers to a <sequence> element which is
used to invoke a named sequence of mediators. </p>
@@ -259,7 +350,8 @@
Spring ApplicationContext (BeanFactory).
This could be referred subsequently by Spring mediator instances which
will use this context. </p>
-<pre> <spring:config name="string" src="file"/><br>
+<pre> <spring:config name="string" src="file"/>
+
</pre>
<p>The name attribute specifies a unique name for the configuration,
and the src attribute specifies the Spring configuration file. </p>
@@ -268,7 +360,8 @@
src="file:///wiki/modern/img/moin-www.png" alt="[WWW]" height="11"
width="11"> http://ws.apache.org/ns/synapse/spring</a> namespace. </p>
<h4>Spring mediator</h4>
-<pre> <spring:spring bean="exampleBean1" (config="spring1" | src="spring.xml)"/><br>
+<pre> <spring:spring bean="exampleBean1" (config="spring1" | src="spring.xml)"/>
+
</pre>
<p>The <spring> element creates an instance of a mediator, which
is managed by Spring. This Spring bean must implement the Mediator
@@ -297,154 +390,335 @@
category and attempt to use the Gold endpoint, failing which the Silver
endpoint is tried. For requests that does not fall into the Gold
category the default silver endpoint is used always. </p>
-<pre> <synapse><br> <definitions><br> <sequence name="registration_flow"><br> <validate schema="http://registry/xsd/registration.xsd" source="//regRequest"><br> <on-fail><br> <set-property name="error-code" value="100"/><br> <set-property name="error-reason" value="validation failed"/><br> <sequence ref="fault_flow"/><br> </on-fail><br> </validate> <br> <filter xpath="/regRequest[@Category='GOLD']"><br> <send><br> <failover><br> <endpoint ref="gold_registration"/><br> <endpoint ref="silver_registration"/><br> </failover><br> </send><br> <filter> <br> <send><br> <endpoint ref="silver_registration"/><br> </send><br> <sequence><br> <br>
- <sequence name="fault_flow"><br> <log level="simple"><br> <property name="application" value="synapse:get-property('reg-app')"/><br> </log><br> <makefault version="soap11"><br> <code value="synapse:get-property('error-code')"/><br> <reason expression="synapse:get-property('error-reason')"><br> <makefault><br> <send/><br> <sequence><br> <br>
- <endpoint name="gold_registration" address="http://gold/registration"/><br> <endpoint name="silver_registration" address="http://silver/registration"/><br> <br>
- <set-property name="reg_app" value="Registration Application"/> <br> </definitions><br> <br>
- <rules><br> <switch source="synapse:get-property('to')"><br> <case regex="/registration"><br> <sequence ref="registration_flow"/><br> </case><br> <case regex="someother"><br> ...<br> </case><br> <default><br> <drop/><br> </default><br> </rules><br> <br>
- </synapse>
-<br></pre>
+<pre> <synapse>
+ <definitions>
+ <sequence name="registration_flow">
+ <validate schema="http://registry/xsd/registration.xsd" source="//regRequest">
+ <on-fail>
+ <set-property name="error-code" value="100"/>
+ <set-property name="error-reason" value="validation failed"/>
+ <sequence ref="fault_flow"/>
+ </on-fail>
+ </validate>
+ <filter xpath="/regRequest[@Category='GOLD']">
+ <send>
+ <failover>
+ <endpoint ref="gold_registration"/>
+ <endpoint ref="silver_registration"/>
+ </failover>
+ </send>
+ <filter>
+ <send>
+ <endpoint ref="silver_registration"/>
+ </send>
+ <sequence>
+
+ <sequence name="fault_flow">
+ <log level="simple">
+ <property name="application" value="synapse:get-property('reg-app')"/>
+ </log>
+ <makefault version="soap11">
+ <code value="synapse:get-property('error-code')"/>
+ <reason expression="synapse:get-property('error-reason')">
+ <makefault>
+ <send/>
+ <sequence>
+
+ <endpoint name="gold_registration" address="http://gold/registration"/>
+ <endpoint name="silver_registration" address="http://silver/registration"/>
+
+ <set-property name="reg_app" value="Registration Application"/>
+ </definitions>
+
+ <rules>
+ <switch source="synapse:get-property('to')">
+ <case regex="/registration">
+ <sequence ref="registration_flow"/>
+ </case>
+ <case regex="someother">
+ ...
+ </case>
+ <default>
+ <drop/>
+ </default>
+ <switch>
+ </rules>
+
+</synapse>
+
+</pre>
<h3>Example 0. </h3>
-<pre><br><synapse xmlns="http://ws.apache.org/ns/synapse"><br> <br> <definitions><br> <br> <sequence name="stockquote"><br> <!-- set the To address to the real endpoint --><br> <header name="To" value="http://ws.invesbot.com/stockquotes.asmx"/><br> <br> <!-- check if the symbol is MSFT --><br> <filter xpath="//*[wsx:symbol='MSFT']" xmlns:wsx="http://ws.invesbot.com/"><br> <!-- if it is throw a fault --><br> <makefault><br> <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/><br> <reason value="Isn't there a Windows API for that?"/><br> </makefault><br> </filter><br> </sequence><br><br> </definitions><br><br> <rules><br> <!-- now log the message using log4j --><br> <log level="full"/><br> <br> <!-- Check if the URL matches the stockquote gateway/dumb case --><
br> <filter source="get-property('To')" regex=".*/StockQuote.*"><br> <sequence ref="stockquote"/><br> </filter><br> <br> <!-- check if the URL matches the virtual url - either the proxy or ws-add case --><br> <filter source="get-property('To')" regex="http://.*stockquotes.*"><br> <sequence ref="stockquote"/><br> </filter><br> <br> <!-- send the message on --><br> <send/><br> </rules><br><br></synapse> <br>
+<pre><synapse xmlns="http://ws.apache.org/ns/synapse">
+
+ <definitions>
+
+ <sequence name="stockquote">
+ <!-- set the To address to the real endpoint -->
+ <header name="To" value="http://ws.invesbot.com/stockquotes.asmx"/>
+
+ <!-- check if the symbol is MSFT -->
+ <filter xpath="//*[wsx:symbol='MSFT']" xmlns:wsx="http://ws.invesbot.com/">
+ <!-- if it is throw a fault -->
+ <makefault>
+ <code value="tns:Receiver"
+ xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
+ <reason value="Isn't there a Windows API for that?"/>
+ </makefault>
+ </filter>
+ </sequence>
+
+ </definitions>
+
+ <rules>
+ <!-- now log the message using log4j -->
+ <log level="full"/>
+
+ <!-- Check if the URL matches the stockquote gateway/dumb case -->
+ <filter source="get-property('To')" regex=".*/StockQuote.*">
+ <sequence ref="stockquote"/>
+ </filter>
+
+ <!-- check if the URL matches the virtual url - either the proxy or ws-add case -->
+ <filter source="get-property('To')" regex="http://.*stockquotes.*">
+ <sequence ref="stockquote"/>
+ </filter>
+
+ <!-- send the message on -->
+ <send/>
+ </rules>
+
+</synapse>
+
</pre>
<p>The above configuration is available with the Synapse distribution
and illustrates the usual Stock quote examples. The client code for
these are available with the Synapse samples, and the README.txt of the
samples defines these in detail. </p>
<h3>Example 1. </h3>
-<synapse xmlns="http://ws.apache.org/ns/synapse"><br>
- <br>
- <definitions><br>
-<br>
- <sequence name="customrequest"><br>
- <!-- set the To address to the
-real endpoint --><br>
- <header name="To"
-value="http://ws.invesbot.com/stockquotes.asmx"/><br>
- <br>
- <!-- set correlation field to
-custom label --><br>
- <set-property
-name="correlate/label" value="customquote"/><br>
- <br>
- <!-- transform the custom
-quote into a standard quote requst --><br>
- <transform
-xslt="file:synapse_repository/conf/sample/transform.xslt"/><br>
- <br>
- <!-- send message to real
-endpoint and stop --><br>
- <send/><br>
- </sequence><br>
-<br>
- <sequence
-name="customresponse"><br>
- <!-- transform the custom
-quote into a standard quote requst --><br>
- <transform
-xslt="file:synapse_repository/conf/sample/transform_back.xslt"/><br>
- <br>
- <!-- now send the custom
-response back to the client and stop --><br>
- <send/>
- <br>
- </sequence><br>
- <br>
- <sequence name="stockquote"><br>
- <!-- set the To address to the
-real endpoint --><br>
- <header name="To"
-value="http://ws.invesbot.com/stockquotes.asmx"/><br>
- <br>
- <!-- check if the symbol is
-MSFT --><br>
- <filter
-xpath="//*[wsx:symbol='MSFT']"
-xmlns:wsx="http://www.webserviceX.NET/"><br>
- <!-- if it is
-throw a fault --><br>
- <makefault><br>
-
- <code value="tns:Receiver"
-xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/><br>
-
- <reason value="Isn't there a Windows API for that?"/><br>
- </makefault><br>
- </filter><br>
- <br>
- <send/><br>
- </sequence><br>
- <br>
- <sequence name="standardrequest"><br>
- <!-- now log the
-message using log4j --><br>
- <log level="full"/><br>
- <br>
- <!-- Check if the URL
-matches the stockquote gateway/dumb case --><br>
- <filter
-source="get-property('To')" regex=".*/StockQuote.*"><br>
-
- <sequence ref="stockquote"/><br>
- </filter><br>
- <br>
- <!-- check if the URL
-matches the virtual url - either the proxy or ws-add case --><br>
- <filter
-source="get-property('To')" regex="http://stockquote.*"><br>
-
- <sequence ref="stockquote"/><br>
- </filter><br>
-
- <br>
- <!-- send the message
-on --><br>
- <send/><br>
- </sequence><br>
-<br>
- </definitions><br>
-<br>
- <rules><br>
- <in><br>
- <!-- is this a custom
-stock quote message? --><br>
- <filter
-xpath="//m0:CheckPriceRequest"
-xmlns:m0="http://www.apache-synapse.org/test"><br>
-
- <sequence ref="customrequest"/><br>
- </filter><br>
- <br>
- <!-- else, proceed as
-usual with the standard processing rules --><br>
- <sequence
-ref="standardrequest"/><br>
- </in><br>
- <br>
- <out><br>
- <!-- is this a custom
-stock quote reply? --><br>
- <filter
-source="get-property('correlate/label')" regex="customquote"><br>
-
- <sequence ref="customresponse"/><br>
- </filter><br>
-<br>
- <!-- just
-let the message flow through --><br>
- <send/><br>
- </out>
- <br>
- </rules><br>
-<br>
-</synapse> <br>
+<pre><synapse xmlns="http://ws.apache.org/ns/synapse">
+
+ <definitions>
+
+ <sequence name="customrequest">
+ <!-- set the To address to the real endpoint -->
+ <header name="To" value="http://ws.invesbot.com/stockquotes.asmx"/>
+
+ <!-- set correlation field to custom label -->
+ <set-property name="correlate/label" value="customquote"/>
+
+ <!-- transform the custom quote into a standard quote requst -->
+ <transform xslt="file:synapse_repository/conf/sample/transform.xslt"/>
+
+ <!-- send message to real endpoint and stop -->
+ <send/>
+ </sequence>
+
+ <sequence name="customresponse">
+ <!-- transform the custom quote into a standard quote requst -->
+ <transform xslt="file:synapse_repository/conf/sample/transform_back.xslt"/>
+
+ <!-- now send the custom response back to the client and stop -->
+ <send/>
+ </sequence>
+
+ <sequence name="stockquote">
+ <!-- set the To address to the real endpoint -->
+ <header name="To" value="http://ws.invesbot.com/stockquotes.asmx"/>
+
+ <!-- check if the symbol is MSFT -->
+ <filter xpath="//*[wsx:symbol='MSFT']" xmlns:wsx="http://www.webserviceX.NET/">
+ <!-- if it is throw a fault -->
+ <makefault>
+ <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
+ <reason value="Isn't there a Windows API for that?"/>
+ </makefault>
+ </filter>
+
+ <send/>
+ </sequence>
+
+ <sequence name="standardrequest">
+ <!-- now log the message using log4j -->
+ <log level="full"/>
+
+ <!-- Check if the URL matches the stockquote gateway/dumb case -->
+ <filter source="get-property('To')" regex=".*/StockQuote.*">
+ <sequence ref="stockquote"/>
+ </filter>
+
+ <!-- check if the URL matches the virtual url -
+ either the proxy or ws-add case -->
+ <filter source="get-property('To')" regex="http://stockquote.*">
+ <sequence ref="stockquote"/>
+ </filter>
+
+ <!-- send the message on -->
+ <send/>
+ </sequence>
+
+ </definitions>
+
+ <rules>
+ <in>
+ <!-- is this a custom stock quote message? -->
+ <filter xpath="//m0:CheckPriceRequest"
+ xmlns:m0="http://www.apache-synapse.org/test">
+ <sequence ref="customrequest"/>
+ </filter>
+
+ <!-- else, proceed as usual with the standard processing rules -->
+ <sequence ref="standardrequest"/>
+ </in>
+
+ <out>
+ <!-- is this a custom stock quote reply? -->
+ <filter source="get-property('correlate/label')" regex="customquote">
+ <sequence ref="customresponse"/>
+ </filter>
+
+ <!-- just let the message flow through -->
+ <send/>
+ </out>
+ </rules>
+
+</synapse>
+</pre>
<p>This example illustrates the correlation of incoming and outgoing
messages and the use of the <in> and <out> mediators that
simplify the mediation configuration. This example also shows how an
XSLT transformation of a message may be performed on receipt or reply,
and also how a SOAP fault message may be created when required. </p>
<h3>Example 2. </h3>
-<pre><synapse xmlns="http://ws.apache.org/ns/synapse"><br> <br> <definitions><br> <br> <!-- define global properties --><br> <set-property name="version" value="0.1"/><br> <br> <!-- define a reuseable endpoint definition and use it within config --><br> <endpoint name="invesbot" address="http://ws.invesbot.com/stockquotes.asmx"/><br><br> <sequence name="customrequest"><br> <!-- is this a valid custom request ? --><br> <validate schema="file:synapse_repository/conf/sample/validate.xsd"><br> <on-fail><br> <!-- if the request does not validate againt schema throw a fault --><br> <makefault><br> <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/><br> <reason value="Invalid custom quote request"/><br> </makefault><br> <br> <!-- send the fault and stop processing --><br> <
;send/><br> </on-fail><br> </validate><br><br> <switch source="//m0:CheckPriceRequest/m0:Code" xmlns:m0="http://www.apache-synapse.org/test"><br> <case regex="IBM"><br> <set-property name="symbol" value="Great stock - IBM"/><br> </case><br> <case regex="MSFT"><br> <set-property name="symbol" value="Are you sure? - MSFT"/><br> </case><br> <default><br> <set-property name="symbol" expression="fn:concat('Normal Stock - ', //m0:CheckPriceRequest/m0:Code)" xmlns:m0="http://www.apache-synapse.org/test"/><br> </default><br> </switch><br> <br> <!-- set a dynamic (local) message property --><br> <br> <br> <!-- set correlation field to custom label --><br> <set-property name="correlate/label" value="customquote"/><br> <br> <!-- transform the custom quote into a standard quote requst --><br>
<transform xslt="file:synapse_repository/conf/sample/transform.xslt"/><br> <br> <log level="custom"><br> <property name="Text" value="Sending quote request"/><br> <property name="version" expression="get-property('version')"/><br> <property name="symbol" expression="get-property('symbol')"/><br> </log><br> <br> <!-- send message to real endpoint referenced by name "invesbot" and stop --><br> <send><br> <endpoint ref="invesbot"/><br> </send><br> </sequence><br><br> <sequence name="customresponse"><br> <!-- transform the custom quote into a standard quote requst --><br> <transform xslt="file:synapse_repository/conf/sample/transform_back.xslt"/><br> <br> <!-- now send the custom response back to the client and stop --><br> <send/> <br> </sequence><br> <br> <sequence name="stockquote">
<br> <!-- set the To address to the real endpoint --><br> <header name="To" value="http://ws.invesbot.com/stockquotes.asmx"/><br> <br> <!-- check if the symbol is MSFT --><br> <filter xpath="//*[wsx:symbol='MSFT']" xmlns:wsx="http://www.webserviceX.NET/"><br> <!-- if it is throw a fault --><br> <makefault><br> <code value="tns:Receiver" xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/><br> <reason value="Isn't there a Windows API for that?"/><br> </makefault><br> </filter><br> <br> <send/><br> </sequence><br> <br> <sequence name="standardrequest"><br> <!-- now log the message using log4j --><br> <log level="full"/><br> <br> <!-- Check if the URL matches the stockquote gateway/dumb case --><br> <filter source="get-property('To')" regex=".*/StockQuote.*"><br> <sequence ref="st
ockquote"/><br> </filter><br> <br> <!-- check if the URL matches the virtual url - either the proxy or ws-add case --><br> <filter source="get-property('To')" regex="http://stockquote.*"><br> <sequence ref="stockquote"/><br> </filter><br> <br> <!-- send the message on --><br> <send/><br> </sequence><br><br> </definitions><br><br> <rules><br> <in><br> <!-- is this a custom stock quote message? --><br> <filter xpath="//m0:CheckPriceRequest" xmlns:m0="http://www.apache-synapse.org/test"><br> <sequence ref="customrequest"/><br> </filter><br> <br> <!-- else, proceed as usual with the standard processing rules --><br> <sequence ref="standardrequest"/><br> </in><br> <br> <out><br> <!-- is this a custom stock quote reply? --><br> <filter source="get-property('correlate/label')" regex="custom
quote"><br> <sequence ref="customresponse"/><br> </filter><br><br> <!-- just let the message flow through --><br> <send/><br> </out> <br> </rules><br><br></synapse> <br>
+<pre><synapse xmlns="http://ws.apache.org/ns/synapse">
+
+ <definitions>
+
+ <!-- define global properties -->
+ <set-property name="version" value="0.1"/>
+
+ <!-- define a reuseable endpoint definition and use it within config -->
+ <endpoint name="invesbot" address="http://ws.invesbot.com/stockquotes.asmx"/>
+
+ <sequence name="customrequest">
+ <!-- is this a valid custom request ? -->
+ <validate schema="file:synapse_repository/conf/sample/validate.xsd">
+ <on-fail>
+ <!-- if the request does not validate againt schema throw a fault -->
+ <makefault>
+ <code value="tns:Receiver"
+ xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
+ <reason value="Invalid custom quote request"/>
+ </makefault>
+
+ <!-- send the fault and stop processing -->
+ <send/>
+ </on-fail>
+ </validate>
+
+ <switch source="//m0:CheckPriceRequest/m0:Code"
+ xmlns:m0="http://www.apache-synapse.org/test">
+ <case regex="IBM">
+ <set-property name="symbol" value="Great stock - IBM"/>
+ </case>
+ <case regex="MSFT">
+ <set-property name="symbol" value="Are you sure? - MSFT"/>
+ </case>
+ <default>
+ <set-property name="symbol"
+ expression="fn:concat('Normal Stock - ', //m0:CheckPriceRequest/m0:Code)"
+ xmlns:m0="http://www.apache-synapse.org/test"/>
+ </default>
+ </switch>
+
+ <!-- set a dynamic (local) message property -->
+
+
+ <!-- set correlation field to custom label -->
+ <set-property name="correlate/label" value="customquote"/>
+
+ <!-- transform the custom quote into a standard quote requst -->
+ <transform xslt="file:synapse_repository/conf/sample/transform.xslt"/>
+
+ <log level="custom">
+ <property name="Text" value="Sending quote request"/>
+ <property name="version" expression="get-property('version')"/>
+ <property name="symbol" expression="get-property('symbol')"/>
+ </log>
+
+ <!-- send message to real endpoint referenced by name "invesbot" and stop -->
+ <send>
+ <endpoint ref="invesbot"/>
+ </send>
+ </sequence>
+
+ <sequence name="customresponse">
+ <!-- transform the custom quote into a standard quote requst -->
+ <transform xslt="file:synapse_repository/conf/sample/transform_back.xslt"/>
+
+ <!-- now send the custom response back to the client and stop -->
+ <send/>
+ </sequence>
+
+ <sequence name="stockquote">
+ <!-- set the To address to the real endpoint -->
+ <header name="To" value="http://ws.invesbot.com/stockquotes.asmx"/>
+
+ <!-- check if the symbol is MSFT -->
+ <filter xpath="//*[wsx:symbol='MSFT']" xmlns:wsx="http://www.webserviceX.NET/">
+ <!-- if it is throw a fault -->
+ <makefault>
+ <code value="tns:Receiver"
+ xmlns:tns="http://www.w3.org/2003/05/soap-envelope"/>
+ <reason value="Isn't there a Windows API for that?"/>
+ </makefault>
+ </filter>
+
+ <send/>
+ </sequence>
+
+ <sequence name="standardrequest">
+ <!-- now log the message using log4j -->
+ <log level="full"/>
+
+ <!-- Check if the URL matches the stockquote gateway/dumb case -->
+ <filter source="get-property('To')" regex=".*/StockQuote.*">
+ <sequence ref="stockquote"/>
+ </filter>
+
+ <!-- check if the URL matches the virtual url - either the proxy or ws-add case -->
+ <filter source="get-property('To')" regex="http://stockquote.*">
+ <sequence ref="stockquote"/>
+ </filter>
+
+ <!-- send the message on -->
+ <send/>
+ </sequence>
+
+ </definitions>
+
+ <rules>
+ <in>
+ <!-- is this a custom stock quote message? -->
+ <filter xpath="//m0:CheckPriceRequest" xmlns:m0="http://www.apache-synapse.org/test">
+ <sequence ref="customrequest"/>
+ </filter>
+
+ <!-- else, proceed as usual with the standard processing rules -->
+ <sequence ref="standardrequest"/>
+ </in>
+
+ <out>
+ <!-- is this a custom stock quote reply? -->
+ <filter source="get-property('correlate/label')" regex="customquote">
+ <sequence ref="customresponse"/>
+ </filter>
+
+ <!-- just let the message flow through -->
+ <send/>
+ </out>
+ </rules>
+
+</synapse>
</pre>
<p>This example adds onto the example 2 shown above and shows how the
validate mediator could be used to perform message validation. This
@@ -458,9 +732,18 @@
this excersice as the validation mediator extension is dependent on the
Xerces parser. </p>
<h3>Example 3. </h3>
-<pre><synapse xmlns="http://ws.apache.org/ns/synapse" xmlns:spring="http://ws.apache.org/ns/synapse/spring">
- <definitions><br> <spring:config name="springconfig" src="./../../repository/conf/sample/springsample.xml"/><br> </definitions><br>
- <rules><br> <spring:spring bean="springtest" config="springconfig"/><br> <spring:spring bean="springtest" src="./../../repository/conf/sample/springsample.xml"/><br> </rules><br></synapse><br>
+<pre><synapse xmlns="http://ws.apache.org/ns/synapse"
+ xmlns:spring="http://ws.apache.org/ns/synapse/spring">
+ <definitions>
+ <spring:config name="springconfig" src="./../../repository/conf/sample/springsample.xml"/>
+ </definitions>
+
+ <rules>
+ <spring:spring bean="springtest" config="springconfig"/>
+ <spring:spring bean="springtest" src="./../../repository/conf/sample/springsample.xml"/>
+ </rules>
+</synapse>
+
</pre>
</body>
</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: synapse-dev-help@ws.apache.org