Oracle Coherence REST を WebLogic Server への デプロイ手順 日本オラクル株式会社 作成日 : 2011/10/17 更新日 : 2011/11/2 VERSION: 1.1 Copyright Oracle Corporation Japan, A

Transcription

1 Oracle Coherence REST を WebLogic Server への デプロイ手順 日本オラクル株式会社 作成日 : 2011/10/17 更新日 : 2011/11/2 VERSION: 1.1 Copyright Oracle Corporation Japan, All rights reserved. i

2 利用時の注意点 本ドキュメントのご利用に際しましては 以下の注意点にご留意くださいますようよろしくお願いいたします 本ドキュメントは参考情報として現状有姿 ("AS-IS") で提供され いかなる保証もありません 商品性及び特定目的への適合性についての黙示の保証を含め 明示的あるいは黙示的な保証は一切無いものとします 本ドキュメントについてのサポートサービスは一切提供されません Oracle ECM パートナー様以外への本ドキュメントの提供はお控えください ii

3 目次 1. はじめに 本資料について 目的 対象 前提知識 構成 参考情報 基本情報 動作確認済環境 /OS/ 必須アプリケーション 改訂履歴 Coherence REST を WebLogic Server へのデプロイ 環境構築 システム要件の確認 Coherence 3.7.1のインストール WebLogic Server のインストール Coherence RESTとは Coherence RESTの概要 Coherence RESTの依存関係 Coherence RESTの構成の概要 WebLogic Serverへのデプロイ 基本的なWebアプリケーションの作成 デプロイのCoherence RESTのパッケージの作成 WebLogic Serverへのデプロイ RESTクライアントでの動作確認 RESTクライアントの入手 RESTクライアントでの動作確認 iii

4 1. はじめに 1.1. 本資料について 目的 この資料では Oracle Coherence REST アプリケーションを WebLogic Server にデプロイする手順を説明します 対象 次の読者を対象としています ソフトウェア開発者およびアーキテクトの方 前提知識 次の読者を対象としています WebLogic Server Java EE に関する知識と用語の理解 構成 各操作は前項 ( 前章 ) に書かれた設定が前提となります 当ドキュメントに記された手順通りに設定を行ってください 参考情報 Oracle Coherence Client Guide Release Deploying Coherence REST 基本情報 動作確認済環境 /OS/ 必須アプリケーション Oracle Coherence for Java バージョン Version: Oracle WebLogic Server バージョン Version: 11g (10.3.5) OS Windows XP Professional Sp3 必須アプリケーション JDK/JRE 以上 1

5 改訂履歴 なし 2

6 2. Coherence REST を WebLogic Server へのデプロイ 2.1. 環境構築 システム要件の確認 WebLogic Server と Oracle Coherence for Java をインストールする前に システム要件を確認します Oracle Fusion Middleware のシステム要件は以下の URL より確認できます Oracle Fusion Middleware System Requirements and Specifications 11g Release 1 (11.1.1) また サポート条件をあわせて確認します 最新のサポート条件は 以下の URL より確認できます Oracle Fusion Middleware 11g Release1( x) certification Matrix なお Oracle Coherence for Java のシステム要件について 以下の資料を参照してください Oracle Coherence 開発者ガイド - Oracle Coherence for Java のインストール - システム要件 Coherence のインストール Coherence のダウンロード Oracle Coherence は 複数のハードウェアから構成されたサーバー群で仮想的な共有メモリ領域を確保し 大量のデータを高速処理するソフトです 最新版の Oracle Coherence for Java は 以下のページからダウンロードできます Coherence のインストール ダウンロードした coherence-java b27797.zip ファイルの内容を C: oracle product ( 以下は COHERENCE_HOME と記述 ) というディレクトリに抽出します この zip ファイルには 次のサブディレクトリを含む coherence ディレクトリが含まれています bin: コマンド スクリプトを格納 doc: 製品のドキュメントを格納 lib: 必要なライブラリ ファイルを格納 WebLogic Server のインストール WebLogic Server のダウンロード OTN より Coherence+OEPE-Package Installer 版の WebLogic Server をダウンロードします ダウンロード先 WebLogic Server のインストール WebLogic Server のインストールは 以下のインストール ガイドを参照してインストールしてください Oracle Fusion Middleware Installation Guide for Oracle WebLogic Server - Starting the Installation Program in Graphical Mode on Windows 3

7 2.2. Coherence REST とは Coherence REST の概要 REST とは REST(REpresentational State Transfer) は ウェブのような分散ハイパーメディア システムのためのソフトウェア アーキテクチャのスタイル ( 標準ではない ) のひとつです REST 原則に従うシステムでは すべてのリソースは URI (Uniform Resource Identifier) で表される一意的なアドレスを持ちます HTTP プロトコルの GET/PUT/POST/DELETE 操作を使うことにより リソースを取得 / 追加 / 更新 / 削除することが可能です REST 原則に従うシステムは しばしば RESTful といわれます Coherence REST 導入 新版の Oracle Coherence では Coherence REST(Coherence RESTful API) が新たに導入されました Coherence REST は HTTP プロトコルを介して Coherence キャッシュとキャッシュのエントリに簡単にアクセスできます リモート クライアントが Coherence クラスタのメンバーでなくても Coherence に格納されたデータをアクセスできます なお HTTP を使用して JSON や XML などの複数の表現形式のデータを マーシャリングできます Coherence REST を導入することにより Coherence キャッシュを利用できるクライアント言語が拡大されました 具体的には Ruby や Python などで Coherence キャッシュで保持されたデータに対し アクセス 操作 レポートが可能になっています Coherence REST の依存関係 Coherence REST は 次の Oracle およびサードパーティのライブラリに依存します 名前説明 JAR ファイル Jersey 1.8 JAX-RS(REST の Web サービス用の Java API JSR 311) のリファレンス実装 jersey-core-1.8.jar jersey-json-1.8.jar jersey-server-1.8.jar jersey-grizzly2-1.8.jar jersey-grizzly2-1.8.jar は以下の Jersey プロジェクト ページからダウンロードします Grizzly Jerseyとうまく統合する組込みのWebサーバー grizzly-framework jar grizzly-http jar grizzly-http-server jar Jackson JSONシリアライザ jackson-all jar Jersey と Jackson の JAR ファイルは COHERENCE_HOME/lib ディレクトリに含まれています Grizzly の JAR ファイルは Grizzly のプロジェクト ページからダウンロードできます Coherence REST の構成の概要 Coherence REST は 以下の二つの構成ファイルを使用して構成されます 4

8 キャッシュ構成デプロイメント ディスクリプタ REST 構成デプロイメント ディスクリプタ キャッシュ構成デプロイメント ディスクリプタ このファイルは クライアント側のキャッシュ サービスや HTTP 経由でリモートの REST クライアントからの接続を受け付ける HTTP のアクセプターを定義するために使用されます アクセプターは クライアントが接続するクラスタ側の HTTP サーバーのアドレスとポートが含まれます デフォルトのファイル名が coherence-cache- config.xml です このファイルのスキーマは coherence-cacheconfig.xsd ファイルです <http-acceptor> 要素の完全なリファレンスについて 以下の資料を参照してください Oracle Coherence 開発者ガイド - キャッシュ構成要素 - <http-acceptor> tm#cohdg5594 実行時に classpath 上で検出された最初のキャッシュ構成ファイルが使用されます また キャッシュ構成ファイルは tangosol.coherence.cacheconfig システム プロパティを使用して明示的に指定できます プログラムによって設定することもできます キャッシュ構成ファイルの指定の詳しくは 以下の資料を参照してください Oracle Coherence 開発者ガイド - 構成の理解 - キャッシュ構成ファイルの指定 REST 構成デプロイメント ディスクリプタ このファイルは Jersey のリソース構成クラス カスタム アグリゲーターとカスタム エントリ プロセッサを設定するために使用されます デフォルトのファイル名が coherence-rest-config.xml です スキーマが coherence-rest-config.xsd ファイルで定義されています このファイルが classpath 上に存在する必要があり 名前が tangosol.coherence.rest.config システム プロパティを使用してオーバーライドできます REST 構成デプロイメント ディスクリプタの詳細なリファレンスについては 以下の資料を参照してください Oracle Coherence クライアント ガイド 付録 A REST 構成要素 WebLogic Server へのデプロイ 基本的な Web アプリケーションの作成 ここでは 以下の階層でサンプル Web アプリケーション RestExample を作成します / /WEB-INF/web.xml /WEB-INF/classes/example/Person.java /WEB-INF/classes/example/Person.class /WEB-INF/lib 以下は Web アプリケーション RestExample の格納先を RESTExample_ROOT と表記します 以下は 作成の手順を説明します /WEB-INF/web.xmlを作成 <?xml version="1.0" encoding="utf-8"?> <web-app xmlns:xsi=" 5

9 xmlns=" xmlns:web=" xsi:schemalocation=" id="webapp_id" version="2.5"> <display-name>restexample</display-name> </web-app> /WEB-INF/classes/example/Person.java を作成 package example; import java.io.serializable; import javax.xml.bind.annotation.xmlaccesstype; import javax.xml.bind.annotation.xmlaccessortype; public class Person implements Serializable { public Person() {} public Person(String name, int age) { m_name = name; m_age = age; } public String getname() { return m_name; } public void setname(string name) { m_name = name; } public int getage() { return m_age; } public void setage(int age) { m_age = age; } } protected String m_name; protected int m_age; /WEB-INF/classes/example/Person.java をコンパイル 以下の java コマンドで Person.java をコンパイルします > cd RESTExample_ROOT\WEB-INF\classes > javac example\person.java デプロイの Coherence REST のパッケージの作成 ここでは 上に作成した基本的な Web アプリケーションを基づき Coherence REST の Web アプリケーションを作成して パッケージを生成します / WEB-INF/lib ディレクトリに次のJARをコピー COHERENCE_HOME/lib ディレクトリから /WEB-INF/lib ディレクトリに次のJARをコピーします coherence.jar coherence-rest.jar jackson-all jar 6

10 jersey-core-1.8.jar jersey-json-1.8.jar jersey-server-1.8.jar /WEB-INF/web.xml に次のサーブレット定義を追加以下の定義をコピーして web.xmlファイルの <web-app> 要素の下に追加します <servlet> <servlet-name>coherence REST</servlet-name> <servlet-class>com.sun.jersey.spi.container.servlet.servletcontainer</servlet-class> <init-param> <param-name>com.sun.jersey.config.property.resourceconfigclass</param-name> <param-value>com.tangosol.coherence.rest.server.defaultresourceconfig</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-INF/weblogic.xml を作成 以下のように WebLogic Server 固有のデプロイメント ディスクリプタ /WEB-INF/weblogic.xml を作成します <?xml version="1.0" encoding="utf-8"?> <wls:weblogic-web-app xmlns:wls=" xmlns:xsi=" xsi:schemalocation=" <wls:container-descriptor> <wls:prefer-web-inf-classes>true</wls:prefer-web-inf-classes> </wls:container-descriptor> </wls:weblogic-web-app> /WEB-INF/classes ディレクトリに次の xml ファイルを作成 coherence-rest-config.xml coherence-cache-config.xml tangosol-coherence-override.xml /WEB-INF/classes/coherence-rest-config.xml <?xml version="1.0"?> <rest xmlns:xsi=" xmlns=" xsi:schemalocation= " coherence-rest-config.xsd"> <resources> <resource> <cache-name>dist-http-example</cache-name> <key-class>java.lang.string</key-class> <value-class>example.person</value-class> </resource> 7

11 </resources> </rest> coherence-rest-config.xmlファイルの詳細については 前述のREST 構成デプロイメント ディスクリプタを参照してください /WEB-INF/classes/coherence-cache-config.xml <?xml version="1.0"?> <cache-config xmlns:xsi=" xmlns=" xsi:schemalocation=" coherence-cache-config.xsd"> <caching-scheme-mapping> <cache-mapping> <cache-name>dist-http-example</cache-name> <scheme-name>dist-http</scheme-name> </cache-mapping> </caching-scheme-mapping> <caching-schemes> <distributed-scheme> <scheme-name>dist-http</scheme-name> <backing-map-scheme> <local-scheme/> </backing-map-scheme> <autostart>true</autostart> </distributed-scheme> </caching-schemes> </cache-config> この例では キャッシュ名は dist-http-example と設定されています coherence-cache-config.xmlファイルの詳細については 前述のキャッシュ構成デプロイメント ディスクリプタを参照してください /WEB-INF/classes/tangosol-coherence-override.xml <?xml version="1.0" encoding="utf-8"?> <coherence xmlns=" xmlns:xsi=" xsi:schemalocation=" <cluster-config> <member-identity> <cluster-name system-property="tangosol.coherence.cluster">mycluster</cluster-name> </member-identity> <multicast-listener> <port system-property="tangosol.coherence.clusterport">3059</port> </multicast-listener> </cluster-config> </coherence> この構成はオプションの構成です この構成では デフォルトのCoherenceのクラスタ名を MyCluster に ポートを 3059 にオーバーライドします tangosol-coherence-override.xmlの詳細について 以下の資料を参照してください Web アーカイブ (WAR) ファイルを作成 8

12 以下のコマンドで WAR ファイルを作成します > cd RESTExample_ROOT > jar -cvf RestExample.war * 作成したアーカイブには 次のファイルが含まれている必要があります /WEB-INF/web.xml /WEB-INF/weblogic.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/jackson-all jar /WEB-INF/lib/jersey-core-1.8.jar /WEB-INF/lib/jersey-json-1.8.jar /WEB-INF/lib/jersey-server-1.8.jar WebLogic Server へのデプロイ ここでは WebLogic 管理コンソールを使って 上に生成した Coherence Rest パッケージ RestExample.war を WebLogic Server にデプロイする手順を説明します WebLogic 管理コンソールにログイン 管理ユーザーとパスワードを入力して ログイン をします RestExample.war のデプロイ 9

13 左側に デプロイメント Deployments を選択して 表示される デプロイメントのサマリー Summary of Deployment ページの インストール Install をクリックします インストールおよびデプロイの準備をするデプロイメントの選択 Locate deployment to install and prepare for deployment ページが表示されます RESTExample_ROOT RestExample.war を選択して 次へ Next をクリックします ターゲット指定スタイルの選択 Choose targeting style ページが表示されます このデプロイメントをアプリケーションとしてインストールする Intall this deployment as an application を選択して 次へ Next をクリックします 10

14 オプション設定 Optional Settings ページが表示されます デフォルトのまま 終了 Finish をクリックします アプリケーション名は デフォルトは war ファイルの名前です この例では RestExample となります 11

15 デプロイメントのサマリー Summary of Deployment ページが表示されます RestExample のアプリケーションが追加され ヘルス health 状態が OK であることを確認します ログを確認してみます ブラウザーから Coherence キャッシュのデータのアクセル アプリケーション名 }/{ キャッシュ名 } の形式でキャッシュ コレクションをアクセスします この例では でアクセスします 12

16 Coherence クラスタが起動されたことをログで確認してみます 2.4. REST クライアントでの動作確認 REST クライアントの入手 Coherence REST は キャッシュとの対話に使用できる多くの操作を事前に定義されています REST クライアントでは HTTP プロトコルを介して Coherence REST を使ってキャッシュに対する操作が可能となります ここでは Mozilla Firefox のアドオンとなる REST クライアントを使用します ダウンロード先 13

17 REST クライアントのインストール 上記のダウンロード先を Mozilla Firefox ブラウザーで開き + Add to Firefox ボタンをクリックします インストール確認ダイアログで Install Now をクリックします アドオンをインストールしたらブラウザーを再起動します ブラウザーを再起動したら Tools REST Client で REST クライアントを起動します 14

18 + Add Request Header ボタンをクリックします Content-Type=application/json のヘッダを追加します REST クライアントでの動作確認 ここでは REST クライアントで Coherence RESTful API で Coherence キャッシュに対し PUT/GET/POST/DELETE 操作をおこないます Coherence RESTful API の詳細について 以下の資料を参照してください Oracle Coherence Client Guide Release Using the Coherence REST API PUT 操作 PUT 操作では キャッシュに単一のオブジェクトを追加 更新することができます 以下の操作は Coherence APIのcache.put(1, new Person( chris, 30)) と相当です PUT Content-Type=application/json Request Body: {"name":"chris","age":30} 15

19 以下の操作は Coherence APIのcache.put(2, new Person( adam, 26)) と相当です PUT Content-Type=application/json Request Body: {"name":"adam","age":26} GET 操作 GET 操作では キャッシュ内に存在するオブジェクトを取得できます 以下の操作は Coherence APIのcache.get(1) と相当です GET 16

20 以下の操作は Coherence API の cache.get(1) と相当です GET 以下の操作は Coherence API の cache.entryset(new EqualsFilter("getName", "adam")); GET is 'adam' 17

21 以下の操作は dist-http-example キャッシュから全てのオブジェクトの name のみ取得します GET 以下の操作は Coherence API の cache. aggregate(alwaysfilter.instance, new Count()) と相当です GET 18

22 以下の操作は Coherence API の cache.aggregate(createfilter("true"), new DoubleAverage("getAge")) と相当です GET POST 操作 POST 操作では キャッシュ内のオブジェクトを更新する Processor を実行できます 事前定義の Processor があります またカスタム作成できます 事前定義の Processor は 以下の資料を参照してください Oracle Coherence Client Guide Release Listing of Pre-defined Entry Processors カスタム Processor の作成については 以下の資料を参照してください Oracle Coherence Developer's Guide Release Using Entry Processors for Data Concurrency POST 19

23 DELETE 操作 DELETE 操作では キャッシュ内の一つまたは 複数のオブジェクトを削除できます 以下の操作は Coherence APIの cache.remove(1) と相当です DELETE 最後 再度以下の GET 操作をおこないます GET 20

24 21