Sie können Beispiel-Client-Code für eine JAX-RS-Ressource (Java™ API
for RESTful Web Services) mittels einer REST-Projektadresse generieren.
Vorbereitende Schritte
Wichtig: Gilt für Liberty
Führen Sie die folgende Konfiguration für
WebSphere Application Server Developer Tools for Eclipse durch:
- Fügen Sie den Vorgaben die Liberty-Laufzeitumgebung hinzu.
- Erstellen Sie in der Ansicht "Server" einen Liberty-Server.
- Erstellen Sie ein Webprojekt mit mindestens einem REST-Service, der im Projekt definiert ist. Wenn Sie keine Services definieren, hat der REST-Knoten keine untergeordneten Elemente.
Vorgehensweise
- Blenden Sie ein.
- Klicken Sie mit der rechten Maustaste auf die Adresse oder auf eines der untergeordneten Elemente und wählen Sie aus. Der Dialog JAX-RS 2.0-Client wird angezeigt.
- Übernehmen Sie im Feld Quellenordner die Standardeinstellung für den Zielordner des generierten Clients oder geben Sie einen Zielordner an.
- Übernehmen Sie im Feld Name die Standardeinstellung für den Java-Klassennamen des Clients oder geben Sie einen Klassennamen an.
- Übernehmen Sie im Feld Paket die Standardeinstellung für den Java-Paketnamen des Clients oder geben Sie einen Paketnamen an.
- Wählen Sie die Ressourcen aus, die für die Generierung des Client-Codes verwendet werden sollen.
- Generieren Sie eine neue Filterklasse.
- Wählen Sie JAX-RS-Clientfilter generieren aus.
- Übernehmen Sie die Standardeinstellung für den Namen der Filterklasse oder geben Sie einen Namen an.
Diese Option erstellt eine Grundklasse, die die Schnittstellen ClientRequestFilter
und ClientResponseFilter aus dem JAX-RS 2.0-Paket
javax.ws.rs.client implementiert. Sie können die Implementierungsdetails für die Schnittstellenmethoden vervollständigen, nachdem Sie die neue Filterklasse generiert haben.
- Optional: Wenn Sie JAXB-Klassen und den Client in demselben Projekt generieren möchten, wählen Sie Verwenden Sie das XML-Schema für die JAXB-Generierung aus.
Die Ressourcenmethode des JAX-RS-Service enthält möglicherweise JAXB-Klassen als Methodenargumente oder Rückgabetypen.
Wenn Sie keine JAXB-Quelle, aber das XML-Schema haben, können Sie die JAXB-Klassen generieren,
sodass Ihr Client-Code auf sie zugreifen kann.
- Klicken Sie auf Weiter.
Der Dialog JAX-RS-Client mit JAXB wird angezeigt.
- Optional: Geben Sie im Feld Java-Paket für JAXB-Ziel das Java-Paket an, das Sie für die generierten JAXB-Klassen verwenden möchten.
Dieser Wert wird mit der Option -p an den Binding-Compiler oder an das Tool "Java
Architecture for XML Binding Compiler" (XJC) übergeben.
- Klicken Sie auf Durchsuchen..., um zu der XSD-Datei zu navigieren, aus der die JAXB-Klasse generiert werden soll.
Sie können die XSD-Datei auch im XML-Schema eingeben. Dieser Wert wird mit der Option -b an den
Binding-Compiler oder an das Tool XJC übergeben.
- Optional: Wenn Sie benutzerdefinierte JAXB-Binding-Dateien angeben möchten, wählen Sie JAXB-Bindingdateien angeben aus.
Wenn Sie diese Option auswählen, können Sie auf Hinzufügen klicken, um angepasste Binding-Deklarationsdateien
hinzuzufügen. Sie können Dateien auch entfernen, indem Sie sie hervorheben und Entfernen auswählen.
- Optional: Wenn Sie Anbietererweiterungen zulassen möchten, wählen Sie Anbietererweiterungen zulassen aus.
Diese Auswahl ist möglicherweise für die Verarbeitung einiger XML-Schemadokumente erforderlich. Der Wert wird mit der Option
-extension an den Binding-Compiler oder an das Tool XJC übergeben.
- Klicken Sie auf Fertigstellen.
Ergebnisse
Sie haben Beispiel-Client-Code für eine JAX-RS-Ressource generiert.
Wenn Sie den optionalen Schritt zum Generieren von
JAXB-Klassen ausgeführt haben, haben Sie außerdem JAXB-Klassen in demselben Projekt generiert, in dem sich auch Ihr JAX-RS-Client befindet.
Des Weiteren haben Sie eine neue Java-Klassendatei mit der JAX-RS 2.0-Client-API erstellt, die für den Zugriff auf den JAX-RS-Service
verwendet werden kann. Jede mit Annotationen versehene Methode des JAX-RS-Service hat eine entsprechende JAX-RS-Clientmethode, die anhand von Annotationen
in den JAX-RS-Servicemethoden generiert wurde. Zu den JAX-RS-Servicemethoden
gehören @PathParam, @QueryParam, @Consumes,
@Produces, @Path und Ressourcenmethoden wie @GET, @PUT oder
@POST.
Einschränkung: Für alle Klassen, auf die sich der Algorithmus zur JAX-RS-Clientgenerierung auswirkt, müssen die folgenden
Einschränkungen berücksichtigt werden:
- Die Klassen müssen eine Zeichenfolge, eine primitive Klasse, eine JAX-RS-API-Klasse oder eine Benutzerklasse sein, die
von Java Architecture for XML Binding (JAXB) mit Annotationen versehen wurde.
Diese Klassen dürfen nicht binär sein.
- Alle Klassen müssen im Quellenformat vorliegen, damit der Algorithmus sie finden kann.
Befinden sich die Klassen nicht in demselben Projekt wie der
JAX-RS-Service, kann der JAX-RS-Client nicht generiert werden.
Nächste Schritte
Fügen Sie dem Beispiel Code hinzu, damit der Client-Code funktioniert und Ihre Anforderungen bezüglich JAX-RS 2.0-Client-Code
erfüllt. Fügen Sie den Client-Code einer JSP oder einem Servlet hinzu, um das Beispiel zu testen.
Ihr Client-Code muss sich in einem Servlet-Container befinden,
weil eigenständige Java-Anwendungen nicht unterstützt werden.
Wenn Sie funktionierenden JAX-RS 2.0-Client-Code haben, verwenden Sie ihn, um den
JAX-RS 2.0-Service zu starten.