Installation du service de données REST

Nous allons expliquer comment installer sur un serveur Web le service de données REST d'WebSphere eXtreme Scale.

Avant de commencer

Configuration logicielle

Le service de données REST d'WebSphere eXtreme Scale est une application Web Java qui peut être déployée sur tout serveur d'applications prenant en charge la spécification de servlet Java version 2.3 et un environnement d'exécution Java version 5 ou plus récente.

Les logiciels suivants sont requis :
  • Java Standard Edition 5 ou version ultérieure
  • le conteneur de servlets Web version 2.3 ou ultérieure, qui inclut l'un des éléments suivants :
    • le serveur d'applications WebSphere version 6.1.0.25 ou ultérieure
    • le serveur d'applications WebSphere version 7.0.0.5 ou ultérieure
    • WebSphere Community Edition version 2.1.1.3 ou ultérieure
    • Apache Tomcat version 5.5 ou ultérieure
  • WebSphere eXtreme Scale, Version 7.1 ou ultérieure, y compris la version d'évaluation.

Pourquoi et quand exécuter cette tâche

Le service de données REST WebSphere eXtreme Scale inclut un seul fichier wxsrestservice.war. Le fichier wxsrestservice.war comporte un seul servlet qui fait office de passerelle entre vos applications client WCF Data Services ou tout autre client REST HTTP et une grille de données.

Le service de données REST contient un exemple qui permet de créer rapidement une grille de données et d'interagir avec elle en utilisant un client eXtreme Scale ou le service de données REST. Voir Configuration des services de données REST pour plus d'informations sur l'utilisation de l'exemple.

Lors de l'installation de WebSphere eXtreme Scale 7.1 ou de l'extraction de la version d'évaluation d'eXtreme Scale version 7.1, les répertoires et fichiers suivants sont inclus :
  • base_servicerest/lib
    Le répertoire lib contient ces fichiers :
    • wxsrestservice.ear – L'archive d'application d'entreprise de service de données REST à utiliser avec le serveur d'application WebSphere et le serveur d'application CE WebSphere.
    • wxsrestservice.war – Le module Web de service de données REST à utiliser avec Apache Tomcat.

    Le fichier wxsrestservice.ear inclut le fichier wxsrestservice.war et tous deux sont étroitement couplés à l'environnement d'exécution WebSphere eXtreme Scale. En cas de mise à niveau d'WebSphere eXtreme Scale vers une nouvelle version ou si un groupe de correctifs est appliqué, les fichiers wxsrestservice.war file ou wxsrestservice.ear devront être mis à niveau manuellement vers la version installée dans ce répertoire.

  • base_servicerest/gettingstarted

    Le répertoire gettingstarted contient un exemple simple montrant comment utiliser le service de données REST WebSphere eXtreme Scale avec une grille de données.

Procédure

Packagez et déployez le service de données REST.

Le service de données REST a été conçu en tant que module WAR autonome. Pour configurer le service de données REST, vous devez commencer par packager dans un fichier JAR ou dans un répertoire la configuration du service de données REST et les éventuels fichiers de configuration d'WebSphere eXtreme Scale. Ce package d'application est ensuite référencé par l'environnement d'exécution du serveur de conteneur Web. La figure suivante illustre les fichiers utilisés par le service de données REST d'eXtreme Scale.

Figure 1. Fichiers du service de données REST d'WebSphere eXtreme Scale
Fichiers du service de données REST de WebSphere eXtreme Scale

Le fichier JAR de configuration du service REST ou le répertoire doit contenir le fichier suivant :

wxsRestService.properties : le fichier wxsRestService.properties comprend les options de configuration du service de données REST : points de contact du service de catalogue, noms d'ObjectGrid à exposer, options de suivi, etc. Voir Fichier de propriétés du service de données REST.

Les fichiers suivants du client ObjectGrid sont facultatifs :
  • META-INF/objectGridClient.xml : le fichier XML de substitution de client ObjectGrid est utilisé pour se connecter à la grille de données distante. Par défaut, ce fichier n'est pas requis. En son absence, le service REST utilise la configuration du serveur en désactivant le cache proche.
    Le nom du fichier peut être remplacé à l'aide de la propriété de configuration du service de données REST objectGridClientXML. S'il est fourni, ce fichier XML doit inclure :
    1. Les ObjectGrids à exposer au service de données REST.
    2. Toute référence au fichier XML descripteur d'entité associé à chaque configuration ObjectGrid.
  • META-INF/fichiers XML de descripteurs d'entités : un ou plusieurs fichiers XML de descripteurs d'entités ne sont requis que si le client doit remplacer la définition d'entité du client. Le fichier XML du descripteur d'entité doit être utilisé avec le fichier XML du descripteur d'entité de remplacement ObjectGrid par les clients.
  • Classes entité Vous pouvez utiliser des classes entité annotées ou un fichier XML descripteur d'entité pour décrire les métadonnées d'entité. Le service REST ne nécessite les classes d'entités dans le chemin d'accès aux classes que si les serveurs eXtreme Scale sont configurés avec les classes de métadonnées d'entités. Aucun fichier XML de descripteur d'entité de remplacement par le client n'est utilisé.

    Voici un exemple avec le fichier de configuration minimum requise, où les entités sont définies dans XML sur les serveurs :

    restserviceconfig.jar:
    wxsRestService.properties
    Le fichier de propriétés contient :
    catalogServiceEndPoints=localhost:2809
    objectGridNames=NorthwindGrid

    Un exemple avec une entité, des fichiers XML de remplacement et des classes entité :

    restserviceconfig.jar:
    wxsRestService.properties
    Le fichier de propriétés contient :
    catalogServiceEndPoints=localhost:2809
    objectGridNames=NorthwindGrid
    com/acme/entities/Customer.class
    META-INF/objectGridClient.xml
    Le fichier XML descripteur du client ObjectGrid contient :
    <objectGrid name="CustomerGrid" entityMetadataXMLFile="emd.xml"/>
    META-INF/emd.xml
    Le fichier XML descripteur des métadonnées d'entité contient :
    <entity class-name="com.acme.entities.Customer" name="Customer"/>