(Tcl) SOAP with MTOM XOP Attachment

Demonstrates how to send the following sample SOAP request with an MTOM/XOP attachment:

Content-Type: Multipart/Related; start-info="text/xml"; type="application/xop+xml"; boundary="----=_Part_0_1744155.1118953559416"
Content-Length: 3453
SOAPAction: "some-SOAP-action"

------=_Part_1_4558657.1118953559446
Content-Type: application/xop+xml; type="text/xml"; charset=utf-8

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Detail xmlns="http://example.org/mtom/data">
      <image>
        <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org" />
      </image>
    </Detail>
  </soap:Body>
</soap:Envelope>

------=_Part_1_4558657.1118953559446
Content-Type: image/jpeg
Content-ID: <5aeaa450-17f0-4484-b845-a8480c363444@example.org>


... binary data ...

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

set soapXml [new_CkXml]

CkXml_put_Tag $soapXml "soap:Envelope"
set success [CkXml_AddAttribute $soapXml "xmlns:soap" "http://schemas.xmlsoap.org/soap/envelope/"]

CkXml_NewChild2 $soapXml "soap:Body" ""
set success [CkXml_GetChild2 $soapXml 0]

CkXml_NewChild2 $soapXml "Detail" ""
set success [CkXml_GetChild2 $soapXml 0]
set success [CkXml_AddAttribute $soapXml "xmlns" "http://example.org/mtom/data"]

CkXml_NewChild2 $soapXml "image" ""
set success [CkXml_GetChild2 $soapXml 0]

CkXml_NewChild2 $soapXml "xop:Include" ""
set success [CkXml_GetChild2 $soapXml 0]
set success [CkXml_AddAttribute $soapXml "xmlns:xop" "http://www.w3.org/2004/08/xop/include"]
set success [CkXml_AddAttribute $soapXml "href" "cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org"]

CkXml_GetRoot2 $soapXml
CkXml_put_EmitXmlDecl $soapXml 0

set xmlBody [CkXml_getXml $soapXml]
puts "$xmlBody"

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/something/someTarget"

CkHttpRequest_put_ContentType $req "multipart/related; start-info=\"text/xml\"; type=\"application/xop+xml\""
CkHttpRequest_AddHeader $req "SOAPAction" "some-SOAP-action"

set success [CkHttpRequest_AddStringForUpload2 $req "" "" $xmlBody "utf-8" "application/xop+xml; type=\"text/xml\"; charset=utf-8"]

# The bytes will be sent as binary (not base64 encoded).
set success [CkHttpRequest_AddFileForUpload2 $req "" "qa_data/jpg/starfish.jpg" "image/jpeg"]

# The JPEG data is the 2nd sub-part, and therefore is at index 1 (the first sub-part is at index 0)
set success [CkHttpRequest_AddSubHeader $req 1 "Content-ID" "<5aeaa450-17f0-4484-b845-a8480c363444@example.org>"]

CkHttp_put_FollowRedirects $http 1

# For debugging, set the SessionLogFilename property
# to see the exact HTTP request and response in a log file.
# (Given that the request contains binary data, you'll need an editor
# that can gracefully view text + binary data.  I use EmEditor for most simple editing tasks..)
CkHttp_put_SessionLogFilename $http "qa_output/mtom_sessionLog.txt"

set useTls 1
# Note: Please don't run this example without changing the domain to your own domain...
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "www.example.org" 443 $useTls $req]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkXml $soapXml
    delete_CkHttpRequest $req
    exit
}

set xmlResponse [new_CkXml]

set success [CkXml_LoadXml $xmlResponse [CkHttpResponse_bodyStr $resp]]
puts [CkXml_getXml $xmlResponse]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkXml $soapXml
delete_CkHttpRequest $req
delete_CkXml $xmlResponse