この章では、Coherence*Web WebInstallerを使用して、Java EEアプリケーション向けのCoherence*Webを様々なアプリケーション・サーバーにインストールする手順について説明します。
準備: 「サポートされているWebコンテナ」を参照して、アプリケーション・サーバー固有のインストール手順を実行する必要があるかどうかを確認してください。WebLogic Server上でCoherence*Webをデプロイするには、次の2つの方法があります。
|
Coherence*Webは、様々なWebコンテナ上のJava EEアプリケーションに対して有効にできます。Coherence*Webを有効にするには、アプリケーションをデプロイする前に、自動化したCoherence*Web WebInstallerを使用して、デプロイの準備が整ったアプリケーションを実行する必要があります。この自動化したインストーラによって、アプリケーションのデプロイメント準備が完了します。インスペクトとインストールの2段階でインストール・プロセスが実行されます。これらの各段階でのインストーラの動作は、「Coherence*WebインストーラによるJava EEアプリケーションの設定」を参照してください。
このインストーラは、JavaコマンドラインまたはAntタスクから実行できます。次の各項では、Javaコマンドラインから実行する方法について説明します。Antタスク・ベースのインストールについては、「Coherence*Web WebInstaller Antタスク」を参照してください。
「サポートされているWebコンテナ」の説明にあるすべてのWebコンテナは、WebInstallerで同じ一般的なインストール手順を使用してインストールできます。この手順の詳細は「Coherence*Webセッション管理モジュールをインストールする一般的な手順」を参照してください。
Webコンテナの中には、一般的なインストール手順を開始する前に、そのコンテナ固有の追加手順の実行を必要とするものがわずかにあります。Oracle OC4J、Caucho、WebLogic 10.xなどがこのようなコンテナに該当します。次に挙げる項で、アプリケーション・サーバー固有のインストール手順について説明しています。
Coherence*Webセッション管理モジュールをOracle WebLogic 10〜10.2のサーバーにインストールするには、次の手順を実行します。
Coherenceのライブラリ・ディレクトリで、webInstaller.jar
を解凍してcoherence-web.jar
を抽出します。
jar -xvf webInstaller.jar web-install/coherence-web.jar
このコマンドを実行すると、web-install
サブディレクトリにcoherence-web.jar
ファイルが配置されます。次のコマンドを使用して、coherence-web.jar
ファイルを1階層上のライブラリ・ディレクトリに移動します。
Windowsの場合:
move web-install\coherence-web.jar . rmdir web-install
Unixの場合:
mv web-install/coherence-web.jar . rmdir web-install
サーバー・クラスタで実行するWebLogic 10.xのインストール環境ごとに、次のコマンドを使用してライブラリを更新します(ここでは見やすくするために複数の行に分割して示していますが、本来は1行に入力する単一のコマンドです)。
java -cp coherence.jar;coherence-web.jar com.tangosol.coherence.servlet.WebPluginInstaller <wls-home-path> -install
たとえば、Windowsの場合は次のようにします。
java -cp coherence.jar;coherence-web.jar com.tangosol.coherence.servlet.WebPluginInstaller C:\bea\weblogic\wlserver_10 -install
「Coherence*Webセッション管理モジュールをインストールする一般的な手順」の説明にある手順に従ってインストールを完了します。サーバー・タイプとして「WebLogic/10.x
」を指定します。
Coherence*Webセッション管理モジュールをCaucho Resin 3.1.xサーバーにインストールするには、次の手順を実行します。
Coherenceのライブラリ・ディレクトリで、webInstaller.jar
を解凍してcoherence-web.jar
を抽出します。
jar -xvf webInstaller.jar web-install/coherence-web.jar
このコマンドを実行すると、web-install
サブディレクトリにcoherence-web.jar
ファイルが配置されます。次のコマンドを使用して、coherence-web.jar
ファイルを1階層上のライブラリ・ディレクトリに移動します。
Windowsの場合:
move web-install\coherence-web.jar . rmdir web-install
Unixの場合:
mv web-install/coherence-web.jar . rmdir web-install
サーバー・クラスタで実行するResinのインストール環境ごとに、次のコマンドを使用してライブラリを更新します(ここでは見やすくするために複数の行に分割して示していますが、本来は1行に入力する単一のコマンドです)。
java -cp coherence.jar;coherence-web.jar com.tangosol.coherence.servlet.WebPluginInstaller <resin-home-path> -install
たとえば、Windowsの場合は次のようにします。
java -cp coherence.jar;coherence-web.jar com.tangosol.coherence.servlet.WebPluginInstaller C:\opt\resin31 -install
「Coherence*Webセッション管理モジュールをインストールする一般的な手順」の説明にある手順に従ってインストールを完了します。サーバー・タイプとして「Resin/3.1.x
」を指定します。
「サポートされているWebコンテナ」に挙げたどのWebコンテナにJava EEアプリケーション用のCoherence*Webをインストールする場合でも、次の手順を実行する必要があります。
Oracle OC4J、Caucho、またはWebLogicのいずれかのコンテナにCoherence*Webセッション管理モジュールをインストールする場合は、まず各コンテナ固有のインストール手順を実行し、その後で一般的なインストール手順を開始する必要があります。各コンテナ固有のインストール手順は、「アプリケーション・サーバー固有のインストール手順」を参照してください。
デプロイするJava EEアプリケーション用のCoherence*Webをインストールするには:
アプリケーション・ディレクトリ、.ear
ファイル、および.war
ファイルを他のプロセスで使用もアクセスもしていないことを確認します。
現在のディレクトリをCoherenceのライブラリ・ディレクトリに変更します(Windowsの場合は%COHERENCE_HOME%\lib
、Unixの場合は$COHERENCE_HOME/lib
)。
Javaコマンドを実行できるようにパスを構成していることを確認します。
次のコマンドを実行してアプリケーションのインスペクト手順を完了します。次のコマンドラインで、<app-path>
にはアプリケーションへのフル・パスを指定し、<server-type>
には、使用しているサーバーの名前を表1-1から選択して指定します。
java -jar webInstaller.jar <app-path> -inspect -server:<server-type>
アプリケーションを配置したディレクトリに、Java EEアプリケーション用のcoherence-web.xml
コンフィギュレーション・ディスクリプタ・ファイルが作成されます(すでに存在している場合はそれが更新されます)。このコンフィギュレーション・ディスクリプタには、アプリケーション用としてインストーラ推奨のデフォルトのCoherence*Web設定が収められています。
このまま、次のインストール手順(手順6)に進むことができますが、各自の要件に基づいてCoherence*Web設定を見直し、変更した上でインストールを続けることもできます。
ディスクリプタcoherence-web.xml
を編集することで、Coherence*Web設定を変更します。変更可能なCoherence*Web設定は、付録A「Coherence*Webコンフィギュレーション・パラメータ」を参照してください。context-param
のサブ要素であるparam-name
およびparam-value
を使用して、必要な機能を有効にします。
例:
表3-1の設定では、すべてのServletContext
(グローバル)属性をクラスタ化し、そのクラスタにあるサーバーがこれらの属性に同じ値を持ち、これらの属性が変更されたときはサーブレット仕様で指定されたイベントを受け取るようにします。
表3-2の設定をアプリケーションで使用すると、そのアプリケーションに存在するすべてのセッションを列挙したり、そのいずれかを取得して調査または操作したりできます。
表3-3の設定を使用すると、SecureRandom
アルゴリズムを使用して生成したHttpSession
IDを長くすることができます。この長さは任意の値にできますが、実際は、CookieまたはURLに適した長さにする必要があります(セッションIDの管理方法に依存)。これを長くすると、セッションが意図的にハイジャックされる危険性を低くできます。
デフォルトでは、HttpSession
IDはCookieで管理されます。アプリケーションでサポートされているURLエンコーディングを有効にするには、表3-4に示すオプションを設定します。
これらの変更内容を十分に確認した後、ファイルを保存してエディタを終了します。シェルまたはコマンドラインで作業している場合は、必ずCoherenceのライブラリ・ディレクトリに戻ってください。
次のコマンドで、<app-path>
をアプリケーションへのフル・パスに置き換えて実行すると、Coherence*Webアプリケーションのインストール手順が始まります。
java -jar webInstaller.jar <app-path> -install
このインストーラでは、有効なcoherence-web.xml
コンフィギュレーション・ディスクリプタを使用できるように、それをアプリケーションと同じディレクトリに置く必要があります。
更新したアプリケーションをデプロイし、すべてが問題なく機能することを確認します。このとき、必要に応じてロード・バランサを使用します。このロード・バランサは、テストでの使用のみを目的としたものなので、本番環境では使用しないでください。
Coherence*Web WebInstaller Antタスクを使用すると、既存のAntビルド・ファイルからインストーラを実行できます。
この項の内容は次のとおりです。
Coherence*Web WebInstaller Antタスクを使用するには、例3-1に示すタスク・インポート文をAntビルド・ファイルに追加します。この例で、${
coherence.home
}
はCoherenceをインストールした環境のルート・ディレクトリを指しています。
例3-1 Coherence*Web WebInstaller用のタスク・インポート文
<taskdef name="cwi" classname="com.tangosol.coherence.misc.CoherenceWebAntTask">
<classpath>
<pathelement location="${coherence.home
}/lib/webInstaller.jar"/>
</classpath>
</taskdef>
次の手順は、AntビルドからJava EEアプリケーションにCoherence*Webをインストールするための基本的なプロセスを示しています。
通常どおりにJava EEアプリケーションをビルドします。
生成されたCoherence*Web XMLディスクリプタを必要に応じて編集します。
operations
属性をinstall
に設定して、Coherence*Web Antタスクを実行します。
アプリケーションで反復手順のある開発作業(JSP、サーブレット、静的リソースなどの変更)を実行する場合は、次のインストール・プロセスを使用します。
operations
属性をuninstall
、failonerror
属性をfalse
、descriptor
属性を前述の手順2で生成したCoherence*Web XMLディスクリプタの場所にそれぞれ設定して、Coherence*Web Antタスクを実行します。
通常どおりにJava EEアプリケーションをビルドします。
operations
属性をinspect
、install
およびdescriptor
属性を前述の手順2で生成したCoherence*Web XMLディスクリプタの場所にそれぞれ設定して、Coherence*Web Antタスクを実行します。
Coherence*WebをインストールしたJava EEアプリケーションのCoherence*Webコンフィギュレーション設定を変更するには、次の手順を使用します。
operations
属性をuninstall
、descriptor
属性をJava EEアプリケーションのCoherence*Web XMLディスクリプタの場所にそれぞれ設定して、Coherence*Web Antタスクを実行します。
Coherence*Web XMLディスクリプタで、必要なコンフィギュレーション・パラメータを変更します。
operations
属性をinstall
、descriptor
属性を手順2で変更したCoherence*Web XMLディスクリプタの場所にそれぞれ設定して、Coherence*Web Antタスクを実行します。
表3-5は、Coherence*Web WebInstaller Antタスクで使用可能な属性を示しています。
表3-5 Coherence*Web WebInstaller Antタスクの属性
属性 | 説明 | 必須/オプション |
---|---|---|
app |
目的のJava EEアプリケーションへのパス。WARファイル、EARファイル、展開したWARディレクトリ、または展開したEARディレクトリのいずれかへのパスを指定できます。 |
|
backup |
元の目的のJava EEアプリケーションのバックアップを保存するディレクトリへのパス。この属性は、デフォルトでJava EEアプリケーションのインストール先ディレクトリに設定されます。 |
オプション |
descriptor |
Coherence*Web XMLディスクリプタへのパス。この属性は、デフォルトで目的のJava EEアプリケーションのインストール先ディレクトリにある |
オプション |
failonerror |
0以外のステータスでCoherence*Webインストーラが終了した場合はAntビルドを停止します。デフォルトは |
オプション |
nowarn |
警告メッセージを表示しません。この属性の値は |
オプション |
operations |
実行する操作をカンマまたはスペースで区切って指定します。指定できる操作は、 |
必須 |
server |
目的のJava EEアプリケーション・サーバーの別名。 |
オプション |
touch |
Coherence*Webインストーラによって変更されたJSPとTLDにtouchコマンドを実行します。この属性に指定できる値は、 |
オプション |
verbose |
詳細出力を表示します。この属性の値は |
オプション |
myWebApp.war
Webアプリケーションをインスペクトして、現在の作業ディレクトリでmy-coherence-web.xml
という名前のCoherence*Web XMLディスクリプタを作成します。
<cwi app="myWebApp.war" operations="inspect" descriptor="my-coherence-web.xml"/>
現在の作業ディレクトリにあるmy-coherence-web.xml
という名前のCoherence*Web XMLディスクリプタを使用して、myWebApp.war
WebアプリケーションにCoherence*Webをインストールします。
<cwi app="myWebApp.war" operations="install" descriptor="my-coherence-web.xml"/>
myWebApp.war
WebアプリケーションからCoherence*Webをアンインストールします。
<cwi app="myWebApp.war" operations="uninstall">
/dev/myWebApp/src
ディレクトリにあるmy-coherence-web.xml
という名前のCoherence*Web XMLディスクリプタを使用して、/dev/myWebApp/build
ディレクトリに配置したmyWebApp.war
WebアプリケーションにCoherence*Webをインストールし、元のWebアプリケーションのバックアップを/dev/myWebApp/work
ディレクトリに配置します。
<cwi app="/dev/myWebApp/build/myWebApp.war" operations="install" descriptor="/dev/myWebApp/src/my-coherence-web.xml" backup="/dev/myWebApp/work"/>
/dev/myWebApp/build
ディレクトリにあるcoherence-web.xml
という名前のCoherence*Web XMLディスクリプタを使用して、/dev/myWebApp/build
ディレクトリに配置したmyWebApp.war
WebアプリケーションにCoherence*Webをインストールします。Webアプリケーションがまだインスペクトされていない(つまり、/dev/myWebApp/build/coherence-web.xml
が存在しない)場合は、Coherence*Webをインストールする前にWebアプリケーションをインスペクトします。
<cwi app="/dev/myWebApp/build/myWebApp.war" operations="inspect,install"/>
/dev/myWebApp/src
ディレクトリにあるmy-coherence-web.xml
という名前のCoherence*Web XMLディスクリプタを使用して、/dev/myWebApp/build
ディレクトリに配置したmyWebApp.war
WebアプリケーションにCoherence*Webを再インストールします。
<cwi app="/dev/myWebApp/build/myWebApp.war" operations="uninstall,install" descriptor="/dev/myWebApp/src/my-coherence-web.xml"/>
Coherenceには、ソフトウェアによる軽量なロード・バランサが付属しています。このソフトウェアはテスト以外の目的には使用できません。セッション管理などの機能テストではきわめて効果的で、たいへん使いやすいソフトウェアです。
それぞれがIPアドレスとポートの一意な組合せでアプリケーションを実行する複数のアプリケーション・サーバー・プロセスを、1台以上のサーバー・マシン上で開始します。
コマンド(またはシェル)ウィンドウを開きます。
現在のディレクトリをCoherenceのライブラリ・ディレクトリに変更します(Windowsの場合は%COHERENCE_HOME%\lib
、Unixの場合は$COHERENCE_HOME/lib
)。
Javaコマンドを実行できるようにパスを構成していることを確認します。
次のコマンドラインを使用してソフトウェア・ロード・バランサを開始します(これらの各コマンドラインによって、デフォルトのHTTPポートであるポート80でアプリケーションが使用可能になります)。
たとえば、2つのアプリケーション・サーバー・インスタンスを7001
ポートと7002
ポートに持つ1台のマシンでローカルにロード・バランシングをテストするには、次のように入力します。
java -jar coherence-loadbalancer.jar localhost:80 localhost:7001 localhost:7002
server1
、server2
、およびserver3
に対して7001
ポートで負荷を分散するserver1
でローカルにロード・バランサを実行するには、次のように入力します。
java -jar coherence-loadbalancer.jar server1:80 server1:7001 server2:7001 server3:7001
上述のコマンドラインを実行すると、これまでhttp://server1:7001/my.jsp
をURLとしていたアプリケーションに、http://server1:80/my.jsp
またはhttp://server1/my.jsp
のみを指定してアクセスできるようになります。
注意: アプリケーションで使用されるアドレスが、相対リダイレクトまたはロード・バランサのアドレスのいずれかであることを確認してください。 |
表3-6は、ロード・バランサのコマンドライン・オプションを示しています。
インスペクトの手順では、Coherence*Web WebInstallerによって次のタスクが実行されます。
アプリケーションと目的のWebコンテナに関する基本的な情報、および目的のWebコンテナに適したデフォルトのCoherence*Webコンフィギュレーション・コンテキスト・パラメータを記述したテンプレートであるcoherence-web.xml
コンフィギュレーション・ファイルを生成します。使用可能なパラメータの詳細は、付録A「Coherence*Webコンフィギュレーション・パラメータ」を参照してください。
既存のcoherence-web.xml
コンフィギュレーション・ファイルが存在する場合(たとえば、過去にCoherence*Webインストーラを実行したことがある場合)は、既存のファイルにあるコンテキスト・パラメータは生成したテンプレートにあるパラメータにマージされます。
目的のJava EEアプリケーションにある各WebアプリケーションからJSPを列挙して、各JSPに関する情報をcoherence-web.xml
コンフィギュレーション・ファイルに追加します。
目的のJava EEアプリケーションにある各WebアプリケーションからTLDを列挙して、各TLDに関する情報をcoherence-web.xml
コンフィギュレーション・ファイルに追加します。
インストールの手順では、Coherence*Web WebInstallerによって次のタスクが実行されます。
アンインストールの手順で復元できるように、元のJava EEアプリケーションのバックアップを作成します。
インスペクトの手順(1)で生成したCoherence*Webコンフィギュレーション・コンテキスト・パラメータを、目的のJava EEアプリケーションに含まれる各Webアプリケーションのweb.xml
ディスクリプタに追加します。
各Webアプリケーションから、アプリケーション固有のServletContextListener
、ServletContextAttributeListener
、ServletRequestListener
、ServletRequestAttributeListener
、HttpSessionListener
、およびHttpSessionAttributeListener
の各クラス(TLDによって登録されたものを含む)を登録解除します。
Coherence*Web ServletContextListener
を各web.xml
ディスクリプタに登録します。実行時に、Coherence*Web ServletContextListener
によって、各アプリケーション固有のServletContextListener
に各ServletContextEvent
が伝播します。
Coherence*Web ServletContextAttributeListener
を各web.xml
ディスクリプタに登録します。実行時に、Coherence*Web ServletContextAttributeListener
によって、各アプリケーション固有のServletContextAttributeListener
に各ServletContextAttributeEvent
が伝播します。
各web.xml
ディスクリプタで宣言した各アプリケーション固有のServlet
をCoherence*Web SessionServlet
でラップします。実行時に、各Coherence*Web SessionServlet
からラップされたServlet
に権限が委譲されます。
インスペクト手順(2)で列挙した各JSPに次のディレクティブを追加します。
<%@ page extends="com.tangosol.coherence.servlet.api22.JspServlet" %>
アンインストールの手順では、Coherence*Web WebInstallerによって、設定済のJava EEアプリケーションがインストール・プロセスの手順(1)で作成した元のバージョンのバックアップに置き換えられます。
注意: Coherence*WebのネイティブなWebLogic SPI実装には、この項の内容は該当しません。Java EEセキュリティを使用しているアプリケーションに、WebInstallerを使用してCoherence*Webをインストールする場合にこの項が該当します。 |
Java EEセキュリティを使用しているアプリケーションにCoherence*Webをインストールするには、インストールで次の手順を別途実行する必要があります。
Coherence*WebセッションCookieを有効にします。
詳細は、表A-1のcoherence-session-cookies-enabled
コンフィギュレーション要素を参照してください。
Coherence*WebセッションCookieの名前を、目的のWebコンテナで使用していない名前に変更します。
デフォルトでは、JSESSIONID
がほとんどのコンテナでセッションCookie名として使用されるため、Coherence*WebセッションCookie名としてはCSESSIONID
をお薦めします。詳細は、表A-1のcoherence-session-cookie-name
コンフィギュレーション要素を参照してください。
目的のWebコンテナに対するセッション・レプリケーションを有効にします。
セッション・レプリケーションが有効になっていない場合、またはコンテナでセッション・レプリケーションの形態がサポートされていない場合は、フェイルオーバーの際にWebアプリケーションに対する再認証を実行する必要があります。セッション・レプリケーションの有効化に関する手順は、Webコンテナのドキュメントを参照してください。
このコンフィギュレーションによって、指定の認証済ユーザーに次の2つのセッションが関連付けられます。
Webアプリケーションで作成したすべてのセッション・データを含むCoherence*Webセッション
認証中にWebコンテナによって作成され、ユーザーの特定に必要な情報のみを保存したセッション