Web Services - Concepts, Architecture and Applications Part 6: Service Description (WSDL)

Transcription

1 Web Services - Concepts, Architecture and Applications Part 6: Service Description (WSDL) Gustavo Alonso and Cesare Pautasso Computer Science Department ETH Zürich alonso@inf.ethz.ch Some slides were modified or added by: Nilufer Onder Computer Science Department Michigan Technological University

2 What is WSDL? Web Services Description Language (WSDL) is an XML format for describing network services as a set of endpoints operating on messages containing either document-oriented or procedure-oriented communication. ( The original document was prepared by Ariba, IBM, and Microsoft. The Web Services Description Language specification is in working draft 2.0 (November 2003, June 2007) WSDL discusses how to describe the different parts that comprise a Web service. A WSDL document defines services as collections of network endpoints, or ports. The general framework is to store WSDL descriptions where potential clients can find the services they need ETH Zürich Part 6: WSDL 2

3 WSDL definitions In WSDL, abstract definition of endpoints and messages is separated from their concrete network deployment or data format bindings Abstract definition Types: a container for data type definitions (e.g., using XSD) Message: a typed definition of the data being communicated Operation: description of an action supported by the service Port type: set of operations supported by one or more endpoints Concrete description Binding: protocol and data format specification for a particular port type Port: a single endpoint defined as a combination of a binding and a network address Service: a collection of related endpoints ETH Zürich Part 6: WSDL 3

4 Elements of WSDL WSDL document Types (type information for the document, e.g., XML Schema) Message 1 Message 2 Message 3 Message 4 Operation 1 Operation 2 Operation 3 Interface (abstract service) Message 5 Message 6 Abstract description of the service binding 1 endpoint 1 binding 2 endpoint 2 binding 3 endpoint 3 Service (the interface in all its available implementations) binding 4 endpoint 4 Concrete description of the service ETH Zürich Part 6: WSDL 4

5 WSDL Example From: Web Services Description Language (WSDL)1.1. W3C Note 15 March 2001 <?xml version= 1.0?> <definitions name= StockQuote Targetnamespace= Xmlns:tns= Xmlns:xsdl= Xmlns:soap= Xmlns= /> ETH Zürich Part 6: WSDL 5

6 WSDL Example - Types From: Web Services Description Language (WSDL)1.1. W3C Note 15 March 2001 <types> <schema targetnamespace= xmlns= <element name= TradePriceRequest > <complextype> <all> <element name= tickersymbol type= string /> </all> </complextype> </element> <element name= TradePrice > <complextype> <all> <element name= price type= float /> </all> </complextype> </element> </schema> </types> ETH Zürich Part 6: WSDL 6

7 Types in WSDL The types in WSDL are used to specify the contents of the messages (normal messages and fault messages) that will be exchanged as part of the interactions with the Web service The type system is typically based on XML Schema (structures and data types) - support is mandatory for all WSDL processors An extensibility element can be used to define a schema definition language other than XML Schema ETH Zürich Part 6: WSDL 7

8 WSDL Example - Messages From: Web Services Description Language (WSDL)1.1. W3C Note 15 March 2001 <message name= GetLastTradePriceInput > <part name= body element= wsdl:tradepricerequest /> </message> <message name= GetLastTradePriceOutput > <part name= body element= wsdl:tradeprice /> </message> ETH Zürich Part 6: WSDL 8

9 Messages and Faults Called message reference component, it contains three elements: message reference: indicating the message pattern used for this message direction: whether it is an inbound or outbound message message: the actual contents of the message expressed in terms of the types previously defined Messages are divided into parts, each of them being a data structure represented in XML. Each part must have a type (basic or complex types, previously declared in the WSDL document). If a SOAP binding is used, a WSDL message element is meant to match the contents of the body of a SOAP message. By looking at the types and looking at the message, it is possible to build a SOAP message that matches the WSDL description (and this can be done automatically since the description is XML based and the types also supported by SOAP) Called the fault reference component, it contains: a name message reference: the message to which the fault refers to direction: whether the fault is inbound or outbound message: the actual contents ETH Zürich Part 6: WSDL 9

10 WSDL Example Operation and Port From: Web Services Description Language (WSDL)1.1. W3C Note 15 March 2001 <porttype name= StockQuotePortType > <operation name= GetLastTradePrice > <input message= tns:getlasttradepriceinput /> <output message= tns:getlasttradepriceoutput /> </operation> </porttype> ETH Zürich Part 6: WSDL 10

11 Operations An operation is a set of messages and faults. The sequencing and number of messages in the operation is determined by the message exchange pattern (would add a line containing <fault message= to the operation) An operation has: name message exchange pattern message references: the messages involved (input, output) fault references: the faults involved (infault, outfault) style (optional): RPC, setattribute or get-attribute features and properties Style: RPC = implies interactions mirroring the behavior of RPC set- and get- attribute = implies interactions of the type commonly found in object oriented languages Features and properties: used to specified characteristics of the message exchange implied by an operation. Examples include reliability, security, routing, etc ETH Zürich Part 6: WSDL 11

12 WSDL Example Binding From: Web Services Description Language (WSDL)1.1. W3C Note 15 March 2001 <binding name= StockQuoteSoapBinding type= tns:stockquoteporttype > <soap:binding style= document transport= /> <operation name= GetLastTradePrice > <soap:operation soapaction= /> <input> <soap:body use= literal /> </input> <output> <soap:body use= literal /> </output> </operation> </binding> ETH Zürich Part 6: WSDL 12

13 Bindings and ports A binding defines message formats and protocol details for the operations and messages of a given Port Type A binding corresponds to a single Port Type (obvious since it needs to refer to the operations and messages of the Port Type) A Port Type can have several bindings (thereby providing several access channels to the same abstract service) The binding is extensible with elements that allow to specify mappings of the messages and operations to any format or transport protocol. In this way WSDL is not protocol specific. A port specifies the address of a binding, i.e., how to access the service using a particular protocol and format Ports can only specify one address and they should not contain any binding information The port is often specified as part of a service rather than on its own ETH Zürich Part 6: WSDL 13

14 WSDL Example Service From: Web Services Description Language (WSDL)1.1. W3C Note 15 March 2001 <service name= StockQuoteService > <documentation>my first service</documentation> <port name= StockQuotePort binding= tns:stockquotebinding > <soap:address location= /> </port> </service> </definitions> ETH Zürich Part 6: WSDL 14

15 Bindings, endpoints, and services A binding describes a concrete message format and transmission protocol for a given endpoint A binding can be generic or refer to a concrete interface A binding can be defined for an entire interface or on an operation basis A binding has: name interface: the interface to which this binding applies operations: a set of binding operation components features and properties A binding operation component specifies the binding for a given operation: name: the operation for which the binding applies message references fault references The binding operation component contains message and fault bindings for all messages and faults of an operation An endpoint associates an address to a given binding A service groups together all the endpoints for a given interface The specification includes bindings for HHTP, SOAP and MIME (the latter may eventually be dropped) ETH Zürich Part 6: WSDL 15

16 Message exchange patterns IN-ONLY a single incoming message (A) with no faults ROBUST IN-ONLY an inbound message (A) that might trigger a fault message IN-OUT An incoming message (A) received from node N An outgoing message (B) sent to node N Faults, if any, replace message B IN-MULTI-OUT Like IN-OUT but with zero or more outbound messages and fault replaces message behavior OUT-ONLY An outbound message (A) that expects no faults ROBUST OUT-ONLY An outbound message (A) that might trigger a fault OUT-IN An outbound message (A) to node N An inbound message (B) from node N Faults, if any, replace message B ASYNCHRONOUS OUT-IN Like OUT-IN but with trigger behavior for messages OUT-MULTI-IN reverse of IN-MULTI-OUT ETH Zürich Part 6: WSDL 16

17 Interfaces in WSDL 2.0 An interface defines the messages a service sends or receives by grouping the messages into operations An interface can extend the operations of other interfaces (inheritance) An interface has: name extended interfaces: other interfaces that this one extends style default: default style for operations operations features and properties An interface corresponds to the abstract description of the Web service, it does not contain any information about where the service resides or what protocols are used to invoke the Web service ETH Zürich Part 6: WSDL 17

18 WSDL 1.1 vs WSDL 2.0 WSDL 2.0 Endpoints Interfaces Support for Interface inheritance Ports PortTypes WSDL 1.1 Removed operation overloading Supported operation overloading Messages defined through Types Operations nested inside Interfaces Endpoints nested inside Bindings Messages composed of Parts 6 Top level elements: Messages, Operations, PortTypes, Bindings, Ports and Services. 9 Message Exchange Patterns New: Features and Properties 4 Transmission Primitives (One-way, Request-Response, Solicit-Response, Notification) ETH Zürich Part 6: WSDL 18

19 On the use of WSDL ETH Zürich Part 6: WSDL 19

20 Potential Uses of WSDL Traditional service description language: a contract that a Web service implements Input to stub compilers: will generate required stubs and additional information for developing both the service and the clients (allow designers to reason about the semantics of a Web service. However, semantics is outside the scope of current WSDL specifications.) ETH Zürich Part 6: WSDL 20

21 Conversations WSDL is in its current version an extension of the IDL model to support interaction through the Internet: XML as syntax and type system possibility of grouping operations into a service different options for accessing the service (addresses and protocols) This is its great advantage it is straightforward to adapt existing middleware platforms to use or support WSDL automatic translation from existing IDLs to WSDL is trivial but also the disadvantage electronic commerce and B2B interactions are not single service calls WSDL does not reflect the structure of the procedures to follow to correctly interact with a service (conversations) business protocol = set of valid conversations Without a business protocol, most of the development work is still manual ETH Zürich Part 6: WSDL 21

22 Using Workflows with ebxml BEA CONVERSATIONS ETH Zürich Part 6: WSDL 22

23 Conversations (example) The xcbl 3.5 ChangeOrder document is a buyer-initiated document that can be used to change an existing Order already received and responded to by a seller. The document can be used to make changes to header level information, change line items, cancel line items, add line items, etc. Note that if an OrderResponse has not been received for a given Order, a ChangeOrder is not necessary (an Order with a purpose of Replace should be used). Similarly, if an entire order is to be cancelled (regardless of whether a response has been received or not) an Order with a purpose of Cancellation should be used. xcbl 3.5 Order Management Recommended Use, Version 1.0 November 19, 2001 ETH Zürich Part 6: WSDL 23

24 Other standards ebxml shows here again what could be a possible evolution path for WSDL (or the type of technology that is being built on top of WSDL) ebxml does not consider a client/ server model but an interaction between partners (peer-to-peer) Consequently, the service description model for ebxml is the description of how two business processes interact with each other: partners publish their processes (an external view over them) a collaboration agreement is drawn based on those processes the collaboration agreement describes the business protocol between those partners Multiple standards will continue to coexist service service VIEW OF BUSINESS PROCESS PARTNER 1 COLLABORATION AGREEMENT VIEW OF BUSINESS PROCESS ETH Zürich PARTNER 2 Part 6: WSDL 24

25 Automatic development The ultimate goal of WSDL is to provide support for automating as much as possible for the development process for Web services: given the WSDL description, a WSDL compiler generates the stubs or skeletons necessary to develop clients that can interact with the service for that purpose, WSDL must rely on a standard protocol so that generic stubs can be created, this is where SOAP comes into the picture WSDL is meant as a bridge between internal services and external (Web) services Similarly, the ultimate goal in ebxml is to automate the process of developing a collaboration agreement, deploying it and enforcing its rules: given a collaboration agreement (possibly a standard one), one should be able to automatically generate a stub or skeleton for the individual business processes at the ends of the agreement partners need only to extend the stub process with their own internal logic this is why ebxml needs more than SOAP as the agreement is used to control and direct the flow of messages between partners at the platform level ETH Zürich Part 6: WSDL 25

26 WSDL Summary The goal of WSDL is to describe Web services, in particular describe service interfaces. The WSDL data structure has interesting implications on how services are described and how they interact Services can initiate operations like a client (blurred notion of client and service provider) WSDL does not presume a particular form of communication (first defines the abstract interface, then the location and protocol) Abstract interfaces are reusable: different services could combine different interfaces using different bindings, and could make them available at different addresses WSDL documents can import other WSDL documents The WSDL description is correlated with SOAP. If the messages defined in WSDL are exchanged using SOAP, then the InterfaceBindings contain all the information needed to infer or automatically construct SOAP messages (interaction style, XML encoding, transport bindings) ETH Zürich Part 6: WSDL 26