Corrected one-way MEP proposal

David Hull <[email protected]> Wed, 29 Mar 2006 14:04:53 -0500
Newsgroups gmane.text.xml.distributed
Message-ID <[email protected]>
Somewhere along the line, one or more processors put gibberish into the
href of anything that looked like a link.  I've fixed that here.  I've
also edited the state machine descriptions, which still had a little bit
of cut-n-paste left over from the request-response MEP description I
started from.  These descriptions now are deliberately /too/ minimal
(probably), but the state machines themselves may not be.
one-way-MEP.htm (text/html, 8.8 KB)
<!DOCTYPE html PUBLIC "-W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>SOAP One-way Message Exchange Pattern</title>
  <meta content="&Ntilde;and&uacute; 0.6" name="GENERATOR">
  <meta content="text/html;charset=UTF-8" http-equiv="Content-Type">
</head>
<body>
<h1>6. SOAP-Supplied
Message Exchange Patterns and Features</h1>
<div class="div1">
<div class="div2">
<h3><a name="meppropconv"></a></h3>
</div>
<div class="div2">
<h3><a name="singlereqrespmep"></a>6.4 SOAP One-way Message
Exchange Pattern</h3>
<p>This section defines the message exchange pattern (MEP) called
"One-way". The description is an abstract presentation of the operation
of this MEP. It is not intended to describe a real implementation or to
suggest how a real implementation should be structured.</p>
<div class="div3">
<h4><a name="mepname"></a>6.4.1 SOAP Feature Name</h4>
<p>This message exchange pattern is identified by the URI (see SOAP
1.2 Part 1 <a
 href="http://www.w3.org/TR/2003/REC-soap12-part2-20030624/">[SOAP
Part 1]</a> <a
 href="http://www.w3.org/TR/2003/REC-soap12-part2-20030624/#soapfeatspec">SOAP
Features</a>):</p>
<ul>
  <li>
    <p>"http://www.w3.org/2003/05/soap/mep/one-way/</p>
  </li>
</ul>
</div>
<div class="div3">
<h4><a name="bindinfdesc"></a>6.4.2 Description</h4>
<p>The SOAP one-way MEP defines the exchange of a single SOAP
message between a <span style="font-style: italic;">sender</span> and
a <span style="font-style: italic;">receiver</span>. In the absence of
failure in the underlying protocol, this MEP consists of exactly one
SOAP message.</p>
<p>In the normal operation of a message exchange conforming to the
one-way MEP, the message is first transferred from the sending SOAP
node to the receiving SOAP node. </p>
<p>Abnormal operation during a One-way message exchange is be
caused by a failure to transfer the message. Such failure might be
silent at either or both of the sending and receiving SOAP nodes
involved, or might result in the generation of a SOAP or
binding-specific fault (see <a href="#bindfaulthdn"><b>6.4.4
Fault Handling</b></a>). Also, during abnormal operation the SOAP nodes
involved in the message exchange might differ as to whether the message
exchange completed successfully. </p>
<p>The scope of a one-way MEP is limited to the exchange of single
message between one sending and one receiving SOAP node. This pattern
does not mandate any correlation between multiple messages nor specific
timing for multiple messages. Implementations MAY choose to support
more complex patterns of interaction.</p>
</div>
<div class="div3">
<h4><a name="bindformdesc"></a>6.4.3 State Machine Description</h4>
<p>The One-way MEP defines a set of properties described in <b>Table
3</b>.</p>
<a name="tabreqresprops"></a>
<table border="1">
  <caption>Table 3: Property definitions for Request-Response MEP</caption>
  <tbody>
    <tr>
      <th>Property Name</th>
      <th>Property Description</th>
      <th>Property Type</th>
    </tr>
    <tr>
      <td><code>http://www.w3.org/2003/05/soap/mep/OutboundMessage</code>
      </td>
      <td>An abstract structure that represents the current
outbound message in the message exchange. This abstracts both SOAP
Envelope and any other information structures that are transferred
along with the envelope.</td>
      <td>Not specified</td>
    </tr>
    <tr>
      <td><code>http://www.w3.org/2003/05/soap/mep/ImmediateDestination</code>
      </td>
      <td>The identifier of the immediate destination of an
outbound message.</td>
      <td>xs:anyURI</td>
    </tr>
  </tbody>
</table>
<p>To initiate a message exchange conforming to the One-way MEP,
the sending SOAP node instantiates a local message exchange context.<b>Table
4</b> describes how the context is initialized.</p>
<a name="tabreqcon"></a>
<table border="1">
  <caption>Table 4: Instantiation of a Message Exchange Context for
a requesting SOAP node</caption> <tbody>
    <tr>
      <th>Property Name</th>
      <th>Property Value</th>
      <th>Notes</th>
    </tr>
    <tr>
      <td><code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/ExchangePatternName</code>
      </td>
      <td>"http://www.w3.org/2003/05/soap/mep/one-way/" </td>
      <td>&nbsp;</td>
    </tr>
    <tr>
      <td><code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/FailureReason</code>
      </td>
      <td>
      <p>"None"</p>
      </td>
      <td>
      <p>A relative URI whose base URI is the value of <code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/ExchangePatternName</code>
      </p>
      </td>
    </tr>
    <tr>
      <td><code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/Role</code>
      </td>
      <td>
      <p>"SendingSOAPNode/"</p>
      </td>
      <td>
      <p>A relative URI whose base URI is the value of <code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/ExchangePatternName</code>
      </p>
      </td>
    </tr>
    <tr>
      <td><code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/State</code>
      </td>
      <td>
      <p>"Init"</p>
      </td>
      <td>
      <p>A relative URI whose base URI is the value of <code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/Role</code>
      </p>
      </td>
    </tr>
    <tr>
      <td><code>http://www.w3.org/2003/05/soap/mep/OutboundMessage</code>
      </td>
      <td>An abstraction of the message </td>
      <td>&nbsp;</td>
    </tr>
    <tr>
      <td><code>http://www.w3.org/2003/05/soap/mep/ImmediateDestination</code>
      </td>
      <td>An identifier (URI) that denotes the receiving SOAP node </td>
      <td>&nbsp;</td>
    </tr>
  </tbody>
</table>
<p>There may be other properties related to the operation of the
message exchange context instance. Such properties are initialized
according to their own feature specifications. </p>
<p>Once the message exchange context is initialized, control of the
context is passed to a (conforming) local binding instance. </p>
<p>The diagram below shows the logical state transitions at the
requesting and responding SOAP nodes during the lifetime of the message
exchange. At each SOAP node, the local binding instance updates
(logically) the value of the <code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/State</code>
property to reflect the current state of
the message exchange. The state names are relative URIs, relative to a
base URI value carried in the <code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/Role</code>
property of the local message exchange context.</p>
<span style="font-weight: bold; font-style: italic;">&lt;figure
omitted&gt;</span><br style="font-weight: bold; font-style: italic;">
<p align="center">Figure 2: One-way MEP State Transition Diagram.</p>
When the requesting and responding SOAP nodes transition between
states, the local binding instance (logically) updates a number of
properties. <b>Table 6</b> and <b>Table 7</b> describe these updates
for the requesting and the responding
SOAP nodes, respectively.<br>
&nbsp;<a name="tabreqstatetrans"></a>
<table border="1" width="100%">
  <caption>Table 6: SendingSOAP Node State Transitions</caption> <tbody>
    <tr>
      <th valign="top">CurrentState</th>
      <th valign="top">Transition Condition</th>
      <th valign="top">NextState</th>
      <th valign="top">Action</th>
    </tr>
    <tr>
      <td rowspan="2" valign="top">"Init"</td>
      <td valign="top">Message transmission failure</td>
      <td valign="top">"Fail"</td>
      <td valign="top">Set <code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/FailureReason</code>
to "transmissionFailure"</td>
    </tr>
    <tr>
      <td valign="top">Completed message transmission<br>
      </td>
      <td valign="top">"Success"</td>
      <td valign="top"><br>
      </td>
    </tr>
  </tbody>
</table>
<a name="tabresstatetrans"></a>
<table border="1" width="100%">
  <caption>Table 7: Receiving SOAP Node State Transitions</caption> <tbody>
    <tr>
      <th valign="top">CurrentState</th>
      <th valign="top">Transition Condition</th>
      <th valign="top">NextState</th>
      <th valign="top">Action</th>
    </tr>
    <tr>
      <td rowspan="2" valign="top">"Init"</td>
      <td valign="top">Message reception failure</td>
      <td valign="top">"Fail"</td>
      <td valign="top">Set <code>http://www.w3.org/2003/05/soap/bindingFramework/ExchangeContext/FailureReason</code>
to "receptionFailure".</td>
    </tr>
    <tr>
      <td valign="top">Message received. Message available in <code>http://www.w3.org/2003/05/soap/mep/InboundMessage</code>
      </td>
      <td valign="top">"Success"</td>
      <td valign="top"><br>
      </td>
    </tr>
  </tbody>
</table>
<br>
</div>
<div class="div3">
<h4><a name="bindfaulthdn"></a>6.4.4 Fault Handling</h4>
This MEP makes no claims about the disposition or handling of SOAP
faults generated by the either SOAP node. </div>
</div>
</div>
</body>
</html>