WSDL. Web Services Description Language. André Vorbach. André Vorbach

Transkript

1 André Vorbach WSDL Web Services Description Language André Vorbach

2 Übersicht Was ist WSDL? Dokumentenstruktur Elemente Definitions Types Messages porttype Binding Service SOAP-Bindings Beispiel

3 Was ist WSDL? (Entstehung) Spezifikation zur Beschreibung und Lokalisierung von Webservices in XML-Format Entwickelt von Ariba, Microsoft und IBM Im März 2001 dem W3C als Vorschlag vorgelegt (aktuell: WDSL v1.2) Weiterentwicklung durch eigene Arbeitsgruppe

4 Was ist WSDL? (Beschreibung) Rezept, um die Kommunikation von Anwendungen zu automatisieren Vertrag zwischen Dienst-Suchendem und Dienst-Anbieter Wie muss ich mit dem Service umgehen Unabhängig vom Nachrichtenformat (Protokoll- und Plattformunabhängig) Hauptsächlich Bindungen zu SOAP, MIME, HTTP GET/POST

5 Dokumentstruktur Definition Abstrakte Definitionen types messages porttype Konkrete Definitionen binding service

6 Elemente <definitions></definitions> Wurzelelement Enthält die anderen Elemente, deren Entitäten Anschlüsse und Nachrichten definieren Definiert den Namen des Webservices Enthält Angaben zu Namensräumen für Typendefinitionen, WSDL und SOAP-Bindung Kann eigenen Namensraum definieren Kann Namensräume importieren

7 Elemente <definitions></definitions> <?xml version="1.0" encoding="utf-8"?> <definitions name="helloservice" targetnamespace=" xmlns=" xmlns:soap=" xmlns:tns=" xmlns:xsd=" [Definition der Elemente] </definitions> targetnamespace = eigen erzeugter Namespace (tns) Xmlns =Default WSDL-Namespace Xmlns:soap = SOAP-Namespace Xmlns:xsd= XML-Schema-Namespace

8 Elemente <types></types> Beinhaltet Typendefinitionen für den Austausch aller Nachrichten zwischen Client und Server Bevorzugt xsd-typen (XML-Schema) wegen Plattformunabhängigkeit Jedem Element wird ein Typ zugeordnet Können auch Komplexe Typen sein (Arrays ) Jedes Element hat einen eindeutigen Namen Schema-Element wird benötigt zur Angabe des Namensraumes

9 Elemente <types></types> <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>

10 Elemente <messages></messages> Beinhaltet die logischen Teile einer Nachricht Jeder Nachrichtenaustausch ist eine Message Jede Message hat einen eindeutigen Namen Jede Message besteht aus Parts, das sind die Elemente, die in Types definiert worden sind ( Funktionsparameter) Die Typendefinition kann auch in den Parts direkt stattfinden

11 Elemente <messages></messages> <message name="sayhellorequest"> <part name="firstname" element="tns:name"/> </message> oder <message name="sayhelloresponse"> <part name="greeting" type="xsd:string"/> </message> (Type-Definition bereits in Element-Definition)

12 Elemente <porttype></porttype> Zusammenfassung mehrerer Messages zu Operationen - quasi die Funktionen Abstrakte Darstellung in Empfangs- und Sende- Operationen Vertrag zwischen Client und Server über Interaktion Operationen bestehen aus einer Menge von <input> = empfangen <output> = senden und <fault> = Fehler Messages

13 Elemente <porttype></porttype> One-Way: <porttype name="stockquote_porttype"> <operation name="getlasttradeprice"> <input message="tns:getlasttradepriceinput"/> <fault message= tns:calculatefaultmessage /> </operation> </porttype> Request-Response: <porttype name="stockquote_porttype"> <operation name="getlasttradeprice"> <input message="tns:getlasttradepriceinput"/> <output message="tns:getlasttradepriceoutput"/> <fault message= tns:calculatefaultmessage /> </operation> </porttype>

14 Elemente <binding></binding> Bindet einen bestimmten porttype an ein Protokoll Erklärung, wie porttype über das Internet übertragen wird Eine Bindung definiert das Format der Nachricht und Details des Protokolls Bindung über Erweiterungselemente zu SOAP, HTTP Get/Post oder MIME Eine Bindung muß genau ein Protokoll spezifizieren

15 Elemente <binding></binding> <binding name="stockquotesoapbinding" type="tns:stockquote_porttype"> <soap:binding style= > <operation name="getlasttradeprice"> <input> </input> <output> </output> <fault> </fault> </operation> </binding> <soap:operation soapaction= > <soap:body > <soap:body > <soap:body >

16 Elemente <service></service> Port = Netzwerkendpunkt durch die Spezifikation einer Adresse <port name="stockquoteport" binding="tns:stockquotesoapbinding"> <soap:address location=" </port> Service fasst alle Port-Elemente zusammen Ports können nicht untereinander kommunizieren <service name="stockquoteservice"> <documentation>my first service</documentation> <port name="stockquoteport1" binding="tns:stockquotebinding"> </port> <port name="stockquoteport2" binding="tns:stockquotebinding2"> </port> </service>

17 SOAP-Bindings <soap: > Erweiterungselemente für die Bindung an SOAP-Nachrichten (außerhalb des WSDL Namespace definiert) WSDL unterstützt SOAP 1.1 Ermöglicht SOAP-spezifische Elemente zu benutzen Binding Header Body Adress Einfügen von Elementen: <soap:elementname />

18 SOAP-Bindings <soap: > soap:binding verdeutlicht die Bindung zum SOAP-Format mit Envelope, Header und Body transport-attribut gibt den Transportmechanismus an, z.b. HTTP, SMTP Style-Attribut gibt an, ob rpc oder document Nachrichten Format <binding name = > <soap:binding style = rpc transport= </binding>

19 SOAP-Bindings <soap: > soap:body Gibt an, wie und wo die Nachrichtenteile im SOAP-Body-Element erscheinen <input> <soap:body /> </input> soap:header Hiermit können Informationen in Header Elemente der SOAP-Nachricht angegeben werden <input> <soap:header /> </input>

20 SOAP-Bindings <soap: > soap:address Spezifiziert die Adresse des Ports, über die der Dienst erreicht werden kann <port > <soap:address location=" </port> soap:operation Bindet eine bestimmte Operation an eine bestimmte SOAP-Implementierung Element muss vorhanden sein <operation > <soap:operation soapaction= /> </operation>

21 Zusammenfassung WSDL dokumentiert/beschreibt einen Netwerkdienst 6 Elemente Definitions : Stammelement, Namensräume, Name des Webservice Types :Was für Datentypen werden übermittelt? Messages : Was für Nachrichten werden übermittelt? porttype : Welche Operationen (Funktionen) werde unterstützt? Binding : Wie werden die Nachrichten über das Netz übertragen? Service : Wo ist der Dienst?

22 Beispiel //1 ebay Price Watcher (XMethods Inc.) Nimmt eine GebotsID an, gibt den aktuellen Preis zurück Definition: <?xml version="1.0"?> <definitions name="ebaywatcherservice" targetnamespace= " xmlns:tns=" xmlns:xsd=" xmlns:soap=" xmlns=" Types / Message: <message name="getcurrentpricerequest"> <part name="auction_id" type = "xsd:string"/> </message> <message name="getcurrentpriceresponse"> <part name="return" type = "xsd:float"/> </message> 2 Nachrichten werden definiert mit je einem Parameter (string / float)

23 Beispiel //2 (porttype) porttype : <porttype name="ebaywatcherporttype"> <operation name="getcurrentprice"> <input message="tns:getcurrentpricerequest" name="getcurrentprice"/> <output message="tns:getcurrentpriceresponse" name="getcurrentpriceresponse"/> </operation> </porttype> Eine Operation getcurrentprice wird definiert. Request-Response Verhalten

24 Beispiel //3 (bindings) <binding name="ebaywatcherbinding" type="tns:ebaywatcherporttype"> <soap:binding style="rpc" transport=" <operation name="getcurrentprice"> Binding Element spezifiziert SOAP als Transportprotokoll <soap:operation soapaction=""/> <input name="getcurrentprice"> <soap:body use="encoded namespace="urn:xmethods-ebaywatcher" encodingstyle=" </input> <output name="getcurrentpriceresponse"> <soap:body use="encoded namespace="urn:xmethods-ebaywatcher" encodingstyle=" </output> </operation> </binding>

25 Beispiel //4 (service) <service name="ebaywatcherservice"> <documentation> Checks current high bid for an ebay auction </documentation> <port name="ebaywatcherport binding="tns:ebaywatcherbinding"> <soap:address location= " </port> </service> </definitions> Spezifiziert den Dienst unter der URI

26 Szenario Registrierung des Webservice mittels JAXR bei einem UDDI-Server (Broker) Veröffentlichung durch UDDI-Server Client kontaktiert den UDDI-Server, der ihn an den WS-Anbieter verweist Client fordert von Anbieter das WSDL- Dokument an, das als Gebrauchsanweisung dient Inanspruchnahme des Webservice durch den Client

27 Quellen Web Services Essentials, Ethan Cerami O`Reilly, ISBN Developing WebServices with.net Framework, Scott Short Microsoft Press, ISBN Fertig, danke!