Author: saminda
Date: Sat Dec 31 03:24:45 2005
New Revision: 360269
URL: http://svn.apache.org/viewcvs?rev=360269&view=rev
Log:
Added EnvironmentAware testing test case.
Updated SynapseMessageReciever.
Added userguide.html.
Added:
incubator/synapse/trunk/java/test/org/apache/axis2/META-INF/environmentaware-service.xml
incubator/synapse/trunk/java/test/org/apache/axis2/test/EnvironmentAwareMediator.java
incubator/synapse/trunk/java/test/org/apache/synapse/environment/
incubator/synapse/trunk/java/test/org/apache/synapse/environment/EnvironmentAwareTest.java
incubator/synapse/trunk/java/test/rules/synapse-environmentaware.xml
incubator/synapse/trunk/java/xdocs/userguide.html
Modified:
incubator/synapse/trunk/java/maven.xml
incubator/synapse/trunk/java/src/org/apache/synapse/axis2/SynapseMessageReceiver.java
Modified: incubator/synapse/trunk/java/maven.xml
URL:
http://svn.apache.org/viewcvs/incubator/synapse/trunk/java/maven.xml?rev=360269&r1=360268&r2=360269&view=diff
==============================================================================
--- incubator/synapse/trunk/java/maven.xml (original)
+++ incubator/synapse/trunk/java/maven.xml Sat Dec 31 03:24:45 2005
@@ -84,6 +84,18 @@
<include name="**"/>
</jar>
+ <echo message="----------------Creating EnvironmentAware-Mediator
aar----------------"/>
+ <mkdir dir="target/services/environmentaware-mediator/META-INF"/>
+ <mkdir
dir="target/services/environmentaware-mediator/org/apache/axis2/test"/>
+ <copy
file="test/org/apache/axis2/META-INF/environmentaware-service.xml"
+
tofile="target/services/environmentaware-mediator/META-INF/services.xml"/>
+ <copy
file="target/test-classes/org/apache/axis2/test/EnvironmentAwareMediator.class"
+
tofile="target/services/environmentaware-mediator/org/apache/axis2/test/EnvironmentAwareMediator.class"/>
+ <jar jarfile="target/environmentaware-mediator.aar"
+ basedir="target/services/environmentaware-mediator">
+ <include name="**"/>
+ </jar>
+
<echo message="-----------Creating Testing Repository - SendOn
----------"/>
<mkdir dir="target/synapse-repository-sendon"/>
<copy file="target/synapse.aar"
@@ -108,14 +120,31 @@
<copy file="target/test-mediator.aar"
tofile="target/synapse-repository-sendonAxis2/services/test-mediator.aar"/>
+
<copy file="synapse-test-resources/axis2/modules/addressing.mar"
tofile="target/synapse-repository-sendonAxis2/modules/addressing.mar"/>
<copy file="repository/axis2.xml"
tofile="target/synapse-repository-sendonAxis2/axis2.xml"/>
+ <echo message="-----------Creating Testing Repository -
EnvironmentAware ----------"/>
+ <mkdir dir="target/synapse-repository-environmentaware"/>
+
+ <copy file="target/environmentaware-mediator.aar"
+
tofile="target/synapse-repository-environmentaware/services/environmentaware-mediator.aar"/>
+ <copy file="target/synapse.aar"
+
tofile="target/synapse-repository-environmentaware/services/synapse.aar"/>
+ <copy file="synapse-test-resources/axis2/modules/addressing.mar"
+
tofile="target/synapse-repository-environmentaware/modules/addressing.mar"/>
+ <copy file="synapse-test-resources/axis2/axis2.xml"
+
tofile="target/synapse-repository-environmentaware/axis2.xml"/>
+ <copy file="test/rules/synapse-environmentaware.xml"
+
tofile="target/synapse-repository-environmentaware/synapse.xml"/>
+
<ant:delete file="target/npe.aar"/>
<ant:delete file="target/test-mediator.aar"/>
<ant:delete dir="target/test-mediator"/>
+ <ant:delete dir="target/environmentaware-mediator"/>
+ <ant:delete dir="target/environmentaware-mediator.aar"/>
</j:if>
@@ -214,7 +243,8 @@
<ant:include name="samples/**"/>
</ant:fileset>
</ant:copy>
- <ant:copy
todir="${samples.dir}/samples/deprecation_mediator/deprecation_mediator/src">
+ <ant:copy
+
todir="${samples.dir}/samples/deprecation_mediator/deprecation_mediator/src">
<ant:fileset dir="src">
<ant:include name="samples/**"/>
<ant:include name="sampleMediators/**"/>
Modified:
incubator/synapse/trunk/java/src/org/apache/synapse/axis2/SynapseMessageReceiver.java
URL:
http://svn.apache.org/viewcvs/incubator/synapse/trunk/java/src/org/apache/synapse/axis2/SynapseMessageReceiver.java?rev=360269&r1=360268&r2=360269&view=diff
==============================================================================
---
incubator/synapse/trunk/java/src/org/apache/synapse/axis2/SynapseMessageReceiver.java
(original)
+++
incubator/synapse/trunk/java/src/org/apache/synapse/axis2/SynapseMessageReceiver.java
Sat Dec 31 03:24:45 2005
@@ -39,6 +39,14 @@
log.debug("receiving message");
SynapseEnvironment env = Axis2SynapseEnvironmentFinder
.getSynapseEnvironment(mc);
+
////////////////////////////////////////////////////////////////////////
+ // SynapseEnvironment is set as a property in MessageContext. This is
due
+ // use we can expect in ServiceMeidatorProcessor and many extensions
yet to come
+ // So it a mediator uses EnvironmentAware, that mediator will be
injected with the correct environment
+ mc.setProperty(
+ org.apache.synapse.Constants.MEDIATOR_SYNAPSE_ENV_PROPERTY,
+ env);
+
////////////////////////////////////////////////////////////////////////
SynapseMessage smc = new Axis2SynapseMessage(mc);
env.injectMessage(smc);
Added:
incubator/synapse/trunk/java/test/org/apache/axis2/META-INF/environmentaware-service.xml
URL:
http://svn.apache.org/viewcvs/incubator/synapse/trunk/java/test/org/apache/axis2/META-INF/environmentaware-service.xml?rev=360269&view=auto
==============================================================================
---
incubator/synapse/trunk/java/test/org/apache/axis2/META-INF/environmentaware-service.xml
(added)
+++
incubator/synapse/trunk/java/test/org/apache/axis2/META-INF/environmentaware-service.xml
Sat Dec 31 03:24:45 2005
@@ -0,0 +1,11 @@
+<service name="environmentaware-mediator">
+ <description>
+ EnvironmentAware-Mediator
+ </description>
+ <parameter name="ServiceClass" locked="false">
+ org.apache.axis2.test.EnvironmentAwareMediator</parameter>
+ <operation name="mediate">
+ <messageReceiver
+
class="org.apache.synapse.axis2.ServiceMediatorMessageReceiver"/>
+ </operation>
+</service>
\ No newline at end of file
Added:
incubator/synapse/trunk/java/test/org/apache/axis2/test/EnvironmentAwareMediator.java
URL:
http://svn.apache.org/viewcvs/incubator/synapse/trunk/java/test/org/apache/axis2/test/EnvironmentAwareMediator.java?rev=360269&view=auto
==============================================================================
---
incubator/synapse/trunk/java/test/org/apache/axis2/test/EnvironmentAwareMediator.java
(added)
+++
incubator/synapse/trunk/java/test/org/apache/axis2/test/EnvironmentAwareMediator.java
Sat Dec 31 03:24:45 2005
@@ -0,0 +1,55 @@
+package org.apache.axis2.test;
+
+import org.apache.synapse.api.Mediator;
+import org.apache.synapse.api.EnvironmentAware;
+import org.apache.synapse.SynapseMessage;
+import org.apache.synapse.SynapseEnvironment;
+import org.apache.synapse.SynapseException;
+/*
+* Copyright 2004,2005 The Apache Software Foundation.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+public class EnvironmentAwareMediator implements Mediator, EnvironmentAware {
+ private SynapseEnvironment se;
+ private ClassLoader cl;
+ public boolean mediate(SynapseMessage smc) {
+ getSynapseEnvironment();
+ getClassLoader();
+ return true;
+ }
+
+ public void setSynapseEnvironment(SynapseEnvironment se) {
+ this.se =se ;
+ if (se == null) {
+ throw new SynapseException("EnvironmentAware - SynapseEnvironment
injection is Faling");
+ }
+ }
+
+ public void setClassLoader(ClassLoader cl) {
+ this.cl = cl;
+ if (cl == null ) {
+ throw new SynapseException("EnvironmentAware - ClassLoader
injection is Faling");
+ }
+ }
+
+ public SynapseEnvironment getSynapseEnvironment() {
+ return se;
+ }
+
+ public ClassLoader getClassLoader() {
+ return cl;
+ }
+}
Added:
incubator/synapse/trunk/java/test/org/apache/synapse/environment/EnvironmentAwareTest.java
URL:
http://svn.apache.org/viewcvs/incubator/synapse/trunk/java/test/org/apache/synapse/environment/EnvironmentAwareTest.java?rev=360269&view=auto
==============================================================================
---
incubator/synapse/trunk/java/test/org/apache/synapse/environment/EnvironmentAwareTest.java
(added)
+++
incubator/synapse/trunk/java/test/org/apache/synapse/environment/EnvironmentAwareTest.java
Sat Dec 31 03:24:45 2005
@@ -0,0 +1,56 @@
+package org.apache.synapse.environment;
+
+import org.apache.axis2.transport.http.SimpleHTTPServer;
+import org.apache.axis2.addressing.EndpointReference;
+import org.apache.axis2.client.Options;
+import org.apache.axis2.client.MessageSender;
+import org.apache.synapse.util.Axis2EvnSetup;
+import junit.framework.TestCase;
+
+import javax.xml.namespace.QName;
+/*
+* Copyright 2004,2005 The Apache Software Foundation.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+public class EnvironmentAwareTest extends TestCase {
+ private SimpleHTTPServer synapseServer;
+ private EndpointReference targetEpr = new EndpointReference(
+ "http://127.0.0.1:5043/axis2/services/anonymous";);
+ private QName operation = new QName("anonymous");
+
+ public void setUp() throws Exception {
+ synapseServer = new
SimpleHTTPServer("target/synapse-repository-environmentaware",
+ 5043);
+ synapseServer.start();
+ }
+
+ protected void tearDown() throws Exception {
+ synapseServer.stop();
+ }
+
+ public void testSendProcessor() throws Exception {
+ // this test case throws exceptions if fail
+ // exceptions are propergated from Synapes Server
+ MessageSender sender = new MessageSender();
+ Options options = new Options();
+ options.setTo(targetEpr);
+ sender.setClientOptions(options);
+ sender.send(operation.getLocalPart(),
+ Axis2EvnSetup.payloadNamedAdddressing());
+
+ }
+
+}
Added: incubator/synapse/trunk/java/test/rules/synapse-environmentaware.xml
URL:
http://svn.apache.org/viewcvs/incubator/synapse/trunk/java/test/rules/synapse-environmentaware.xml?rev=360269&view=auto
==============================================================================
--- incubator/synapse/trunk/java/test/rules/synapse-environmentaware.xml (added)
+++ incubator/synapse/trunk/java/test/rules/synapse-environmentaware.xml Sat
Dec 31 03:24:45 2005
@@ -0,0 +1,7 @@
+<synapse xmlns="http://ws.apache.org/ns/synapse";>
+ <stage name="test-environmentaware">
+ <engage-addressing-in/>
+ <servicemediator name="environmentaware-mediator"
+ service="environmentaware-mediator"/>
+ </stage>
+</synapse>
\ No newline at end of file
Added: incubator/synapse/trunk/java/xdocs/userguide.html
URL:
http://svn.apache.org/viewcvs/incubator/synapse/trunk/java/xdocs/userguide.html?rev=360269&view=auto
==============================================================================
--- incubator/synapse/trunk/java/xdocs/userguide.html (added)
+++ incubator/synapse/trunk/java/xdocs/userguide.html Sat Dec 31 03:24:45 2005
@@ -0,0 +1,478 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>Synapse Userguide</title>
+</head>
+
+<body>
+<h1>UserGuide</a></h1>
+
+<p>Apache Synapse is a mediation framework for Web Services. Synapse allows
messages flowing through, into, or out of an organization to be mediated,
including aspects such as: </p>
+<ul>
+<li><p> Logging, service lookup, performance mediation </p>
+</li>
+<li><p> Versioning, failover, monitoring </p>
+</li>
+<li><p> Fault management, tracing </p>
+
+</li>
+</ul>
+
+<h3>Getting started</h3>
+
+<p>Although there is a cleanly defined division between Synapse and Axis2, the
Synapse system relies on Axis2 to run. Firstly, it uses the AXIOM object model,
and secondly it uses Axis2 as a listener and sender for Web service requests.
There are two ways to set up the Synapse server. </p>
+<ol>
+<li><p> synapse.war which can be deployed in a servlet container. </p>
+</li>
+<li><p> A lightweight server which runs with its own HTTP server (it uses
Axis2's SimpleHTTPServer which is a simple lightweight HTTP server option that
does not require a Servlet Engine) </p>
+
+</li>
+</ol>
+<p>You can either download these or build them using Maven. </p>
+<p>You can build the war file by using the command:
+</p>
+<pre>
+ maven dist-bin
+</pre>
+<p>which creates both the WAR and binary distribution JARs. </p>
+<p>If you to use synapse.war, deploy it in into your favorite servlet
container. </p>
+<p>Once it's exploded, you will see in <tt>WEB-INF</tt> the axis2.xml which
has been configured to execute Synapse properly and synapse.xml, which will
hold the rules pertaining to messages passing through Synapse. </p>
+
+<p>If you wish to use the standalone server, unzip the
Synapse-M1-SNAPSHOT.zip. In the bin directory you will find a script called:
</p>
+
+<pre>
+synapse [.sh or .bat]
+</pre>
+<p>You should also see a directory called <tt>synapse-repository</tt>. In
there you should find the axis2.xml and synapse.xml config files. The axis2.xml
should not need to be modified, but if you know what you are doing you can of
course! </p>
+<p>The command line for synapse-lightweight takes the repository directory and
listening port, so:
+</p>
+<pre>
+sh bin/synapse.sh synapse-repository 8080 [Linux]
+
+bin\synapse synapse-repository 8080 [Win]
+
+</pre>
+
+<h3>Deployment models</h3>
+
+<p>Synapse can intermediate in a number of different models: </p>
+
+<ul>
+
+<li>Transparent mode
+<ol>
+<li>In this mode, Synapse acts as an HTTP Proxy. </li>
+<li>Clients are configured with the Synapse endpoint URL as the HTTP Proxy
URL.</li>
+<li>Synapse can work with both WS-A and non-WS-A SOAP messages in this model.
</li>
+</ol>
+</li>
+<li>Gateway mode
+<ol>
+<li> In this mode, the client explicitly sends a message to Synapse (with or
without WS-A headers) </li>
+<li> The synapse.xml must include enough routing information to correctly set
the WS-A To and then Synapse forwards the message </li>
+</ol>
+
+<li >Smart client mode</li>
+
+<ol>
+<li >In this mode, the client sends the message to Synapse but sets the WSA
headers to the ultimate destination </li>
+</ol></ul>
+
+<h3 >Processing model</h3>
+
+<p>Synapse has an overall model under which there are two ways to extend the
framework. </p>
+<ol >
+<li><p> Using the SPI, developers can build Synapse Extensions, which
extend both the functionality and the XML configuration syntax of Synapse. </p>
+</li>
+<li><p> Using the API, developers can build Mediators, which extend the
functionality of Synapse but use the existing XML syntax. </p>
+
+</li>
+<li><p> There are also built-in mediators that do common tasks like
logging, redirection etc. </p>
+</li>
+</ol>
+</ul>
+<p>Typically users of Synapse extend the function using mediators, while the
Synapse development team can extend the core by building extensions. </p>
+<p>A synapse deployment attaches to one or more transport listeners, and
mediates messages from those listeners. One of the key decisions is how to
"attach" mediators to messages. </p>
+
+<h4 >Rules</h4>
+
+<p>By default Synapse will execute all defined mediators against a given
message, but this can be affected by using simple rules. Synapse has two
predefined rules: <tt><xpath></tt> and <tt><regex></tt>. xpath
evaluates and XPath expression against the message, while regex matches a
regular expression against one of the message headers (such as the
<tt>wsa:To</tt> address). </p>
+
+<p>Synapse also has two simple rules <tt><in></tt> and
<tt><out></tt> which process only request or response messages (as seen
by the target service). </p>
+
+<h4 >Stages</h4>
+
+<p>As a message goes through the Synapse engine, it can pass through multiple
stages. Each stage is a way of grouping and organizing mediators and rules. A
stage simply gives the group a name. </p>
+
+<h4 >An example</h4>
+
+<p>At this point an example would be useful. </p>
+
+<pre>
+<stage name="stage1-all">
+ <!--This enables the addressing module which looks at wsa headers
-->
+ <engage-addressing-in/>
+
+<!--Logs the message -->
+ <log/>
+
+</stage>
+
+<stage name="stage2-service-specific" >
+ <regex message-address="to" pattern="http://xmethods.*">
+ <header type="to"
value="http://64.124.140.30:9090/soap"/>
+ </regex>
+</stage>
+
+<stage name="stage3-send-all">
+ <send/>
+</stage>
+</pre>
+<p>This example demonstrates <em>stage</em>, <em>regex</em> and some built in
mediators: <em>log</em>, <em>addressing</em> and <em>header</em>. It does not
demonstrate the <em>xpath</em>, <em>in</em> or <em>out</em> rules. </p>
+
+<p>Every stage will be executed for each message. The first stage does initial
processing including parsing the addressing headers and logging the message.
</p>
+<p>The next stage is using a regex rule to redirect every message addresses to
xmethods.com and xmethods.net to the real SOAP address of the XMethods quote
service. </p>
+<p>Finally the last stage sends the message on. For responses, the messages
come back through the same stages. This time the message will not be redirected
because the "to" address on the response will not match xmethods. </p>
+
+<h4 >User Mediators</h4>
+
+<p>Synapse allows users to extend the built in mediators and add their own.
The mediators use the Synapse API. The API has three interfaces. </p>
+
+<h4 >SynapseMessage</h4>
+
+
+<p>The primary interface is the <a >SynapseMessage</a> interface: </p>
+
+<pre>
+public interface SynapseMessage {
+
+ public SOAPEnvelope getEnvelope();
+ public void setEnvelope(SOAPEnvelope envelope) throws AxisFault;
+
+ public EndpointReference getTo();
+ public void setTo(EndpointReference reference);
+ // lots more header get/setters not shown
+ // and a few other things ... see the real code
+
+ public Object getProperty(String key);
+ public void setProperty(String key, Object value);
+
+ public void setResponse(boolean b);
+ public boolean isResponse();
+}
+</pre>
+<p>The <a >SynapseMessage</a> interface is based on the Axis2 <a
>MessageContext</a> interface. It uses the Axis2 <a >EndpointReference</a> and
SOAPEnvelope classes/interfaces. </p>
+<p>The purpose of this interface is to capture a message as it flows through
the system. As you will see the messages are represented using the SOAP
infoset. Binary messages can be embedded in the Envelope using the MTOM support
built into Axis2's AXIOM object model. </p>
+
+<h4 >Mediator interface</h4>
+
+
+<p>The second key interface for mediator writers is the Mediator interface:
</p>
+
+<pre>
+package org.apache.synapse.api;
+
+import org.apache.synapse.SynapseMessage;
+
+public interface Mediator {
+ public boolean mediate(SynapseMessage sm);
+}
+
+</pre>
+<p>The mediator can modify the <a >SynapseMessage</a> in any way it likes -
adjusting the routing headers or changing the message. If it returns false,
that signals to the Synapse processing model to stop processing further. For
example, if the mediator is a security agent it may decide that this message is
dangerous and should not be processed further. This is generally the exception
as mediators are usually designed to co-operate to process the message onwards.
</p>
+
+<h4 >EnvironmentAware</h4>
+
+
+<p>The final aspect of the API is the <a >EnvironmentAware</a> interface. If
the mediator implements this, then it will have the <a >SynapseEnvironment</a>
injected into it: </p>
+
+<pre>
+package org.apache.synapse.api;
+
+import org.apache.synapse.SynapseEnvironment;
+
+public interface EnvironmentAware {
+ public void setSynapseEnvironment(SynapseEnvironment se);
+ public void setClassLoader(ClassLoader cl);
+
+}
+</pre>
+<p>The <a >SynapseEnvironment</a> allows the mediator access to the
underlying engine: </p>
+
+<pre>
+package org.apache.synapse;
+
+
+public interface SynapseEnvironment {
+ public void injectMessage(SynapseMessage smc);
+ public ClassLoader getClassLoader();
+ public void send(SynapseMessage smc);
+ public Processor lookupProcessor(String name);
+ public void addProcessor(Processor p);
+ public Processor getMasterProcessor();
+ public void setMasterProcessor(Processor p);
+}
+</pre>
+
+<h4 >Mediator configuration</h4>
+
+<p>Mediators can be configured in a few ways, including as classes, using IoC
containers such as Spring, and as deployed Axis2 Services. </p>
+
+<h4 >ClassMediator</h4>
+
+
+<ul>
+<li ><p>Firstly, they can be loaded as simple classes: </p>
+
+</li>
+</ul>
+
+<pre>
+<classmediator name="optional-name" class="org.apache.sample.MyLogger"/>
+</pre>
+<p>This will load a class named <tt>org.apache.sample.MyLogger</tt> and use it
to mediate messages. </p>
+
+<h4 >ServiceMediator</h4>
+
+
+<p>This will direct the message through a deployed Axis2 service which
implements the mediate interface: </p>
+
+<pre>
+<servicemediator name="optional-name" service="service-name"/>
+</pre>
+
+<h4 >SpringMediator</h4>
+
+<p>This model is supported by an optional extension, and requires that you
have the <tt>spring-core</tt>, <tt>spring-context</tt> and
<tt>spring-beans</tt> libraries from the <a
href="http://www.springframework.org";> Spring framework</a> website, as well as
the <tt>springmediator.jar</tt> in your classpath. </p>
+
+<p>The Spring mediator model uses a spring assembly to configure an assembly
of beans. The bean assembly must produce at one bean which implements the
mediator interface. </p>
+
+<pre>
+<synapse-spring:springmediator name="optional-name"
bean="name-of-bean-which-implements-mediator">
+ <beans>
+ <bean .... spring bean assembly configuration goes here >
+ </beans>
+</synapse-spring:springmediator>
+
+</pre>
+
+<h3 >In and Out</h3>
+
+<p>We could have been more explicit that the redirection is only designed to
apply to "in" messages by using the <in> rule. </p>
+
+<pre>
+<stage name="stage1-all">
+ ...
+</stage>
+
+<in name="stage2-service-specific" >
+ <regex message-address="to" pattern="http://xmethods.*">
+ ...
+</in>
+
+<stage name="stage3-send-all">
+ ...
+</stage>
+
+</pre>
+<p>There is a corresponding <tt><out></tt> rule. </p>
+
+<h4 >References</h4>
+
+<p>In order to make the configuration more re-usable, every rule, stage or
mediator can be named:
+</p>
+<pre>
+ <stage name="thisname">
+</pre>
+
+<p>The name can then be used to "refer" to the mediator. </p>
+<p>So
+</p>
+<pre>
+<ref ref="thisname"/>
+</pre>
+<p>will cause the same processing to happen as if the stage had been included
at that point. </p>
+<p>For example:
+</p>
+<pre>
+<in>
+ <stage name="both">
+
+ . . .
+ </stage>
+ <stage name="inonly"> ...</stage>
+</in>
+<out>
+ <ref ref="both"/>
+
+</out>
+</pre>
+<p>Please note this is one area where we expect to do considerable work </p>
+
+<h4 >Never</h4>
+
+
+<p>This is a stage where none of the children get executed. Its purpose is to
allow you to place rules and mediations and have them not executed but instead
refer to them from one or more other places. </p>
+<p>So the following may be deemed equivalent to the previous example
+</p>
+<pre>
+<in>
+ <ref ref="both"/>
+
+ <stage name="inonly"> ...</stage>
+</in>
+<out>
+ <ref ref="both"/>
+<out>
+<never>
+
+ <stage name="both"> ...</stage>
+</never>
+</pre>
+
+<h4 >Content based routing</h4>
+
+<p>We can further improve our example by adding some "content-based" routing.
Using an <xpath> rule we can make tests within the XML. For example, we
could decide not to allow stock ticker queries against certain companies whose
share prices we were jealous of - MSFT say :-). </p>
+
+<p>To do this we can add a rule:
+</p>
+<pre>
+<xpath expr="//*[Symbol='MSFT']">
+ <fault/>
+</xpath>
+</pre>
+<p>This rule identifies any messages with a tag <tt>Symbol</tt> whose content
is MSFT. The <tt><fault></tt> mediator returns a fault to the client. </p>
+
+<p>We can place this rule under the regex rule, so it only applies to requests
aimed at xmethods.*:
+</p>
+<pre>
+<regex message-address="to" pattern="http://xmethods.*">
+ <header type="to" value="http://64.124.140.30:9090/soap"/>
+ <xpath expr="//*[Symbol='MSFT']">
+ <fault/>
+ </xpath>
+
+</regex>
+</pre>
+<p>Note that the rules, like the stages, can have more than one child. While
it isn't fixed in Synapse, the built-in rules and mediators all use the same
"plan" to execute their children, which involves executing in the lexical order
that they occur in the synapse.xml. </p>
+
+<h3 >XML Configuration Elements</h3>
+
+<p>Every element in the Synapse configuration file maps to a instance of a
Processor. There are two types of element - <strong>nodes</strong> that
"contain" sub-elements (ex: <tt><regex/></tt>, <tt><stage/></tt>
and <tt><xpath/></tt>) and <strong>leaves</strong> others which only
contain configuration for that element or have no xml children (ex:
<tt><engage-addressing-in/></tt>). </p>
+
+<h4 >Grouping and Referencing elements</h4>
+
+
+<ol t>
+<li><p><tt><stage/></tt> </p>
+</li>
+<li ><p><tt><in/></tt> </p>
+</li>
+<li ><p><tt><out/></tt> </p>
+</li>
+
+<li ><p><tt><never/></tt> </p>
+</li>
+<li ><p><tt><ref/></tt> </p>
+</li>
+</ol>
+
+<h4 >Rule elements</h4>
+
+
+<ol >
+<li><p><tt><regex/></tt> </p>
+
+</li>
+<li ><p><tt><xpath/></tt> </p>
+</li>
+</ol>
+
+<h4 >Built-in mediators</h4>
+
+
+<ol >
+<li><p><tt><engage-addressing-in/></tt> </p>
+</li>
+<li ><p><tt><log/></tt> </p>
+
+</li>
+<li ><p><tt><fault/></tt> </p>
+</li>
+<li ><p><tt><send/></tt> </p>
+</li>
+<li ><p><tt><header/></tt> </p>
+</li>
+</ol>
+
+<h4 >User mediator types</h4>
+
+
+<ol >
+<li><p><tt><servicemediator/></tt> </p>
+</li>
+<li ><p><tt><classmediator/></tt> </p>
+</li>
+</ol>
+
+<h3 >Samples</h3>
+
+
+<h4 >Logging</h4>
+
+<p>The system ships with a couple of samples. These include sample clients and
appropriate synapse.xml intermediary configurations. </p>
+<p>The first sample demonstrates the logging facility. Here is a simple
synapse.xml:
+</p>
+<pre>
+<synapse xmlns="http://ws.apache.org/ns/synapse">
+ <engage-addressing-in/>
+ <log/>
+ <send/>
+
+</synapse>
+</pre>
+<p>The logging uses the Log4J/Commons Logging support in Apache. You can
configure it using <tt>log4j.properties</tt>. </p>
+<p>The sample client is a standard Axis2 client built to run against the
XMethods Quote Service. However, it has been modified to use a different
transport address from the Web Services Addressing TO header. In other words,
the SOAP envelope is addressed to the XMethods service, but the actual HTTP
request goes to Synapse. The sample client has three (optional) parameters: </p>
+
+<pre>
+StockQuoteClient SYMBOL XmethodsURL TransportURL
+</pre>
+<p>e.g.
+</p>
+<pre>
+StockQuoteClient IBM http://64.124.140.30:9090/soap http://localhost:8080
+
+</pre>
+<p>The sample synapse.xml can be used to demonstrate a few simple behaviours.
1) Firstly try this:
+</p>
+<pre>
+StockQuoteClient IBM http://64.124.140.30:9090/soap
http://64.124.140.30:9090/soap
+</pre>
+<p>This will bypass Synapse and simply call XMethods. </p>
+<p>2) Now start Synapse on port 8080 and try
+</p>
+<pre>
+StockQuoteClient
+</pre>
+<p>on its own. You should see the messages being logged as they pass through
Synapse. </p>
+<p>3) This time try
+</p>
+
+<pre>
+StockQuoteClient IBM urn:xmethods-delayed-quotes
+</pre>
+<p>This should hit a regex rule which replaces the "virtual URI" that is in
the wsa:To header with the real URL. </p>
+<p>4) Now try
+</p>
+<pre>
+StockQuoteClient MSFT
+</pre>
+<p>which should hit a "content-based" xpath rule. </p>
+<a ></a>
+
+<!-- end page -->
+</body>
+</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
