Author: ruwan
Date: Wed Oct 31 14:04:17 2007
New Revision: 590828
URL: http://svn.apache.org/viewvc?rev=590828&view=rev
Log:
Adding the clone, iterate, aggregate and cache configuration to the language
documentation and a small typo in the ClooneFactory
Modified:
webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/CloneMediatorFactory.java
webservices/synapse/trunk/java/src/site/resources/Synapse_Configuration_Language.html
Modified:
webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/CloneMediatorFactory.java
URL:
http://svn.apache.org/viewvc/webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/CloneMediatorFactory.java?rev=590828&r1=590827&r2=590828&view=diff
==============================================================================
---
webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/CloneMediatorFactory.java
(original)
+++
webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/CloneMediatorFactory.java
Wed Oct 31 14:04:17 2007
@@ -38,7 +38,7 @@
* <sequence> (mediator +) </sequence>
* <endpoint> endpoint </endpoint>
* </target>
- * </iterate>
+ * </clone>
* </pre>
*/
public class CloneMediatorFactory extends AbstractMediatorFactory {
Modified:
webservices/synapse/trunk/java/src/site/resources/Synapse_Configuration_Language.html
URL:
http://svn.apache.org/viewvc/webservices/synapse/trunk/java/src/site/resources/Synapse_Configuration_Language.html?rev=590828&r1=590827&r2=590828&view=diff
==============================================================================
---
webservices/synapse/trunk/java/src/site/resources/Synapse_Configuration_Language.html
(original)
+++
webservices/synapse/trunk/java/src/site/resources/Synapse_Configuration_Language.html
Wed Oct 31 14:04:17 2007
@@ -405,7 +405,7 @@
<h2><a name="mediator">Mediators</a></h2>
<p>A mediator token refers to any of the following tokens:</p>
-<pre><a href="#send">send</a> | <a href="#drop">drop</a> | <a
href="#log">log</a> | <a href="#property">property</a> | <a
href="#sequence_ref">sequence</a> | <a href="#validate">validate</a> | <a
href="#makefault">makefault</a> | <a href="#xslt">xslt</a> | <a
href="#header">header</a> | <a href="#filter">filter</a> | <a
href="#switch">switch</a> | <a href="#in">in</a> | <a href="#out">out</a> | <a
href="#dblookup">dblookup</a> | <a href="#dbreport">dbreport</a> | <a
href="#RMSequence">RMSequence</a> | <a href="#throttle">throttle</a> | <a
href="#xquery">xquery</a> | <a href="#class">class</a> | <a
href="#script">script</a> | <a href="#spring">spring</a> </pre>
+<pre><a href="#send">send</a> | <a href="#drop">drop</a> | <a
href="#log">log</a> | <a href="#property">property</a> | <a
href="#sequence_ref">sequence</a> | <a href="#validate">validate</a> | <a
href="#makefault">makefault</a> | <a href="#xslt">xslt</a> | <a
href="#header">header</a> | <a href="#filter">filter</a> | <a
href="#switch">switch</a> | <a href="#in">in</a> | <a href="#out">out</a> | <a
href="#dblookup">dblookup</a> | <a href="#dbreport">dbreport</a> | <a
href="#RMSequence">RMSequence</a> | <a href="#throttle">throttle</a> | <a
href="#xquery">xquery</a> | <a href="#cache">cache</a> | <a
href="#clone">clone</a> | <a href="#iterate">iterate</a> | <a
href="#aggregate">aggregate</a> | <a href="#class">class</a> | <a
href="#script">script</a> | <a href="#spring">spring</a> </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
@@ -819,6 +819,88 @@
the 'key' attribute is present ,then the expression will be evaluated against
a XML document that will be loaded from the registry,otherwise the expression
will be evaluated against the current SOAP envelope.</p>
+
+<h4><a name="cache">Cache</a></h4>
+<pre> <cache (id="string")? hashGenerator="class" scope="string"
timeout="mili-seconds">
+ <onCacheHit (sequence="key")?>
+ (mediator)+
+ </onCacheHit>
+ <implementation type=(memory | disk) maxSize="int"/>
+ </cache></pre>
+
+<p>The <cache> mediator will evaluate the hash value of the incoming
message as described
+in the hash generator implementation (which should be a class implementing the
+org.wso2.caching.digest.DigestGenerator interface) and looks in the cache for
a matching response.
+If the generated hash value has been found in the cache then the cache
mediator will execute the
+onCacheHit sequence which can be inlined as well as refered. Cache can be
configured on the
+per-mediator or per-host basis and also configuration provides the timeout
management through
+the timeout attribute. For the moment this is just an in-memory cache which
will be extended to
+a disk-based and hierachical in the future.</p>
+
+<h4><a name="clone">Clone</a></h4>
+<pre> <clone continueParent=(true | false)>
+ <target to="uri" [soapAction="qname"] sequence="sequence_ref"
endpoint="endpoint_ref">
+ <sequence>
+ (mediator)+
+ </sequence>
+ <endpoint>
+ endpoint
+ </endpoint>
+ </target>
+ </clone></pre>
+
+<p>The <clone> mediator implements a part of the Message Splitter EIP
and will
+split the message in to number of identical messages all of which are
identical with
+the clonning message and processed parallely using either the specified
sequence or
+endpoint or both. Clonning message (parent) can be continued or dropped
depending on
+the boolean value of the continueParent attribute which defaults to false and
drops
+the parent when false. This drop is not a general drop, rather stop the
message processing
+but does not closes the transport channel, leaving the ability of one or a set
of cloned message
+responses to be sent back to the caller</p>
+
+<h4><a name="iterate">Iterate</a></h4>
+<pre> <iterate continueParent=(true | false) preservePayload=(true | false)
(attachPath="xpath")? expression="xpath">
+ <target to="uri" [soapAction="qname"] sequence="sequence_ref"
endpoint="endpoint_ref">
+ <sequence>
+ (mediator)+
+ </sequence>
+ <endpoint>
+ endpoint
+ </endpoint>
+ </target>
+ </iterate></pre>
+
+<p>The <iterate> mediator implements another part of the Message
Splitter EIP and will
+split the message in to number of different messages derived from the parent
message by
+finding the matching elements of the XPATH expression specified in the
configuration.
+New messages will be created for each and every matching element and processed
parallely
+using either the specified sequence or endpoint or both. Parent message can be
continued
+or dropped in the same way as in the clone mediator. Iterate parent drop also
is a channel
+blocking drop as per in the clone mediator.</p>
+
+<h4><a name="aggregate">Aggregate</a></h4>
+<pre> <aggregate>
+ <corelateOn expression="xpath"/>
+ <completeCondition timeout="time-in-seconds">
+ <messageCount min="int-min" max="int-max"/>
+ </completeCondition>
+ <onComplete expression="xpath" sequence="sequence-ref">
+ (mediator +)?
+ </onComplete>
+ <invalidate sequence="sequence-ref" timeout="time-in-seconds">
+ (mediator +)?
+ </invalidate>
+ </aggregate></pre>
+
+<p>The <aggregate> mediator implements the Message Aggregator EIP and
will
+aggregate the messages splitted using either the clone or iterate mediators.
+At the same time it can aggregate messages on the presence of matching
elements specified
+by the corelateOn XPATH expression. Aggregate will collect the messages coming
in to that
+until the messages on the aggregation satisfies the complete condition. On
completion of
+the aggregation it will execute the aggregated message using the onComplete
sequence. Aggregated
+message will be created by combining the messages participating in the
aggregation using the
+onComplete XPATH expression. If a particular aggregation fails to complete in
a pre configured
+time, then that particular aggregation will be invalidated using the
invalidate sequence.</p>
<h3>Extension mediators</h3>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
