Rheinwerk Computing :: Java SE 8 Standard-Bibliothek

15.3Daily Soap und das SOAP-Protokoll

Bei den Firmen DevelopMentor, IBM, Lotus Development Corp., Microsoft und UserLand Software entstand das XML-basierte SOAP-Protokoll (bis Version 1.2 stand die Abkürzung für Simple Object Access Protocol). Es wird seit 1998 entwickelt und bietet einen einfachen Zugriff auf Serverressourcen mit den etablierten Webstandards HTTP und XML. SOAP selbst beschreibt die Art und Weise, wie Inhalte (Serialisierung) und die XML-Daten übertragen werden. Die Übertragung hat mit SOAP aber eigentlich nichts zu tun, denn dafür sind andere Protokolle definiert. HTTP ist ein ideales Transportprotokoll, da es für Webseiten in der Regel keine Beschränkungen von Firewalls gibt. Die beiden Kommunikationsparteien regeln mit SOAP so einen entfernten Methodenaufruf, der die Parameter und Ergebnisse in XML kodiert und überträgt. Durch die unabhängigen und anerkannten Webstandards bietet SOAP gegenüber RMI oder CORBA den Vorteil, nicht an eine Programmiersprache gebunden zu sein. Java-Client kann gut auf in C# implementierte SOAP-Dienste zurückgreifen, genauso wie ein PHP-Client SOAP-Dienste auf einem Java-Applikationsserver aufrufen kann. Die SOAP-Übertragung kommt auch Oracle mit seinem Ziel einer betriebssystem- und plattformunabhängigen Schnittstelle entgegen.

Probleme von SOAP

Den Vorteilen stehen allerdings einige Nachteile gegenüber. Die XML-Repräsentation der Dokumente macht die Dokumente groß, und das XML-Dokument müsste eigentlich auch Schema-validiert werden. Dann kostet das Parsen der Parameter und der Aufbau der Ergebnisse auf beiden Seiten etwas Zeit, und Mehrdeutigkeiten können sich ergeben, wenn etwa im XML-Text ein Datum ohne Zeitzone steht. In Umgebungen, die eine schmale Übertragung fordern – etwa bei der Kommunikation zwischen mobilem Endgerät und Server –, setzen Entwickler eher auf REST-Aufrufe und komprimierte Datenströme. Des Weiteren ist auch die Sicherheit von SOAP-Verbindungen noch nicht hinreichend gelöst. Ein Client könnte sich mit einem Server verbinden und einen Aufruf starten, obwohl die Berechtigung fehlt. Sicherheitseigenschaften müssten erst auf der Serverseite implementiert werden. Die in Klartext übertragenen Nachrichten bilden ein weiteres Problem, das SSL jedoch verhindern kann.

15.3.1Die technische Realisierung

Ein Client-Programm besorgt sich, wie bei entfernten Programmen üblich, eine Referenz auf das entfernte Objekt. Das ist eine URL auf einen RPC-Router. Dieser Router wird mittels einer normalen HTTP-POST-Anfrage aktiviert. Er bekommt über den Client eine XML-kodierte Nachricht (der Content-Typ ist einfach text/html), in der die aufzurufende Methode und ihre Parameter kodiert sind. Der RPC-Router nimmt diese Nachricht entgegen, parst das empfangene XML-Dokument und leitet die Anfrage an die Methode weiter. Diese produziert die Ausgabe, die wiederum als XML-Dokument über die Antwort vom Server zum Client geschickt wird. Der Client nimmt das Ergebnis entgegen, und die Kommunikation ist beendet.

SOAP bietet für entfernte Methodenaufrufe einige Standarddatentypen an. Zu diesen gehören einfache Datentypen wie Ganzzahlen, Fließkommazahlen, Zeit- und Datumsangaben und Binärdaten. Außerdem unterstützt SOAP zusammengesetzte Datentypen wie Strukturen und Arrays. Wie diese Daten nun tatsächlich in eine XML-Nachricht umgesetzt werden, müssen wir glücklicherweise nicht wissen. Als Endanwender kommen wir mit der Nachricht nicht in Kontakt.

15.3.2Web-Service-APIs und Implementierungen

SOAP ist nur ein Standard zum Austausch von Daten, aber kein Framework. Für Java gibt es zwei APIs für Web-Services:

JAX-WS (Java API for XML-Based Web Services) ist die standardisierte Web-Service-API. Die aktuelle Version ist JAX-WS 2.2, und sie wird im JSR-224 spezifiziert.
JAX-RPC ist der Vorläufer von JAX-WS. Die API wurde im JSR-101, »Java APIs for XML based RPC«, spezifiziert, gilt aber heute als veraltet. Obwohl JAX-WS als Nachfolger von JAX-RPC gilt, haben sie doch eigentlich nichts miteinander zu tun. Die Spezifikation endete mit der Version 1.1.

Diese APIs werden über diverse Implementierungen umgesetzt:

Implementierung	Bemerkungen
JAX-WS Referenzimplementierung (http://jax-ws.java.net/)	Die JAX-WS RI ist Teil des Projekts Metro eines kompletten Web-Service-Stacks.
JDK	Das JDK ab Version 6 integriert die Referenzimplementierung der aktuellen JAX-WS-2.1-Spezifikation, und JDK 7 JAX-WS 2.2. Sie enthalten nicht das alte JAX-RPC.
Apache Axis2 (http://ws.apache.org/axis2/)	Axis ist ein Klassiker im SOAP-Geschäft*. Axis2 implementiert JAX-WS, und das ältere Axis (1) implementiert die JAX-RPC-API.
Apache CXF (http://cxf.apache.org/)	CXF implementiert JAX-WS und auch JAX-RPC. Sie geht auf XFire und Ionas Celtix zurück.
*) Von Axis gibt es zwei Versionen: Axis2 (http://ws.apache.org/axis2/) und Axis (http:// ws.apache.org/axis/). Axis2 ist eine komplette Neuimplementierung von Axis (1), und Axis (1) endete 2006. Vor Apache Axis gab es Apache SOAP, aber das ist noch viel älter …

Tabelle 15.3SOAP-Implementierungen

Da die JAX-WS-API und -Implementierung Teil der Java SE bzw. vom JDK ist, können wir Web-Service-Beispiele ohne Zusatzaufwand realisieren.

15.3.3@WebService

In Java wurden viele interessante Techniken integriert, um Web-Services einfach zu definieren und anzusprechen. Im ersten Schritt wollen wir einen Web-Service definieren und implementieren sowie ihn automatisch am integrierten Mini-Webserver anmelden. Die zentrale statische Methode dazu heißt Endpoint.publish(…). Im nächsten Schritt lassen wir uns über ein mitgeliefertes Tool wsimport Zugriffsklassen generieren, um auf unseren selbst definieren Web-Service sowie den existierenden Web-Service von »JavaPortal News« im Internet zuzugreifen.

15.3.4Einen Web-Service definieren

Web-Services mit JAX-WS 2 sind einfache Java-Klassen, die mit speziellen Annotationen versehen sind. Die Annotationen aus dem Paket javax.jws sind im Einzelnen:

@WebService: Jede Web-Service-Implementierung muss diese Klassen-Annotation besitzen. Optionale Elemente sind zum Beispiel name (bestimmt den <wsdl:portType>, Standard ist der unqualifizierte Name der Klasse bzw. Schnittstelle), targetNamespace, serviceName oder portName.
@SOAPBinding: Setzt den Stil der Nachrichten auf Dokument oder RPC.
@WebMethod: Die Annotation macht eine Methode zur Web-Service-Operation. Der Standardname unter <wsdl:operation> ist der Name der Methode; er lässt sich mit dem Element operationName ändern.
@WebParam: Beschreibt die Parameter genauer. Das Element name überschreibt den Parameternamen, der sonst »argX« hieße, für das WSDL-Element <wsdl:part>.
@WebResult: Bestimmt die Rückgabe einer Web-Service-Methode genauer.
@OneWay: Wird für asynchrone Aufrufe genutzt.

Wirklich nötig sind nur @WebMethod, @SOAPBinding und @WebService.

Beispiel

Unser folgender Web-Service deklariert zwei Methoden zur Veröffentlichung:

Listing 15.11com/tutego/insel/ws/MyWebServices.java

package com.tutego.insel.ws;

import javax.jws.*;
import javax.jws.soap.SOAPBinding;

@WebService(name="ChrisWebServices")
@SOAPBinding(style = SOAPBinding.Style.RPC)
public class MyWebServices {

@WebMethod
public String hello( String name ) {
return "Hello " + name + "!";
}

@WebMethod(operationName="body-mass-index")
@WebResult(name = "your-bmi")
public double bmi( @WebParam(name="height") double height,
@WebParam(name="weight") double weight ) {
return weight / ((height * height) / 10000);
}
}

15.3.5Web-Services veröffentlichen

Ein SOAP-Server muss die Anfragen entgegennehmen und an eine Java-Methode weiterleiten. In der Java-Welt realisieren üblicherweise Servlets eines Webcontainers die Annahme; sie nehmen die XML-Pakete entgegen, nehmen die Anfrage auseinander und leiten sie zur jeweiligen Implementierung weiter.

Die Veröffentlichung eines Web-Services ist sehr stark von der verwendeten Umgebung – sprich dem Container und der Implementierung – abhängig. In der Java Standard Edition ist das Anmelden ein Einzeiler, denn ein kleiner eingebetteter Webserver veröffentlicht einen Web-Service unkompliziert. Im Mittelpunkt stehen die Klasse Endpoint und die statische Methode publish(String address, Object implementor), die unter einer gegebenen URL eine Endpunkt-Implementierung anmeldet:

Listing 15.12com/tutego/insel/ws/PublishWsOnServer.java, main()

Endpoint endpoint = Endpoint.publish( "http://localhost:8080/services",
new MyWebServices() );
JOptionPane.showMessageDialog( null, "Server beenden" );
endpoint.stop();

Der Server veröffentlicht unseren Web-Service und bietet die WSDL-Beschreibungsdatei unter der URL http://localhost:8080/services?wsdl an.

15.3.6Einen JAX-WS-Client implementieren

Da entfernte Web-Service-Aufrufe am besten wie lokale Aufrufe über eine Java-Schnittstelle statisch gebunden sind, soll ein Dienstprogramm aus einer gegebenen WSDL-Datei Hilfsklassen für den komfortablen Zugriff generieren. Je nach Implementierung gibt es diverse Generatoren, und Oracle liefert das Tool wsimport mit.

wsimport

Das Kommandozeilentool wsimport wenden wir auf den einen Web-Service an. Des Weiteren gibt es eine Reihe von freien Web-Services im Internet, von denen http://www.webservicex.net/ einige anbietet. Wir entscheiden uns für einen GEO-IP-Service, der zur IP-Adresse das Land ermittelt, aus dem der Server wohl stammt. Die Webseite http://www.webservicex.net/ws/ WSDetails.aspx?WSID=64&CATID=12 gibt ein paar Informationen und referenziert die WSDL-URL http://www.webservicex.net/geoipservice.asmx?WSDL.

Da die Umsetzung automatisiert werden soll, setzen wir den Aufruf von wsimport in ein Skript:

Listing 15.13useWsimport.bat

PATH=%PATH%;C:\Program Files\Java\jdk1.8.0\bin
wsimport -s src -p com.tutego.insel.ws.gen.geoipservice http://www.webservicex.net/¿
geoipservice.asmx?WSDL
wsimport -d src -keep -p com.tutego.insel.ws.gen.chrisws http://localhost:8080/¿
services?wsdl

Der Schalter -d bestimmt den Pfad für die Quellen. Die Option -keep legt fest, dass die Quellen überhaupt generiert werden, und -p bezeichnet das Paket.

Am Ende hat wsimport die gewünschten Pakete mit unterschiedlichen Typen generiert:

com.tutego.insel.ws.gen.chrisws.ChrisWebServices.java
com.tutego.insel.ws.gen.chrisws.MyWebServicesService.java
com.tutego.insel.ws.gen.geoipservice.GeoIP.java
com.tutego.insel.ws.gen.geoipservice.GeoIPService.java
com.tutego.insel.ws.gen.geoipservice.GeoIPServiceSoap.java
com.tutego.insel.ws.gen.geoipservice.GetGeoIP.java
com.tutego.insel.ws.gen.geoipservice.GetGeoIPContext.java
com.tutego.insel.ws.gen.geoipservice.GetGeoIPContextResponse.java
com.tutego.insel.ws.gen.geoipservice.GetGeoIPResponse.java
com.tutego.insel.ws.gen.geoipservice.ObjectFactory.java
com.tutego.insel.ws.gen.geoipservice.package-info.java

[»]Hinweis

Leider ist es blauäugig, anzunehmen, dass für jede WSDL-Datei das Tool wsimport die Zugriffsklassen baut. Das Dienstprogramm ist sehr wählerisch, und vieles funktioniert nicht. Eine häufige Fehlermeldung – etwa auf Googles WSDL-Datei – wird diese hier sein:

error: rpc/encoded wsdls are not supported in JAXWS 2.0.

Hier hilft nur eine ausführliche Analyse, Google oder http://stackoverflow.com/.

Client mit Service-Klassen

Wichtig sind jeweils die Klassen, die auf -Service enden, denn sie ermöglichen den Zugriff auf die entfernten Methoden.

Listing 15.14com/tutego/insel/ws/ClientForGeneratedStubs.java, main()

GeoIPServiceSoap ipService = new GeoIPService().getGeoIPServiceSoap();
GeoIP geoIP = ipService.getGeoIP( "193.99.144.85" );
System.out.println( "IP-Adresse kommt aus " +
geoIP.getCountryCode() );

ChrisWebServices port = new MyWebServicesService().getChrisWebServicesPort();
System.out.printf( "%s Dein BMI ist %.1f%n",
port.hello( "Chris" ),
port.bodyMassIndex( 183, 84 ) );

Mit gestartetem Server gibt der Client zum Beispiel die folgenden Ausgaben aus:

IP-Adresse kommt aus DEU
Hello Chris! Your BMI is 25,1

Wie hat Ihnen das Openbook gefallen? Wir freuen uns immer über Ihre Rückmeldung. Schreiben Sie uns gerne Ihr Feedback als E-Mail an kommunikation@rheinwerk-verlag.de.