Norm 225 Service Definition mit WSDL

Transkript

1 1 Norm 225 Service Definition mit WSDL 2 3 Release und Version Release 1, Version 2.0, vom 19. Juni Status Offizielle Norm 6 7 Editor Dr. Torsten Schmale, inubit AG Autoren Markus Heussen, RheinLand Gruppe (markus.heussen@creditlife.net) Marc Pellmann, inubit AG (marc.pellmann@inubit.com) Sascha Klose, VHV Versicherung (sklose@vhv.de) Dr. Dieter Ackermann, VOLKSWOHL BUND (dieter.ackermann@volkswohl-bund.de) Dr. Thomas Kippenberg, Nürnberger (thomas.kippenberg@nuernberger.de) Dr. Torsten Schmale, inubit AG (ts@inubit.com) Jörg Treiner, IDEAL Gruppe (treiner@ideal-versicherung.de) Stefan Hauptmann, VDV Klaus Reimer GmbH (stefan.hauptmann@v-d-v.de) John Bodenstein, AssFiNET AG (john.bodenstein@assfinet.de) Sören Chittka, VOLKSWOHL BUND, (soeren.chittka@volkswohl-bund.de) Thomas Belting, RheinLand Gruppe, (thomas.belting@rheinland-versicherungen.de) Gegenstand der Norm Die Norm 225 definiert wie BiPRO-konforme Services mit den Mechanismen der WSDL (Web Service Description Language) zu beschreiben sind Voraussetzung Norm 210, Release Seite 1 von 10 -

2 Hinweis zur Veröffentlichung Die anliegend überreichte Norm ist urheberrechtlich für die BiPRO geschützt. Das Dokument wird Ihnen im Rahmen Ihrer Mitgliedschaft bei der BiPRO und damit als Mitglied dieses geschlossenen Empfängerkreises überlassen. Dementsprechend stellt die Überlassung an Sie keine Erstveröffentlichung der Norm dar. Zur Erstveröffentlichung gegenüber Dritten bleibt somit die BiPRO alleine berechtigt. Die Veröffentlichung erfolgt gemäß Norm100. Aufgrund der besonderen Wertigkeit der Normen für die Mitglieder sind wir gehalten, Verstöße gerichtlich zu ahnden Seite 2 von 10 -

3 37 Inhaltsverzeichnis Norm 225 Service Definition mit WSDL... 1 Inhaltsverzeichnis... 3 Service Definition mit WSDL... 4 WSDL-Templates... 4 wsdl:definitions... 4 wsdl:service... 5 wsdl:binding... 6 wsdl:porttype... 7 wsdl:message... 8 wsdl:types... 9 Besonderheiten Seite 3 von 10 -

4 50 Service Definition mit WSDL Eine Prozess-Schnittstelle MUSS unter Anwendung der Web Service Description Language (WSDL) in der Version 1.1 beschrieben werden. Die WSDL-Datei definiert wo der Service zu erreichen ist (Internet-Adresse), welche Funktionen der Service anbietet (z. B. getquote = Beitragsermittlung), welche Eingangs-, Ausgangs- und Fehlernachrichten bei Ausführung der Funktionen zu transportieren sind und welche Objekte und Datentypen ausgetauscht werden können. Eine BiPRO-Schnittstelle verfügt über standardisierte Funktionen. Eine individuelle Erweiterung der Schnittstelle um neue Funktionen ist unzulässig Innerhalb der WSDL-Datei KANN mittels Web Service Policy (WS-Policy) beschrieben werden, welches Authentifizierungsverfahren anzuwenden ist und welche besonderen Bedingungen bei der Übertragung von Nachrichten einzuhalten sind (z. B. verpflichtende Objekte bzw. Objekt-Eigenschaften). WSDL-Templates Um eine BiPRO-Konformität sicher zu stellen, MUSS die Beschreibung der Schnittstelle unter Verwendung der nachfolgend beschriebenen WSDL-Templates (Muster, Schablonen) erfolgen. wsdl:definitions Dieses Template definiert den grundlegenden Aufbau der Schnittstellendatei und die relevanten Namensräume. <wsdl:definitions targetnamespace="${x1}" xmlns:wsp="${x2}" xmlns:wsp="${x2.1}" xmlns:wsu="${x3}" xmlns:wsse="${x4}" xmlns:bipro="${x1}" xmlns:wsdl="${x5}" xmlns:soapbind="${x6}"> <wsdl:types>${x7}</wsdl:types> <wsdl:message>${x8} <wsdl:message>${x8} <wsdl:message>${x8} <wsdl:message>... <wsdl:porttype>${x9}</wsdl:porttype> <wsdl:binding>${x10}</wsdl:binding> <wsdl:service>${x11}</wsdl:service> - Seite 4 von 10 -

5 86 87 </wsdl:definitions> Variable Wert ${X1} Namespace BiPRO: ${X2} Namespace WS-Policy ${X2.1} Namespace WS-SecurityPolicy ${X3} Namespace WS-Utility: ${X4} Namespace WS-Security: open.org/wss/2004/01/oasis wss-wssecurity-secext- 1.0.xsd ${X5} Namespace WSDL: ${X6} Namespace SOAP-Binding: ${X7} Siehe Template gemäß Abschnitt wsdl:types ${X8} Siehe Template gemäß Abschnitt wsdl:message ${X9} Siehe Template gemäß Abschnitt wsdl:porttype ${X10} Siehe Template gemäß Abschnitt wsdl:binding ${X11} Siehe Template gemäß Abschnitt wsdl:service wsdl:service Dieses Template fasst eine Reihe unterschiedlicher Kommunikationsschnittstellen (Service- Endpoints) in einem Service zusammen. <wsdl:service name="${x12}"> <wsdl:documentation>${x13}</wsdl:documentation> - Seite 5 von 10 -

6 <wsdl:port name="${x14}" binding="bipro:${x14}binding"> <soapbind:address location="${x15}"/> </wsdl:port> </wsdl:service> 97 Variable Wert ${X12} Eindeutige Bezeichnung des Web Services, z. B. HausratTarifierung ${X13} Erläuterung der Aufgabe des Web Services; Fachliche Dokumentation. ACHTUNG: Diese Erläuterung wird möglicherweise von generischen Clients in einer Benutzeroberfläche visualisiert. ${X14} Eindeutige Kennzeichnung des Ports, z. B. Tarifierung ${X15} Internet-Adresse des Web Services, z. B Beispiel <wsdl:service name="hausrattarifierung"> <wsdl:documentation> Dieser Service stellt Funktionen zur Verfuegung, die zur Ermittlung eines Versicherungsbeitrages für die Sparte Hausrat verwendet werden koennen. </wsdl:documentation> <wsdl:port name="tarifierung" binding="bipro:tarifierungbinding"> <soapbind:address location=" </wsdl:port> </wsdl:service> wsdl:binding Dieses Template bestimmt das konkrete Protokoll und die Art der Nachrichtenübertragung innerhalb der einzelnen Funktionen. <wsdl:binding name="${x14}binding" type="bipro:${x14}porttype"> <soapbind:binding style="document" transport=" <wsdl:operation name="${x15}"> <soapbind:operation soapaction="urn:${x15}" style="document"/> - Seite 6 von 10 -

7 <wsdl:input name="${x15}request"> <soapbind:body use="literal"/> </wsdl:input> <wsdl:output name="${x15}response"> <soapbind:body use="literal"/> </wsdl:output> <wsdl:fault name="exception"> <soapbind:fault name="exception" use="literal"/> </wsdl:fault> </wsdl:operation> </wsdl:binding> 128 Variable Wert ${X15} Name der Funktion, z.b. getquote Beispiel <wsdl:binding name="tarifierungbinding" type="bipro:tarifierungporttype"> <soapbind:binding style="document" transport=" <wsdl:operation name="getquote"> <soapbind:operation soapaction="urn:getquote" style="document"/> <wsdl:input name="getquoterequest"> <soapbind:body use="literal"/> </wsdl:input> <wsdl:output name="getquoteresponse"> <soapbind:body use="literal"/> </wsdl:output> <wsdl:fault name="exception"> <soapbind:fault name="exception" use="literal"/> </wsdl:fault> </wsdl:operation> </wsdl:binding> wsdl:porttype Dieses Template definiert die Eingangs-, Ausgangs- und Fehlernachrichten, die im Rahmen einer Funktion verwendet werden. <wsdl:porttype name="${x14}porttype"> <wsdl:operation name="${x15}" parameterorder="parameters"> <wsdl:documentation>${x16}</wsdl:documentation> <wsdl:input message="bipro:${x15}request" name="${x15}request"/> <wsdl:output message="bipro:${x15}response" name="${x15}response"/> - Seite 7 von 10 -

8 <wsdl:fault message="bipro:exception" name="exception"/> </wsdl:operation> </wsdl:porttype> 157 Variable Wert ${X16} Dokumentation der Funktion. ACHTUNG: Diese fachliche Erläuterung wird möglicherweise innerhalb eines generischen Clients innerhalb der Benutzeroberfläche visualisiert Beispiel <wsdl:porttype name="tarifierungporttype"> <wsdl:operation name="getquote" parameterorder="parameters"> <wsdl:documentation> Diese Funktion ermöglicht es Ihnen, einen Versicherungsbeitrag zu berechnen. </wsdl:documentation> <wsdl:input message="bipro:getquoterequest" name="getquoterequest"/> <wsdl:output message="bipro:getquoteresponse" name="getquoteresponse"/> <wsdl:fault message="bipro:exception" name="exception"/> </wsdl:operation> </wsdl:porttype> wsdl:message Dieses Template definiert die zu übertragenden Daten. Hier erfolgt die Verknüpfung der Schnittstellen-Funktionen mit den im XML Schema definierten Nachrichten bzw. Objekten. <wsdl:message name="${x15}request"> <wsdl:part name="parameters" element="bipro:${x15}"/> <wsdl:message name="${x15}response"> <wsdl:part name="parameters" element="bipro:${x15}response"/> <wsdl:message name="exception"> <wsdl:part name="parameters" element="bipro:exception"/> Beispiel <wsdl:message name="getquoterequest"> <wsdl:part name="parameters" element="bipro:getquote"/> - Seite 8 von 10 -

9 <wsdl:message name="getquoteresponse"> <wsdl:part name="parameters" element="bipro:getquoteresponse"/> <wsdl:message name="exception"> <wsdl:part name="parameters" element="bipro:exception"/> wsdl:types 208 Variable Wert Dieses Template definiert die Objekte und Datentypen, die während eines Nachrichtenaustauschs übertragen werden können. <wsdl:types> <xsd:schema version="1.0" xmlns=" xmlns:xsd=" <xsd:import namespace="${x4}" schemalocation="${x17}"/> </xsd:schema> <xsd:schema version="1.0" xmlns=" xmlns:xsd=" <xsd:import namespace="${x1}" schemalocation="${x18}"/> </xsd:schema> </wsdl:types> ${X17} Internet-Adresse zum XML Schema der WS-Security Spezifikation: wss-wssecurity-secext-1.0.xsd ${X18} Internet-Adresse zum Provider-spezifischem XML Schema, z.b Beispiel <wsdl:types> <xsd:schema version="1.0" xmlns=" xmlns:xsd=" <xsd:import namespace=" wss-wssecurity-secext-1.0.xsd" schemalocation=" - Seite 9 von 10 -

10 wss-wssecurity-secext-1.0.xsd"/> </xsd:schema> <xsd:schema version="1.0" xmlns=" xmlns:xsd=" <xsd:import namespace=" schemalocation=" </xsd:schema> </wsdl:types> Besonderheiten In Erweiterung der WS-I Spezifikation zu Punkt (Distinctive Operations) MUSS der Wert des name-attributes des wsdl:operation-elementes innerhalb der gesamten WSDL-Datei eindeutig sein. Die Namensgebung SOLL in englischer Sprache erfolgen. In Einschränkung zu (One-Way-Operations) MUSS auf jeden Request eines Service Consumers ein Response eines Service Providers folgen. Das Prozessmodell basiert auf technisch synchroner Verarbeitung Um die Kompatibilität zwischen verschiedenen Frameworks bei der Nutzung von document/literal zu erhöhen, MUSS die Soap-Action mit dem Wert urn:operation belegt werden. - Seite 10 von 10 -