Uploading files with Web services

Digg This!     StumbleUpon     Del.icio.us

RELATED CONTENT Microsoft .NET Web services How do I balance throughput requirements and interoperability? APM software traces transactions across tiers, technologies How you can learn M Grammar for Oslo modeling Legacy modernization opens Windows for publisher Former .NET Web developers ride Ruby and Rails application framework Microsoft Oslo at PDC: Dial 'M' for modeling language Yahoo proxy fight looms New Microsoft site for architects LAMP coders go hybrid route Silverlight shines on bank RIAs Microsoft .NET Web services Research

RELATED GLOSSARY TERMS Terms from Whatis.com − the technology online dictionary Common Language Infrastructure  (SearchSOA.com) Visual J#  (SearchSOA.com)

RELATED RESOURCES 2020software.com, trial software downloads for accounting software, ERP software, CRM software and business software systems Search Bitpipe.com for the latest white papers and business webcasts Whatis.com, the online computer dictionary

A simple SOAP message sent over HTTP protocol usually has a content type of "text/xml". Although you could include a binary attachment as a parameter to a Web service method call, this carries overhead since the data is encoded as xs:base64 or xs:hexbinary (embedded or referenced), adding bloat to the message. Furthermore, it is inefficient for XML parsers to resolve these references, and unwrap the attachment while parsing the SOAP message. To address this several standards emerged for handling SOAP message attachments. SOAP with Attachments is the original W3C recommendation to define how SOAP messages are carried within a MIME "multipart/related" message, as a compound SOAP document. The first MIME part is the SOAP envelope, subsequent parts contain attachments. SOAP with Attachments addressed the problem of reducing payload overhead, but did not provide a formal way to associate attachments with the SOAP message.

DIME and WS-Attachments specifications evolved to improve on this. DIME is similar to MIME, but is an alternate binary message format that supports the compilation of a message with arbitrary types. Rather than a content type "multipart/related" it is packaged as "application/dime" so that those receiving the message can parse it accordingly. WS-Attachments describes how to encapsulate SOAP message in DIME.

To ultimately answer your question, the Web services toolkits support adding attachments to SOAP messages using an object model, so that you are abstracted from the details of populating HTTP headers and building the compound SOAP message. Thanks to the generation of Web service proxies, in a few lines of code you can create a DIME attachment from a binary stream, attach it to the outgoing attachments collection, and invoke the Web service method, as shown here for a .NET Web service.

DimeAttachment attachment =
                new DimeAttachment("image/jpeg",
                TypeFormatEnum.MediaType,
                data);
svc.RequestSoapContext.Attachments.Add(attachment);
svc.SignAttachment(text);