svn commit: r1745923 - /synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/mediators.xml

[isudana]

Author: isudana
Date: Sat May 28 19:27:03 2016
New Revision: 1745923

URL: http://svn.apache.org/viewvc?rev=1745923&view=rev
Log:
Documentation update for Header Mediator with changes made in SYNAPSE-1021

Modified:
    
synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/mediators.xml

Modified: 
synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/mediators.xml
URL: 
http://svn.apache.org/viewvc/synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/mediators.xml?rev=1745923&r1=1745922&r2=1745923&view=diff
==============================================================================
--- 
synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/mediators.xml 
(original)
+++ 
synapse/trunk/java/modules/documentation/src/site/xdoc/userguide/mediators.xml 
Sat May 28 19:27:03 2016
@@ -407,16 +407,25 @@
         <section name="Transformation Mediators" id="TransformationMediators">
             <subsection name="Header Mediator" id="Header">
                 <p>
-                    Header mediator sets or removes a specified header from 
the current SOAP
-                    infoset. The optional 'action' attribute specifies whether 
the mediator should
+                    Header mediator sets or removes a specified header from 
the message.
+                    The optional 'scope' attribute specifies the scope of the 
header.
+                    Scope can be either 'soap' or 'transport'.
+                    If the scope is set to 'soap', header is treated as a soap 
header and if it is 'transport',
+                    header is treated as a transport header.
+                    If the scope is omitted, header is treated as a soap 
header or one of the below mentioned known headers.
+                    The optional 'action' attribute specifies whether the 
mediator should
                     set or remove the header. If omitted, it defaults to 'set' 
action.
                 </p>
-                <div class="xmlConf">&lt;header name="qname" (value="literal" 
| expression="xpath") [action="set"]/&gt;
-&lt;header name="qname" action="remove"/&gt;</div>
+                <div class="xmlConf">&lt;header [name="qname"] 
(value="literal" | expression="xpath") [action="set"] [scope="soap | 
transport"]&gt;
+        [&lt;embeddedxml/&gt;]
+&lt;/header&gt;</div>
+
+                <div class="xmlConf">&lt;header name="qname" action="remove" 
[scope="soap | transport"]/&gt;</div>
                 <p>
                     The value of the 'name' attribute must be one of the 
following aliases or
                     a valid QName with a namespace prefix. In the latter case 
the namespace prefix
                     must be mapped to a valid namespace URI using the standard 
'xmlns' attribute.
+                    When setting an embedded xml element as a soap header, 
'name' attribute is not required.
                 </p>
                 <ul>
                     <li>To</li>