User:Ben Babcock/Cleanup Taskforce/SOAP

This page is no longer active. For the most recent version, please see SOAP.
This article is about a computer protocol. For the common cleaning mixture, see Soap. For other uses of the acronym SOAP, see Soap (disambiguation).

SOAP is a standard for exchanging XML-based messages over a computer network, normally using HTTP. SOAP forms the foundation layer of the web services stack, providing a basic messaging framework that more abstract layers can build on.

There are several different types of messaging patterns in SOAP, but by far the most common is the Remote Procedure Call (RPC) pattern, where one network node (the client) sends a request message to another node (the server), and the server immediately sends a response message to the client.

Overview

edit

SOAP originally was an acronym for Simple Object Access Protocol, but the acronym was dropped in Version 1.2 of the SOAP specification. Originally designed by Dave Winer, Don Box, Bob Atkinson, and Mohsen Al-Ghosein in 1998 with backing from Microsoft (where Atkinson and Al-Ghosein worked at the time), the SOAP specification is currently maintained by the XML Protocol Working Group of the World Wide Web Consortium.

Transport methods

edit

HTTP was chosen as the primary transport protocol for SOAP since it works well with today's Internet infrastructure, specifically, SOAP works well with network firewalls. This is a major advantage over other distributed protocols like GIOP/IIOP or DCOM which are normally filtered by firewalls.

XML was chosen as the standard message format because of its widespread acceptance by major corporations and open source development efforts. Additionally, a wide variety of freely available tools significantly ease the transition to a SOAP-based implementation.

The somewhat lengthy syntax of XML can be both a benefit and a drawback. Its format is easy for humans to read, but can be complex and slow down processing times. For example, GIOP and DCOM use much shorter, binary message formats. On the other hand, hardware appliances are available to accelerate processing of XML messages. "XML Binary" is also being explored as a means for streamlining the throughput requirements of raw (text) XML.

Structure of a SOAP message

edit

A SOAP message is contained in an envelope. Within this envelope are two additional sections: the header and the body of the message. SOAP messages use XML namespaces.

The header contains relevant information about the message. For example, a header can contain the date the message is sent, or authentication information. It is not required, but must always be included at the top of the envelope when it is present.

Example SOAP messages

edit

Here is an example of how a client might format a SOAP message requesting product information from a fictional warehouse web service:

 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
     <getProductDetails xmlns="http://warehouse.example.com/ws">
       <productId>827635</productId>
     </getProductDetails>
   </soap:Body>
 </soap:Envelope>

Here is how the warehouse web service might format its reply message with the requested product information:

 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
     <getProductDetailsResponse xmlns="http://warehouse.example.com/ws">
       <getProductDetailsResult>
         <productName>Toptimate 3-Piece Set</productName>
         <productId>827635</productId>
         <description>3-Piece luggage set.  Black Polyester.</description>
         <price>96.50</price>
         <inStock>true</inStock>
       </getProductDetailsResult>
     </getProductDetailsResponse>
   </soap:Body>
 </soap:Envelope>

See also

edit
edit

Alternatives to SOAP

edit
edit