This document discusses Simple Object Access Protocol (SOAP). SOAP allows applications to exchange information over HTTP and is independent of platform and language. A SOAP message contains an envelope, header, body, and optional fault. The envelope defines the message as SOAP. The header contains application-specific metadata. The body contains the call and response. Fault indicates any errors. SOAP uses HTTP for transport and is XML-based, allowing it to penetrate firewalls.

1. Simple Object Access Protocol (SOAP)Enterprise Modeling3/16/20091

2. Team MembersV. DinushaS. SaatvigaS.Y.Y.D. WickramasingheD. Wijethilake3/16/20092

3. Contents3/16/20093IntroductionSOAPSOAP ElementsSOAP SyntaxSOAP EnvelopeSOAP HeaderSOAP BodySOAP FaultSOAP Http BindingExampleConclusionReference

4. Introduction3/16/20094SOAP is a communication protocol Lets applications exchange information over HTTP. Communication between applications via internetFormat for sending messages IndependencePlatform Language Based on XML, yet simple and extensibleToday’s Apps Communicate using RPC (DCOM , CORBA)RPC represents a compatibility and security problem. firewalls and proxy servers will normally block this kind of traffic. Better way is to communicate through HTTP that is supported by all Internet browsers and servers.

5. SOAP Elements3/16/20095A SOAP message is an ordinary XML DocumentEnvelope - Identifies the XML document as a SOAP messageHeader - Contains header informationBody - Contains call and response informationFault - Contains errors and status information

6. SOAP Syntax3/16/20096A SOAP message MUST Be encoded using XMLUse the SOAP Envelope namespaceUse the SOAP Encoding namespaceNot contain a DTD referenceNOT contain XML Processing InstructionsSkeleton SOAP Message<?xml version="1.0"?> <soap:Envelope xmlns:soap=http://www.w3.org/2001/12/soap-envelope soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding"><soap:Header> ….. </soap:Header> <soap:Body><soap:Fault> ... ... </soap:Fault> </soap:Body></soap:Envelope>

7. SOAP Envelope3/16/20097The root element of a SOAP messageDefines the XML document as a SOAP messagexmlns:soap NamespaceDefines the Envelope as a SOAP Envelope. Different namespace The application generates an error Discards the messageencodingStyle AttributeDefines the data types used in the document.May appear on any SOAP elementWill apply to element's contents and all child elementsA SOAP message has No default encoding<?xml version="1.0"?> <soap:Envelopexmlns:soap="http://www.w3.org/2001/12/soap-envelope" soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding"> ... Message information goes here ... </soap:Envelope>

8. SOAP Header3/16/20098Optional & If present - Must be the first child element of the EnvelopeApplication-specific information of the SOAP Message Authentication, Payment, etc.All immediate child elements of Header must be namespace-qualifiedAttributes – Defines how a recipient should process the SOAP messagemustUnderstand AttributeIs Header entry Mandatory/Optional for the recipient to process?<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope" soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding"> <soap:Header> <m:Trans xmlns:m="http://www.w3schools.com/transaction/" soap:mustUnderstand="1“ >234 </m:Trans> </soap:Header> ... ...</soap:Envelope>

9. SOAP Header cont.3/16/20099actorAttributeAddresses the Header element to a specific endpointencodingStyleAttributeDefines data types used in the documentMay appear on any SOAP elementWill apply to that element's contents and all child elementsA SOAP message has no default encoding<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope" soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding"> <soap:Header> <m:Trans xmlns:m="http://www.w3schools.com/transaction/" soap:actor="http://www.w3schools.com/appml/" >234 </m:Trans> </soap:Header> ... ...</soap:Envelope>

10. SOAP Header cont.3/16/200910actorAttributeAddresses the Header element to a specific endpointencodingStyleAttributeDefines data types used in the documentMay appear on any SOAP elementWill apply to that element's contents and all child elementsA SOAP message has no default encodingsoap:encodingStyle="URI" <?xml version="1.0"?> <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope" soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding"> <soap:Header> <m:Trans xmlns:m="http://www.w3schools.com/transaction/" soap:actor="http://www.w3schools.com/appml/" >234 </m:Trans> </soap:Header> ... ...</soap:Envelope>

11. SOAP Body3/16/200911The actual SOAP message for the ultimate endpoint of the messageImmediate child elements may be namespace-qualifiedRequestResponse<?xml version="1.0"?> <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope" soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding"><soap:Body> <m:GetPrice xmlns:m="http://www.w3schools.com/prices"> <m:Item>Apples</m:Item> </m:GetPrice> </soap:Body></soap:Envelope> <?xml version="1.0"?> <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope" soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding"><soap:Body> <m:GetPriceResponse xmlns:m="http://www.w3schools.com/prices"> <m:Price>1.90</m:Price> </m:GetPriceResponse> </soap:Body></soap:Envelope>

12. SOAP Fault3/16/200912Optional yet indicates Error MessagesMust appear as a child element of the Body Can only appear once in a SOAP messageSub elements:<faultcode>  Code for identifying the fault VersionMismatchFound  An invalid namespace for the SOAP Envelope MustUnderstand Immediate Header child element not understood (mustUnderstand -"1") Client Message was incorrectly formed /contained incorrect infoServer Message not proceed due to server error<faultstring>  A human readable explanation of the fault<faultactor> Who caused the fault <detail>  Application specific error information related to the Body

13. SOAP Http Binding3/16/200913HttpHTTP communicates over TCP/IPAn HTTP client connects to an HTTP server using TCPAfter establishing a connection, client can send an HTTP request to serverThe server then processes the request and sends an HTTP response back to the client.The response contains a status code that indicates the status of the requestIf the server could not decode the request, it could have returned an error messagePOST /item HTTP/1.1 Host: 189.123.345.239 Content-Type: text/plain Content-Length: 200200 OK Content-Type: text/plain Content-Length: 200400 Bad Request Content-Length: 0

14. SOAP Http Binding cont.3/16/200914SOAP = HTTP + XMLA SOAP method HTTP request/response Complies with the SOAP encoding rulesA SOAP request HTTP POST (Specifies at least two HTTP headers [Type, Length])HTTP GETContent-TypeOptional MIME type for the message Character encoding (used for the XML body of the request/response)Content-LengthThe number of bytes in the body of the request/responsePOST /item HTTP/1.1 Content-Type: application/soap+xml; charset=utf-8 Content-Length: 250

15. SOAP Http Binding cont.3/16/200915SOAP = HTTP + XMLA SOAP method HTTP request/response Complies with the SOAP encoding rulesA SOAP request HTTP POST (Specifies at least two HTTP headers [Type, Length])HTTP GETContent-TypeOptional MIME type for the message Character encoding (used for the XML body of the request/response)Content-LengthThe number of bytes in the body of the request/responsePOST /item HTTP/1.1 Content-Type: application/soap+xml; charset=utf-8 Content-Length: 250

16. Exampleimport java.util.Calendar;import java.util.GregorianCalendar;import javax.jws.WebService;@WebService(name = "GetDatesWS", serviceName = "GetDatesWS")public class GetDates { public GetDates() { } public Calendar getDate() { return Calendar.getInstance(); } public Calendar getDateHence( intdaysHence) { GregorianCalendarmyCalendar = new GregorianCalendar(); myCalendar.add(GregorianCalendar.DATE, daysHence); return myCalendar; } }

17. SOAP Binding

18. GetDate()<soap:Envelopexmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body xmlns:ns1="http://datespackage/"> <ns1:getDate/> </soap:Body> </soap:Envelope>

19. Invoke GetDate()<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns0="http://datespackage/"> <env:Body> <ns0:getDateResponse> <ns0:return>2009-03-16T20:05:24.578+05:30</ns0:return> </ns0:getDateResponse> </env:Body></env:Envelope>

20. GetDateHence(intnoOfDays)<soap:Envelopexmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body xmlns:ns1="http://datespackage/"> <ns1:getDateHence> <ns1:daysHence> 5 </ns1:daysHence> </ns1:getDateHence> </soap:Body> </soap:Envelope>

21. Invoke GetDateHence(intnoOfDays)<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns0="http://datespackage/"> <env:Body> <ns0:getDateHenceResponse> <ns0:return>2009-03-21T20:09:41.531+05:30</ns0:return> </ns0:getDateHenceResponse> </env:Body></env:Envelope>

22. Conclusion3/16/200922SOAP is a communication protocolSOAP = Http + XMLPlatform & Language IndependentAble to penetrate firewallsElements:EnvelopeHeaderBodyFault

23. Reference3/16/200923http://www.w3schools.com/soap/default.asphttp://www.onjava.com/pub/a/onjava/2002/02/27/tomcat.html?page=1http://www.scottnichol.com/apachesoapinstall.htmhttp://www.oracle.com/technology/obe/obe1013jdev/ws/wsandascontrol.htm

24. Thank You !3/16/200924