REST-Datenservice installieren

In diesem Abschnitt wird beschrieben, wie der REST-Datenservice von WebSphere eXtreme Scale in einem Webserver installiert wird.

Vorbereitende Schritte

Softwarevoraussetzungen

Der REST-Datenservice von WebSphere eXtreme Scale ist eine Java-Webanwendung, die in jedem Anwendungsserver implementiert werden kann, der die Java-Servlet-Spezifikation Version 2.3 und eine Java Runtime Environment der Version Version 5 oder höher unterstützt.

Die folgende Software ist erforderlich:
  • Java Standard Edition 5 oder höher
  • Web-Servlet-Container Version 2.3 oder höher mit einer der folgenden Komponenten:
    • WebSphere Application Server Version 6.1.0.25 oder höher
    • WebSphere Application Server Version 7.0.0.5 oder höher
    • WebSphere Community Edition Version 2.1.1.3 oder höher
    • Apache Tomcat Version 5.5 oder höher
  • WebSphere eXtreme Scale Version 7.1 oder höher ,einschließlich der Testversion.

Informationen zu diesem Vorgang

Der REST-Datenservice von WebSphere eXtreme Scale enthält eine einzige Datei wxsrestservice.war. Die Datei wxsrestservice.war enthält ein einziges Servlet, das als Gateway zwischen Ihren WCF-Data-Services-Clientanwendungen oder einem anderen HTTP-REST-Client und einem Datengrid agiert.

Der REST-Datenservice enthält ein Beispiel, das Ihnen ermöglicht, schnell ein Datengrid zu erstellen und mit diesem über einen eXtreme-Scale-Client oder den REST-Datenservice zu interagieren. Weitere Einzelheiten zur Verwendung des Beispiels finden Sie unter REST-Datenservices konfigurieren.

Wenn WebSphere eXtreme Scale 7.1 installiert oder die Testversion von eXtreme Scale Version 7.1 extrahiert wird, sind die folgenden Verzeichnisse und Dateien enthalten:
  • Ausgangsverzeichnis_des_REST-Service/lib
    Das Verzeichnis "lib" enthält die folgenden Dateien:
    • wxsrestservice.ear – Der Unternehmensanwendungsarchiv des REST-Datenservice für WebSphere Application Server und WebSphere Application Server CE.
    • wxsrestservice.war – Das Webmodul des REST-Datenservice für Apache Tomcat.

    Die Datei wxsrestservice.ear enthält die Datei wxsrestservice.war, und beide sind eng mit der Laufzeitumgebung von WebSphere WebSphere eXtreme Scale gekoppelt. Wenn ein Upgrade von WebSphere eXtreme Scale auf eine neue Version vorgenommen oder ein Fixpack angewendet wird, muss die Datei wxsrestservice.war bzw. wxsrestservice.ear manuell auf die in diesem Verzeichnis installierte Version aktualisiert werden.

  • Ausgangsverzeichnis_des_REST-Service/gettingstarted

    Das Verzeichnis gettingstarted enthält ein einfaches Beispiel, das veranschaulicht, wie der REST-Datenservice von WebSphere eXtreme Scale mit einem Datengrid verwendet wird.

Vorgehensweise

Packen und implementieren Sie den REST-Datenservice.

Der REST-Datenservice ist als eigenständiges WAR-Modul entworfen. Zum Konfigurieren des REST-Datenservice müssen Sie die Konfiguration des REST-Datenservice und die optionalen Konfigurationsdateien von WebSphere eXtreme Scale in eine JAR-Datei oder in ein Verzeichnis packen. Dieses Anwendungspaket wird anschließend von der Laufzeitumgebung des Webcontainerservers referenziert. Die folgende Abbildung zeigt die vom REST-Datenservice von eXtreme Scale verwendeten Dateien.

Abbildung 1. Dateien des REST-Datenservice von WebSphere eXtreme Scale
Dateien des REST-Datenservice von WebSphere eXtreme Scale

Die Konfigurations-JAR-Datei bzw. das Konfigurationsverzeichnis des REST-Service muss die folgenden Dateien enthalten:

wxsRestService.properties: Die Datei wxsRestService.properties enthält die Konfigurationsoptionen für den REST-Datenservice. Dazu gehören die Katalogserviceendpunkte, die Namen der bereitzustellenden ObjectGrids, Traceoptionen usw. Weitere Informationen finden Sie unter Eigenschaftendatei des REST-Datenservice.

Die folgenden ObjectGrid-Clientdateien sind optional:
  • META-INF/objectGridClient.xml: Die XML-Datei für das Überschreiben von ObjectGrid-Clients wird verwendet, um eine Verbindung zum fernen Datengrid herzustellen. Diese Datei ist standardmäßig nicht erforderlich. Wenn diese Datei nicht vorhanden ist, verwendet der REST-Service die Serverkonfiguration, woraufhin der nahe Cache inaktiviert wird.
    Der Name der Datei kann mit der Konfigurationseigenschaft "objectGridClientXML" des REST-Datenservice überschrieben werden. Wenn diese XML-Datei bereitgestellt wird, muss sie Folgendes enthalten:
    1. Alle ObjectGrids, die Sie dem REST-Service bereitstellen möchten
    2. Referenz auf die XML-Entitätsdeskriptordatei, die jeder ObjectGrid-Konfiguration zugeordnet ist
  • META-INF/XML-Entitätsdeskriptordateien: XML-Entitätsdeskriptordateien sind nur erforderlich, wenn der Client die Entitätsdefinition des Clients überschreiben muss. Die XML-Entitätsdeskriptordatei muss zusammen mit der XML-Deskriptordatei für das Überschreiben von ObjectGrid-Clients verwendet werden.
  • Entitätsklassen: Zum Beschreiben der Entitätsmetadaten können Sie annotierte Entitätsklassen oder eine XML-Entitätsdeskriptordatei verwenden. DER REST-Service erfordert nur dann Entitätsklassen im Klassenpfad, wenn die eXtreme-Scale-Server mit Entitätsmetadatenklassen konfiguriert wurden und keine XML-Entitätsdeskriptordatei für das Überschreiben von Clients verwendet wird.

    Im Folgenden sehen Sie ein Beispiel mit der erforderlichen Mindestkonfigurationsdatei, in dem die Entitäten in der XML auf den Servern definiert sind:

    restserviceconfig.jar:
    wxsRestService.properties
    Die Eigenschaftendatei enthält Folgendes:
    catalogServiceEndPoints=localhost:2809
    objectGridNames=NorthwindGrid

    Beispiel mit einer einzigen Entität, XML-Dateien für Überschreiben und Entitätsklassen:

    restserviceconfig.jar:
    wxsRestService.properties
    Die Eigenschaftendatei enthält Folgendes:
    catalogServiceEndPoints=localhost:2809
    objectGridNames=NorthwindGrid
    com/acme/entities/Customer.class
    META-INF/objectGridClient.xml
    Die ObjectGrid-XML-Deskriptordatei des Clients enthält Folgendes:
    <objectGrid name="CustomerGrid" entityMetadataXMLFile="emd.xml"/>
    META-INF/emd.xml
    Die XML-Deskriptordatei für die Entitätsmetadaten enthält Folgendes:
    <entity class-name="com.acme.entities.Customer" name="Customer"/>