Author: rajika
Date: Mon Jun 29 02:09:51 2009
New Revision: 40274
URL: http://wso2.org/svn/browse/wso2?view=rev&revision=40274

Log:
Added class mediator docs.

Added:
   trunk/esb/java/docs/xdoc/mediators/class.xml

Added: trunk/esb/java/docs/xdoc/mediators/class.xml
URL: 
http://wso2.org/svn/browse/wso2/trunk/esb/java/docs/xdoc/mediators/class.xml?pathrev=40274
==============================================================================
--- (empty file)
+++ trunk/esb/java/docs/xdoc/mediators/class.xml        Mon Jun 29 02:09:51 2009
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!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" />
+  <title>WSO2 ESB - Class Mediator </title>
+  <link href="css/esb-docs.css" rel="stylesheet" />
+  <link href="styles/dist-docs.css" rel="stylesheet" type="text/css"
+  media="all" />
+</head>
+
+<body>
+<h2>Class Mediator</h2>
+
+<p>The class mediator creates an instance of a custom specified class and sets 
it as a mediator. The class must
+    implement the org.apache.synapse.api.Mediator interface. If any properties 
are specified, the corresponding
+    setter methods are invoked on the class, once, during initialization.  </p>
+
+<h3>Syntax</h3>
+<pre xml:space="preserve"> &lt;class name="class-name"&gt;
+   &lt;property name="string" value="literal"&gt; 
+    (either literal or XML child)
+   &lt;/property&gt;
+ &lt;/class&gt;
+</pre>
+
+<h3>UI Configuration</h3>
+  <div class="image">
+    <img src="../class-mediator/docs/images/add-class.png" alt=""/>
+    <p>
+      Figure 1: Adding a class mediator
+    </p>
+  </div>
+  <p>
+  Clicking on the class mediator created as shown in figure 1 will open
+  up the class mediator specific options. You can specify the class mediator 
implementaion class and load it by
+  clicking LoadClass button. Once you load the class you'll see the class 
mediator configuration options
+  as in figure2.</p>
+  <div class="image">
+    <img 
src="../pojoCommand-mediator/docs/images/class_mediator_screenshot.jpg" alt=""/>
+    <p>
+      Figure 2: Class mediator configuration options
+    </p>
+  </div>
+  <p>
+  Class mediator configuration descriptions
+  </p>
+  <ul>
+    <li>
+       Class Name: The class name of the class. You have to give the qualified 
name of the class and click
+        "Load Class" button.
+    </li>
+    <li>
+        Properties defined for Class mediator: This list the properties with 
setter functions of the uploaded class.
+        Following fields are listed for each property.
+        <ul>
+            <li>
+                Property Name - Name of the property.
+            </li>
+            <li>
+                Property Value - The value to be set to the property. 
+            </li>
+            <li>
+                Action - Link to delete the unused properties, from the list.
+            </li>
+        </ul>
+    </li>
+  </ul>
+
+<h3>Example</h3>
+
+
+</body>
+</html>

_______________________________________________
Esb-java-dev mailing list
[email protected]
https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev

Reply via email to