[Carbon-commits] [Carbon] svn commit r110444 - in trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer: . docs docs/images images

heshan at wso2.com heshan at wso2.com
Thu Jul 21 07:00:52 EDT 2011


Author: heshan
Date: Thu Jul 21 04:00:52 2011
New Revision: 110444
URL: http://wso2.org/svn/browse/wso2?view=rev&revision=110444

Log:
Adding the documentation for the relaytransformer mediator.


Added:
   trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/
   trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/images/
   trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/images/add_features_screenshot.jpg   (contents, props changed)
   trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/images/add_properties_screenshot.jpg   (contents, props changed)
   trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/images/xslt_mediator_screenshot.jpg   (contents, props changed)
   trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/userguide.html
   trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/images/
   trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/images/mediator-icon.gif   (contents, props changed)
Modified:
   trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/edit-mediator.jsp

Added: trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/images/add_features_screenshot.jpg
URL: http://wso2.org/svn/browse/wso2/trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/images/add_features_screenshot.jpg?pathrev=110444
==============================================================================
Binary file. No diff available.

Added: trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/images/add_properties_screenshot.jpg
URL: http://wso2.org/svn/browse/wso2/trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/images/add_properties_screenshot.jpg?pathrev=110444
==============================================================================
Binary file. No diff available.

Added: trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/images/xslt_mediator_screenshot.jpg
URL: http://wso2.org/svn/browse/wso2/trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/images/xslt_mediator_screenshot.jpg?pathrev=110444
==============================================================================
Binary file. No diff available.

Added: trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/userguide.html
URL: http://wso2.org/svn/browse/wso2/trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/userguide.html?pathrev=110444
==============================================================================
--- (empty file)
+++ trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/docs/userguide.html	Thu Jul 21 04:00:52 2011
@@ -0,0 +1,103 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<!--
+ ~ Copyright (c) 2009, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ ~
+ ~ 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.
+ -->
+    <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"/>
+    <title>Relay Transformer Mediator - User Guide</title>
+    <link href="../../admin/css/documentation.css" rel="stylesheet" type="text/css" media="all"/>
+</head>
+
+<body>
+<h1>Relay Transformer Mediator</h1>
+<p>
+The Relay Transformer Mediator supports all the features provided by the XSLT mediator. In addition
+to those features, it supports streaming transformation, where the incoming stream is given directly
+to the underlying XSLT processor to do the XSLT transformation. The Relay Transformer
+mediator can be used when the ESB started on Message Relay mode. This will give high performance
+numbers.
+
+In addition to the above mentioned specific characteristics, Relay Transformer Mediators shows following
+characteristics that is there on the XSLT mediator.
+
+The mediator applies the specified XSLT transformation to the selected element of the current
+message payload. If the source element is not specified, it defaults to the first child of the soap 
+body. Optionally parameters (XSLT) could be passed into the transformations through the 'property' 
+field. The 'feature' field defines any features which should be explicitly set to the TransformerFactory. 
+The feature 'http://ws.apache.org/ns/synapse/transform/feature/dom' turns on DOM based transformations instead 
+of serializing elements into Byte streams and/or temporary files. Though this would be better in 
+performance than using byte streams, sometimes it may not work for all transformations. 
+</p>
+<img src="images/xslt_mediator_screenshot.jpg"/>
+<p><strong>Relay Transformer Mediator</strong></p>
+
+<ul>
+<li>
+Key : The registry key to refer the xslt.
+</li>
+<li>
+Source: Specify in which part of message (specified in xpath) the xslt should be applied. Default is the SOAP body of
+the message.
+</li>
+</ul>
+
+<h2>Properties of the Relay Transformer mediator</h2>
+<p>
+Manage the properties which would be referred from the xslt in transformation (using get-property(prop-name) xpath extension function).
+</p>
+<img src="images/add_properties_screenshot.jpg"/>
+<p><strong>XSLT Mediator - Add Properties</strong></p>
+
+<ul>
+<li>
+Property Name: Name of the property.
+</li>
+<li>
+Property Type: Whether it is a static value or an xpath expression.
+</li>
+<li>
+Value/ Expression: The static value or the xpath expression.
+</li>
+<li>
+NSEditor: Specify the namespaces that are used in the xpath expression.
+</li>
+<li>
+Action: Delete the property.
+</li>
+</ul>
+
+
+<h2>Features of the Relay Transformer mediator</h2>
+<p>
+Specify the features to be enabled in the XSLT transformation. Read the introduction paragraph of this guide for an example feature.
+</p>
+<img src="images/add_features_screenshot.jpg"/>
+<p><strong>XSLT Mediator - Add Features</strong></p>
+
+<ul>
+<li>
+Feature Name: Name of the feature.
+</li>
+<li>
+Feature Value: Specify whether the feature is turn on (True) or Not (False).
+</li>
+<li>
+Action: Delete the feature.
+</li>
+</ul>
+
+</body>
+</html>

Modified: trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/edit-mediator.jsp
URL: http://wso2.org/svn/browse/wso2/trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/edit-mediator.jsp?rev=110444&r1=110443&r2=110444&view=diff
==============================================================================
--- trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/edit-mediator.jsp	(original)
+++ trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/edit-mediator.jsp	Thu Jul 21 04:00:52 2011
@@ -79,7 +79,7 @@
     Map<String, String> resources = relayTransformerMediator.getResources();
 %>
 <div>
-<script type="text/javascript" src="../xslt-mediator/js/mediator-util.js"></script>
+<script type="text/javascript" src="../relaytransformer/js/mediator-util.js"></script>
 <table class="normal" width="100%">
 <tr>
     <td>

Added: trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/images/mediator-icon.gif
URL: http://wso2.org/svn/browse/wso2/trunk/carbon/components/mediators/relaytransformer/org.wso2.carbon.mediator.relaytransformer.ui/src/main/resources/relaytransformer/images/mediator-icon.gif?pathrev=110444
==============================================================================
Binary file. No diff available.


More information about the Carbon-commits mailing list