Web Services Description Language (WSDL) Überblick. Struktur eines WSDL-Dokuments. Struktur eines WSDL-Dokuments

Transkript

1 Überblick Web Services Description Language (WSDL) Beschreibungssprache für Repräsentation als XML-Dokument Beschreibung von Implementierung von Registrierung von MW-Übung (WS10/11) Beschreibung von 2 1 MW-Übung (WS10/11) Beschreibung von 2 2 Struktur eines WSDL-Dokuments Struktur eines WSDL-Dokuments Äußerstes Element: definitions Repräsentation von Informationen in inneren Elementen Datentypen (types) Beschreibung der vom Web-Service verwendeten Datentypen Kann entfallen, falls ausschließlich Datentypen aus dem W3C-XML-Schema zum Einsatz kommen Nachrichten (message) Beschreibung der zur Kommunikation mit dem Web-Service benötigten Nachrichtenformate (z. B. Aufrufparameter) Beispiel < message name =" add "> <part name =" arg0 " type =" xsd : int "/ > <part name =" arg1 " type =" xsd : int "/ > </ message > Operationen (porttype) Beschreibung der angebotenen Methoden Sammlung von Methoden: Port Zuordnung, welche Nachrichten bei welchen Methoden zum Einsatz kommen Beispiel < porttype name =" AdderService " > < operation name =" add " parameterorder =" arg0 arg1 " > <input message =" tns : add "/ > < output message =" tns : addresponse "/ > </ operation > </ porttype > Kommunikationsprotokoll (binding) Beschreibung der zu verwendenden SOAP-Nachrichtenformate Nachrichtenformate können/müssen für jede Operation separat definiert sein Dienst (service) Beschreibung der vom Web-Service unterstützten Ports Auflistung der Zugriffsmöglichkeiten auf den Web-Service (z. B. Adresse) MW-Übung (WS10/11) Beschreibung von 2 3 MW-Übung (WS10/11) Beschreibung von 2 4

2 Überblick Implementierung von Beschreibung von Implementierung von Registrierung von Typische Vorgehensweise 1. Implementierung des Diensts 2. Zusammenfassung der Dateien zu einem (WAR-)Archiv 3. Integration des Archivs in einen Web-Server (z. B. Tomcat) 4. Implementierung des Clients Java API for XML Web Services (JAX-WS) Standardmäßig integriert in Java 6 Client-Service-Kommunikation via SOAP Zentrales Hilfsmittel: Annotationen Tutorial: MW-Übung (WS10/11) Implementierung von 2 5 MW-Übung (WS10/11) Implementierung von 2 6 Annotationen Erzeugung des Web-Service-Endpunkts Web-Service-Endpunkt (@javax.jws.webservice) Festlegung einer Klasse als Web-Service-Endpunkt Zentrale Parameter Name (name): Abbildung auf das WSDL-Element porttype Dienstname (servicename): Abbildung auf das WSDL-Element service SOAP-Anbindung (@javax.jws.soap.soapbinding) Konfiguration des Nachrichtenformats Zentrale Parameter Codierung von Methodenaufrufen (style): document (Default) oder RPC Information über Parameter-Codierung (use): encoding oder literal (Default) Für Details siehe Web-Service-Methode (@javax.jws.webmethod) Freigabe einer Methode für die Nutzung per Web-Service Methode muss zwingend als public deklariert sein... Klasse: javax.xml.ws.endpoint Statische Methode: Erzeugung des Endpunkts und Veröffentlichung der WSDL-Beschreibung des Web-Service Endpoint publish(string address, Object implementor); address: Adresse unter der die Service-WSDL veröffentlicht werden soll implementor: Implementierung des Web-Service Beim Aufruf von publish() wird ein in Java 6 eingebetteter Web-Server gestartet Verwendung einer Default-Konfiguration Aufgaben Annahme der SOAP-Anfrage Aufruf der angeforderten Methode der Web-Service-Implementierung Zurücksenden einer SOAP-Antwort an den Client MW-Übung (WS10/11) Implementierung von 2 7 MW-Übung (WS10/11) Implementierung von 2 8

3 Erzeugung des Client-Kommunikationsendpunkts Arrays als Parameter/Rückgabewerte Die Client-Anwendung kommuniziert mit dem Web-Service unter Verwendung eines Proxy Proxy fungiert als Stellvertreter für die eigentliche Dienstimplementierung Lokale Methodenaufrufe am Proxy Aufgaben des Proxy Abfangen des Methodenaufrufs Umwandeln des Methodenaufrufs in eine SOAP-Anfrage Senden der Anfrage an den Web-Server Empfangen der SOAP-Antwort vom Web-Server Auspacken des Rückgabewerts aus der Antwort Rückgabe des Ergebnis an den Aufrufer der Methode Automatisierte Erzeugung von Proxy-Hilfsklassen Kommandozeilen-Tool: wsimport Als Grundlage dient die WSDL-Beschreibung des Diensts Dienstspezifische Hilfsklassen: Service-Zugangspunkt und -Schnittstelle Zusätzliche Erzeugung einer Hilfsklasse für jeden verwendeten Array-Typ durch wsimport Kapselung einer Liste von Objekten des Array-Typs Zugriff auf die Liste mittels getitem()-methode Einfügen/Auslesen von Objekten muss über diese Liste erfolgen Beispiel: Array-Klasse für String-Arrays (StringArray) String [] s = { "a", "b" ; // Einpacken StringArray sa = new StringArray (); List < String > sal = sa. getitem (); sal. add (s [0]); sal. add (s [1]); // Auspacken List < String > xsal = sa. getitem (); String [] xs = xsal. toarray ( new String [0]); MW-Übung (WS10/11) Implementierung von 2 9 MW-Übung (WS10/11) Implementierung von 2 10 Beispiel: Addierer als Web-Service Server-Seite Beispiel: Addierer als Web-Service Server-Seite Schnittstelle (mw/adder/mwaddersvcinterface.java) package mw. adder ; public interface MWAdderSvcInterface { public int add ( int a, int b); Implementierung (mw/adder/mwmyaddersvc.java) [...] // Package und ( name = " MWMyAdderSvc ", servicename = " MWAdderSvc SOAPBinding ( style = SOAPBinding. Style. RPC ) Server (mw/adder/mwadderserver.java) [...] // Package und imports public class MWAdderServer { public static void main ( String [] args ) throws Exception { String wsdl = " http :// localhost :12345/ MWAdderSvc? wsdl "; MWAdderSvcInterface adder = new MWMyAdderSvc (); Endpoint e = Endpoint. publish ( wsdl, adder ); System. out. println (" Adder ready : " + e. ispublished ()); public class MWMyAdderSvc implements MWAdderSvcInterface public int add ( int a, int b) { return a + b; while ( true ) { Thread. sleep ( Long. MAX_VALUE ); MW-Übung (WS10/11) Implementierung von 2 11 MW-Übung (WS10/11) Implementierung von 2 12

4 Beispiel: Addierer als Web-Service WSDL Beispiel: Addierer als Web-Service Client-Seite Nach dem Server-Start: Service-WSDL abrufbar (z. B. im Browser) Erzeugung der Proxy-Hilfsklassen für die Client-Seite Kommandozeilenaufruf > wsimport -p mw. adderclient -d bin -s src - keep http :// localhost :12345/ MWAdderSvc? wsdl parsing WSDL... generating code... Annahmen: Quellordner mit Source-Dateien ist src, Zielordner für Class-Dateien ist bin Erzeugte Dateien Subpackage: mw.adderclient Service-Zugangspunkt: mw/adderclient/mwaddersvc.java Service-Schnittstelle: mw/adderclient/mwmyaddersvc.java Client-Anwendung (MWAdderClient.java) Implementierung mittels Proxy-Hilfsklassen Zugriff auf Web-Service wirkt wie lokaler Methodenaufruf MW-Übung (WS10/11) Implementierung von 2 13 MW-Übung (WS10/11) Implementierung von 2 14 Beispiel: Addierer als Web-Service Client-Anwendung Überblick import mw. adderclient. MWAdderSvc ; import mw. adderclient. MWMyAdderSvc ; // Achtung : NICHT // mw. adder. MWMyAdderSvc public class MWAdderClient { private MWMyAdderSvc adder ; // Proxy public MWAdderClient () { MWAdderSvc service = new MWAdderSvc (); adder = service. getmwmyaddersvcport (); public void add ( int a, int b) { int result = adder. add (a, b); System. out. println ( a + " + " + b + " = " + result ); Beschreibung von Implementierung von Registrierung von public static void main ( String [] args ) { MWAdderClient client = new MWAdderClient (); client. add (40, 7); MW-Übung (WS10/11) Implementierung von 2 15 MW-Übung (WS10/11) Registrierung von 2 16

5 Registry für Java API for XML Registries (JAXR) Registry Treffpunkt zwischen Dienstanbieter und Dienstnehmer Dienstanbieter registriert Web-Service unter einem Namen und/oder eine Reihe von Attributen Dienstnehmer findet Web-Service mittels Suchanfrage nach Namen und/oder Attributen Achtung: Die anschließende Kommunikation zwischen Dienstnehmer und Dienstanbieter findet direkt (d. h. ohne Einbeziehung der Registry) statt Registry-Dienst ist üblicherweise selbst als Web-Service implementiert Java API for XML Registries (JAXR) Einheitliche API für den Zugriff auf XML-Registries Unterstützt u. a. Kommunikation mit UDDI-Registries Tutorial: API: Package: javax.xml.registry Zentrale Schnittstellen Connection Grundlegende Verbindung zur Registry Authentifizierung gegenüber der Registry RegistryService Komponente zum Zugriff auf die Registry Bereitgestellt von der Registry-Verbindung Zugriff auf Registry mittels Unterkomponenten von RegistryService BusinessQueryManager Schnittstelle zum Durchsuchen der Registry Rein lesende Operationen keine Authentifizierung notwendig BusinessLifeCycleManager Schnittstelle zum Erstellen, Ändern und Löschen von Registry-Einträgen Modifizierende Operationen Authentifizierung notwendig MW-Übung (WS10/11) Registrierung von 2 17 MW-Übung (WS10/11) Registrierung von 2 18 Verbindungsaufbau zur Registry String registryurl = " http :// localhost :12345/ juddi "; String querymanagerurl = registryurl + "/ inquiry "; String lifecyclemanagerurl = registryurl + "/ publish "; // Zusammenstellung der Verbindungsdaten Properties props = new Properties (); props. setproperty (" javax. xml. registry. querymanagerurl ", querymanagerurl ); props. setproperty (" javax. xml. registry. lifecyclemanagerurl ", lifecyclemanagerurl ); Connection connection ; RegistryService regsvc ; try { // Aufbau der Verbindung ConnectionFactory fact = ConnectionFactory. newinstance (); fact. setproperties ( props ); connection = fact. createconnection (); regsvc = connection. getregistryservice (); catch ( Exception e) { [...] // Fehlerbehandlung Authentifizierung gegenüber der Registry Beispiel: Setzen von Credentials für einen Nutzer,,gruppe0 String user = " gruppe0 "; String password = ""; // Credentials erzeugen PasswordAuthentication pa = new PasswordAuthentication ( user, password. tochararray ()); Set < PasswordAuthentication > credentials = new HashSet < PasswordAuthentication >(); credentials. add (pa ); // Credentials setzen try { Connection connection = [...]; connection. setcredentials ( credentials ); catch ( JAXRException jre ) { [...] // Fehlerbehandlung MW-Übung (WS10/11) Registrierung von 2 19 MW-Übung (WS10/11) Registrierung von 2 20

6 Verwaltung der Registry-Einträge Durchsuchen der Registry Verwaltung in Form von RegistryObject-Objekten Eindeutig identifizierbar über einen Schlüssel (Key) Zusätzlich: Vergabe eines Namens (Name) möglich Kategorien von RegistryObject-Objekten Organization (vgl. Business-Entity in UDDI) Informationen über einen Dienstanbieter (z. B. Adresse, Kontaktperson) Hierarchie aus Organizations möglich Service (vgl. Service in UDDI) Informationen über den eigentlichen Dienst (z. B. Name, Beschreibung) Zuordnung zu einer Organization ServiceBinding (vgl. Binding-Template in UDDI) Informationen über die Implementierung eines Diensts (z. B. Zugangs-URI) Zuordnung zu einem Service Anfrage erfolgt durch Methodenaufruf am BusinessQueryManager findorganizations(): Suche nach Organizations findservices(): Suche nach Services findservicebindings(): Suche nach ServiceBindings... Spezifizierung der Suchparameter Suchkriterien (Find-Qualifiers) Collection von Strings Beispiele: FindQualifier.{EXACT NAME MATCH,SORT BY NAME ASC Namenskriterien (Name-Patterns) Collection von Strings Beispiele:,,MyService,,,%Service Rückgabe der Antwort per BulkResponse-Objekt Kapselung einer Collection von Organizations, Services,... Kapselung einer Collection von Exceptions MW-Übung (WS10/11) Registrierung von 2 21 MW-Übung (WS10/11) Registrierung von 2 22 Durchsuchen der Registry Beispiel: Suche nach Organizations deren Name mit,,g beginnt; Ausgabe in aufsteigender alphabetischer Reihenfolge // Erzeugung der Suchkriterien Collection < String > findqualifiers = new ArrayList < String >(); findqualifiers. add ( FindQualifier. SORT_ BY_ NAME_ ASC ); // Erzeugung der Namenskriterien Collection < String > namepatterns = new ArrayList < String >(); namepatterns. add ("g %"); // Ausfuehrung der Suche try { RegistryService regsvc = [...]; BusinessQueryManager m = regsvc. getbusinessquerymanager (); BulkResponse br = m. findorganizations ( findqualifiers, namepatterns, null, null, null, null ); Collection < Organization > orgs = br. getcollection (); for ( Organization o: orgs ) { [...] // Auswertung der Ergebnisse catch ( Exception e) { [...] Einschub: Strings in JAXR Kapselung in InternationalString-Objekten Erzeugung durch den BusinessLifeCycleManager Extraktion des Java-Strings per getvalue()-methode Beispiel try { String s = " Hallo "; // Einpacken BusinessLifeCycleManager lcm = regsvc. getbusinesslifecyclemanager (); InternationalString is = lcm. createinternationalstring ( s); // Auspacken String xs = is. getvalue (); System. out. println (xs ); catch ( JAXRException jre ) { [...] // Fehlerbehandlung MW-Übung (WS10/11) Registrierung von 2 23 MW-Übung (WS10/11) Registrierung von 2 24

7 Erzeugung von Registry-Einträgen Erzeugung von Registry-Einträgen String on = " MyOrg "; String sn = " MyService "; BusinessLifeCycleManager lcm = [...]; Beispiel Zentrale Aufgabe des BusinessLifeCycleManager Vorgehen 1. Erzeugung eines neuen Organization-Eintrags 2. Erzeugung eines neuen Service-Eintrags für die Organization 3. Erzeugung eines neuen ServiceBinding-Eintrags für den Service Anmerkungen Falls einer der Einträge bereits existiert, kann der entsprechende Schritt weggelassen werden Das Erzeugen eines Eintrags für eine Organization, die bereits existiert, löscht alle Service- und ServiceBinding-Einträge dieser Organization // Organization erzeugen InternationalString onis = lcm. createinternationalstring ( on ); organization = lcm. createorganization ( onis ); // Service fuer diese Organization erzeugen InternationalString snis = lcm. createinternationalstring ( sn ); Service service = lcm. createservice ( snis ); organization. addservice ( service ); // ServiceBinding fuer diesen Service erzeugen ServiceBinding binding = lcm. createservicebinding (); [...] // ServiceBinding spezifizieren service. addservicebinding ( binding ); // Organization in der Registry sichern Collection < Organization > orgs = new ArrayList < Organization >(1); orgs. add ( organization ); BulkResponse response = lcm. saveorganizations ( orgs ); [...] // Antwort auf Exceptions ueberpruefen MW-Übung (WS10/11) Registrierung von 2 25 MW-Übung (WS10/11) Registrierung von 2 26 Überblick Beschreibung von Implementierung von Registrierung von Bereitstellung eines eigenen Web-Service Teilaufgaben Kommandozeilen-Tool für Registry-Zugriff Web-Service zur Erweiterung eines bereits bestehenden Web-Service Client zum Zugriff auf beide Client (zu implementieren) Web- Service A (vorhanden) Web- Service B (zu implementieren) MW-Übung (WS10/11) 2 27 MW-Übung (WS10/11) 2 28

8 Registry-Zugriff Facebook-Dienst Kommandozeilen-Client für den Zugriff auf eine Registry, bei der die URLs zu WSDL-Beschreibungen von registriert sind Angebotene Kommandos LIST: Ausgabe der registrierten WSDL-URLs für einen Dienst REGISTER: Registrierung einer WSDL-URL für einen Dienst Registry-Zugangsdaten Nutzername: eigener Gruppenname (z. B.,,gruppe0 ) Passwort: leere Zeichenkette (,, ) Locale-Einstellungen Die Registry unterscheidet zwischen verschiedenen Locale-Einstellungen Die von uns bereitgestellte Registry verwendet en US Einstellen der Locale im Konstruktor des Kommandozeilen-Client Locale.setDefault(Locale.US); Von uns bereit gestellt Dienst zur Verwaltung von Nutzern und ihrer Freundschaftsbeziehungen zu anderen Nutzern Verwaltete Information für jeden Nutzer ID: eindeutige Kennzeichnung des Nutzers Name: (Klar-)Name des Nutzers Freunde: Liste mit den IDs von Freunden des Nutzers Angebotene Methoden Suche nach Nutzern, deren Namen die Zeichenkette name enthält String[] searchids(string name); Ausgabe des Klarnamen zu einer ID String getname(string id); Ausgabe aller Freunde eines Nutzers String[] getfriends(string id); MW-Übung (WS10/11) 2 29 MW-Übung (WS10/11) 2 30 Pfad-Dienst Web-Service-Client Im Rahmen von zu implementieren Dienst zur Ermittlung der kürzesten Verbindung zwischen Nutzern Angebotene Methode Ausgabe der kürzesten Verbindung zwischen den Nutzern startid und endid in Form einer Liste von Nutzer-IDs public String[] calculatepath(string startid, String endid); Implementierung Zurückgreifen auf Methoden des Facebook-Diensts Bestimmung des kürzesten Pfads Von uns bereit gestellt: Implementierung des Dijkstra-Algorithmus Zu implementieren: Zusammenstellung der Eingabemenge von IDs Vorgehen: Schrittweise Erweiterung der Freundeskreise von startid und endid bis diese sich überschneiden Kommandozeilen-Client für den Zugriff auf beide Angebotene Kommandos SEARCH: Suche nach Nutzern FRIENDS: Ausgabe der Namen aller Freunde eines Nutzers PATH: Kürzester Pfad (Nutzernamen) zwischen zwei Nutzern SEARCH, FRIENDS, PATH Client calculatepath() searchids(), getname(), getfriends() Path Service getfriends() Facebook Service MW-Übung (WS10/11) 2 31 MW-Übung (WS10/11) 2 32