Die Web Service Description Language (WSDL) ist ein XML-Format, um Netzwerkdienste, die sogenannten WebServices zu beschreiben. In einer WSDL werden Nachrichten, die zwischen mehreren Endpunkten ausgetauscht werden, definiert. Diese Nachrichten werden innerhalb der WSDL zunächst abstrakt beschrieben und erst danach an bestimmte Netzwerkprotokolle und Nachrichtenformate gebunden.
Struktur eines WSDL-Dokuments
Ein WSDL-Dokument wird im XML-Format verfasst, wobei der Namensraum (Namespace) der WSDL-Elemente http://schemas.xmlsoap.org/wsdl/ ist. Das Wurzelelement eines WSDL-Dokuments ist <definitions>.
<?xml version="1.0" encoding="UTF-8"?> <definitions xmlns="http://schemas.xmlsoap.org/wsdl/" name="Name des Dokuments (optional)" targetNamespace="Namensraum des WSDL-Dokuments (optional)"> </definitions>
Services werden durch die folgende Elemente definiert:
| Element | Beschreibung |
|---|---|
| <types> | In dem Element types werden die verwendeten Datentypen beschrieben, die in allen Nachrichten des Services verwendet werden. |
| <message> | In dem Element message werden die Nachrichten definiert, die übertragen werden, wobei jede Nachricht aus mehreren Teilen besteht. Die Nachrichten verwenden die unter types definierten Datentypen. |
| <operation> | Eine operation besteht aus einer (One-way, Notification) oder zwei Nachrichten (Request-response, Solicit-response) und bilden die Operationen (Funktionen) des Services. |
| <portType> | Ein portType faßt mehrere Operationen zusammen, wobei sich jede Operation auf eine Ein- und Ausgabenachricht bezieht, die unter message definiert ist. |
| <binding> | Unter binding werden nun die abstrakten Nachrichten und Operationen, die unter message bzw. portType definiert wurden, an konkrete Netzwerkprotokolle und Datenformate gebunden. |
| <port> | Ein port beschreibt eine Adresse, meist eine URI, unter der die unter binding definierten Bindungen erreichbar sind. |
| <service> | In einem service werden alle unter port beschriebenen Adressen zusammengefasst. |
In einem WSDL-Dokument basiert jedes Element auf dem jeweils vorhergehenden, so werden im Element <message> Nachrichten definiert, die auf den Datentypen und Datenstrukturen basieren, die unter <types> definiert wurden. Die <portType>-Elemente definieren Operationen (<operation>), die sich aus Nachrichten zusammensetzen. Im <binding> werden diese Operationen an konkrete Netzwerkprotokolle gebunden und im <port>-Element werden den Bindungen Adressen zugeordnet. Ein <service> fasst nun bestimmte <port>-Elemente zu einem Paket zusammen.
<types>
In dem Element types werden alle relevanten Datentypen und Datenstrukturen definiert, die in den Nachrichten verwendet werden. Für die Definition wird die XML Schema Definition XSD verwendet.
<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://schemas.xmlsoap.org/wsdl/"
name="Name des Dokuments (optional)"
targetNamespace="Namensraum den das WSDL-Dokument definiert (optional)">
<types>
<xsd:schema xmlns="http://www.w3.org/2000/10/XMLSchema" ...>
</xsd:schema>
</types>
...
</definitions>
Beispiel
<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://schemas.xmlsoap.org/wsdl/"
name="BitworldService"
targetNamespace="http://www.bitworld.de/bitworldService.wsdl"
xmlns:xsd1="http://www.bitworld.de/schemas">
<types>
<xsd:schema xmlns="http://www.w3.org/2000/10/XMLSchema"
targetNamespace="http://www.bitworld.de/schemas">
<element name="Person">
<complexType>
<all>
<element name="vorname" type="string"/>
<element name="nachname" type="string"/>
</all>
</complexType>
</element>
</xsd:schema>
</types>
...
</definitions>
Oftmals ist es sinnvoller, die Definition der Datentypen und Datenstrukturen in ein separates XML-Schema-Dokument auszulagern und dieses in das WSDL-Dokument zu importieren. Für den Import von externen Quellen wird das Element <input> verwendet.
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://www.w3.org/2000/10/XMLSchema"
targetNamespace="http://www.bitworld.de/schemas">
<element name="Person">
<complexType>
<all>
<element name="vorname" type="string"/>
<element name="nachname" type="string"/>
</all>
</complexType>
</element>
</xsd:schema>
In dem WSDL-Dokument wird das XML-Schema nun mittels <import> eingebunden, wobei das Element <types> nicht angegeben wird.
<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://schemas.xmlsoap.org/wsdl/"
name="BitworldService"
targetNamespace="http://www.bitworld.de/bitworldService.wsdl">
<import namespace="http://www.bitworld.de/schemas"
location="http://www.bitworld.de/schemas/bitworld.xsd"/>
...
</definitions>
Auf diese Weise können auch andere Teile des WSDL-Dokuments in externe Dateien ausgelagert und importiert werden. So ist es möglich, eine gemeinsame Datentyp-Basis für verschiedene Sammlungen von Services (Service-Domänen) zu erstellen.
<message>
Nachrichten bestehen aus einem oder mehreren <part>-Elementen — den Parametern der Nachricht. Jedes <message>-Element muss einen eindeutigen Namen haben, wobei der Name nur innerhalb der definierten <message>-Elemente eindeutig sein muss.
<message name="eindeutiger Nachrichtenname">
<part>
Ein <part>-Element definiert einen Nachrichtenparameter. Jedem <part> muss innerhalb des umgebenden <message>-Elements ein eindeutiger Name gegeben werden. Zusätzlich muss ein Datentyp angegeben werden, wobei man entweder ein anderes XSD-Element in dem Attribut element oder einen xsd:simpleType oder xsd:complexType in dem Attribut type angeben muss.
<part name="eindeutiger Parametername" element="qualifizierter Elementname" type="qualifizierter Typname (simpleType oder complexType), z.B. xsd:string">
Die Elementnamen beziehen sich auf die unter <types> oder mittels <import> definierten Elemente.
Beispiel
<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://schemas.xmlsoap.org/wsdl/"
name="BitworldService"
targetNamespace="http://www.bitworld.de/bitworldService.wsdl"
xmlns:xsd1="http://www.bitworld.de/schemas">
<types>
<xsd:schema xmlns="http://www.w3.org/2000/10/XMLSchema"
targetNamespace="http://www.bitworld.de/schemas">
<element name="Person">
<complexType>
<all>
<element name="vorname" type="string"/>
<element name="nachname" type="string"/>
</all>
</complexType>
</element>
</xsd:schema>
</types>
<message name="speicherePerson">
<part name="person" element="xsd1:Person">
<part name="email" type="xsd:string">
</message>
</definitions>
<portType>
Ein portType fasst eine Menge von Operationen (Funktionen) zusammen, die sich aus den definierten Nachrichten zusammensetzen. Eine Operation besteht aus mindestens einer Nachricht und maximal zwei Nachrichten. In der WSDL-Spezifikation werden die folgenden vier Typen von Operationen (Transmission primitives) definiert:
Endpunkte
Im folgenden taucht öfter der Begriff Endpunkt auf, so dass hier kurz erleutert werden soll, was unter einem Endpunkt zu verstehen ist.
Unter einem Endpunkt (Endpoint) ist ein Kommunikationspartner gemeint, der Nachrichten sendet und/oder Nachrichten empfängt.
| Typ | Endpunkt-Rolle | Beschreibung |
|---|---|---|
| One-way | Service-Anbieter Provider | Der Endpunkt empfängt eine Nachricht. |
| Request-response | Service-Anbieter Provider | Der Endpunkt empfängt eine Nachricht und sendet eine dazugehörige Nachricht (Antwort). |
| Solicit-response | Service-Nutzer Consumer | Der Endpunkt sendet eine Nachricht und empfängt eine Nachricht. |
| Notification | Service-Nutzer Consumer | Der Endpunkt sendet eine Nachricht. |
Quellen
Web Services Description Language (WSDL) 1.1, W3C Note 15 March 2001

![Validate my RSS feed [Valid RSS]](/templates/bitworld/images/valid-rss.png)
