Author: ruwan Date: Tue Jul 7 07:21:20 2009 New Revision: 40963 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=40963
Log: Fixing the mediator guide Modified: trunk/esb/java/docs/xdoc/mediator_guide.xml Modified: trunk/esb/java/docs/xdoc/mediator_guide.xml URL: http://wso2.org/svn/browse/wso2/trunk/esb/java/docs/xdoc/mediator_guide.xml?rev=40963&r1=40962&r2=40963&view=diff ============================================================================== --- trunk/esb/java/docs/xdoc/mediator_guide.xml (original) +++ trunk/esb/java/docs/xdoc/mediator_guide.xml Tue Jul 7 07:21:20 2009 @@ -17,11 +17,12 @@ ~ under the License. ~ --> -<!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=iso-8859-1" /> +<!DOCTYPE html + PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"/> <title>WSO2 ESB - Mediator Catalog </title> <link href="css/esb-docs.css" rel="stylesheet" /> <link href="styles/dist-docs.css" rel="stylesheet" type="text/css" @@ -29,8 +30,30 @@ </head> <body xml:lang="en"> -<h2>Mediator Catalog </h2> - +<h1>WSO2 Enterprise Service Bus (ESB) Mediator Catalog</h1> + <p>Mediators are the basic component of a mediation framework and the WSO2 ESB has a + comprehensive set of mediators. This guide will walk you through the genral concept of + mediation inside the WSO2 ESB and will also describe each and every mediator shipped with + WSO2 ESB 2.1.0, one by one</p> +<h2>Contents</h2> +<ul> + <li><a href="#Intro">Introduction</a></li> + <li><a href="#HowMediatorWorks">How does a mediator work?</a></li> + <li><a href="#Sequences">Sequences</a> + <ul> + <li><a href="#InLineSequence">In-line Sequences</a></li> + <li><a href="#NamedSequence">Named Sequences</a></li> + </ul> + </li> + <li><a href="#HowMessageMediate">How does a message comes to a mediator?</a> + <ul> + <li><a href="#MessageMediation">Message Mediation</a></li> + <li><a href="#ProxyServices">Proxy Services</a></li> + </ul> + </li> + <li><a href="#MediatorCatalog">The Mediator Catalog</a></li> +</ul> +<h2 id="Intro">Introduction</h2> <p>Message mediation is a fundamental part of any ESB. WSO2 ESB achieves message mediation through it's mediators. ESB comes with a rich set of 30 plus mediators to support the most common mediation functionalities as well as @@ -56,7 +79,7 @@ <p>Now let's briefly look at how the mediation framework works. </p> -<h3>How does a mediator work?</h3> +<h2 id="HowMediatorWorks">How does a mediator work?</h2> <p>A mediator is a full powered processing unit in ESB. In run-time it has access to all the parts of ESB along with the current message. Usually a @@ -67,13 +90,13 @@ run-time information. Then this mediator can do virtually anything with the message. Here are some examples of mediator functionalities. </p> <ul> - <li>Drop Mediator : Drops a message, stopping further processing of the + <li><a href="mediators/drop.html">Drop Mediator</a> : Drops a message, stopping further processing of the message</li> - <li>Send Mediator : Send the message out, using information inside the + <li><a href="mediators/send.html">Send Mediator</a> : Send the message out, using information inside the message or according to some external configuration</li> - <li>Script Mediator : Executes a scripting language with the message</li> - <li>Filter Mediator: Filter messages using XPath</li> - <li>XSLT Mediator: Do XSLT transformations on messages </li> + <li><a href="mediators/script.html">Script Mediator</a> : Executes a scripting language with the message</li> + <li><a href="mediators/filter.html">Filter Mediator</a> : Filter messages using XPath</li> + <li><a href="mediators/xslt.html">XSLT Mediator</a> : Do XSLT transformations on messages </li> </ul> <p>Wide range usage of mediators is visible through the above few examples.</p> @@ -83,7 +106,7 @@ any other built in mediator will be exactly same from the API and the privileges.</p> -<h3>Sequences</h3> +<h2 id="Sequences">Sequences</h2> <p>Sequence is a List Mediator of the ESB. That means it can hold other mediators and execute them. It is a part of the core of ESB and message @@ -92,14 +115,14 @@ <p>There are two types of sequences.</p> -<h4>In-line Sequences</h4> +<h3 id="InLineSequence">In-line Sequences</h3> <p><sequence name="string">other mediators</sequence></p> <p>In-line sequences has their child mediators defined inside the sequence itself.</p> -<h4>Named Sequences</h4> +<h3 id="NamedSequence">Named Sequences</h3> <p><sequence key="name"/></p> @@ -137,13 +160,13 @@ be called. Every sequence has an error handler. If one isn't explicitly specified, fault sequence will be treated as the error handler.</p> -<h4>How does a message comes to a mediator?</h4> +<h2 id="HowMessageMediate">How does a message comes to a mediator?</h2> <p>There are two operational modes in the ESB. They are message mediation and proxy services. Message mediation is all about mediators. Proxy services can use message mediation as well.</p> -<h4>Message Mediation</h4> +<h3 id="MessageMediation">Message Mediation</h3> <p>A message comes to the main sequence of the ESB if the message is not for any of the proxy services defined in the ESB.</p> @@ -160,7 +183,7 @@ <p>If an error occurs in a sequence, message will go through sequence's fault sequence.</p> -<h4>Proxy Services</h4> +<h3 id="ProxyServices">Proxy Services</h3> <p>Proxy service can have 3 sequences. Depending on the message path these three sequences can be executed. All the three sequences are optional.</p> @@ -181,6 +204,8 @@ an introduction to the usage of the sequence editor. Following is the catalog of the built in mediators of WSO2 ESB.</p> +<h2 id="MediatorCatalog">The Mediator Catalog</h2> + <table border="1"> <thead> <tr> @@ -196,27 +221,27 @@ <td>Send a message out </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/log.html">Log</a> </td> <td>Logs a message </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/property.html">Property</a> </td> <td>Set or remove properties associated with the message </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/sequence.html">Sequence</a> </td> <td>Refer a sequence </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/event.html">Event</a></td> <td>Send event notifications to an event source </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/drop.html">Drop</a> </td> <td>Drops a message </td> </tr> @@ -226,27 +251,27 @@ <td>Filter a messages using XPath, If else kind of logic </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/in-out.html">Out</a> </td> <td>Inbuilt filter for choosing messages in ESB out path </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/in-out.html">In</a></td> <td>Inbuilt filter for choosing messages in ESB in path </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/switch.html">Swith</a> </td> <td>Filter messages using XPath, Switch logic </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/router.html">Router</a></td> <td>Route messages based on XPath filtering </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/validate.html">Validate</a></td> <td>Schema validation for messages </td> </tr> @@ -256,17 +281,17 @@ <td>XSLT transformations</td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/xquery.html">XQuery</a></td> <td>XQuey </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/header.html">Header</a> </td> <td>Sets or remove SOAP headers </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/fault.html">Fault</a> </td> <td>Create SOAP Faults </td> </tr> @@ -277,57 +302,57 @@ </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/clone.html">Clone</a> </td> <td>Clones a message </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/iterate.html">Iterate</a> </td> <td>Splits a message </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/aggregate.html">Aggregate</a></td> <td>Combines messages </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/callout.html">Callout</a></td> <td>Blocking web services calls</td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/transaction.html">Transaction</a></td> <td>Executes a set of mediators transactionally </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/throttle.html">Throttle</a></td> <td>Limit the number of messages </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/rmsequence.html">RMSequence</a></td> <td>Reliable messaging </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/dbreport.html">DBReport</a></td> <td>Writes data to a database </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/dblookup.html">DBLookup</a></td> <td>Retrieve information from a database </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/rule.html">Rule</a></td> <td>Executes Rules </td> </tr> <tr> - <td></td> + <td/> <td>Entitlement </td> <td>Fine grain authentication </td> </tr> @@ -337,23 +362,22 @@ <td>Create and execute a custom mediator</td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/pojo-command.html">POJOCommand</a> </td> <td>Executes a custom command </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/script.html">Script</a></td> <td>Executes a mediator written in a Scripting language </td> </tr> <tr> - <td></td> + <td/> <td><a href="mediators/spring.html">Spring</a></td> <td>Create a mediator managed by Spring </td> </tr> </tbody> </table> -<p></p> </body> </html> _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
