SOAP 1.1 Binding for MTOM 1.0

1.1 Requirements

This specification intends to meet the following requirements:

• Specify the minimal changes to MTOM and XOP to enable these facilities to be used interoperably with SOAP 1.1.
• Allow substantial parts of a SOAP 1.2 MTOM/XOP implementation to be reused with SOAP 1.1.
• Clarify that SOAP 1.1 envelopes so constructed must use XML 1.0 for interoperability.
• Illustrate updates to the [Describing Binary Content] specification (syntax changes) since the publication of XOP.

1.2 Example

Table 1 shows a representation of a SOAP envelope XML Infoset prior to XOP processing. Table 2 shows the same Infoset, serialized using the application/xop+xml format in a MIME Multipart/Related package. These examples correspond to those in [XOP, 1.2 Examples], adjusted to illustrate SOAP 1.1 envelopes.

Table 1: XML Infoset prior to XOP processing (Example 1, SOAP 1.1)

(01) <s11:Envelope
(02)      xmlns:s11='http://schemas.xmlsoap.org/soap/envelope/'
(03)      xmlns:xmime='http://www.w3.org/2005/05/xmlmime'>
(04)   <s11:Body>
(05)     <m:data xmlns:m='http://example.org/stuff'>
(06)       <m:photo
(07)         xmime:contentType='image/png'>/aWKKapGGyQ=</m:photo>
(08)       <m:sig
(09)         xmime:contentType='application/pkcs7-signature'>Faa7vROi2VQ=</m:sig>
(10)     </m:data>
(11)   </s11:Body>
(12) </s11:Envelope>

Lines (01-02) in Table  indicate the message is encoded as SOAP 1.1.  Lines (07) and (09) are elements with base64encoded binary data.  For purposes of this example, both of these blocks of data will be optimized.

Table 2: Infoset serialized as a XOP package (Example 2, SOAP 1.1)

(13) MIME-Version: 1.0
(14) Content-Type: Multipart/Related;boundary=MIME_boundary;
(15)     type="application/xop+xml";
(16)     start="<mymessage.xml@example.org>";
(17)     start-info="text/xml"
(18) Content-Description: A SOAP message with my pic and sig in it
(19) SOAPAction: "http://example.org/action/data"
(20)  
(21) --MIME_boundary
(22) Content-Type: application/xop+xml; 
(23) charset=UTF-8; 
(24)     type="text/xml"
(25) Content-Transfer-Encoding: 8bit
(26) Content-ID: <mymessage.xml@example.org>
(27) 
(28) <s11:Envelope
(29)     xmlns:s11='http://schemas.xmlsoap.org/soap/envelope/'
(30)     xmlns:xmime='http://www.w3.org/2005/05/xmlmime'>
(31)   <s11:Body>
(32)     <m:data xmlns:m='http://example.org/stuff'>
(33)      <m:photo 
(34)          xmime:contentType='image/png'><xop:Include
(35)          xmlns:xop='http://www.w3.org/2004/08/xop/include'
(36)          href='cid:me.png@example.org'/></m:photo>
(37)        <m:sig
(38)          xmime:contentType='application/pkcs7-signature'><xop:Include
(39)          xmlns:xop='http://www.w3.org/2004/08/xop/include'
(40)          href='cid:my.hsh@example.org'/></m:sig>
(41)      </m:data>
(42)   </s11:Body>
(43) </s11:Envelope>
(44)  
(45) --MIME_boundary
(46) Content-Type: image/png
(47) Content-Transfer-Encoding: binary
(48) Content-ID: <me.png@example.org>
(49)  
(50) // binary octets for png
(51)  
(52) --MIME_boundary
(53) Content-Type: application/pkcs7-signature
(54) Content-Transfer-Encoding: binary
(55) Content-ID: <my.hsh@example.org>
(56)  
(57) // binary octets for signature
(58)  
(59) --MIME_boundary--
(60)  

Lines (17) and (24) in Table  show the media type “text/xml” as required by SOAP 1.1.  Lines (28-43) illustrate SOAP 1.1 envelope.  Other parts of this package are identical to those one would find in a XOP package for a SOAP 1.2 envelope.

2.1 XML Namespaces

Table 3 lists XML namespaces that are used in this specification. The choice of any namespace prefix is arbitrary and not semantically significant.

Table 3: Prefixes and XML Namespaces used in this specification.

2.2 Notational Conventions

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC 2119].

2.3 Compliance

Normative text within this specification takes precedence over outlines, which in turn take precedence over examples.

3.1 Serialization of a SOAP 1.1 message

When sending a SOAP 1.1 message using the MIME Multipart/Related Serialization, the SOAP envelope Infoset is serialized into XML 1.0 as specified in [XOP] 3.1 Creating XOP packages. Specifically:

• The content-type of the outer package MUST be multipart/related.
• The type parameter of the content-type header of the outer package MUST have a value of application/xop+xml (see [XOP], 4.1 MIME Multipart/Related XOP Packages).
• The start-info parameter of the content-type header of the outer package MUST specify a content-type for the root part of text/xml.
• The content-type of the root part MUST be application/xop+xml (see [XOP], 4.1 MIME Multipart/Related XOP Packages).
• The type parameter of the content-type header of the root part MUST specify a content-type of text/xml.

The result is a MIME Multipart/Related XOP package (see [XOP]): one body part, the root, containing an XML 1.0 representation of the modified SOAP 1.1 envelope, with an additional part used to contain the binary representation of each element that was optimized.

This section corresponds to, and supercedes, [MTOM] 3.2 Serialization of a SOAP message which describes similar treatment for SOAP 1.2.

3.2 Sending a SOAP 1.1 message over HTTP