31 Coherence RESTのデプロイ

Coherence RESTは、埋込みHTTPサーバー、WebLogic Server、および任意の汎用サーブレット・コンテナにデプロイできます。

この章の内容は次のとおりです。

埋込みHTTPサーバーによるデプロイ

Coherenceでは、RESTful Webサービスをホストするために使用できるNetty埋込みHTTPサーバーが実装されます。「埋込みHTTPサーバーの変更」を参照してください。

• DefaultHttpServer (Oracleの軽量HTTPサーバーでバッキング)

• NettyHttpServer (Netty HTTPサーバーでバックアップされ、本番環境に推奨)

HTTPサーバーは、Coherenceプロキシ・サーバー上で有効である必要があります。HTTPサーバーを有効にするには、プロキシのキャッシュ構成ファイルを編集して、<http-acceptor>要素を<proxy-scheme>要素の中に追加し、HTTPサーバーのホストおよびポートを指定します。<address>要素は、ローカル・アドレスにルーティングする外部NATアドレスもサポートしますが、両方のアドレスで同じポート番号を使用する必要があります。

次の例では、ローカルホスト127.0.0.1およびポート8080でリクエストを受け入れるようにHTTPサーバーを構成します。例では、HTTPサーバー・クラスおよびJerseyリソース構成クラスを明示的に定義し、Coherence RESTアプリケーションのコンテキスト・パスとして/を使用しています。ただし、デフォルト値があるので含める必要はありません。コンテキスト・パスは必要に応じて変更でき、別のコンテキス・パスとともに追加のCoherence RESTアプリケーションを定義できます。『Oracle Coherenceでのアプリケーションの開発』のhttp-acceptorに関する項を参照してください。

<proxy-scheme>
   <service-name>ExtendHttpProxyService</service-name>
   <acceptor-config>
      <http-acceptor>
         <class-name>com.tangosol.coherence.http.netty.NettyHttpServer</class-name>
         <local-address>
            <address>127.0.0.1</address>
            <port>8080</port>
         </local-address>
         <resource-config>
            <context-path>/</context-path>
            <instance>
               <class-name>
                  com.tangosol.coherence.rest.server.DefaultResourceConfig
               </class-name>
            </instance>
         </resource-config>
      </http-acceptor>
   </acceptor-config>
   <autostart>true</autostart>
</proxy-scheme>

POFを使用している場合は、pof-config.xmlファイルにREST POFタイプの場所が含まれていることを確認します。「POFが有効化されているサービスへのRESTサーバー・アクセスの構成」を参照してください。

WebLogicサーバーへのデプロイ

WebLogic Serverには、WebLogicサーバー・ドメイン内にCoherenceアプリケーションをパッケージ化、デプロイおよび管理する方法を標準化するCoherence統合機能が含まれています。Coherence RESTは統合標準に準拠する必要があります。『Oracle WebLogic Serverクラスタの管理』の「Coherenceクラスタの構成と管理」を参照してください。さらに、Coherenceアプリケーションは、グリッド・アーカイブ(GAR)としてパッケージ化する必要があります。『Oracle Coherenceでのアプリケーションの開発』のCoherenceアプリケーションのパッケージ化に関する項を参照してください。

この項には次のトピックが含まれます:

タスク1: Coherence RESTのWebLogicサーバー・ドメインの構成

Coherence RESTをホストするWebLogicサーバー・ドメインに、管理Coherenceサーバーを作成します。サーバーは、Coherenceクラスタのストレージが無効なメンバーとして構成する必要があります。Coherence RESTソリューションに複数の管理Coherenceサーバーが必要な場合、そのサーバーはWebLogicサーバー・クラスタ内の階層として管理される必要があります。『Oracle WebLogic Serverクラスタの管理』のCoherenceクラスタの設定に関する項を参照してください。

タスク2: Coherence REST Webアプリケーションのパッケージ化

Coherence REST Webアプリケーションをパッケージ化するには:

1. 次のようにWebアプリケーション・ディレクトリ構造を作成します。

   /
   /WEB-INF/
   /WEB-INF/classes/
   /WEB-INF/lib/
   

2. Webアプリケーション・デプロイメント・ディスクリプタ(web.xml)を作成し、次のようにRESTアプリケーションのサーブレットの定義を含めます。

   ノート:

   WebLogic Serverのクラスパスには、RESTアプリケーションの停止中にクラスタ・メンバーを停止するデフォルトのサーブレット・コンテキスト・リスナーを含むcoherence-rest.jarライブラリが含まれています。このリスナーは次に示すように登録されています。クラスタ・メンバーがシャットダウンされない場合、シャットダウン後に様々な例外がスローされます。

   <web-app>
      ...
      <listener>
         <listener-class>
            com.tangosol.coherence.rest.servlet.DefaultServletContextListener
         </listener-class>
      </listener>
      <servlet>
         <servlet-name>Coherence REST</servlet-name>
         <servlet-class>org.glassfish.jersey.servlet.ServletContainer
         </servlet-class>
         <init-param>
            <param-name>jakarta.ws.rs.Application</param-name>
            <param-value>
               com.tangosol.coherence.rest.server.ContainerResourceConfig
            </param-value>
         </init-param>
         <load-on-startup>1</load-on-startup>
      </servlet>
      <servlet-mapping>
         <servlet-name>Coherence REST</servlet-name>
         <url-pattern>/rest/*</url-pattern>
       </servlet-mapping>
         ...
   </web-app>
   

3. web.xmlファイルを/WEB-INF/ディレクトリに保存します。
4. jarユーティリティを使用して、WARファイルを作成します。たとえば、Webアプリケーション・ディレクトリのルートでコマンド・プロンプトから次のコマンドを発行します。

   jar -cvf coherence_rest.war *
   

タスク3: Coherenceアプリケーションのパッケージ化

Coherenceアプリケーションをパッケージ化するには:

1. coherence-rest-config.xmlファイルをCoherenceアプリケーションのルートにコピーします。構造は次のとおりにする必要があります。

   /
   /com/myco/MyClass.class
   /lib/
   /META-INF/
   /META-INF/coherence-application.xml
   /META-INF/coherence-cache-config.xml
   /META-INF/pof-config.xml
   coherence-rest-config.xml
   

2. pof-config.xmlファイルを編集し、Coherence RESTデフォルト・ユーザー・タイプを含むcoherence-rest-pof-config.xml POF構成ファイルをインクルードします。「POFが有効化されているサービスへのRESTサーバー・アクセスの構成」を参照してください。
3. jarユーティリティを使用して、GARファイルを作成します。たとえば、コマンド・プロンプトからGARディレクトリのルートで次のコマンドを発行します。

   jar -cvf MyCohApp.gar *
   

タスク4: エンタープライズ・アプリケーションのパッケージ化

エンタープライズ・アプリケーションをパッケージ化するには:

1. エンタープライズ・アプリケーション・ディレクトリ構造を作成し、Coherence REST WARファイルおよびCoherenceアプリケーションGARファイルをEARのルートにコピーします。たとえば:

   /
   /META-INF/
   /META-INF/application.xml
   /META-INF/weblogic-application.xml
   /coherence_rest.war
   /MyCohApp.gar
   

2. application.xmlファイルを編集し、Coherence REST Webアプリケーションのモジュール定義を追加します。たとえば:

   <application>
      <module>
         <web>
            <web-uri>coherence_rest.war</web-uri>
            <context-root>/</context-root>
         </web>
      </module>
   </application>
   

3. weblogic-application.xmlファイルを編集し、CoherenceアプリケーションのGARファイルのモジュール参照を追加します。たとえば:

   <weblogic-application>
      <module>
         <name>person</name>
         <type>GAR</type>
         <path>MyCohApp.gar</path>
      </module>
   </weblogic-application>
   

4. jarユーティリティを使用して、EARファイルを作成します。たとえば、コマンド・プロンプトでEARディレクトリのルートから次のコマンドを発行します。

   jar -cvf MyCohRestApp.ear *
   

タスク5: エンタープライズ・アプリケーションのデプロイ

エンタープライズ・アプリケーションをデプロイするには:

1. WebLogicリモート・コンソールまたはWLSTツールを使用して、タスク1で作成した管理対象CoherenceサーバーにEARをデプロイします。
2. ブラウザから、管理Coherenceサーバーのリスニング・ポートに移動しURLの一部にキャッシュ名を含めることにより、デプロイメントを検証します。たとえば: http://host:port/rest/{cacheName}

Jakarta EEサーバー(一般)へのデプロイ

Coherence RESTは、任意の標準Jakarta EE環境にデプロイできます。

この項には次のトピックが含まれます:

デプロイメント用のCoherence RESTのパッケージ化

Coherence RESTアプリケーションをパッケージ化するには:

1. 次のように基本のWebアプリケーション・ディレクトリ構造を作成します。

   /
   /WEB-INF
   /WEB-INF/classes
   /WEB-INF/lib
   

2. coherence.jarおよびcoherence-rest.jarライブラリをCOHERENCE_HOME/libディレクトリから/WEB-INF/libディレクトリにコピーします。
3. Coherence RESTの依存性をORACLE_HOME/oracle_common/modules/ディレクトリから/WEB-INF/libディレクトリにコピーします。「Coherence RESTの依存性」を参照してください。
4. Webアプリケーション・デプロイメント・ディスクリプタ(web.xml)を作成し、次のようにRESTアプリケーションのサーブレットの定義を含めます。

   ノート:

   デフォルトのサーブレット・コンテキスト・リスナーは、RESTアプリケーションのシャットダウン中にクラスタ・メンバーをシャットダウンするcoherence-rest.jarに含まれています。このリスナーは次に示すように登録されています。クラスタ・メンバーがシャットダウンされない場合、シャットダウン後に様々な例外がスローされます。

   <web-app>
      ...
      <listener>
         <listener-class>
            com.tangosol.coherence.rest.servlet.DefaultServletContextListener
         </listener-class>
      </listener>
      <servlet>
         <servlet-name>Coherence REST</servlet-name>
         <servlet-class>org.glassfish.jersey.servlet.ServletContainer
         </servlet-class>
         <init-param>
            <param-name>jakarta.ws.rs.Application</param-name>
            <param-value>
               com.tangosol.coherence.rest.server.ContainerResourceConfig
            </param-value>
         </init-param>
         <load-on-startup>1</load-on-startup>
      </servlet>
      <servlet-mapping>
         <servlet-name>Coherence REST</servlet-name>
         <url-pattern>/*</url-pattern>
       </servlet-mapping>
         ...
   </web-app>
   

5. web.xmlファイルを/WEB-INF/ディレクトリに保存します。
6. coherence-rest-config.xmlファイルをWEB-INF/classesディレクトリにコピーします。
7. coherence-cache-config.xmlファイルおよびtangosol-coherence-override.xmlファイルをWEB-INF/classesディレクトリにコピーします。
8. POFを使用している場合は、pof-config.xmlファイルをWEB-INF/classesディレクトリにコピーします。pof-config.xmlファイルにREST POFタイプの場所が含まれていることを確認します。「POFが有効化されているサービスへのRESTサーバー・アクセスの構成」を参照してください。
9. jarユーティリティを使用して、Web ARchive (WAR)ファイルを作成します。たとえば、Webアプリケーション・ディレクトリのルートでコマンド・プロンプトから次のコマンドを発行します。

   jar -cvf coherence_rest.war *
   

   アーカイブには次のファイルが含まれます。:

   /WEB-INF/web.xml
   /WEB-INF/classes/coherence-rest-config.xml
   /WEB-INF/classes/tangosol-coherence-override.xml
   /WEB-INF/classes/coherence-cache-config.xml
   /WEB-INF/lib/coherence.jar
   /WEB-INF/lib/coherence-rest.jar
   /WEB-INF/lib/coherence_dependencies
   

サーブレット・コンテナへのデプロイ

Coherence RESTをWARファイルとしてパッケージ化することで、Coherence RESTを任意のサーブレット・コンテナにデプロイできます。「デプロイメント用のCoherence RESTのパッケージ化」を参照してください。WARファイルのデプロイの詳細は、ベンダーのドキュメントを参照してください。また、追加のサーブレット・コンテナ・デプロイメントのオプションについては、Jerseyユーザー・ガイドを参照してください。

https://eclipse-ee4j.github.io/jersey.github.io/documentation/3.0.0/index.html

POFが有効化されているサービスへのRESTサーバー・アクセスの構成

POFが有効化されているサービスには、定義済のCoherence REST POFユーザー・タイプが含まれている必要があります。ユーザー・タイプは、coherence-rest.jarライブラリに配置されているcoherence-rest-pof-config.xmlファイルに定義され、実行時に自動的にロードされます。

RESTのデフォルトのユーザー・タイプを構成するには、pof-config.xmlファイルを編集して、coherence-rest-pof-config.xml POF構成ファイルを含めます。たとえば:

<pof-config>
   <user-type-list>
      <include>coherence-pof-config.xml</include>
      <include>coherence-rest-pof-config.xml</include>
      ...
   </user-type-list>
</pof-config>