Schlagwort: http.net-API

Wir kennen das sicherlich alle:

Es gibt da eine SOAP-Schnittstelle, mit der man unbedingt etwas klären muss.
Menschen haben es da etwas schwerer als Rechner.

Also dann, man nehme sich kurzerhand einen solchen (Computer) und entscheide, welche Sprache man heute sprechen möchte. Heute, was bei mir eigentlich gestern war, fiel die Wahl auf Python.

Zum Schreiben eines SOAP-Clients bietet sich nach kurzer Befragung des Internet der Inhaber eines äußerst themengerechten, netten Logos an: SUDS

Alles ist etwas simpler, als es am Anfang scheint, nicht umsonst ist der erste Satz auf der offiziellen Seite dieses Frameworks, ich zitiere:

„Suds is a lightweight SOAP python client for consuming Web Services.“

Nicht wesentlich unterhalb dieses Satzes gelangt man auf eine nette “Getting Started”-Doku, die eigentlich alles enthält, was man sich für solch einen Einstieg erwünscht.
Erst einmal importiert man das Framework, oder, in diesem Fall, noch etwas weniger.

from suds.client import Client

Anschließend bastelt man sich einen solchen Client und gibt ihm auch gleich die Adresse des Servers.

client = Client('https://test/foo.bar/service.asmx?WSDL')

Solch ein Server hat sehr genaue Vorstellungen von Gesprächen, daher wird er uns genau sagen, was er in welcher Form gesagt bekommen möchte. Möchte man sich das anschauen, bietet es sich an mit

print client

einen Blick auf diese Anforderungen zu werfen.

Gehen wir nun davon aus, dass wir eine Methode benutzen wollen, die neben einem ganz normalen String auch noch einen komplexen Typ verlangt, eine Authentifizierung. Diese validiert die Berechtigung des Fragestellers mittels zweier Strings, dem Benutzernamen und dem Passwort. Da unser Client den Typ schon kennt, suchen auch wir uns dessen vordefinierten Namen. (Wichtig: Es geht explizit um die Anforderung des Servers, nicht um Typen die Teil von SUDS oder Python wären!)

Nehmen wir an, sein Name ist „AuthData“ und er beinhaltet die beiden Strings „username“ und „password“

auth = client.factory.create('AuthData')

bewirkt, dass eine Variable des Types AuthData nach den Spezifikationen des Servers erstellt wird.

Mit auth.username = 'admin' und auth.password = 'geheim'
(Beispiel für unsichere Zugangsdaten)

werden die Werte gefüllt.

Die Antwort des Servers wird erst zwischengespeichert

result = client.service.HalloServer(auth, 'Hallo')

und dann zum Beispiel mit einem

print result

ausgegeben. Fertig liest sich das dann:

from suds.client import Client
client = Client('https://test/foo.bar/service.asmx?WSDL')
auth = client.factory.create('AuthData')
auth.username = 'admin'
auth.password = 'geheim'
result = client.service.HalloServer(auth, 'Guten Morgen')
print result

Wer wissen möchte, wie so etwas realistisch in Bezug auf die http.net API aussehen würde, kann das Beispiel demnächst auch als Python-Sampleclient auf der API Dokuseite wiederfinden.

Wie komm ich denn jetzt hier zu meiner Klasse…?

Die automatische Generierung von Klassen aus einem Webinterface-XML-Schema ist an sich eine praktische Sache.

Schön ist das im Visual Studio 2010 gelöst:
Möchte man sich zum Beispiel in vb.net eine individuelle Schnittstelle zur http.net-API schreiben, fügt man die wsdl-URI der API einfach als Service Reference ein und kann dann unkompliziert die importierten Methoden im eigenen Code benutzen.

Möchte man ein ähnlich bequemes Verfahren nun auch in Java nutzen, benutzt selbst aber aus Prinzip, fehlenden Adminrechten am eigenen Computer, Kostengründen oder in der Konsequenz ähnlich gearteten Gründen einen simplen Editor statt einer funktionsbeladenen Entwicklungsumgebung, ist es nötig sich extern eine Lösung zu suchen.

Wenn man bisher nichts mit SOAP zu tun hatte, sollte man beispielsweise Axis von vorneherein ausschließen, oder wenigstens davon absehen, sich den “dos-and don’ts”-ähnlichen Artikel auf der Apacheseite durchzulesen, denn spätestens mit Hinweisen wie “If you don’t know them, Axis is a dangerous place to learn”, vergeht einem dann doch das letzte bisschen Experimentierfreude.

Weitere Ergebnisse auf einer populären Suchmaschine der eigenen Wahl fordern etliche Foren zu Tage, in denen Personen von Personen berichten, die irgendwann mal irgendetwas mit einem Webservice und Java, unter Umständen sogar etwas mit SOAP getan haben sollen…

Nunja, die Lösung liegt dann doch schon von Anfang an auf dem eigenen Computer, zumindest bei installiertem JDK, und zwar in Form des Tools “wsimport”. In der cmd namentlich aufgerufen, unter Angabe von Zielpfad (-d) und URI… passiert vorerst leider auch dort nicht das Gewünschte, aber immerhin gibt es einige Fehlermeldungen. Diese wiederum führen zu weiteren Foren, in denen schließlich eine Option “-B-XautoNameResolution” erwähnt wird.

-B weißt dabei auf die nachfolgende Methode hin, die wsimport dazu zwingt, Variablennamen nicht nach den geltenden Konventionen umzuformen, denn dadurch können Namensdoppelungen entstehen, die oben erwähnte Fehlermeldungen verursachen. (Nachzulesen auch unter https://jaxb.dev.java.net/issues/show_bug.cgi?id=314)

Mit der Funktion -extension unterbindet man anschließend lästige Warnungen, begründet in der Ignorierung der Konventionen, -keep erstellt neben .class auch .java Dateien und mit -p bietet sich die Möglichkeit, einen Package-Namen anzulegen.
Zusammengefasst sieht das dann folgendermaßen aus:

wsimport -d [Zielordner] [API-URI] -B-XautoNameResolution -extension -keep -p [Package]

Bemerkt sei noch, dass die Lösung wesentlich leichter zu finden war als im Nachhinein die Erklärung, was denn nun eigentlich das Problem war.