REST データ・サービスのインストール

このトピックでは、WebSphere® eXtreme Scale REST データ・サービスを Web サーバーにインストールする方法について説明します。

始める前に

ソフトウェア要件

WebSphere eXtreme Scale REST データ・サービスは、Java Web アプリケーションであり、Java サーブレット仕様バージョン 2.3 および Java ランタイム環境バージョン 5 以上をサポートする任意のアプリケーション・サーバーにデプロイできます。

以下のソフトウェアが必要です。
  • Java Standard Edition 5 以上
  • 以下のいずれかを含んだ、Web サーブレット・コンテナーのバージョン 2.3 以上
    • WebSphere Application Server バージョン 6.1.0.25 以上
    • WebSphere Application Server バージョン 7.0.0.5 以上
    • WebSphere Community Edition バージョン 2.1.1.3 以上
    • Apache Tomcat バージョン 5.5 以上
  • WebSphere eXtreme Scale バージョン 7.1 以上 (試用版を含む)

このタスクについて

WebSphere eXtreme Scale REST データ・サービスには、単一 wxsrestservice.war ファイルが含まれます。wxsrestservice.war には、WCF Data Services クライアント・アプリケーションまたはその他の HTTP REST クライアントとデータ・グリッド間のゲートウェイとして機能する単一のサーブレットが含まれています。

REST データ・サービスには、迅速にデータ・グリッドを作成し、eXtreme Scale クライアントまたは REST データ・サービスを使用してそのグリッドと対話できるようにするサンプルが含まれています。サンプルの使用法の詳細については、REST データ・サービスの構成を参照してください。

WebSphere eXtreme Scale 7.1 をインストールするか、eXtreme Scale バージョン 7.1 試用版を解凍した場合には、以下のディレクトリーおよびファイルが含まれます。
  • restservice_home/lib
    lib ディレクトリーには、以下のファイルが含まれます。
    • wxsrestservice.ear – WebSphere Application Server および WebSphere Application Server CE で使用するための REST データ・サービス・エンタープライズ・アプリケーション・アーカイブ。
    • wxsrestservice.war – Apache Tomcat で使用するための REST データ・サービス Web モジュール。

    wxsrestservice.ear ファイルには、wxsrestservice.war ファイルが含まれており、ともに WebSphere WebSphere eXtreme Scale ランタイムに密結合されています。WebSphere eXtreme Scale を新しいバージョンにアップグレードするかフィックスパックを適用した場合には、wxsrestservice.war ファイルまたは wxsrestservice.ear ファイルを、このディレクトリーにインストールされたバージョンに手動でアップグレードする必要があります。

  • restservice_home/gettingstarted

    gettingstarted ディレクトリーには、WebSphere eXtreme Scale REST データ・サービスをデータ・グリッドで使用する方法を説明する単純なサンプルが含まれます。

手順

REST データ・サービスをパッケージ化し、デプロイします。

REST データ・サービスは、必要なものを完備した WAR モジュールとして設計されています。 REST データ・サービスを構成するには、まず、REST データ・サービス構成およびオプションの WebSphere eXtreme Scale 構成ファイルを JAR ファイルまたはディレクトリーにパッケージ化する必要があります。このアプリケーション・パッケージは、Web コンテナー・サービス・ランタイムによって参照されます。 次の図に、eXtreme Scale REST データ・サービスで使用されるファイルを示します。

図 1. WebSphere eXtreme Scale REST データ・サービスのファイル
WebSphere eXtreme Scale REST データ・サービスのファイル

REST サービス構成 JAR またはディレクトリーには、以下のファイルが含まれている必要があります。

wxsRestService.properties: wxsRestService.properties ファイルには、REST データ・サービスの構成オプションが含まれます。これには、カタログ・サービス・エンドポイント、公開する ObjectGrid 名、トレース・オプションなどがあります。 REST データ・サービスのプロパティー・ファイルを参照してください。

以下の ObjectGrid クライアント・ファイルはオプションです。
  • META-INF/objectGridClient.xml: ObjectGrid クライアント・オーバーライド XML ファイルは、リモート・データ・グリッドに接続するために使用します。デフォルトでは、このファイルは必要ではありません。 このファイルが存在しない場合には、REST サービスはサーバー構成を使用して、ニア・キャッシュを使用不可にします。
    ファイルの名前は、objectGridClientXML REST データ・サービス構成プロパティーを使用してオーバーライドできます。 この XML ファイルを提供する場合には、ファイルに以下を含める必要があります。
    1. REST データ・サービスに公開するすべての ObjectGrid。
    2. 各 ObjectGrid 構成に関連付けられたエンティティー記述子 XML ファイルへの参照。
  • META-INF/エンティティー記述子 XML ファイル: クライアントでクライアントのエンティティー定義をオーバーライドする必要がある場合にのみ、1 つ以上のエンティティー記述子 XML ファイルが必要です。エンティティー記述子 XML ファイルは、ObjectGrid クライアント・オーバーライド XML 記述子ファイルと組み合わせて使用する必要があります。
  • エンティティー・クラス。アノテーションが付けられたエンティティー・クラスまたはエンティティー記述子 XML ファイルを使用して、エンティティー・メタデータを記述できます。 REST サービスでは、eXtreme Scale サーバーがエンティティー・メタデータ・クラスを使用して構成されていて、クライアント・オーバーライド・エンティティー XML 記述子を使用しない場合にのみ、クラスパス内にエンティティー・クラスが必要になります。

    エンティティーがサーバー上で XML で定義された、最小要件の構成ファイルを使用した例:

    restserviceconfig.jar:
    wxsRestService.properties
    プロパティー・ファイルには、以下が含まれます。
    catalogServiceEndPoints=localhost:2809
    objectGridNames=NorthwindGrid

    単一エンティティー、オーバーライド XML ファイル、およびエンティティー・クラスの例:

    restserviceconfig.jar:
    wxsRestService.properties
    プロパティー・ファイルには、以下が含まれます。
    catalogServiceEndPoints=localhost:2809
    objectGridNames=NorthwindGrid
    com/acme/entities/Customer.class
    META-INF/objectGridClient.xml
    クライアント ObjectGrid 記述子 XML ファイルには、以下が含まれます。
    <objectGrid name="CustomerGrid" entityMetadataXMLFile="emd.xml"/>
    META-INF/emd.xml
    エンティティー・メタデータ記述子 XML ファイルには、以下が含まれます。
    <entity class-name="com.acme.entities.Customer" name="Customer"/>