SOAP Web Service WSDL Week 14 Web site

SOAP, Web Service, WSDL Week 14 Web site: http: //fog. ccsf. edu/~hyip

Usage of XML • Ajax • Web Service, WSDL • SOAP

Web Service • A Web Service is a set of functions that can be accessed and executed over a network. While generic in its definition, a Web Service usually refers to the exchange of XML messages using the SOAP framework. • SOAP’s core functionality is to support this exchange of XML messages from one application to another. SOAP is a lightweight protocol because, for the most part, a SOAP message is basically an XML file in a SOAP wrapper. And, this wrapper, often referred to as the SOAP envelope, adds very little overhead to the messaging process. • The exchange of SOAP messages is most frequently done over the Internet via HTTP. A client application sends a SOAP message as an HTTP request, and the server sends back its SOAP message as an HTTP response. Because the SOAP message exchange works using HTTP, it allows for easier communication between computers on different networks. This is one of the biggest advantages of using SOAP over other remote communication frameworks.

Sample of Web Service • Web Service – Hello § Function say. Hello. To. World …

Simple Object Access Protocol (SOAP) • SOAP version 1. 2 is an XML-based messaging framework. • SOAP supports server-to-server communication. • Specifically, it allows for platform- and language-independent communication between different applications, typically running on different servers.

SOAP Message Schema • The SOAP framework is based on the XML language, which means that all the rules about writing XML documents apply to SOAP messages. • The root element of a SOAP message is the Envelope element. It must declare the SOAP namespace, which defines the elements and attributes of a SOAP message. • A SOAP message has an optional Header element which, if present, must be the first immediate child of the Envelope element. It allows application -specific communication between the client and the server, beyond the actual SOAP message itself. • The Body element is a required child element of the Envelope element and contains the actual SOAP message content. In a request message, the Body element’s children correspond to the operation being called, and its grandchildren correspond to the operation’s parameters. In a response message, the word “Response” is typically appended to the Body element’s children (the operation elements) and its grandchildren are the operation’s result values.

SOAP request • (request. xml) This SOAP request message is calling the procedure say. Hello and passing the name parameter with the value “Kevin”. <? xml version="1. 0"? > <soap: Envelope xmlns: soap="http: //www. w 3. org/2003/05/soapenvelope"> <soap: Body xmlns: s="http: //www. xyz. com/ns/hello"> <s: say. Hello> <s: name>Kevin</s: name> </s: say. Hello> </soap: Body> </soap: Envelope>

SOAP response • (response. xml) This SOAP message is the response to the request message above. It is returning the result of the say. Hello procedure, using the say. Hello. Response element. <? xml version="1. 0" encoding="utf-8"? > <soap: Envelope xmlns: soap="http: //www. w 3. org/2003/05/soap-envelope" xmlns: xsi="http: //www. w 3. org/2001/XMLSchema-instance" xmlns: xsd="http: //www. w 3. org/2001/XMLSchema"> <soap: Body xmlns: s="http: //www. xyz. com/ns/hello"> <s: say. Hello. Response> <s: say. Hello. Result>Hello Kevin, How are you? </s: say. Hello. Result> </s: say. Hello. Response> </soap: Body> </soap: Envelope>

The HTTP Protocol • HTTP communicates over TCP/IP. An HTTP client connects to an HTTP server using TCP. After establishing a connection, the client can send an HTTP request message to the server: POST /item HTTP/1. 1 Host: 189. 123. 255. 239 Content-Type: text/plain Content-Length: 200

The HTTP Protocol (continue…) • The 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 request: 200 OK Content-Type: text/plain Content-Length: 200

SOAP Binding • The SOAP specification defines the structure of the SOAP messages, not how they are exchanged. This gap is filled by what is called "SOAP Bindings". SOAP bindings are mechanisms which allow SOAP messages to be effectively exchanged using a transport protocol. • Most SOAP implementations provide bindings for common transport protocols, such as HTTP or SMTP. • HTTP is synchronous and widely used. A SOAP HTTP request specifies at least two HTTP headers: Content-Type and Content. Length. • SMTP is asynchronous and is used in last resort or particular cases. • Java implementations of SOAP usually provide a specific binding for the JMS (Java Messaging System) protocol.

A SOAP example with HTTP • In the example below, a say. Hello request is sent to a server. The request has a Name parameter, and a say. Hello. Result parameter that will be returned in the response. The namespace for the function is defined in "http: //www. xyz. com/ns/hello".

A SOAP request POST /Hello HTTP/1. 1 Host: www. example. org Content-Type: application/soap+xml; charset=utf-8 Content-Length: nnn <? xml version="1. 0"? > <soap: Envelope xmlns: soap="http: //www. w 3. org/2003/05/soap-envelope"> <soap: Body xmlns: s="http: //www. xyz. com/ns/hello"> <s: say. Hello> <s: name>Kevin</s: name> </s: say. Hello> </soap: Body> </soap: Envelope>

The SOAP response HTTP/1. 1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: nnn <? xml version="1. 0" encoding="utf-8"? > <soap: Envelope xmlns: soap="http: //www. w 3. org/2003/05/soap-envelope" xmlns: xsi="http: //www. w 3. org/2001/XMLSchema-instance" xmlns: xsd="http: //www. w 3. org/2001/XMLSchema"> <soap: Body xmlns: s="http: //www. xyz. com/ns/hello"> <s: say. Hello. Response> <s: say. Hello. Result>Hello Kevin, How are you? </s: say. Hello. Result> </s: say. Hello. Response> </soap: Body> </soap: Envelope>

Web Services Description Language (WSDL) • WSDL is an XML language for describing how to interface with Web Services. Where SOAP provides the message exchange framework for a Web Service, WSDL documents the messages that can be sent. • WSDL is not needed for the exchange of Web Service messages – this can happen using SOAP exclusively. However, with WSDL, requesting applications are given technical information abut the Web Service which supports an easier, more automated, and less error prone exchange.

WSDL Schema • • • A WSDL document is an XML document, and its root element is definitions. The definitions elements has five major child elements (in sequence): types, message, port. Type, binding, and service. The center hub of them all is the port. Type element. It describes the available operations and the messages each expects. It is the equivalent of a description of the application’s library, and each operation contains the equivalent of a list of specific function calls. The types and message elements work hand in hand. The message element identifies the messages each operation expects, and the parameters each message will contain. These parameters reference the elements defined for your Web Service, and their definitions are found in the types element. The binding element defines the transport protocol of the SOAP message exchange (which is typically done via HTTP, but can be done via SMTP, FTP, or other transport protocols). Then, for each named operation, you define how the messages appear inside the SOAP body element. Finally, the service element puts together the pieces of the Web service by connecting the port. Type with the binding. And it identifies the public URI of the Web Service itself.

WSDL Document <definitions> <types> data type definitions. . . . </types> <message> definition of the data being communicated. . </message> <port. Type> set of operations. . . </port. Type> <binding> protocol and data format specification. . </binding> </definitions>

WSDL Sample <definitions> <message name="say. Hello. Request"> <part name="name" type="xs: string"/> </message> <message name="say. Hello. Response"> <part name="say. Hello. Result" type="xs: string"/> </message> <port. Type name="Hello"> <operation name="say. Hello"> <input message="say. Hello. Request"/> <output message="say. Hello. Response"/> </operation> </port. Type> </definitions>

WSDL Binding to SOAP <definitions> <message name="say. Hello. Request"> <part name="name" type="xs: string"/> </message> <message name="say. Hello. Response"> <part name="say. Hello. Result" type="xs: string"/> </message> <port. Type name="Hello"> <operation name="say. Hello"> <input message="say. Hello. Request"/> <output message="say. Hello. Response"/> </operation> </port. Type> <binding type=“Hello" name="b 1"> <soap: binding style="document" transport="http: //schemas. xmlsoap. org/soap/http" /> <operation> <soap: operation soap. Action="http: //example. com/say. Hello"/> <input><soap: body use="literal"/></input> <output><soap: body use="literal"/></output> </operation> </binding> </definitions>

References • XML: Visual Quick. Start Guide, 2 nd Edition, by Kevin Howard Goldberg, Peachpit Press, ISBN 0321559673 • http: //www. w 3 schools. com/