Author: supun Date: Tue Jun 30 23:09:48 2009 New Revision: 40474 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=40474
Log: Updating the header mediator guide Modified: branches/esb/java/2.1/product/docs/xdoc/mediators/header.xml Modified: branches/esb/java/2.1/product/docs/xdoc/mediators/header.xml URL: http://wso2.org/svn/browse/wso2/branches/esb/java/2.1/product/docs/xdoc/mediators/header.xml?rev=40474&r1=40473&r2=40474&view=diff ============================================================================== --- branches/esb/java/2.1/product/docs/xdoc/mediators/header.xml (original) +++ branches/esb/java/2.1/product/docs/xdoc/mediators/header.xml Tue Jun 30 23:09:48 2009 @@ -1,48 +1,73 @@ -<?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 - Header 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>Header Mediator</h2> - -<p>The header mediator sets or removes a specified header from the current soap -info-set. At the moment set header only supports simple valued headers. </p> - -<h3>Syntax</h3> -<pre xml:space="preserve"> <header name="qname" (value="literal" | expression="xpath") [action="set"]/> - <header name="qname" action="remove"/></pre> - -<p>The optional action attribute specifies whether the mediator should set or -remove the header. If omitted, it defaults to a set-header.</p> - -<h3>UI Configuration</h3> - -<p><img alt="" -src="../header-mediator/docs/images/header_mediator_screenshot.jpg" /> </p> - -<p><strong>Figure1: Header Mediator</strong> </p> - -<p>Here are the option you have in configuring the header mediator. </p> -<ul> - <li>Name: Name of the header element, You can declare the namespace used in - the header element by clicking the Namespace link right to the text field. - </li> - <li>Action: (Set/Remove), Specify whether you want to remove this header from - the incomming message or set a new header, Default to Set. </li> - <li>Value/Expression: A static value or an xpath expression that will be - executed on the message to set the header value. </li> -</ul> - -<h3>Example</h3> - -<p></p> -</body> -</html> +<?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 - Header 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>Header Mediator</h2> + +<p>The header mediator sets or removes a specified header from the current soap +info-set. At the moment set header only supports simple valued headers. </p> + +<h3>Syntax</h3> +<pre xml:space="preserve"> <header name="qname" (value="literal" | expression="xpath") [action="set"]/> + <header name="qname" action="remove"/></pre> + +<p>The optional action attribute specifies whether the mediator should set or +remove the header. If omitted, it defaults to a set-header.</p> + +<h3>UI Configuration</h3> + +<p><img alt="" +src="../header-mediator/docs/images/header_mediator_screenshot.jpg" /> </p> + +<p><strong>Figure1: Header Mediator</strong> </p> + +<p>Here are the option you have in configuring the header mediator. </p> +<ul> + <li>Name: Name of the header element, You can declare the namespace used in + the header element by clicking the Namespace link right to the text field. + </li> + <li>Action: (Set/Remove), Specify whether you want to remove this header from + the incomming message or set a new header, Default to Set. </li> + <li>Value/Expression: A static value or an xpath expression that will be + executed on the message to set the header value. </li> +</ul> + +<h3>Example</h3> +<pre xml:space="preserve"> <in> + <RMSequence single="true" version="1.0"/> + <send> + <endpoint name="reliable"> + <address uri="http://localhost:9000/services/ReliableStockQuoteService"> + <enableRM/> + <enableAddressing/> + </address> + </endpoint> + </send> + </in> + <out> + <header name="wsrm:SequenceAcknowledgement" action="remove" + xmlns:wsrm="http://schemas.xmlsoap.org/ws/2005/02/rm"/> + <header name="wsrm:Sequence" action="remove" + xmlns:wsrm="http://schemas.xmlsoap.org/ws/2005/02/rm"/> + <header name="wsrm:AckRequested" action="remove" + xmlns:wsrm="http://schemas.xmlsoap.org/ws/2005/02/rm"/> + <send/> + </out></pre> + +<p>ESB receives a non reliable message and it forward it to an endpoint that +supports reliable messaging. In this example when ESB recieves a message we +send it using Reliable messaging. So the response ESB receives is having +Reliable messaging headers. We don't want to send these headers to the client +who doesn't support reliable messaging. So we remove the reliable messaging +headers before sending the reponse to the client.</p> +</body> +</html> _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
