管理および設定ガイド
JBoss Enterprise Application Platform 6 向け
エディッション 2
概要
前書き
第1章 JBoss Enterprise Application Platform の管理に関する入門書
1.1. JBoss Enterprise Application Platform 6 の紹介
1.2. JBoss Enterprise Application Platform 6 の新しい機能と変更された機能
- JBoss Enterprise Application Platform 6 は、Java Enterprise Edition 6 の Full Profile および Web Profile の仕様の認定された実装です。
- 管理対象ドメインは、複数のサーバーインスタンスおよび物理ホストを一元管理し、スタンドアローンサーバーは単一のサーバーインスタンスを可能にします。
- 設定、デプロイメント、ソケットバインディング、モジュール、拡張、およびシステムプロパティはすべて、サーバーグループ別に管理できます。
- 管理コンソールと CLI は、ドメインまたはスタンドアローン JBoss Enterprise Application Platform 6 インスタンスを管理する新しいインターフェースです。XML 設定ファイルを手作業で編集する必要がなくなりました。管理 CLI ではバッチモードも提供され、管理タスクを処理するスクリプトを作成し、自動化できます。
- セキュリティードメインなどのアプリケーションセキュリティーは、設定を簡素化できるよう一元管理されています。
- JBoss Enterprise Application Platform 6 のディレクトリーレイアウトは単純化されました。
modules/
ディレクトリーには、共通およびサーバー固有のlib/
ディレクトリーの代わりにアプリケーションサーバーモジュールが含まれるようになりました。domain/
およびstandalone/
ディレクトリーには、ドメインおよびスタンドアローンデプロイメント用のアーティファクトおよび設定ファイルが含まれます。 - 各種モジュールがオンデマンドでロードおよびアンロードされるように、クラスローディングメカニズムが完全にモジュール化されました。このため、パフォーマンスおよびセキュリティ面で利点があるだけでなく、非常に短時間で起動や再起動を行うことができます。
- データソース管理も単純化されました。データベースドライバーは、他のサービスと同様にデプロイできます。また、管理コンソールまたは管理 CLI で直接データソースを作成および管理できます。
- JBoss Enterprise Application Platform 6 の起動および終了が非常に速くなります。これは、特に開発者にとって利点があります。少ないリソースが使用されるため、システムリソースの使用が非常に効率的になります。
第2章 アプリケーションサーバー管理
2.1. アプリケーションサーバーの管理
2.2. インストールの構造および詳細
表2.1 最上位のディレクトリとファイル
名前 | 目的 |
---|---|
appclient/ | アプリケーションクライアントコンテナの設定詳細が含まれます。 |
bin/ | Red Hat Enterprise Linux および Microsoft Windows 用 JBoss Enterprise Application Platform 6 向け起動スクリプトが含まれます。 |
bundles/ | JBoss Enterprise Application Platform 6 の内部機能に関する OSGi バンドルが含まれます。 |
docs/ | ライセンスファイル、スキーマ、およびサンプル |
domain/ | JBoss Enterprise Application Platform 6 が管理対象ドメインとして実行された時に使用される設定ファイル、デプロイメントコンテンツ、および書き込み可能領域。 |
modules/ | サービスが要求したときに JBoss Enterprise Application Platform 6 により動的にロードされるモジュール。 |
standalone/ | JBoss Enterprise Application Platform 6 がスタンドアローンサーバーとして実行された場合に使用される設定ファイル、デプロイメントコンテンツ、および書き込み可能領域。 |
welcome-content/ | デフォルトインストールのポート 8080 で利用可能な Welcome Web アプリケーションにより使用されるコンテンツが含まれます。 |
jboss-modules.jar
| モジュールをロードするブートストラップメカニズム。 |
表2.2 domain/
ディレクトリーにあるディレクトリー
名前 | 目的 |
---|---|
configuration/ | 管理ドメイン用の設定ファイル。これらのファイルは管理コンソールや管理 CLI で変更し、直接編集するためのものではありません。 |
data/ | デプロイされたサービスの情報。サービスは、デプロイメントスキャナーではなく、管理コンソールや管理 CLI を使用してデプロイするため、このディレクトリーにファイルを手動で置かないようにしてください。 |
log/ | ローカルインスタンスで実行されるホストおよびプロセスコントローラー用実行時ログファイルが含まれます。 |
servers/ | ドメイン内の各サーバーインスタンス用の同等の data/ 、log/ 、および tmp/ ディレクトリーが含まれます。これらのディレクトリーには、最上位の domain/ ディレクトリー内の同じディレクトリーに類似したデータが含まれます。 |
tmp/ | 管理対象ドメインに対してローカルユーザーを認証するために管理 CLI で使用される共有キーメカニズムに関するファイルなどの一時データが含まれます。 |
表2.3 standalone/
ディレクトリーにあるディレクトリー
名前 | 目的 |
---|---|
configuration/ | スタンドアローンサーバー用の設定ファイル。これらのファイルは管理コンソールや管理 CLI で変更し、直接編集するためのものではありません。 |
deployments/ | デプロイしたサービスの情報。スタンドアローンサーバーには、デプロイメントスキャナーが含まれているため、このディレクトリにデプロイ用のアーカイブを置くことができます。しかし、管理コンソールあるいは管理 CLI を使いデプロイメントを管理する方法が推奨されます。 |
lib/ | スタンドアローンサーバーモードに関連する外部ライブラリ。デフォルトは空です。 |
tmp/ | サーバーに対してローカルユーザーを認証するために管理 CLI で使用される共有キーメカニズムに関連するファイルなどの一時データが含まれます。 |
2.3. JBoss Enterprise Application Platform 6 プロファイル
2.4. Enterprise Application Platform の設定ファイル
domain.xml
または standalone.xml
になります。ファイルのデフォルトの場所は、サーバーが管理ドメインとして稼稼働しているか、スタンドアロンサーバーとして稼動しているかによって異なります。
表2.4 domain.xml
の場所
サーバーモード | 場所 |
---|---|
管理ドメイン | EAP_HOME/domain/configuration/domain.xml |
スタンドアロンサーバー | EAP_HOME/standalone/configuration/standalone.xml |
2.5. 管理 API
2.5.1. 管理アプリケーションプログラミングインターフェース (API)
JBoss Enterprise Application Platform 6 は、サーバーを設定および管理する 3 つの方法 (Web インターフェース、コマンドラインクライアント、および XML 設定ファイルのセット) を提供します。設定ファイルを編集する推奨される方法には管理コンソールと管理 CLI が含まれますが、これら 3 つの方法で設定に行われた編集は、さまざまなビューで常に同期され、最終的に XML ファイルに永続化されます。サーバーインスタンスの実行中に XML 設定ファイルに行われた編集は、サーバーモデルによって上書きされることに注意してください。
管理コンソールは、Google Web Toolkit (GWT) で構築された Web インターフェースの例です。管理コンソールは、HTTP 管理インターフェースを使用してサーバーと通信します。HTTP API エンドポイントは、管理レイヤーと統合するために HTTP プロトコルに依存する管理クライアントのエントリポイントです。HTTP API エンドポイントは、 JSON エンコードプロトコルと de-typed な RPC スタイル API を使用して管理対象ドメインまたはスタンドアロンサーバーに対して管理操作を定義および実行します。HTTP API は Web コンソールによって使用されますが、さまざまな他のクライアントに対して統合機能を提供します。
例2.1 HTTP API 設定ファイルの例
<management-interfaces> [...] <http-interface interface="management" port="9990"/> <management-interfaces>
表2.5 TableTitle
URL | 説明 |
---|---|
http://localhost:9990/console | ローカルホストでアクセスされる管理コンソール (管理対象ドメイン設定を制御します)。 |
http://hostname:9990/console | リモートでアクセスされる管理コンソール (ホストを指定し、管理対象ドメイン設定を制御します)。 |
http://hostname:9990/management | HTTP 管理 API は管理コンソールと同じポートで実行され、API に公開された raw 属性と値を表示します。 |
ネイティブ API ツールの例には管理 CLI があります。この管理ツールは管理対象ドメインまたはスタンドアロンサーバーインスタンスに使用できるため、ユーザーはドメインコントローラーまたはスタンドアロンサーバーインスタンスに接続して、de-typed 管理モデルを介して利用可能な管理操作を実行できます。
例2.2 ネイティブ API 設定ファイルの例
<management-interfaces> <native-interface interface="management" port="9999"/> [...] <management-interfaces>
2.6. JBoss Enterprise Application Platform の起動
2.6.1. JBoss Enterprise Application Platform の起動
タスク
2.6.2. スタンドアローンサーバーとして JBoss Enterprise Application Platform 6 を起動
- Red Hat Enterprise Linux。
コマンドの実行:
EAP_HOME/bin/standalone.sh
- Microsoft Windows Server。
コマンドの実行:
EAP_HOME\bin\standalone.bat
- オプション:別のパラメーターを指定します。
起動スクリプトに渡すことができる他のパラメーター一覧を出力するには、
-h
パラメーターを使います。
JBoss Enterprise Application Platform 6 スタンドアロンサーバーインスタンスが起動します。
2.6.3. 管理ドメインとして JBoss Enterprise Application Platform 6 を起動
- Red Hat Enterprise Linux。
コマンドの実行:
EAP_HOME/bin/domain.sh
- Microsoft Windows Server。
コマンドの実行:
EAP_HOME\bin\domain.bat
- オプション:起動スクリプトに追加パラメーターを渡す
起動スクリプトに渡すことができる各種パラメーターを確認するには、
-h
パラメーターを使います。
JBoss Enterprise Application Platform 6 監理対象ドメインインスタンスが起動します。
2.6.4. 別の設定で Enterprise Application platform を起動
設定ファイルを指定しない場合、サーバーはデフォルトファイルで起動します。しかし、サーバーを起動してから設定を手動で指定することができます。このプロセスは管理ドメインを使うか、スタンドアローンサーバーを使うか、またどのオペレーティングシステムを使うかで少し変わってきます。
別の設定ファイルを使う前に、デフォルト設定をテンプレートとして使い別設定ファイルの作成準備をします。管理ドメインの場合は、設定ファイルをEAP_HOME/domain/configuration/
に置く必要があります。また、スタンドアローンサーバーは、設定ファイルをEAP_HOME/standalone/configuration/
に置いて下さい。
注記
管理ドメイン
管理ドメインでは、設定ファイルのファイル名をオプションとして--domain-config
パラメーターに渡します。設定ファイルがEAP_HOME/domain/configuration/
にある場合は、全パスを渡す必要はありません。例2.3 Red Hat Enterprise Linux 上の管理ドメインで別の設定ファイルを利用
[user@host bin]$ ./domain.sh --domain-config=
domain-alternate.xml
例2.4 Microsoft Windows サーバー上の管理ドメインで別の設定ファイルを利用
C:\EAP_HOME\bin> domain.bat --domain-config=
domain-alternate.xml
スタンドアローンサーバー
管理ドメインでは、設定ファイルのファイル名をオプションとして--server-config
パラメーターに渡します。設定ファイルがEAP_HOME/domain/configuration/
にある場合は、設定ファイルの全パスを渡す必要はありません。例2.5 Red Hat Enterprise Linux 上のスタンドアローンサーバーで別の設定ファイルを利用
[user@host bin]$ ./standalone.sh --server-config=
standalone-alternate.xml
例2.6 Microsoft Windows サーバー上のスタンドアローンサーバーで別の設定ファイルを利用
C:\EAP_HOME\bin> standalone.bat --server-config=
standalone-alternate.xml
Enterprise Application Platform が別設定を使い実行されました。
2.6.5. Enterprise Application Platform の停止
Enterprise Application Platform を停止する方法は、起動方法によって異なります。このタスクでは、対話的に起動されたインスタンスを停止し、サービスにより起動されたインスタンスを停止して、スクリプトによりバックグラウンドにフォークされたインスタンスを停止します。
注記
手順2.1 タスク:
コマンドラインプロンプトから対話的に起動したインスタンスを停止します。
Enterprise Application Server が実行されているターミナルでCtrl-C
を押します。オペレーティングシステムサービスとして起動されたインスタンスを停止します。
オペレーティングシステムに応じて、以下のいずれかの手順を実行します。Red Hat Enterprise Linux
Red Hat Enterprise Linux の場合に、サービススクリプトを記述したときは、stop
機能を使用します。これは、スクリプトに記述する必要があります。次に、service scriptname stop
を使用できます。ここで、scriptname はスクリプトの名前です。Microsoft Windows Server
Microsoft Windows の場合は、net service
コマンドを使用するか、コントロールパネルの [サービス] アプレットからサービスを停止します。
バックグラウンドで実行されているインスタンスを停止します (Red Hat Enterprise Linux)。
- プロセスリストからインスタンスを特定します。1 つのオプションは、コマンド
ps aux |grep "[j]ava -server"
を実行することです。これにより、ローカルマシンで実行されている各 Enterprise Application Platform インスタンスの 1 つの結果が返されます。 kill process_ID
, を実行してプロセスにTERM
シグナルを送信します。ここで、process_ID は、上記のps aux
コマンドの 2 番目のフィールドにある数字です。
これらの各代替は Enterprise Application Platform をクリーンにシャットダウンするため、データは失われません。
2.6.6. サーバー実行時に渡すスイッチと引数のリファレンス
standalone.xml
、domain.xml
、および host.xml
の設定ファイルで定義されたものとは別の設定でサーバーを起動できます。これには、ソケットバインディングの代替セットや二次設定でのサーバーの起動が含まれることがあります。利用可能なこれらのパラメーターのリストには、起動時にヘルプスイッチを渡すことによってアクセスできます。
例2.7
-h
スイッチまたは --help
スイッチが追加されています。ヘルプスイッチの結果については、以下の表で説明されています。
[localhost bin]$ standalone.sh -h
表2.6 実行時スイッチおよび引数の表
引数またはスイッチ | 説明 |
---|---|
-b=<value> | システムプロパティー jboss.bind.address を該当する値に設定します。 |
-b <value> | システムプロパティー jboss.bind.address を該当する値に設定します。 |
-b<interface>=<value> | システムプロパティー jboss.bind.address.<interface> を該当する値に設定します。 |
-D<name>[=<value>] | システムプロパティーを設定します。 |
-h | ヘルプメッセージを表示し、終了します。 |
--help | ヘルプメッセージを表示し、終了します。 |
-P=<url> | 該当する URL からシステムプロパティーをロードします。 |
-P <url> | 該当する URL からシステムプロパティーをロードします。 |
--properties=<url> | 該当する URL からシステムプロパティーをロードします。 |
--server-config=<config> | 使用するサーバー設定ファイルの名前。デフォルト値は standalone.xml です。 |
-V | アプリケーションサーバーのバージョンを表示し、終了します。 |
-v | アプリケーションサーバーのバージョンを表示し、終了します。 |
--version | アプリケーションサーバーのバージョンを表示し、終了します。 |
2.7. JBoss Enterprise Application Platform 6 をサービスとして実行
2.7.1. JBoss Enterprise Application Platform 6 をオペレーティングシステムサービスとして実行
2.7.2. Red Hat Enterprise Linux でサービスとして JBoss Enterprise Application Platform をインストール
以下の手順を使用して JBoss Enterprise Application Platform 6 をサービスとして Red Hat Enterprise Linux にインストールします。
このタスクを完了するには管理者権限が必要です。
手順2.2 タスク
/etc/init.d/
ディレクトリーに起動スクリプトをコピーします。起動スクリプトと、関連する設定ファイルは、EAP_HOME/bin/init.d/
ディレクリーに存在します。これらの各ファイルを/etc/init.d/
ディレクリーにコピーします。[user@host init.d]$
sudo cp jboss-as-standalone.sh jboss-as.conf /etc/init.d
起動スクリプトをサービスとして追加します。
chkconfig
サービス管理コマンドを使用して、新しいjboss-as-standalone.sh
サービスを自動的に起動されるサービスのリストに追加します。[user@host init.d]$
sudo chkconfig --add jboss-as-standalone.sh
スクリプトオプションを編集します。
必要な場合は、jboss-as.conf
ファイルを編集して JBoss Enterprise Application Platform と JVM の起動オプションをカスタマイズします。ファイルのコメントをガイダンスとして使用します。このファイルで、JBoss Enterprise Application Platform 6 を抽出したディレクリーを参照するようJBOSS_HOME
変数を設定することが推奨されます。ディレクリー名の最後にスラッシュ (/) を追加しないでください。スクリプト自体を編集します。
起動スクリプト自体を編集する必要がある場合があります。起動ファイルの名前と JBoss Enterprise Application Platform インスタンスの場所について推測が行われます。スクリプトをカスタマイズし、以下の変数に特別な注意を払います。これらの変数は、JBoss Enterprise Application Platform 6 を管理対象ドメインとして起動するためにカスタマイズする必要があります。JBOSS_HOME
- JBoss Enterprise Application Platform 6 が抽出される場所JBOSS_USER
- JBoss Enterprise Application Platform を実行できるユーザー。これは、非特権ユーザーである必要があります (スーパーユーザー特権なし)。JBOSS_CONFIG
- JBoss Enterprise Application Platform 6 を起動するために使用される設定ファイルの名前 (domain.xml
やstandalone.xml
など)JBOSS_SCRIPT
- JBoss Enterprise Application Platform 6 を起動するために使用されるスクリプト (domain.sh
やstandalone.sh
など)
サービスを起動します。
必要な場合は、Red Hat Enterprise Linux サービスを起動するために標準的な構文を使用して新しいサービスを起動します。[user@host bin]$
sudo service jboss-as-standalone.sh start
JBoss Enterprise Application Platform 6 は、Red Hat Enterprise Linux がデフォルトのランレベルに到達したときに自動的に起動し、オペレーティングシステムでシャットダウンルーチンが完了した時に自動的に終了します。
2.7.3. JBoss Enterprise Application Platform 6 をサービスとして Microsoft Windows にインストール
このタスクでは、JBoss Enterprise Application Platform 6 をサービスとして Microsoft Windows にインストールします。
このタスクを完了するには管理者権限が必要です。
手順2.3 タスク
お使いのアーキテクチャー向けのネイティブユーティリティーパッケージをダウンロードします。
32 ビット、64 ビット、および Itanium 64 ビットパッケージは、Red Hat カスタマーポータル (https://access.redhat.com) で入手できます。Red Hat カスタマーポータルからのソフトウェアのダウンロードに関する詳細については、『『JBoss Enterprise Application Platform 6 Installation Guide』』(JBoss Enterprise Application Platform 6 インストールガイド) (https://access.redhat.com/knowledge/docs/JBoss_Enterprise_Application_Platform/ で入手可能) を参照してください。ダウンロードしたアーカイブを展開します。
アーカイブを新規フォルダーに展開します。結果:modules\native\bin\
フォルダーが作成されます。modules\native\bin\
フォルダーには、JBoss Enterprise Application Platform 6 をサービスとしてインストールするために必要なファイルが含まれます。これらのサービスは、Apache Commons により提供される一連のラッパースクリプトである 『Procrun』 の一部です。『Procrun』 とその構文の詳細については、http://commons.apache.org/daemon/procrun.html を参照してください。modules\sbin\prunsrv.exe
実行可能ファイルを実行します。prunsrv.exe install path_to_startup_script
結果サービスがインストールされます。JBoss Enterprise Application Platform 6 がサービスアプレット
services.msc
にリストされます。サービスを管理します。
modules\bin\prunmgr.exe
実行可能ファイルを使用してサービスを管理、追加、または削除します。以下のコマンドラインオプションがサポートされています。- run
- service
- start
- stop
- update
- install
- delete
- pause [seconds]
- version
- help
一般的な構文は以下のとおりです。prunmgr.exe commandservice_name
コマンドラインで net service
コマンドを使用するか、services.msc
アプレットを使用して、Microsoft Windows Server で JBoss Enterprise Application Platform 6 を起動および停止したり、JBoss Enterprise Application Platform 6 の自動起動を管理したりできます。
2.8. サーバーの起動と停止
2.8.1. サーバーの起動と停止
shutdown
操作を使用してサーバーをシャットダウンできます。管理コンソールでは同等の操作が存在しません。これはお使いのファイルシステムを自由に使用して実行中のインスタンスをシャットダウンできるためです。
shutdown
操作により、サーバー、ドメインコントローラー (この場合は特に)、すべてのホストコントローラー、およびサーバーインスタンスがシャットダウンされます。
2.8.2. 管理コンソールを使用したサーバーの起動
手順2.4 タスク
管理コンソールでの Server Instances への移動
- コンソールの右上から Runtime タブを選択します。
- コンソールの左側にあるメニューから Domain Status → Server Instances を選択します。
図2.1 サーバーインスタンス
サーバーの選択
Server Instances のリストから、起動するサーバーを選択します。実行されているサーバーはチェックマークで示されます。Start ボタンをクリックします。
サーバーリスト上部にある Start ボタンをクリックして、確認ダイアログボックスを開きます。Confirm ボタンをクリックしてサーバーを起動します。図2.2 サーバーの変更の確認
選択されたサーバーは起動され、実行されています。
図2.3 起動されたサーバー
2.8.3. 管理コンソールを使用したサーバーの停止
手順2.5 タスク
管理コンソールの Server Instances に移動します。
- コンソールの右上から Runtime タブを選択します。
- コンソールの左側にあるメニューから Domain Status → Server Instances を選択します。
図2.4 サーバーインスタンス
サーバーの選択
Server Instances のリストから、停止するサーバーを選択します。実行されているサーバーはチェックマークで示されます。Stop ボタンをクリックします。
サーバーリスト上部にある Stop ボタンをクリックして、確認ダイアログボックスを開きます。Confirm ボタンをクリックしてサーバーを起動します。図2.5 サーバーの変更の確認
選択されたサーバーが停止します。
図2.6 停止されたサーバー
2.9. ファイルシステムパス
2.9.1. ファイルシステムパス
domain.xml
、host.xml
、および standalone.xml
の設定には、パスを宣言できるセクションが含まれます。設定の他のセクションは、各インスタンスの絶対パスを宣言せず論理名を使用することにより、これらのパスを参照できます。これにより、特定のホスト設定をユニバーサルな論理名に解決できるため、設定や管理がしやすくなります。
log
ディレクトリーを参照する jboss.server.log.dir
パスの参照が含まれます。
例2.8 ロギングディレクトリーの相対パス例
<file relative-to="jboss.server.log.dir" path="server.log"/>
表2.7 標準的なパス
値 | 説明 |
---|---|
jboss.home | JBoss EAP 6 ディストリビューションのルートディレクトリー。 |
user.home | ユーザーホームディレクトリー。 |
user.dir | ユーザーのカレントワーキングディレクトリ。 |
java.home | Java インストールディレクトリー。 |
jboss.server.base.dir | 各サーバーインスタンスのルートディレクトリー。 |
jboss.server.data.dir | サーバーが永続データファイルストレージに使用するディレクトリー。 |
jboss.server.log.dir | サーバーがファイルストレージに使用するディレクトリー。 |
jboss.server.tmp.dir | サーバーが一時ファイルストレージに使用するディレクトリー。 |
jboss.domain.servers.dir | ホストコントロールが管理対象ドメインの各サーバーインスタンスに対して作業領域を作成するディレクトリー。 |
path
要素を設定ファイルに追加することにより、独自のパスを追加したり、上記の最初の 5 つを除くすべてをオーバーライドしたりできます。次の例は、各サーバーインスタンスのルートディレクトリーに対する新しい相対パス宣言を示しています。
例2.9 相対パスの形式
<path name="examplename" path="example/path" relative-to="jboss.server.data.dir"/>
表2.8 パス属性
属性 | 説明 |
---|---|
name | パスの名前。 |
path | 実際のファイルシステムパス。relative-to 属性が指定されない限り、絶対パスとして処理され、値はそのパスの相対パスとして処理されます。 |
relative-to | 以前に指定された別のパスの名前を示すオプション属性、またはシステムにより提供される標準的ないずれかのパス。 |
domain.xml
設定ファイルの path
要素には、name 属性のみが必要です。以下の例のとおり、実際のファイルシステムパスを示す情報を含める必要はありません。
例2.10 ドメインパスの例
<path name="example"/>
domain.xml
設定の他の部分が参照できる example
という名前のパスがあることを宣言します。example
で宣言された実際のファイルシステムの場所は、ドメイングループに参加しているホストインスタンスの各 host.xml
設定ファイルに固有です。この方法が使用された場合は、実際のファイルシステムパスを指定する各マシンの host.xml
にパス要素が含まれる必要があります。
例2.11 ホストパスの例
<path name="example" path="path/to/example" />
standalone.xml
内の path
要素には、実際のファイルシステムパスの指定を含める必要があります。
2.10. ファイルの履歴設定
2.10.1. ファイルの履歴設定
standalone.xml
インスタンス、domain.xml
、host.xml
ファイルが含まれます。これらのファイルは直接編集することで変更できますが、アプリケーションサーバーモデルを管理 CLI や管理コンソールといった、利用可能な管理オペレーションを使い設定する方法を推奨しています。
2.10.2. サーバーを以前の設定で起動
standalone.xml
を使用してスタンドアロンサーバーの以前の設定でアプリケーションサーバーを起動する方法を示しています。同じコンセプトは、domain.xml
と host.xml
それぞれを使用した監理対象ドメインに適用されます。
- 開始するバックアップバージョンを特定します。この例では、正常な起動後の最初の変更の前にサーバーモデルのインスタンスが呼び出されます。
EAP_HOME/configuration/standalone_xml_history/current/standalone.v1.xml
jboss.server.config.dir
下で相対ファイル名を渡すことによってバックアップモデルのこのインスタンスでサーバーを起動します。EAP_HOME/bin/standalone.sh --server-config=standalone_xml_history/current/standalone.v1.xml
アプリケーションサーバーが、選択された設定で起動されます。
2.10.3. 管理 CLI を使用した設定スナップショットの保存
前提条件
standalone.xml
インスタンスを使用しますが、同じプロセスは domain.xml
モデルと host.xml
モデルに適用されます。
スナップショットの保存
take-snapshot
操作を実行して、現在のサーバーインスタンスのコピーを取得します。[standalone@localhost:9999 /] :take-snapshot { "outcome" => "success", "result" => "/home/User/EAP_HOME/standalone/configuration/standalone_xml_history/snapshot/20110630-172258657standalone.xml" }
現在のサーバーインスタンスのスナップショットが保存されます。
2.10.4. 設定スナップショットのロード
standalone.xml
インスタンスを使用しますが、同じプロセスは domain.xml
モデルと host.xml
モデルに適用されます。
- ロードするスナップショットを識別します。この例では、スナップショットディレクトリーから以下のファイルが呼び出されます。スナップショットファイルのデフォルトのパスは以下のとおりです。
EAP_HOME/standalone/configuration/standalone_xml_history/snapshot/20110812-191301472standalone.xml
スナップショットは相対パスにより表されます。たとえば、上記の例は次のように記述できます。jboss.server.config.dir/standalone_xml_history/snapshot/20110812-191301472standalone.xml
- ファイル名を渡して、選択したスナップショットインスタンスでサーバーを起動します。
EAP_HOME/bin/standalone.sh --server-config=standalone_xml_history/snapshot/20110913-164449522standalone.xml
サーバーは、選択したスナップショットプロファイルで再起動されます。
2.10.5. 管理 CLI を使用した設定スナップショットの削除
前提条件
standalone.xml
インスタンスを使用しますが、同じプロセスは domain.xml
モデルと host.xml
モデルに適用されます。
スナップショットの削除
ロードするスナップショットを指定します。この例では、スナップショットディレクトリーから以下のファイルが削除されます。jboss.domain.config.dir/configuration/standalone_xml_history/snapshot/20110812-191301472standalone.xml
スナップショットの削除
:delete-snapshot
コマンドを実行して、特定のスナップショットを削除します。[standalone@localhost:9999 /]
:delete-snapshot(name="20110630-165714239standalone.xml")
{"outcome" => "success"}
スナップショットが削除されます。
2.10.6. 管理 CLI を使用したすべての設定スナップショットのリスト
前提条件
standalone.xml
インスタンスを使用しますが、同じプロセスは domain.xml
モデルと host.xml
モデルに適用されます。
手順2.6 タスク
すべてのスナップショットのリスト
:list-snapshots
コマンドを実行して、保存されたすべてのスナップショットをリストします。[standalone@localhost:9999 /]
:list-snapshots
{ "outcome" => "success", "result" => { "directory" => "/home/hostname/EAP_Home/standalone/configuration/standalone_xml_history/snapshot", "names" => [ "20110818-133719699standalone.xml", "20110809-141225039standalone.xml", "20110802-152010683standalone.xml", "20110808-161118457standalone.xml", "20110912-151949212standalone.xml", "20110804-162951670standalone.xml" ] } }
スナップショットがリストされます。
第3章 管理インターフェース
3.1. 管理コンソールと管理 CLI について
3.2. 管理コンソール
3.2.1. 管理コンソール
3.2.2. 管理コンソールへログイン
前提条件
- JBoss Enterprise Application Platform 6 が稼働している必要があります。
手順3.1 タスク
管理コンソールのスタートページに移動
Web ブラウザーで管理コンソールに移動します。デフォルトの場所は http://localhost:9990/console/ です。ポート 9990 は管理コンソールのソケットバインディングとして事前定義されています。管理コンソールへログイン
以前作成したアカウントのユーザー名とパスワードを入力し、管理コンソールのログイン画面にログインします。図3.1 管理コンソールのログイン画面
結果
- 管理対象ドメイン
- スタンドアロンサーバー
3.2.3. 管理コンソールの言語の変更
サポート言語
- ドイツ語 (de)
- 簡体中国語 (zh-Hans)
- ブラジルポルトガル語 (pt-BR)
- フランス語 (fr)
- スペイン語 (es)
- 日本語 (ja)
手順3.2 タスク
管理コンソールにログインします。
Web ベースの管理コンソールにログインします。Settings ダイアログを開きます。
画面の右下付近に Settings ラベルがあります。これをクリックして管理コンソールの設定を開きます。必要な言語を選択します。
Locale 選択ボックスから必要な言語を選択します。次に、Save を選択します。確認ボックスで、アプリケーションをリロードする必要があることが示されます。Confirm をクリックします。新しいロケールを使用するために Web ブラウザを更新します。
3.2.4. 管理コンソールを使用したサーバーの設定
手順3.3 タスク
管理コンソールでサーバーの Server Configuration パネルに移動します。
- コンソールの右上から Server タブを選択します。
- コンソールの左側にある Server Configurations メニュー項目を展開し、リストから該当するサーバーを選択します。
図3.2 サーバー設定
サーバー設定の編集
- サーバーリストの下にある Edit ボタンをクリックします。
- 設定属性の変更を行います。
- サーバーリストの下にある Save ボタンをクリックします。
サーバー設定が変更され、サーバーの次回再起動時に反映されます。
3.2.5. 管理コンソールでのデプロイメントの追加
前提条件
手順3.4 タスク
管理コンソールの Manage Deployments パネルに移動します。
- コンソールの右上から Runtime タブを選択します。
- 管理ドメインまたはスタンドアロンサーバーに対し、コンソールの左側にあるメニューから Deployments → Manage Deployments オプションを選択します。
Manage Deployments パネルが表示されます。図3.3 ドメインデプロイメントの管理
デプロイメントコンテンツの追加
Deployments パネルの右上の Add Content ボタンを選択します。Upload ダイアログボックスが表示されます。デプロイするファイルの選択
ダイアログボックスで、Choose File ボタンを選択します。デプロイするファイルを参照し、アップロードするために選択します。ファイルが選択されたら、Next ボタンを選択して 作業を続行します。図3.4 デプロイメント選択
デプロイメント名の確認
Upload ダイアログボックスに表示されるデプロイメント名とランタイム名を確認します。名前を確認したら、Save ボタンを選択してファイルをアップロードします。図3.5 デプロイメント名の確認
選択したコンテンツがサーバーにアップロードされ、デプロイメント可能になります。
図3.6 管理ドメインのアップロードされたデプロイメント
図3.7 スタンドアロンサーバーインスタンスのアップロードされたデプロイメント
3.2.6. 管理コンソールでの新しいサーバーの作成
手順3.5 タスク
管理コンソールの Server Configuration パネルに移動します。
- コンソールの右上から Hosts タブを選択します。
- コンソールの左側にある Server Configurations メニュー項目を展開し、リストから既存のサーバーを選択します。
選択したサーバーの Server Configuration パネルが表示されます。図3.8 サーバー設定
新しい設定の作成
- Server Configuration パネルの上部にある New Server Config ボタンを選択します。
- Create Server Configuration ダイアログで基本的なサーバー設定を編集します。
- Save ボタンを選択して、新しいサーバー設定を保存します。
図3.9 新しい設定の作成
新しいサーバーが作成され、Server Configurations リストに表示されます。
3.2.7. 管理コンソールを使用したデフォルトログレベルの変更
手順3.6 タスク
管理コンソールの Logging パネルに移動します。
- 管理ドメインを使用している場合は、コンソールの右上の Profiles タブを選択し、次にコンソールの左側にあるドロップダウンリストから該当するプロファイルを選択します。
- 管理ドメインまたはスタンドアロンサーバーに対し、コンソールの左側にあるメニューより Core → Logging と選択します。
- コンソール上部の Log Categories タグをクリックします。
図3.10 ロギングパネル
ロガーの詳細の編集
Log Categories テーブル内のいずれかのエントリの詳細を編集します。- Log Categories テーブル内のエントリを選択し、下の Details セクションの Edit ボタンを押します。
- Log Level ドロップダウンボックスでカテゴリーのログレベルを設定します。設定したら、Save ボタンを押します。
該当するカテゴリーのログレベルが更新されます。
3.2.8. 管理コンソールで新規サーバーグループを作成
前提条件
手順3.7 タスク
Server Groups のビューに移動します。
右上端の Profiles タブを選択します。- 左側の欄の Server Groups メニューにある Group Configurations タブを選択します。
図3.11 Server Groups ビュー
サーバーグループの追加
Add ボタンをクリックし新規サーバーグループを追加します。サーバーグループの設定
- サーバーグループ名を入力します。
- サーバーグループを追加したいプロファイルを選択します。
- サーバーグループを追加したいソケットバインディングを選択します。
- Save ボタンを押し新しく作成したグループを保存します。
図3.12 Create Server Group ダイアログ
この新規サーバーグループが管理コンソールで表示されるようになります。
3.3. 管理 CLI
3.3.1. 管理コマンドラインインターフェース (CLI)
3.3.2. Management CLI の起動
前提条件
- 管理 CLI にアクセスする前に以下のいずれかを実行してください。
手順3.8 タスク
Linux での CLI の起動
コマンドラインで以下のコマンドを入力して、EAP_HOME/bin/jboss-cli.sh
ファイルを実行します。$ EAP_HOME/bin/jboss-cli.sh
Windows での CLI の起動
ダブルクリックするか、コマンドラインで以下のコマンドを入力して、EAP_HOME\bin\jboss-cli.bat
ファイルを実行します。C:\>EAP_HOME\bin\jboss-cli.bat
3.3.3. 管理 CLI の終了
前提条件
手順3.9 タスク
quit
コマンドの実行管理 CLI で、quit
コマンドを入力します。[domain@localhost:9999 /]
quit
Closed connection to localhost:9999
3.3.4. 管理 CLI を使用した管理対象サーバーインスタンスへの接続
前提条件
手順3.10 タスク
connect
コマンドを実行します。管理 CLI で、connect
コマンドを入力します。[disconnected /]
connect
Connected to domain controller at localhost:9999- または、Linux システムで管理 CLI を起動するときに管理対象サーバーに接続するために、
--connect
パラメーターを使用します。$
EAP_HOME/bin/jboss-cli.sh --connect
--connect
パラメーターは、ホストとサーバーのポートを指定するために使用できます。ポートの値が9999
であるアドレス192.168.0.1
に接続するには、次のコマンドが適用されます。$
EAP_HOME/bin/jboss-cli.sh --connect --controller=192.168.0.1:9999
3.3.5. 管理 CLI でのヘルプの使用
前提条件
管理 CLI には、一般的なオプションと状況依存オプションから構成されるヘルプダイアログが組み込まれてます。運用状況に依存するヘルプコマンドでは、スタンドアロンまたはドメインコントローラーへの接続を確立する必要があります。接続が確立されない限り、これらのコマンドはリストに表示されません。
手順3.11 タスク
help
コマンドの実行管理 CLI で、help
コマンドを入力します。[standalone@localhost:9999 /]
help
状況依存ヘルプの使用
管理 CLI で、help -commands
拡張コマンドを入力します。[standalone@localhost:9999 /]
help --commands
- 特定のコマンドの詳細については、
'--help'
を引数としてhelp
コマンドを実行してください。[standalone@localhost:9999 /]
deploy --help
CLI ヘルプ情報が表示されます。
3.3.6. バッチモードでの管理 CLI の使用
手順3.12 タスク
バッチモードの開始
batch
コマンドを使用してバッチモードを開始します。[standalone@localhost:9999 /] batch [standalone@localhost:9999 / #]
バッチモードは、プロンプトでハッシュ記号 (#
) で示されます。バッチへの操作要求の追加
バッチモードが開始されたら、操作要求を通常どおり入力します。操作要求は、入力された順序でバッチに追加されます。操作要求のフォーマット化の詳細については、「管理 CLI での操作とコマンドの使用」 を参照してください。バッチの実行
操作要求のシーケンス全体が入力されたら、run-batch
コマンドを使用してバッチを実行します。[standalone@localhost:9999 / #] run-batch The batch executed successfully.
操作要求の入力されたシーケンスはバッチとして完了します。
3.3.7. 管理 CLI での操作とコマンドの使用
手順3.13 タスク
操作要求の構築
操作要求では、管理モデルとの低レベルの対話が可能です。この場合、サーバー設定を制御された方法で編集できます。操作要求は、以下の 3 つの部分から構成されます。- アドレス (スラッシュ (
/
) の接頭辞を指定)。 - 操作名 (コロン (
:
) の接頭辞を指定)。 - パラメーターのオプションセット (丸かっこ (
()
) で囲む)。
アドレスの決定
設定はアドレス指定可能なリソースの階層ツリーとして表されます。各リソースノードは、異なる操作セットを提供します。アドレスは、操作を実行するリソースノードを指定します。アドレスでは以下の構文を使用します。/node-type=node-name
- node-type は、リソースノードタイプです。これは、設定 XML の要素名に対してマッピングされます。
- これは、 node-name はリソースノード名です。これは、設定 XML の要素の
name
属性に対してマッピングされます。 - スラッシュ (
/
) を使用してリソースツリーの各レベルを区切ります。
設定 XML ファイルを参照して必要なアドレスを決定します。EAP_HOME/standalone/configuration/standalone.xml
ファイルは、スタンドアロンサーバーの設定を保持し、EAP_HOME/domain/configuration/domain.xml
ファイルとEAP_HOME/domain/configuration/host.xml
ファイルは管理対象ドメインの設定を保持します。例3.1 操作アドレスの例
ロギングサブシステムで操作を実行するには、操作要求の以下のアドレスを使用します。/subsystem=logging
Java データソースに対して操作を実行するには、操作要求の以下のアドレスを使用します。/subsystem=datasources/data-source=java
操作の決定
リソースノードの各タイプに応じて操作は異なります。操作では以下の構文を使用します。:operation-name
- operation-name は、要求する操作の名前です。
利用可能な操作をリストするために、スタンドアロンサーバーの任意のリソースアドレスでread-operation-names
操作を使用します。例3.2 利用可能な操作
ロギングサブシステムのすべての利用可能な操作をリストするために、スタンドアロンサーバーの以下の要求を入力します。[standalone@localhost:9999 /]
/subsystem=logging:read-operation-names
{ "outcome" => "success", "result" => [ "add", "change-root-log-level", "read-attribute", "read-children-names", "read-children-resources", "read-children-types", "read-operation-description", "read-operation-names", "read-resource", "read-resource-description", "remove-root-logger", "set-root-logger", "write-attribute" ], "compensating-operation" => undefined }パラメーターの決定
各操作では異なるパラメーターが必要な場合があります。パラメーターは以下の構文を使用します。(parameter-name=parameter-value)
- parameter-name は、パラメーターの名前です。
- parameter-value は、パラメーターの値です。
- 複数のパラメーターは、カンマ (
,
) で区切られます。
必要なパラメーターを決定するには、リソースノードで操作名をパラメーターとして渡し、read-operation-description
コマンドを実行します。詳細については、例3.3「操作パラメーターの決定」 を参照してください。例3.3 操作パラメーターの決定
ロギングサブシステムでchange-root-log-level
操作の必須パラメーターを決定するには、以下のようにread-operation-description
コマンドを入力します。[standalone@localhost:9999 /]
/subsystem=logging:read-operation-description(name=change-root-log-level)
{ "outcome" => "success", "result" => { "operation-name" => "change-root-log-level", "description" => "Change the root logger level.", "request-properties" => {"level" => { "type" => STRING, "description" => "The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.", "required" => true }} }, "compensating-operation" => undefined }
完全操作要求の入力
アドレス、操作、およびパラメーターが決定されたら、完全操作要求を入力します。例3.4 操作要求の例
[standalone@localhost:9999 /]
/subsystem=web/connector=http:read-resource(recursive=true)
管理インターフェースは、サーバー設定の操作要求を実行します。
3.3.8. 管理 CLI コマンドのリファレンス
トピック「管理 CLI でのヘルプの使用」では、一般オプションと状況依存オプションがあるヘルプダイアログが含まれる、管理 CLI ヘルプ機能のアクセス方法について説明しています。ヘルプコマンドは、操作コンテキストに依存し、スタンドアロンまたはドメインコントローラーへ確立された接続を必要とします。接続が確立されない限り、これらのコマンドはリストに表示されません。
表3.1
コマンド | 説明 |
---|---|
batch | 新しいバッチを作成してバッチモードを開始するか、既存の保留中のバッチに応じて、バッチを再びアクティベートします。保留中のバッチがない場合は、引数なしで呼び出されたこのコマンドによって新しいバッチが開始されます。名前がない保留中のバッチがある場合は、このコマンドによってそのバッチが再びアクティベートされます。名前がある保留中のバッチがある場合は、保留中のバッチの名前を引数にしてこのコマンドを実行することにより、これらのバッチをアクティベートできます。 |
cd | 現在のノードパスを引数に変更します。現在のノードパスはアドレス部分を含まない操作要求のアドレスとして使用されます。操作要求にアドレスが含まれる場合、そのアドレスは現在のノードパスに対して相対的であると見なされます。現在のノードパスは node-type で終わることがあります。その場合は、logging:read-resource などの node-name を指定すれば操作を実行できます。 |
clear | 画面を消去します。 |
command | 新しいタイプコマンドを追加し、既存の汎用タイプコマンドを削除およびリストできます。汎用タイプコマンドは、特定のノードタイプに割り当てられたコマンドであり、そのタイプのインスタンス向けの操作を実行可能にします。また、既存インスタンスのタイプにより公開された任意のプロパティーを変更することもできます。 |
connect | 指定されたホストおよびポートのコントローラに接続します。 |
connection-factory | 接続ファクトリーを定義します。 |
data-source | データソースサブシステムで JDBC データソース設定を管理します。 |
deploy | ファイルパスで指定されたアプリケーションをデプロイするか、リポジトリで無効な既存のアプリケーションを有効にします。引数なしで実行された場合は、このコマンドにより、既存のすべてのデプロイメントがリストされます。 |
help | ヘルプメッセージを表示します。該当するコマンドの状況依存の結果を提供するには、--commands 引数とともに使用します。 |
history | メモリー内の CLI コマンド履歴を表示し、履歴拡張が有効または無効であるかを表示します。必要に応じて履歴拡張をクリア、無効、および有効にするには、引数とともに使用します。 |
jms-queue | メッセージングサブシステムで JMS キューを定義します。 |
jms-topic | メッセージングサブシステムで JMS トピックを定義します。 |
ls | ノードパスの内容をリストします。デフォルトでは、ターミナルの全体の幅を使用して結果が列で出力されます。-l スイッチを使用すると、1 行あたり 1 つの名前で結果が出力されます。 |
pwd | 現在動作しているノードの完全ノードパスを出力します。 |
quit | コマンドラインインターフェースを終了します。 |
read-attribute | 値を出力し、引数によっては管理対象リソースの属性の説明も出力します。 |
read-operation | 指定された操作の説明を表示します。指定された操作がない場合は利用可能なすべての操作をリストします。 |
undeploy | 目的のアプリケーションの名前で実行された場合にアプリケーションをアンデプロイします。リポジトリからアプリケーションを削除するには引数とともに使用します。アプリケーションを指定せずに実行すると、既存のすべてのデプロイメントをリストします。 |
version | アプリケーションサーバーのバージョンと環境情報を出力します。 |
xa-data-source | データソースサブシステムで JDBC XA データソース設定を管理します。 |
3.3.9. 管理 CLI 操作のリファレンス
Management CLI の操作は、トピック 「管理 CLI を使用した操作名の表示」 で解説している read-operation-names
を使用すると公開できます。また、操作の説明は、トピック 「管理 CLI を使用した操作説明の表示」 で解説している read-operation-descriptions
操作を使用すると公開できます。
表3.2 Management CLI の操作
操作名 | 説明 |
---|---|
add-namespace | namespaces 属性のマップに名前空間プレフィックスマッピングを追加します。 |
add-schema-location | schema-locations 属性のマップにスキーマロケーションマッピングを追加します。 |
delete-snapshot | snapshots ディレクトリからサーバー設定のスナップショットを削除します。 |
full-replace-deployment | 以前にアップロードされたデプロイメントコンテンツを使用可能なコンテンツの一覧に追加して、ランタイムの同名の既存コンテンツを置き換え、その置き換えられたコンテンツを使用可能なコンテンツの一覧から削除します。詳細はリンク先を参照してください。 |
list-snapshots | snapshots ディレクトリに保存されているサーバー設定のスナップショットを一覧表示します。 |
read-attribute | 選択したリソースの属性値を表示します。 |
read-children-names | 指定タイプの選択したリソース配下にあるすべての子リソースの名前を表示します。 |
read-children-resources | 指定のタイプであるすべての子リソースに関する情報を表示します。 |
read-children-types | 選択したリソースの配下にあるすべての子リソースのタイプ名を表示します。 |
read-config-as-xml | 現在の設定を読み込み、XML 形式で表示します。 |
read-operation-description | 特定のリソースに対する操作の詳細を表示します。 |
read-operation-names | 特定のリソースに対する全操作の名前を表示します。 |
read-resource | モデルリソースの属性値および任意の子リソースの基本情報もしくは詳細情報を表示します。 |
read-resource-description | リソースの属性、子リソースのタイプ、および操作についての詳細を表示します。 |
reload | 全サービスをシャットダウンして再起動することにより、サーバーを再ロードします。 |
remove-namespace | namespaces 属性マップから名前空間プレフィックスマッピングを削除します。 |
remove-schema-location | schema-locations 属性マップからスキーマロケーションマッピングを削除します。 |
replace-deployment | ランタイムの既存コンテンツを新規コンテンツに置き換えます。新規コンテンツはデプロイメントコンテンツリポジトリに事前にアップロードしておく必要があります。 |
resolve-expression | 式を、式へ解析可能な入力または文字列として許可し、ローカルのシステムプロパティーおよび環境変数に対して解決する操作です。 |
resolve-internet-address | インターフェース解決基準のセットを取得し、基準に一致するローカルマシンで IP アドレスを見つけます。一致する IP アドレスがない場合は失敗します。 |
server-set-restart-required | 再起動が必要なモードにサーバーを設定します。 |
shutdown | System.exit(0) の呼び出しにより、サーバーをシャットダウンします。 |
start-servers | 現在実行されていないすべての設定済みサーバーを管理対象ドメインで起動します。 |
stop-servers | 管理対象ドメインで現在実行しているすべてのサーバーを停止します。 |
take-snapshot | サーバー設定のスナップショットを作成し、snapshots ディレクトリに保存します。 |
upload-deployment-bytes | 含まれるバイト配列のデプロイメントコンテンツは、デプロイメントコンテンツリポジトリに追加する必要があることを指定します。この操作は、コンテンツをランタイムへデプロイする必要があるとは指定しない点に注意してください。 |
upload-deployment-stream | 含まれる入力ストリームインデックスで利用可能なデプロイメントコンテンツは、デプロイメントコンテンツリポジトリに追加する必要があることを指定します。この操作は、コンテンツがランタイムにデプロイされる必要があることは指定しない点に注意してください。 |
upload-deployment-url | 含まれる URL で利用可能なデプロイメントコンテンツはデプロイメントコンテンツリポジトリに追加する必要があることを指定します。この操作は、コンテンツがランタイムにデプロイされる必要があることは指定しない点に注意してください。 |
validate-address | 操作のアドレスを検証します。 |
write-attribute | 選択したリソースの属性値を設定します。 |
3.4. 管理 CLI の操作
3.4.1. 管理 CLI によるリソースの属性の表示
前提条件
read-attribute
オペレーションは、選択された属性の現在のランタイム値を読み取りするために使用されるグローバルオペレーションです。デフォルトの値や非定義の値を無視し、ユーザーによって設定された値のみを表示することが可能です。要求プロパティーには次のパラメーターが含まれます。
要求プロパティー
name
- 選択されたリソース下で値を取得する属性の名前。
include-defaults
false
を設定すると、デフォルト値を無視し、ユーザーによって設定された属性のみを表示するようオペレーション結果を制限できるブール変数パラメーター。
手順3.14 タスク
read-attribute
オペレーションの実行管理 CLI よりread-attribute
を使用してリソース属性の値を表示します。オペレーション要求の詳細は 「管理 CLI での操作とコマンドの使用」 を参照してください。[standalone@localhost:9999 /]
:read-attribute(name=name-of-attribute)
read-attribute
オペレーションの利点は、特定属性の現在のランタイム値を表示できることです。read-resource
オペレーションでも同様の結果を得ることができますが、include-runtime
要求プロパティーを追加した場合のみ可能で、そのノードに対して使用できる全リソース一覧の一部のみを表示することができます。次の例が示すように、read-attribute
オペレーションは細粒度の属性クエリを対象としています。
例3.5 read-attribute
オペレーションを実行してパブリックインターフェース IP を表示する
read-attribute
を使用して現在のランタイムの厳密値を返します。
[standalone@localhost:9999 /] /interface=public:read-attribute(name=resolved-address) { "outcome" => "success", "result" => "127.0.0.1" }
resolved-address
属性はランタイム値であるため、標準的な read-resource
オペレーションの結果には表示されません。
[standalone@localhost:9999 /] /interface=public:read-resource { "outcome" => "success", "result" => { "any" => undefined, "any-address" => undefined, "any-ipv4-address" => undefined, "any-ipv6-address" => undefined, "inet-address" => expression "${jboss.bind.address:127.0.0.1}", "link-local-address" => undefined, "loopback" => undefined, "loopback-address" => undefined, "multicast" => undefined, "name" => "public", "nic" => undefined, "nic-match" => undefined, "not" => undefined, "point-to-point" => undefined, "public-address" => undefined, "site-local-address" => undefined, "subnet-match" => undefined, "up" => undefined, "virtual" => undefined } }
resolved-address
や他のランタイム値を表示するには、include-runtime
要求プロパティーを使用する必要があります。
[standalone@localhost:9999 /] /interface=public:read-resource(include-runtime=true) { "outcome" => "success", "result" => { "any" => undefined, "any-address" => undefined, "any-ipv4-address" => undefined, "any-ipv6-address" => undefined, "inet-address" => expression "${jboss.bind.address:127.0.0.1}", "link-local-address" => undefined, "loopback" => undefined, "loopback-address" => undefined, "multicast" => undefined, "name" => "public", "nic" => undefined, "nic-match" => undefined, "not" => undefined, "point-to-point" => undefined, "public-address" => undefined, "resolved-address" => "127.0.0.1", "site-local-address" => undefined, "subnet-match" => undefined, "up" => undefined, "virtual" => undefined } }
現在のランタイム属性値が表示されます。
3.4.2. 管理 CLI でのアクティブユーザーの表示
前提条件
whoami
の操作は現在アクティブなユーザーの属性を識別するために使用されるグローバルな操作です。この操作はユーザー名の ID と割り当てられたレルムを公開します。whoami
の操作は、管理者が複数のレルムで複数のユーザーを管理する場合や、複数のターミナルセッションやユーザーアカウントを持つドメインインスタンス全体でアクティブユーザーを追跡する場合に便利です。
手順3.15 タスク
whoami
の実行管理 CLI よりwhoami
を使用し、アクティブユーザーのアカウントを表示します。[standalone@localhost:9999 /]
:whoami
次の例はスタンドアロンサーバーでwhoami
を使用し、アクティブユーザーはusername
でManagementRealm
レルムが割り当てられていることを表しています。例3.6 スタンドアロンインスタンスでの
whoami
の使用[standalone@localhost:9999 /]<command>:whoami</command> { "outcome" => "success", "result" => {"identity" => { "username" => "username", "realm" => "ManagementRealm" }} }
現在のアクティブユーザーのアカウントが表示されます。
3.4.3. 管理 CLI でのシステムおよびサーバー情報の表示
前提条件
手順3.16 タスク
version
コマンドの実行管理 CLI で、version
コマンドを入力します。[domain@localhost:9999 /]
version
アプリケーションサーバーバージョンと環境情報が表示されます。
3.4.4. 管理 CLI を使用した操作説明の表示
前提条件
手順3.17 タスク
read-operation-description
操作の実行管理 CLI で、read-operation-description
を使用して、操作に関する情報を表示します。操作ではキーと値のペアの形式でパラメーターを追加して、表示する操作を示す必要があります。操作結果の詳細については、「管理 CLI での操作とコマンドの使用」 を参照してください。[standalone@localhost:9999 /]
:read-operation-description(name=name-of-operation)
例3.7 list-snapshots 操作の説明の表示
list-snapshots
操作を説明する方法を示しています。
[standalone@localhost:9999 /] :read-operation-description(name=list-snapshots) { "outcome" => "success", "result" => { "operation-name" => "list-snapshots", "description" => "Lists the snapshots", "reply-properties" => { "type" => OBJECT, "value-type" => { "directory" => { "type" => STRING, "description" => "The directory where the snapshots are stored" }, "names" => { "type" => LIST, "value-type" => STRING, "description" => "The names of the snapshots within the snapshots directory" } } }, "read-only" => false } }
選択した操作に関する説明が表示されます。
3.4.5. 管理 CLI を使用した操作名の表示
前提条件
手順3.18 タスク
read-operation-names
の実行管理 CLI よりread-operation-names
操作を使用して利用可能な操作の名前を表示します。操作要求の詳細については、トピック「管理 CLI での操作とコマンドの使用」を参照してください。[standalone@localhost:9999 /]
:read-operation-names
例3.8 管理 CLI を使用した操作名の表示
read-operation-names
操作を説明する方法を示しています。
[standalone@localhost:9999 /]:read-operation-names
{
"outcome" => "success",
"result" => [
"add-namespace",
"add-schema-location",
"delete-snapshot",
"full-replace-deployment",
"list-snapshots",
"read-attribute",
"read-children-names",
"read-children-resources",
"read-children-types",
"read-config-as-xml",
"read-operation-description",
"read-operation-names",
"read-resource",
"read-resource-description",
"reload",
"remove-namespace",
"remove-schema-location",
"replace-deployment",
"shutdown",
"take-snapshot",
"upload-deployment-bytes",
"upload-deployment-stream",
"upload-deployment-url",
"validate-address",
"write-attribute"
]
}
利用可能な操作名が表示されます。
3.4.6. 管理 CLI を使用した利用可能なリソースの表示
前提条件
read-resource
操作は、リソース値を読み取るために使用されるグローバル操作です。これは、現在のノードまたは子ノードのリソースに関する基本的、または完全な情報を捜査結果の範囲を拡大または制限するさまざまな要求プロパティーとともに公開するために使用できます。要求プロパティーには、以下のパラメーターが含まれます。
要求プロパティー
recursive
- 子リソースに関する完全な情報を再帰的に含めるかどうか。
recursive-depth
- 子リソースに関する情報を含める必要がある深度。
proxies
- 再帰的なクエリーにリモートリソースを含めるかどうか (たとえば、ドメインコントローラーのクエリーにスレーブホストコントローラーからのホストレベルリソースを含めるかどうか)。
include-runtime
- 応答に、永続的な設定ではない属性値などのランタイム属性を含めるかどうか。この要求プロパティーは、デフォルトで false に設定されます。
include-defaults
- デフォルト属性の読み取りを有効または無効にするブール値要求プロパティー。falseに設定された場合は、ユーザが設定した属性のみが返され、未定義のままの属性は無視されます。
手順3.19 タスク
read-resource
操作の実行管理 CLI で、read-resource
操作を使用して利用可能なリソースを表示します。[standalone@localhost:9999 /]
:read-resource
以下の例は、スタンドアロンサーバーインスタンスでread-resource
操作を使用して一般的なリソース情報を公開する方法を示しています。結果はstandalone.xml
設定ファイルに類似し、サーバーインスタンス向けにインストールまたは設定されたシステムリソース、拡張機能、インターフェース、およびサブシステムを表示します。これらは、さらに直接問い合わせることができます。例3.9 ルートレベルでの
read-resource
操作の使用[standalone@localhost:9999 /]:read-resource { "outcome" => "success", "result" => { "deployment" => undefined, "management-major-version" => 1, "management-minor-version" => 2, "name" => "hostname", "namespaces" => [], "product-name" => "EAP", "product-version" => "6.0.0.GA", "profile-name" => undefined, "release-codename" => "Steropes", "release-version" => "7.1.2.Final-redhat-1", "schema-locations" => [], "system-property" => undefined, "core-service" => { "management" => undefined, "service-container" => undefined, "server-environment" => undefined, "platform-mbean" => undefined }, "extension" => { "org.jboss.as.clustering.infinispan" => undefined, "org.jboss.as.configadmin" => undefined, "org.jboss.as.connector" => undefined, "org.jboss.as.deployment-scanner" => undefined, "org.jboss.as.ee" => undefined, "org.jboss.as.ejb3" => undefined, "org.jboss.as.jaxrs" => undefined, "org.jboss.as.jdr" => undefined, "org.jboss.as.jmx" => undefined, "org.jboss.as.jpa" => undefined, "org.jboss.as.logging" => undefined, "org.jboss.as.mail" => undefined, "org.jboss.as.naming" => undefined, "org.jboss.as.osgi" => undefined, "org.jboss.as.pojo" => undefined, "org.jboss.as.remoting" => undefined, "org.jboss.as.sar" => undefined, "org.jboss.as.security" => undefined, "org.jboss.as.threads" => undefined, "org.jboss.as.transactions" => undefined, "org.jboss.as.web" => undefined, "org.jboss.as.webservices" => undefined, "org.jboss.as.weld" => undefined }, "interface" => { "management" => undefined, "public" => undefined, "unsecure" => undefined }, "path" => { "jboss.server.temp.dir" => undefined, "user.home" => undefined, "jboss.server.base.dir" => undefined, "java.home" => undefined, "user.dir" => undefined, "jboss.server.data.dir" => undefined, "jboss.home.dir" => undefined, "jboss.server.log.dir" => undefined, "jboss.server.config.dir" => undefined, "jboss.controller.temp.dir" => undefined }, "socket-binding-group" => {"standard-sockets" => undefined}, "subsystem" => { "logging" => undefined, "configadmin" => undefined, "datasources" => undefined, "deployment-scanner" => undefined, "ee" => undefined, "ejb3" => undefined, "infinispan" => undefined, "jaxrs" => undefined, "jca" => undefined, "jdr" => undefined, "jmx" => undefined, "jpa" => undefined, "mail" => undefined, "naming" => undefined, "osgi" => undefined, "pojo" => undefined, "remoting" => undefined, "resource-adapters" => undefined, "sar" => undefined, "security" => undefined, "threads" => undefined, "transactions" => undefined, "web" => undefined, "webservices" => undefined, "weld" => undefined } } }
子ノードに対する
read-resource
操作の実行read-resource
操作は、ルートから子ノードを問い合わせるために実行できます。操作の構造は最初に公開するノードを定義し、ノードに対して実行する操作を追加します。[standalone@localhost:9999 /]
/subsystem=web/connector=http:read-resource
以下の例では、特定の Web サブシステムノードに対してread-resource
操作を行うことにより、Web サブシステムコンポーネントに関する固有のリソース情報を公開できます。例3.10 ルートノードからの子ノードリソースの公開
[standalone@localhost:9999 /] /subsystem=web/connector=http:read-resource { "outcome" => "success", "result" => { "enable-lookups" => false, "enabled" => true, "executor" => undefined, "max-connections" => undefined, "max-post-size" => 2097152, "max-save-post-size" => 4096, "name" => "http", "protocol" => "HTTP/1.1", "proxy-name" => undefined, "proxy-port" => undefined, "redirect-port" => 8433, "scheme" => "http", "secure" => false, "socket-binding" => "http", "ssl" => undefined, "virtual-server" => undefined } }
同じ結果は、cd
コマンドを使用して子ノードに移動し、read-resource
操作を直接実行することにより、得ることができます。例3.11 ディレクトリーを変更することにより子ノードリソースを公開
[standalone@localhost:9999 /] cd subsystem=web
[standalone@localhost:9999 subsystem=web] cd connector=http
[standalone@localhost:9999 connector=http] :read-resource { "outcome" => "success", "result" => { "enable-lookups" => false, "enabled" => true, "executor" => undefined, "max-connections" => undefined, "max-post-size" => 2097152, "max-save-post-size" => 4096, "name" => "http", "protocol" => "HTTP/1.1", "proxy-name" => undefined, "proxy-port" => undefined, "redirect-port" => 8433, "scheme" => "http", "secure" => false, "socket-binding" => "http", "ssl" => undefined, "virtual-server" => undefined } }
再帰的なパラメーターを使用して結果にアクティブな値を含める
再帰的なパラメーターを使用して、永続的でない値、起動時に渡された値、またはランタイムモデルでアクティブな他の属性を含むすべての属性の値を公開できます。[standalone@localhost:9999 /]
/interface=public:read-resource(include-runtime=true)
以前の例と比較して、include-runtime
要求プロパティーを含めることにより、http コネクターにより送信されたバイトや受信されたバイトなどの追加のアクティブな属性が公開されます。例3.12
include-runtime
パラメーターを使用して追加でアクティブな値を公開[standalone@localhost:9999 /] /subsystem=web/connector=http:read-resource(include-runtime=true) { "outcome" => "success", "result" => { "bytesReceived" => "0", "bytesSent" => "0", "enable-lookups" => false, "enabled" => true, "errorCount" => "0", "executor" => undefined, "max-connections" => undefined, "max-post-size" => 2097152, "max-save-post-size" => 4096, "maxTime" => "0", "name" => "http", "processingTime" => "0", "protocol" => "HTTP/1.1", "proxy-name" => undefined, "proxy-port" => undefined, "redirect-port" => 8433, "requestCount" => "0", "scheme" => "http", "secure" => false, "socket-binding" => "http", "ssl" => undefined, "virtual-server" => undefined } }
3.4.7. 管理 CLI を使用した利用可能なリソース説明の表示
前提条件
手順3.20 タスク
read-resource-description
の実行管理 CLI で、read-resource-description
操作を使用して利用可能なリソースを読み取り、表示します。操作要求の詳細については、トピック「管理 CLI での操作とコマンドの使用」を参照してください。[standalone@localhost:9999 /]
:read-resource-description
オプションパラメーターの使用
read-resource-description
操作では、追加パラメーターを使用できます。- リソースの操作の説明を含めるには、
operations
パラメーターを使用します。[standalone@localhost:9999 /]
:read-resource-description(operations=true)
- リソースの継承された操作の説明を含める、または除外するには、
inherited
パラメーターを使用します。デフォルトの状態は true です。[standalone@localhost:9999 /]
:read-resource-description(inherited=false)
- 子リソースの操作の再帰的な説明を含めるには、
recursive
パラメーターを使用します。[standalone@localhost:9999 /]
:read-resource-description(recursive=true)
- リソースの説明を含めるには、
locale
パラメーターを使用します。null の場合は、デフォルトのロケールが使用されます。[standalone@localhost:9999 /]
:read-resource-description(locale=true)
利用可能なリソースの説明が表示されます。
3.4.8. 管理 CLI を使用したアプリケーションサーバーのリロード
前提条件
手順3.21 タスク
reload
操作の実行管理 CLI で、reload
操作を使用してSystem.exit(0)
システムコールを介してサーバーをシャットダウンします。操作要求の詳細については、トピック「管理 CLI での操作とコマンドの使用」を参照してください。[standalone@localhost:9999 /]
:reload
{"outcome" => "success"}
すべてのサービスをシャットダウンし、ランタイムを再び起動することにより、アプライアンスサーバーがリロードされます。管理 CLI が自動的に再接続されます。
3.4.9. 管理 CLI を使用したアプリケーションサーバーのシャットダウン
前提条件
手順3.22 タスク
shutdown
操作の実行管理 CLI で、shutdown
操作を使用しSystem.exit(0)
システムコールを介してサーバーをシャットダウンします。操作要求の詳細については、トピック「管理 CLI での操作とコマンドの使用」を参照してください。[standalone@localhost:9999 /]
:shutdown
アプリケーションサーバーがシャットダウンされます。ランタイムが利用できない場合に、管理 CLI が切断されます。
3.4.10. 管理 CLI での属性の設定
前提条件
write-attribute
操作は、選択されたリソース属性を記述または変更するために使用するグローバル操作です。この操作を使用して永続的な変更を行い、管理対象サーバーインスタンスの設定を変更できます。要求プロパティーには以下のパラメーターが含まれます。
要求プロパティー
name
- 選択されたリソース下で値を設定する属性の名前。
value
- 選択されたリソース下の属性の必要な値。基礎となるモデルが null 値をサポートする場合は、null になることがあります。
手順3.23 タスク
write-attribute
操作の実行管理 CLI で、write-attribute
操作を使用してリソース属性の値を変更します。操作は、完全リソースパスが指定されたリソースの子ノードまたは管理 CLI のルートノードで実行できます。
例3.13 write-attribute
操作でデプロイメントスキャナーを無効にします。
write-attribute
操作を使用してデプロイメントスキャナーを無効にします。操作は、ルートノードから実行されます (タブ補完を使用して正しいリソースパスを入力します)。
[standalone@localhost:9999 /] /subsystem=deployment-scanner/scanner=default:write-attribute(name=scan-enabled,value=false) {"outcome" => "success"}
read-attribute
操作を直接使用して確認できます。
[standalone@localhost:9999 /] /subsystem=deployment-scanner/scanner=default:read-attribute(name=scan-enabled) { "outcome" => "success", "result" => false }
read-resource
操作を使用して、すべてのノードの利用可能なリソース属性をリストすることによっても確認できます。以下の例では、この特別な設定により、scan-enabled
属性が false
に設定されていることが示されます。
[standalone@localhost:9999 /] /subsystem=deployment-scanner/scanner=default:read-resource { "outcome" => "success", "result" => { "auto-deploy-exploded" => false, "auto-deploy-xml" => true, "auto-deploy-zipped" => true, "deployment-timeout" => 600, "path" => "deployments", "relative-to" => "jboss.server.base.dir", "scan-enabled" => false, "scan-interval" => 5000 } }
リソース属性が更新されます。
3.5. 管理 CLI コマンド履歴
3.5.1. 管理 CLI コマンド履歴の利用
.jboss-cli-history
として自動的に保存されるログファイルに追加されます。この履歴ファイルはデフォルトで、CLI コマンドを最大 500 件記録できるよう設定されます。
history
コマンド自体は、現在のセッションの履歴を返しますが、引数を追加すると、セッションメモリーの履歴を無効化、有効化、または消去できます。管理 CLI では、キーボードの矢印キーを使用してコマンドや操作の履歴を前後に移動できます。
3.5.2. 管理 CLI コマンド履歴の表示
前提条件
手順3.24 タスク
history
コマンドの実行管理 CLI で、history
コマンドを入力します。[standalone@localhost:9999 /]
history
CLI が起動された以降、または履歴削除コマンドが実行された以降にメモリに格納された CLI コマンド履歴が表示されます。
3.5.3. 管理 CLI コマンド履歴の削除
前提条件
手順3.25 タスク
history --clear
コマンドの実行管理 CLI で、history --clear
コマンドを入力します。[standalone@localhost:9999 /]
history --clear
CLI が起動された以降に記録されたコマンドの履歴がセッションメモリーから削除されます。コマンド履歴は、ユーザーのホームディレクトリーに保存された .jboss-cli-history
ファイルにまだあります。
3.5.4. 管理 CLI コマンド履歴の無効化
前提条件
手順3.26 タスク
history --disable
コマンドの実行管理 CLI で、history --disable
コマンドを入力します。[standalone@localhost:9999 /]
history --disable
CLI で実行されたコマンドは、メモリ内、またはユーザーのホームディレクトリーに保存された .jboss-cli-history
ファイルに記録されません。
3.5.5. 管理 CLI コマンド履歴の有効化
前提条件
手順3.27 タスク
history --enable
コマンドの実行管理 CLI で、history --enable
コマンドを入力します。[standalone@localhost:9999 /]
history --enable
CLI で実行されたコマンドは、メモリ内、またはユーザーのホームディレクトリーに保存された .jboss-cli-history
ファイルに記録されます。
第4章 ユーザー管理
4.1. ユーザー作成
4.1.1. 管理インターフェースの初期ユーザーの追加
JBoss Enterprise Application Platform 6 の管理インターフェースはデフォルトでセキュアになっており、デフォルトのユーザーが存在しません。これは、単純な設定ミスのため、リモートシステムからセキュリティー違反が発生することを防ぐためのセキュリティー予防措置です。ローカルの HTTP 以外のアクセスは、SASL メカニズムによって保護され、ローカルホストからクライアントが初めて接続するたびに、クライアントとサーバー間でネゴシエーションが行われます。
注記
手順4.1 タスク
add-user.sh
またはadd-user.bat
スクリプトを呼び出します。EAP_HOME/bin/
ディレクトリーへ移動します。ご使用のオペレーティングシステムに対応するスクリプトを呼び出します。- Red Hat Enterprise Linux
[user@host bin]$
./add-user.sh- Microsoft Windows Server
C:\bin>
add-user.bat
管理ユーザーの追加を選択します。
オプションa
を選択して管理ユーザーを追加します。このユーザーはManagementRealm
に追加され、Web ベース管理コンソールまたはコマンドラインベース管理 CLI を使用して監理操作を実行することを許可されます。他のオプションb
を選択すると、ユーザーがApplicationRealm
に追加され、特定のパーミッションは提供されません。このレルムはアプリケーションで使用するために提供されます。ユーザーのレルムを選択します。
次のプロンプトは、ユーザーが追加されるレルムを示します。JBoss Enterprise Application Platform 6 を管理するパーミッションを持つユーザーの場合は、デフォルト値 (ManagementRealm
) を選択します。希望のユーザー名とパスワードを入力します。
入力を促されたら、セキュリティーレルム、ユーザー名、パスワードを入力します。ENTER を押すと、管理インターフェースを使用してユーザーが JBoss Enterprise Application Platform 6 を管理できるManagementRealm
のデフォルトレルムが選択されます。このレルムには最低でも 1 人のユーザーを追加する必要があります。情報を確認するよう促されます。内容が適切である場合はyes
と入力します。ユーザーがリモート JBoss Enterprise Application Platform 6 サーバーインスタンスを表すかどうかを選択します。
管理者以外に、ManagementRealm
で JBoss Enterprise Application Platform 6 に追加する必要がある場合がある他の種類のユーザーは、JBoss Enterprise Application Platform 6 の別のインスタンスを表すユーザーであり、メンバーとしてクラスターに参加することを認証できる必要があります。次のプロンプトでは、この目的のために追加されたユーザーを指定できます。yes
を選択した場合は、異なる設定ファイルに追加する必要があるユーザーのパスワードを表すハッシュされたsecret
値が提供されます。このタスクでは、この質問に対してno
と回答してください。追加ユーザーを入力します。
希望する場合はこの手順を繰り返して追加のユーザーを入力することができます。また、稼働中のシステムにいつでもユーザーを追加することが可能です。デフォルトのセキュリティーレルムを選択する代わりに他のレルムにユーザーを追加して、承認を細かく調整することが可能です。非対話的にユーザーを作成します。
コマンドラインで各パラメーターを渡すと非対話的にユーザーを作成することができます。ログや履歴ファイルにパスワードが表示されるため、この方法は共有システムでは推奨されません。監理レルムを使用した、コマンドの構文は次のとおりです。[user@host bin]$
./add-user.sh usernamepasswordアプリケーションレルムを使用するには、-a
パラメーターを使用します。[user@host bin]$
./add-user.sh -a usernamepassword
追加したすべてのユーザは、指定したセキュリティーレルム内でアクティベートされます。ManagementRealm
レルム内でアクティブなユーザーは、リモートシステムから JBoss Enterprise Application Platform 6 を管理できます。
第5章 ネットワークおよびポート設定
5.1. インターフェース
5.1.1. インターフェースについて
domain.xml
、host.xml
、および standalone.xml
設定ファイルには、インターフェース宣言が含まれます。宣言基準はワイルドカードアドレスを参照したり、有効な一致候補にするためにインターフェースまたはアドレスで必要となる 1 つまたは複数の特徴を指定したりできます。次の例は、通常は standalone.xml
設定ファイルまたは host.xml
設定ファイルで定義される、インターフェース宣言の複数の設定を示しています。これにより、リモートホストグループが独自の固有インターフェース属性を維持できるようになる一方で、ドメインコントローラーの domain.xml
設定ファイルのインターフェースグループを引き続き参照できます。
management
相対名グループと public
相対名グループに対して指定された固有の inet-address
値を示します。
例5.1 inet-address 値で作成されたインターフェースグループ
<interfaces> <interface name="management"> <inet-address value="127.0.0.1"/> </interface> <interface name="public"> <inet-address value="127.0.0.1"/> </interface> </interfaces>
any-address
要素を使用してワイルドカードアドレスを宣言します。
例5.2 ワイルドカード宣言で作成されたグローバルグループ
<interface name="global"> <!-- Use the wild-card address --> <any-address/> </interface>
external
で宣言します。
例5.3 NIC 値で作成された外部グループ
<interface name="external"> <nic name="eth0"/> </interface>
例5.4 特定の状況の値で作成されたデフォルトグループ
<interface name="default"> <!-- Match any interface/address on the right subnet if it's up, supports multicast, and isn't point-to-point --> <subnet-match value="192.168.0.0/16"/> <up/> <multicast/> <not> <point-to-point/> </not> </interface>
5.1.2. インターフェースの設定
standalone.xml
設定ファイルと host.xml
設定ファイルのデフォルトインターフェース設定は、それぞれの相対インターフェーストークンを持つ 3 つの名前付きインターフェースを提供します。管理コンソールまたは管理 CLI を使用して、以下の表で示されたような追加の属性と値を設定できます。また、必要に応じて、相対インターフェースバインディングを特定の値に置き換えることもできます。置き換える場合、-b
スイッチは相対値のみを上書きできるため、サーバーの実行時にインターフェース値を渡すことはできません。
例5.5 デフォルトインターフェース設定
<interfaces> <interface name="management"> <inet-address value="${jboss.bind.address.management:127.0.0.1}"/> </interface> <interface name="public"> <inet-address value="${jboss.bind.address:127.0.0.1}"/> </interface> <interface name="unsecure"> <inet-address value="${jboss.bind.address.unsecure:127.0.0.1}"/> </interface> </interfaces>
表5.1 インターフェース属性と値
インターフェース要素 | 説明 |
---|---|
any | 選択基準を制約するために使用されるアドレス除外タイプの空の要素。 |
any-address | このインターフェースを使用するソケットをワイルドカードアドレスにバインドする必要があることを示す空の要素。java.net.preferIpV4Stack システムプロパティーが true に設定されていない限り、IPv6 ワイルドカードアドレス (::) が使用されます。true に設定された場合は、IPv4 ワイルドカードアドレス (0.0.0.0) が使用されます。ソケットがデュアルスタックマシンの IPv6 anylocal アドレスにバインドされた場合は、IPv6 および IPv4 トラフィックを受け取ることができます。IPv4 (IPv4 マッピング) anylocal アドレスにバインドされた場合は、IPv4 トラフィックのみを受け取ることができます。 |
any-ipv4-address | このインターフェースを使用するソケットを IPv4 ワイルドカードアドレス (0.0.0.0) にバインドする必要があることを示す空の要素。 |
any-ipv6-address | このインターフェースを使用するソケットを IPv6 ワイルドカードアドレス (::) にバインドする必要があることを示す空の要素。 |
inet-address | IPv6 または IPv4 のドット区切り表記の IP アドレス、または IP アドレスに解決できるホスト名。 |
link-local-address | インターフェースの選択基準の一部として、関連付けられたアドレスがリンクローカルであるかどうかを示す空の要素。 |
loopback | インターフェースの選択基準の一部として、ループバックインターフェースであるかどうかを示す空の要素。 |
loopback-address | マシンのループバックインターフェースで実際には設定できないループバックアドレス。IP アドレスが関連付けられた NIC が見つからない場合であっても該当する値が使用されるため、inet-addressType とは異なります。 |
multicast | インターフェースの選択基準の一部として、マルチキャストをサポートするかどうかを示す空の要素。 |
nic | ネットワークインターフェースの名前 (eth0、eth1、lo など)。 |
nic-match | 使用できるインターフェースを見つけるために、マシンで利用可能なネットワークインターフェースの名前を検索する正規表現。 |
not | 選択基準を制約するために使用されるアドレス除外タイプの空の要素。 |
point-to-point | インターフェースの選択基準の一部として、ポイントツーポイントインターフェースであるかどうかを示す空の要素。 |
public-address | インターフェースの選択基準の一部として、公開されたルーティング可能なアドレスを持つかどうかを示す空の要素。 |
site-local-address | インターフェースの選択基準の一部として、関連付けられたアドレスがサイトローカルであるかどうかを示す空の要素。 |
subnet-match | 「スラッシュ表記法」で記述されたネットワーク IP アドレスとアドレスのネットワーク接頭辞のビット数 (たとえば、192.168.0.0/16)。 |
up | インターフェースの選択基準の一部として、現在稼動しているかどうかを示す空の要素。 |
virtual | インターフェースの選択基準の一部として、仮想インターフェースであるかどうかを示す空の要素。 |
インターフェース属性の設定
必要に応じて、インターフェース属性を設定するために、管理 CLI または管理コンソールを選択します。管理 CLI でのインターフェース属性の設定
管理 CLI を使用して、新しいインターフェースを追加し、インターフェース属性に新しい値を書き込みます。新しいインターフェースの追加
必要な場合は、add
操作を使用して新しいインターフェースを作成します。このコマンドは、管理 CLI セッションのルートから実行できます。次の例では、新しいインターフェースの名前タイトル interfacename が 12.0.0.2 と宣言されたinet-address
とともに作成されます。/interface=interfacename/:add(inet-address=12.0.0.2)
インターフェース属性の編集
write
操作を使用して新しい値を属性に書き込みます。タブ補完を使用して、入力するコマンド文字列を補完したり、利用可能な属性を公開したりできます。以下の例では、inet-address
値を 12.0.0.8 に更新します。/interface=interfacename/:write(inet-address=12.0.0.8)
インターフェース属性の編集
read-resource
操作をinclude-runtime=true
パラメーターで実行して値を変更し、サーバーモデルでアクティブな現在のすべての値を公開することを確認します。[standalone@localhost:9999 interface=public]
:read-resource(include-runtime=true)
管理コンソールでのインターフェース属性の設定
管理コンソールを使用して、新しいインターフェースを追加し、インターフェース属性に新しい値を書き込みます。管理コンソールにログインします。
管理対象ドメインまたはスタンドアロンサーバーインスタンスの管理コンソールにログインします。監理対象ドメインを使用する場合は、適切なプロファイルを選択します。
右上にある Profiles タブを選択し、次の画面の左上にある Profile メニューから適切なプロファイルを選択します。ナビゲーションメニューから [Interfaces] 項目を選択します。
ナビゲーションメニューから [Interfaces] 項目を選択します。新しいインターフェースの追加
- Add ボタンをクリックします。
- Name、Inet Address、および Address Wildcard に必要な値を入力します。
- Save をクリックして終了します。
インターフェース属性の編集
- 編集するインターフェースを選択し Edit ボタンをクリックします。
- Name、Inet Address、および Address Wildcard に必要な値を入力します。
- Save をクリックして終了します。
5.2. ソケットバインディンググループ
5.2.1. ソケットバインディンググループについて
domain.xml
設定ファイルと standalone.xml
設定ファイルの両方で見つけることができます。設定の他のセクションは、論理名でこれらのソケットを参照できます。ソケット設定の完全な詳細を含める必要はありません。これにより、さまざまなマシンで異なる可能性がある相対ソケットを参照できます。
例5.6 スタンドアロン設定のデフォルトソケットバインディング
standalone.xml
設定ファイルのデフォルトソケットバインディンググループは、standard-sockets
下でグループ化されます。このグループは、同じ論理参照方法を使用して public
インターフェースでも参照されます。
<socket-binding-group name="standard-sockets" default-interface="public"> <socket-binding name="http" port="8080"/> <socket-binding name="https" port="8443"/> <socket-binding name="jacorb" port="3528"/> <socket-binding name="jacorb-ssl" port="3529"/> <socket-binding name="jmx-connector-registry" port="1090" interface="management"/> <socket-binding name="jmx-connector-server" port="1091" interface="management"/> <socket-binding name="jndi" port="1099"/> <socket-binding name="messaging" port="5445"/> <socket-binding name="messaging-throughput" port="5455"/> <socket-binding name="osgi-http" port="8090" interface="management"/> <socket-binding name="remoting" port="4447"/> <socket-binding name="txn-recovery-environment" port="4712"/> <socket-binding name="txn-status-manager" port="4713"/> </socket-binding-group>
例5.7 ドメイン設定のデフォルトソケットバインディング
domain.xml
設定ファイルのデフォルトソケットバインディンググループには standard-sockets
、ha-sockets
、full-sockets
、および full-ha-sockets
の 4 つのグループが含まれます。これらのグループは public
と呼ばれるインターフェースでも参照されます。
<socket-binding-groups> <socket-binding-group name="standard-sockets" default-interface="public"> <!-- Needed for server groups using the 'default' profile --> <socket-binding name="ajp" port="8009"/> <socket-binding name="http" port="8080"/> <socket-binding name="https" port="8443"/> <socket-binding name="osgi-http" interface="management" port="8090"/> <socket-binding name="remoting" port="4447"/> <socket-binding name="txn-recovery-environment" port="4712"/> <socket-binding name="txn-status-manager" port="4713"/> <outbound-socket-binding name="mail-smtp"> <remote-destination host="localhost" port="25"/> </outbound-socket-binding> </socket-binding-group> <socket-binding-group name="ha-sockets" default-interface="public"> <!-- Needed for server groups using the 'ha' profile --> <socket-binding name="ajp" port="8009"/> <socket-binding name="http" port="8080"/> <socket-binding name="https" port="8443"/> <socket-binding name="jgroups-mping" port="0" multicast-address="${jboss.default.multicast.address:230.0.0.4}" multicast-port="45700"/> <socket-binding name="jgroups-tcp" port="7600"/> <socket-binding name="jgroups-tcp-fd" port="57600"/> <socket-binding name="jgroups-udp" port="55200" multicast-address="${jboss.default.multicast.address:230.0.0.4}" multicast-port="45688"/> <socket-binding name="jgroups-udp-fd" port="54200"/> <socket-binding name="modcluster" port="0" multicast-address="224.0.1.105" multicast-port="23364"/> <socket-binding name="osgi-http" interface="management" port="8090"/> <socket-binding name="remoting" port="4447"/> <socket-binding name="txn-recovery-environment" port="4712"/> <socket-binding name="txn-status-manager" port="4713"/> <outbound-socket-binding name="mail-smtp"> <remote-destination host="localhost" port="25"/> </outbound-socket-binding> </socket-binding-group> <socket-binding-group name="full-sockets" default-interface="public"> <!-- Needed for server groups using the 'full' profile --> <socket-binding name="ajp" port="8009"/> <socket-binding name="http" port="8080"/> <socket-binding name="https" port="8443"/> <socket-binding name="jacorb" interface="unsecure" port="3528"/> <socket-binding name="jacorb-ssl" interface="unsecure" port="3529"/> <socket-binding name="messaging" port="5445"/> <socket-binding name="messaging-group" port="0" multicast-address="${jboss.messaging.group.address:231.7.7.7}" multicast-port="${jboss.messaging.group.port:9876}"/> <socket-binding name="messaging-throughput" port="5455"/> <socket-binding name="osgi-http" interface="management" port="8090"/> <socket-binding name="remoting" port="4447"/> <socket-binding name="txn-recovery-environment" port="4712"/> <socket-binding name="txn-status-manager" port="4713"/> <outbound-socket-binding name="mail-smtp"> <remote-destination host="localhost" port="25"/> </outbound-socket-binding> </socket-binding-group> <socket-binding-group name="full-ha-sockets" default-interface="public"> <!-- Needed for server groups using the 'full-ha' profile --> <socket-binding name="ajp" port="8009"/> <socket-binding name="http" port="8080"/> <socket-binding name="https" port="8443"/> <socket-binding name="jacorb" interface="unsecure" port="3528"/> <socket-binding name="jacorb-ssl" interface="unsecure" port="3529"/> <socket-binding name="jgroups-mping" port="0" multicast-address="${jboss.default.multicast.address:230.0.0.4}" multicast-port="45700"/> <socket-binding name="jgroups-tcp" port="7600"/> <socket-binding name="jgroups-tcp-fd" port="57600"/> <socket-binding name="jgroups-udp" port="55200" multicast-address="${jboss.default.multicast.address:230.0.0.4}" multicast-port="45688"/> <socket-binding name="jgroups-udp-fd" port="54200"/> <socket-binding name="messaging" port="5445"/> <socket-binding name="messaging-group" port="0" multicast-address="${jboss.messaging.group.address:231.7.7.7}" multicast-port="${jboss.messaging.group.port:9876}"/> <socket-binding name="messaging-throughput" port="5455"/> <socket-binding name="modcluster" port="0" multicast-address="224.0.1.105" multicast-port="23364"/> <socket-binding name="osgi-http" interface="management" port="8090"/> <socket-binding name="remoting" port="4447"/> <socket-binding name="txn-recovery-environment" port="4712"/> <socket-binding name="txn-status-manager" port="4713"/> <outbound-socket-binding name="mail-smtp"> <remote-destination host="localhost" port="25"/> </outbound-socket-binding> </socket-binding-group> </socket-binding-groups>
standalone.xml
ソースファイルと domain.xml
ソースファイルで作成および編集できます。バインディングを管理する推奨方法は、管理コンソールまたは管理 CLI を使用することです。管理コンソールを使用する利点には、[General Configuration] セクション下に専用 [Socket Binding Group] 画面があるグラフィカルユーザーインターフェースが含まれます。管理 CLI は、API、バッチ処理とアプリケーションサーバー設定の上位および下位レベルでスクリプトの使用を可能にするコマンドライン方法に基づいたワークフローを提供します。両方のインターフェースにより、変更を永続化したり、サーバー設定に保存したりできます。
5.2.2. ソケットバインディングの設定
standard-sockets
が含まれ、この他のグループを作成することはできません。この他のグループを作成するには、別のスタンドアロンサーバー設定ファイルを作成します。管理対象ドメインでは複数のソケットバインディンググループを作成することが可能で、必要に応じて含まれるソケットバインディングを設定できます。下表は各ソケットバインディングに使用できる属性を表しています。
表5.2 ソケットバインディングの属性
コンポーネント | 説明 | ロール |
---|---|---|
名前 | 設定の他の場所で使用する必要があるソケット設定の論理名。 | 必須 |
ポート | この設定に基づいたソケットをバインドする必要がある基本ポート。すべてのポートの値をインクリメントまたはデクリメントすることにより、サーバーがこの基本値を上書きするよう設定できることに注意してください。 | 必須 |
インターフェース | この設定に基づいたソケットをバインドする必要があるインターフェースの論理名。定義されない場合は、囲んでいるソケットバインディンググループから「default-interface」属性の値が使用されます。 | 任意 |
複数のアドレス | マルチキャストにソケットが使用される場合は、使用するマルチキャストアドレス。 | 任意 |
マルチキャストポート | 会話のライフサイクルにバインドされます。会話スコープは、要求の長さとセッション長さの間にあり、アプリケーションによって制御されます。 | 任意 |
固定ポート | 上記のコンテキストでニーズが満たされない場合は、カスタムスコープを定義できます。 | 任意 |
ソケットバインディンググループのソケットバインディングの設定
管理 CLI または管理コンソールを選択して、必要に応じてソケットバインディングを設定します。管理 CLI を使用したソケットバインディングの設定
管理 CLI を使用してソケットバインディングを設定します。新しいソケットバインディングの追加
add
操作を使用して、必要な場合に新しいアドレス設定を作成します。このコマンドは、管理 CLI セッションのルートから実行できます。この場合、以下の例では、newsocket という新しいソケットバインディングが作成され、port
属性が 1234 として宣言されます。以下の例は、standard-sockets
ソケットバインディンググループ上で編集を行うスタンドアロンサーバーおよび管理対象ドメインの両方に適用されます。[domain@localhost:9999 /] /socket-binding-group=standard-sockets/socket-binding=newsocket/:add(port=1234)
パターン属性の編集
write
操作を使用して新しい値を属性に書き込みます。タブ補完を使用して、入力するコマンド文字列を補完したり、利用可能な属性を公開したりできます。以下の例では、port
値を 2020 に更新します。[domain@localhost:9999 /] /socket-binding-group=standard-sockets/socket-binding=newsocket/:write-attribute(name=port,value=2020)
パターン属性の確認
read-resource
操作でinclude-runtime=true
パラメーターを実行して値を変更し、サーバーモデルでアクティブな現在のすべての値を公開します。[domain@localhost:9999 /] /socket-binding-group=standard-sockets/socket-binding=newsocket/:read-resource
管理コンソールを使用したソケットバインディングの設定
管理コンソールを使用してソケットバインディングを設定します。管理コンソールへのログイン
管理対象ドメインまたはスタンドアロンサーバーの管理コンソールにログインします。Profile tab の選択
右上の Profiles タブを選択します。ナビゲーションメニューより Socket Binding を選択
ナビゲーションメニューから Socket Binding メニュー項目を選択します。管理対象ドメインを使用している場合は Socket Binding Groups メニューから希望のグループを選択します。新しいソケットバインディングの追加
- Add ボタンをクリックします。
- Name、Port、および Binding Group に必要な値を入力します。
- Save をクリックして終了します。
インターフェース属性の編集
- 編集するソケットバインディングを選択し、Edit ボタンをクリックします。
- Name、Interface、または Port など、必要な値を入力します。
- Save をクリックして終了します。
5.2.3. JBoss Enterprise Application Platform 6 により使用されるネットワークポート
- 管理対象ドメインまたはスタンドアロンサーバー設定のいずれを使用するか。
- サーバーグループがデフォルトのソケットバインディンググループのいずれかを使用するか、またはカスタムグループを使用するかどうか。
- 個別デプロイメントの要件。
注記
デフォルトのソケットバインディンググループ
full-ha-sockets
full-sockets
ha-sockets
standard-sockets
表5.3 デフォルトのソケットバインディングの参照
名前 | ポート | マルチキャストポート | 詳細 | full-ha-sockets | full-sockets | ha-socket | standard-socket |
---|---|---|---|---|---|---|---|
ajp | 8009 | Apache JServ プロトコル。HTTP クラスタリングおよび負荷分散に使用します。 | はい | はい | はい | はい | |
http | 8080 | デプロイされた Web アプリケーションのデフォルトポート。 | はい | はい | はい | はい | |
https | 8443 | デプロイされた Web アプリケーションとクライアント間の SSL 暗号化接続。 | はい | はい | はい | はい | |
jacorb | 3528 | JTS トランザクションおよび他の ORB 依存サービス用の CORBA サービス。 | はい | はい | いいえ | いいえ | |
jacorb-ssl | 3529 | SSL 暗号化 CORBA サービス。 | はい | はい | いいえ | いいえ | |
jgroups-diagnostics | 7500 | マルチキャスト。HA クラスターでピア検出に使用されます。 | はい | いいえ | はい | いいえ | |
jgroups-mping | 45700 | マルチキャスト。HA クラスタでの初期メンバーシップを検出するために使用されます。 | はい | いいえ | はい | いいえ | |
jgroups-tcp | 7600 | TCP を使用した、HA クラスター内でのユニキャストピア検出。 | はい | いいえ | はい | いいえ | |
jgroups-tcp-fd | 57600 | TCP を介した HA 障害検出に使用されます。 | はい | いいえ | はい | いいえ | |
jgroups-udp | 55200 | 45688 | UDP を使用した、HA クラスター内でのユニキャストピア検出。 | はい | いいえ | はい | いいえ |
jgroups-udp-fd | 54200 | UDP を介した HA 障害検出に使用されます。 | はい | いいえ | はい | いいえ | |
messaging | 5445 | JMS サービス。 | はい | はい | いいえ | いいえ | |
messaging-group | HornetQ JMS ブロードキャストと検出グループにより参照されます。 | はい | はい | いいえ | いいえ | ||
messaging-throughput | 5455 | JMS Remoting により使用されます。 | はい | はい | いいえ | いいえ | |
mod_cluster | 23364 | JBoss Enterprise Application Platform と HTTP ロードバランサー間の通信に対するマルチキャストポート。 | はい | いいえ | はい | いいえ | |
osgi-http | 8090 | OSGi サブシステムを使用する内部コンポーネントにより使用されます。 | はい | はい | はい | はい | |
remoting | 4447 | リモート EJB の呼び出しに使用されます。 | はい | はい | はい | はい | |
txn-recovery-environment | 4712 | JTA トランザクションリカバリーマネージャー。 | はい | はい | はい | はい | |
txn-status-manager | 4713 | JTA / JTS トランザクションマネージャー。 | はい | はい | はい | はい |
ソケットバインディンググループ以外に、各ホストコントローラーは管理用にさらに 2 つのポートを開きます。
- 9990 - Web 管理コンソールポート
- 9999 - 管理コンソールと管理 API により使用されるポート
5.2.4. ソケットバインディンググループのポートオフセットについて
5.2.5. ポートオフセットの設定
ポートオフセットの設定
管理 CLI または管理コンソールを選択してポートオフセットを設定します。管理 CLI を使用したポートオフセットの設定
管理 CLI を使用してポートオフセットを設定します。ポートオフセットの編集
write
操作を使用して新しい値をポートオフセット属性に書き込みます。次の例は、server-two
のsocket-binding-port-offset
値を 250 に更新します。このサーバーはデフォルトローカルホストグループのメンバーです。[domain@localhost:9999 /] /host=master/server-config=server-two/:write-attribute(name=socket-binding-port-offset,value=250)
ポートオフセット属性の確認
read-resource
操作でinclude-runtime=true
パラメーターを実行して値を変更し、サーバーモデルでアクティブな現在のすべての値を公開します。[domain@localhost:9999 /] /host=master/server-config=server-two/:read-resource(include-runtime=true)
管理コンソールを使用したポートオフセットの設定
管理コンソールを使用してポートオフセットを設定します。管理コンソールにログインします。
管理対象ドメインの管理コンソールにログインします。Server タブを選択します。
右上の Server タブを選択します。ポートオフセット属性の編集
Configuration Name
セクションでサーバーを選択し、Edit ボタンをクリックします。- Port Offset フィールドで必要な値を入力します。
- Save ボタンをクリックして終了します。
5.3. IPv6
5.3.1. IPv6 ネットワーキング向け JVM スタック設定の指定
- タスクの概要
- このトピックでは、設定ファイルを使用した JBoss Enterprise Application Platform 6 インストールでの IPv6 ネットワーキングの有効化について説明します。
手順5.1 タスク
- インストールに関連するファイルを開きます。
スタンドアロンサーバーの場合:
EAP_HOME/bin/standalone.conf
を開きます。管理対象ドメインの場合:
EAP_HOME/bin/domain.conf
を開きます。
- IPv4 Stack Java プロパティーを false に変更します。
-Djava.net.preferIPv4Stack=false
- 以下の Java プロパティーを Java VM オプションに追加します。
-Djava.net.preferIPv6Addresses=true
例:# Specify options to pass to the Java VM. # if [ "x$JAVA_OPTS" = "x" ]; then JAVA_OPTS="-Xms64m -Xmx512m -XX:MaxPermSize=256m -Djava.net.preferIPv4Stack=false -Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Djava.net.preferIPv6Addresses=true" fi
注記
元の設定に戻すには、-Djava.net.preferIPv4Stack
を true に変更し、-Djava.net.preferIPv6Addresses=true
を削除します。
- 結果
- IPv6 アドレスを使用できます。
5.3.2. IPv6 ネットワークに対するインターフェース宣言の設定
次の手順に従って、インターフェース inet アドレスを IPv6 のデフォルトに設定します。
手順5.2 タスク
- コンソールの右上にある Profile タブを選択します。
- General Configuration の Interfaces オプションを選択します。
- 設定する名前付きネットワークインターフェースを選択します。
- Edit ボタンをクリックします。
- 下記の inet アドレスを設定します。
${jboss.bind.address.management:[::1]}
- サーバーを再起動し、変更を実装します。
5.3.3. IPv6 アドレス用 JVM スタック設定の指定
- タスクの概要
- このトピックでは、JBoss Enterprise Application Platform 6 インストールで IPv6 アドレスを優先するよう設定ファイルで設定する方法について説明します。
手順5.3 タスク
- インストールに関連するファイルを開きます。
スタンドアロンサーバーの場合:
EAP_HOME/bin/standalone.conf
を開きます。管理対象ドメインの場合:
EAP_HOME/bin/domain.conf
を開きます。
- 以下の Java プロパティーを Java VM オプションに追加します。
-Djava.net.preferIPv6Addresses=true
例:# Specify options to pass to the Java VM. # if [ "x$JAVA_OPTS" = "x" ]; then JAVA_OPTS="-Xms64m -Xmx512m -XX:MaxPermSize=256m -Djava.net.preferIPv4Stack=false -Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Djava.net.preferIPv6Addresses=true" fi
第6章 データソース管理
6.1. はじめに
6.1.1. JDBC について
6.1.2. JBoss Enterprise Application Platform 6 がサポートするデータベース
6.1.3. データソースの型
datasources
と XA datasources
の 2 つがあります。
6.1.4. データソースの例
警告
6.1.5. -ds.xml ファイルのデプロイメント
*-ds.xml
データソース設定ファイルが必要でした。*-ds.xml
を JBoss Enterprise Application Platform 6 にデプロイするには、http://docs.jboss.org/ironjacamar/schema/datasources_1_1.xsd のスキーマに従います。
警告
重要
*-ds.xml
ファイルをデプロイする場合、すでにデプロイまたは定義されている <driver> エントリーへの参照を使用しなければなりません。
6.2. JDBC ドライバー
6.2.1. 管理コンソールで JDBC ドライバーをインストール
お使いのアプリケーションが JDBC データソースに接続する前に、データソースベンダーの JDBC ドライバーを Enterprise Application Platform が利用できる場所にインストールする必要があります。JBoss Enterprise Application サーバーがあると、他のデプロイメントと同じようにこれらのドライバーをデプロイできます。つまり、管理ドメインを使っている場合、サーバーグループ内の複数のサーバーに対してデプロイ可能です。
このタスクを行う前に、以下の要件を満たす必要があります。
- データベースベンダーから JDBC ドライバーをダウンロードします。
- アーカイブ (ZIP あるいは TAR ファイル) を展開し、実際のドライバーを含む JARファイルを探します。
手順6.1 タスク
管理コンソールへのアクセス
JAR ファイルをお使いのサーバーあるいはサーバーグループにデプロイします。
管理ドメインを使っている場合は、JAR ファイルをサーバーグループにデプロイします。使っていない場合はサーバーにデプロイしてください。「管理コンソールを使いアプリケーションをデプロイ」 を参照してください。
JDBC ドライバーがデプロイされ、お使いのアプリケーションで利用できるようになります。
6.2.2. コアモジュールとしての JDBC ドライバーのインストール
このタスクを実行する前に、以下の前提条件を満たしている必要があります。
- ご使用のデータベースのベンダーから JDBC ドライバーをダウンロードします。JDBC ドライバーのダウンロードロケーションは 「JDBC ドライバーをダウンロードできる場所」 に記載しています。
- アーカイブを展開します。
手順6.2 タスク
EAP_HOME/modules/
ディレクトリ下にファイルパス構造を作成します。たとえば、MySQL JDBC ドライバーの場合には、次のようなディレクトリ構造を作成します:EAP_HOME/modules/com/mysql/main/
- JDBC ドライバーの JAR を
main/
サブディレクトリにコピーします。 main/
サブディレクトリに、以下の例のようなmodule.xml
ファイルを作成します。例6.1 module.xml ファイルの例
<?xml version="1.0" encoding="UTF-8"?> <module xmlns="urn:jboss:module:1.0" name="com.mysql"> <resources> <resource-root path="mysql-connector-java-5.1.15.jar"/> </resources> <dependencies> <module name="javax.api"/> </dependencies> </module>
モジュール名com.mysql
はそのモジュールのディレクトリ構造と一致する必要があります。- サーバーを起動します。
- Management CLI を起動します。
- 次の CLI コマンドを実行して、JDBC ドライバーモジュールをドライバーとして追加します。
/subsystem=datasources/jdbc-driver=DRIVER_NAME:add(driver-name=DRIVER_NAME,driver-module-name=MODULE_NAME,driver-xa-datasource-class-name=XA_DATASOURCE_CLASS_NAME)
例6.2 CLI コマンドの例
/subsystem=datasources/jdbc-driver=mysql:add(driver-name=mysql,driver-module-name=com.mysql,driver-xa-datasource-class-name=com.mysql.jdbc.jdbc2.optional.MysqlXADataSource)
JDBC ドライバーのインストールおよびコアモジュールとしての設定が完了し、アプリケーションのデータソースによる参照が可能な状態となりました。
6.2.3. JDBC ドライバーをダウンロードできる場所
表6.1 JDBC ドライバーをダウンロードできる場所
ベンダー | ダウンロード場所 |
---|---|
MySQL | |
PostgreSQL | |
Oracle | |
IBM | |
Sybase | |
Microsoft |
6.2.4. ベンダー固有クラスへのアクセス
このトピックでは、JDBC 固有クラスを使用するのに必要な手順について説明します。これは、アプリケーションが JDBC API の一部でないベンダー固有の機能を使用する必要がある場合に必要です。
警告
重要
重要
手順6.3 アプリケーションへの依存関係の追加
MANIFEST.MF
ファイルの設定- テキストエディターでアプリケーションの
META-INF/MANIFEST.MF
ファイルを開きます。 - JDBC モジュールの依存関係を追加し、ファイルを保存します。
依存関係: MODULE_NAME
例6.3 依存関係の例
依存関係: com.mysql
jboss-deployment-structure.xml
ファイルの作成アプリケーションのMETA-INF/
またはWEB-INF
フォルダーでjboss-deployment-structure.xml
という名前のファイルを作成します。例6.4 サンプル
jboss-deployment-structure.xml
ファイル<jboss-deployment-structure> <deployment> <dependencies> <module name="com.mysql" /> </dependencies> </deployment> </jboss-deployment-structure>
例6.5 ベンダー固有 API へのアクセス
import java.sql.Connection; import org.jboss.jca.adapters.jdbc.WrappedConnection; Connection c = ds.getConnection(); WrappedConnection wc = (WrappedConnection)c; com.mysql.jdbc.Connection mc = wc.getUnderlyingConnection();
6.3. 非 XA データソース
6.3.1. 管理インターフェースによる非 XA データソースの作成
ここでは、管理コンソールまたは管理 CLI のいずれかを使用して非 XA データソースを作成する手順について取り上げます。
前提条件
- JBoss Enterprise Application Platform 6 サーバーが稼働している必要があります。
注記
手順6.4 タスク
管理 CLI
- CLI ツールを起動し、サーバーに接続します。
- 以下のコマンドを実行して非 XA データソースを作成し、適切に変数を設定します。
data-source add --name=DATASOURCE_NAME --jndi-name=JNDI_NAME --driver-name=DRIVER_NAME --connection-url=CONNECTION_URL
- データソースを有効にします。
data-source enable --name=DATASOURCE_NAME
管理コンソール
- 管理コンソールへログインします。
管理コンソールの Datasources パネルに移動します。
スタンドアロンモード
コンソールの右上より Profile タブを選択します。ドメインモード
- コンソールの右上より Profiles タブを選択します。
- 左上のドロップダウンボックスより該当するプロファイルを選択します。
- コンソールの左側にある Subsystems メニューを展開します。
- コンソールの左側にあるメニューより Connector → Datasources と選択します。
図6.1 データソースパネル
新しいデータソースの作成
- Datasources パネル上部にある Add ボタンを選択します。
- Create Datasource ウィザードで新しいデータソースの属性を入力し、Next ボタンを押します。
- Create Datasource ウィザードで JDBC ドライバーの詳細を入力し、Next ボタンを押します。
- Create Datasource ウィザードで接続設定を入力し、Done ボタンを押します。
非 XA データソースがサーバーに追加されます。standalone.xml
または domain.xml
ファイル、および管理インターフェースで追加を確認することができます。
6.3.2. 管理 CLI でのデータソースの変更
- タスクの概要
- このトピックでは、管理コマンドラインインターフェースを使用して既存のデータソースを設定するために必要な手順について説明します。
手順6.5 タスク
- サーバーを起動します。
- CLI の起動
設定可能な属性の判断
次のコマンドを実行し、データソースの設定可能なオプションを判断します。/subsystem=datasources/data-source=DATASOURCE_NAME:read-resource
属性の設定
write-attribute
コマンドを使用してデータソース属性を設定します。/subsystem=datasources/data-source=DATASOURCE_NAME:write-attribute(name=ATTRIBUTE_NAME,value=ATTRIBUTE_VALUE)
サーバーの再ロード
サーバーを再ロードして変更を確認します。:reload
データソースが変更されます。 変更は管理コンソールと、standalone.xml
または domain.xml
ファイルで確認できます。データソースを削除するには、以下のコマンドを実行します。
data-source remove --name=DATASOURCE_NAME
6.3.3. 管理 CLI によるデータソースの削除
- タスクの概要
- このトピックでは、管理コマンドラインインターフェースを使用して JBoss Enterprise Application Platform 6 からデータソースを削除する手順について説明します。
手順6.6 タスク
- 次のコマンドを実行してデータソースを削除します。
data-source remove --jndi-name=JNDI_NAME
- 結果
- データソースがサーバーから削除されます。新しいデータソースを作成するには、「管理インターフェースによる非 XA データソースの作成」 を参照してください。
6.4. XA データソース
6.4.1. 管理 CLI を用いた XA データソースの作成
- タスクの概要
- 管理コマンドラインインターフェースを使用して JBoss Enterprise Application Platform 6 へ新しい XA データソースを追加する手順について説明します。
前提条件
- データソースのデータベースを作成する必要があります。
- JDBC ドライバーをインストールする必要があります。詳細は 「管理コンソールで JDBC ドライバーをインストール」 と 「コアモジュールとしての JDBC ドライバーのインストール」 を参照してください。
データソースリソースプロパティー
- XA データソースを追加する時に必要なプロパティーは 4 つあります。
- name
- このコマンドに対する XA データソースインスタンスを識別します。
- jndi-name
- XA データソースの JNDI 名を指定します。 java:/ または java:jboss/ で始まらなければなりません。
- driver-name
- XA データソースが使用すべきである JDBC ドライバーを定義します。ドライバーがデプロイされた方法により異なりますが、
.jar
ファイルの名前かモジュール名になります。 - xa-datasource-class
javax.sql.XADataSource
実装の完全修飾名。
xa-data-source
コマンドに使用できるリソースプロパティーの一覧を表示するには、次の管理 CLI コマンドラインを入力します。xa-data-source --help --properties
注記
手順6.7 タスク
- サーバーを起動します。
- 管理 CLI を起動します。
- 次のコマンドを実行して XA データソースを作成します。
xa-data-source add --name=XA_DATASOURCE_NAME --jndi-name=JNDI_NAME --driver-name=DRIVER_NAME --xa-datasource-class=XA_DATASOURCE_CLASS
例6.6 コマンドの例
data-source add --name=MSSQLDS --jndi-name=java:jboss/MSSQLDS --connection-url=jdbc:microsoft:sqlserver://localhost:1433;DatabaseName=MSSQLDB --driver-name=sqljdbc4.jar
XA データソースプロパティーの設定
サーバー名の設定
次のコマンドを実行し、ホストのサーバー名を設定します。/subsystem=datasources/xa-data-source=XA_DATASOURCE_NAME/xa-datasource-properties=ServerName:add(value=HOSTNAME)
データベース名の設定
次のコマンドを実行し、データベース名を設定します。/subsystem=datasources/xa-data-source=XA_DATASOURCE_NAME/xa-datasource-properties=DatabaseName:add(value=DATABASE_NAME)
- データソースを有効にします。
xa-data-source enable --name=NAME
- 結果
- XA データソースがサーバーに追加されます。更にデータソースを設定するには、「管理 CLI を用いた XA データソースの変更」 を参照してください。
6.4.2. 管理 CLI を用いた XA データソースの変更
- タスクの概要
- 管理コマンドラインインターフェースを使用して既存の XA データソースを変更するために必要な手順について説明します。
手順6.8 タスク
設定可能な属性の判断
次のコマンドを実行し、XA データソースの設定可能なオプションを判断します。/subsystem=datasources/xa-data-source=XA_DATASOURCE_NAME:read-resource
属性の設定
write-attribute
コマンドを使用して XA データソース属性を設定します。/subsystem=datasources/xa-data-source=DATASOURCE_NAME:write-attribute(name=ATTRIBUTE_NAME,value=ATTRIBUTE_VALUE)
サブリソースの設定
次のコマンドを実行して XA データソースサブリソースを設定します。/subsystem=datasources/xa-data-source=DATASOURCE_NAME/xa-datasource-properties=PROPERTY_NAME:add(value=PROPERTY_VALUE)
サーバーの再ロード
サーバーを再ロードして変更を確認します。:reload
- 結果
- XA データソースが変更されます。 変更は管理コンソールと、
standalone.xml
またはdomain.xml
ファイルで確認できます。
6.4.3. 管理 CLI を用いた XA データソースの削除
- タスクの概要
- 管理コマンドラインインターフェースを使用して JBoss Enterprise Application Platform 6 から XA データソースを削除する手順について説明します。
手順6.9 タスク
- 次のコマンドを実行して XA データソースを削除します。
xa-data-source remove --jndi-name=JNDI_NAME
- 結果
- サーバーより XA データソースが削除されます。新しい XA データソースを作成する場合は 「管理 CLI を用いた XA データソースの作成」 を参照してください。
6.4.4. XA 復元
6.4.4.1. XA 復元モジュールについて
com.arjuna.ats.jta.recovery.XAResourceRecovery
を拡張する必要があります。
6.4.4.2. XA 復元モジュールの設定
表6.2 一般的な設定属性
属性 | 説明 | |
---|---|---|
recovery-username |
リソースに接続して復元を行うために復元モジュールが使用する必要があるユーザー名。
| |
recovery-password |
リソースに接続して復元を行うために復元モジュールが使用する必要があるパスワード。
| |
recovery-security-domain |
リソースに接続して復元を行うために復元モジュールが使用する必要があるセキュリティードメイン。
| |
recovery-plugin-class-name |
カスタム復元モジュールを使用する必要がある場合は、この属性をモジュールの完全修飾クラス名に設定します。モジュールはクラス
com.arjuna.ats.jta.recovery.XAResourceRecovery を拡張する必要があります。
| |
recovery-plugin-properties |
プロパティーを設定する必要があるカスタム復元モジュールを使用する場合は、この属性をプロパティーに対するカンマ区切りの key=value ペアのリストに設定します。
|
ベンダー固有の設定情報
- Oracle
- Oracle データソースが不適切に設定された場合は、ログ出力に次のようなエラーが示されることがあります。
WARN [com.arjuna.ats.jta.logging.loggerI18N] [com.arjuna.ats.internal.jta.recovery.xarecovery1] Local XARecoveryModule.xaRecovery got XA exception javax.transaction.xa.XAException, XAException.XAER_RMERR
このエラーを解決するには、recovery-username
で設定された Oracle ユーザーが復元に必要なテーブルにアクセスできる必要があります。以下の SQL ステートメントは、Oracle バグ 5945463 用のパッチが適用された Oracle 11g または Oracle 10g R2 インスタンスに対する適切なステートメントです。GRANT SELECT ON sys.dba_pending_transactions TO recovery-username; GRANT SELECT ON sys.pending_trans$ TO recovery-username; GRANT SELECT ON sys.dba_2pc_pending TO recovery-username; GRANT EXECUTE ON sys.dbms_xa TO recovery-username;
11g よりも前の Oracle 11 バージョンを使用する場合は、最後のEXECUTE
ステートメントを以下のように変更します。GRANT EXECUTE ON sys.dbms_system TO recovery-username;
- PostgreSQL
- 準備された (つまり、XA) トランザクションを有効にする手順については、PostgreSQL ドキュメンテーションを参照してください。PostgreSQL の JDBC ドライバーのバージョン 8.4-701 では、
org.postgresql.xa.PGXAConnection
にバグがあり、特定の状況で復元が中断されます。このバグは新しいバージョンで修正されています。 - MySQL
- http://bugs.mysql.com/bug.php?id=12161 に基づき、XA トランザクション復元は一部の MySQL 5 バージョンでは動作しませんでした。この問題は MySQL 6.1 で修正されました。詳細については、バグの URL または MySQL ドキュメンテーションを参照してください。
- IBM DB2
- IBM DB2 では、キャッシュ後または障害発生後にアプリケーションサーバーが再起動されたときに実行する指定済み再同期ステージ中にのみメソッド
XAResource.recover
を呼び出すことが期待されます。これは、DB2 実装での設計に関する決定であり、本書の範囲外です。
6.5. データソースセキュリティー
6.5.1. データソースセキュリティーについて
- セキュリティードメイン: 「セキュリティードメインについて」
- パスワード vault: 「クリアテキストファイルでの機密性が高い文字列のセキュア化について」
例6.7 セキュリティードメインの例
<security> <security-domain>mySecurityDomain</security-domain> </security>
例6.8 パスワード vault の例
<security> <user-name>admin</user-name> <password>${VAULT::ds_ExampleDS::password::N2NhZDYzOTMtNWE0OS00ZGQ0LWE4MmEtMWNlMDMyNDdmNmI2TElORV9CUkVBS3ZhdWx0}</password> </security>
6.6. データソース設定
6.6.1. データソースのパラメーター
表6.3 非 XA および XA データソースに共通のデータソースパラメーター
パラメーター | 説明 |
---|---|
jndi-name | データソースに対する一意の JNDI 名 |
pool-name | データソースの管理プール名 |
enabled | データソースが有効かどうか |
use-java-context |
データソースをグローバルの JNDI にバインドするかどうか
|
spy |
JDBC 層で
spy 機能を有効にします。これで全 JDBC トラフィックをデータソースにロギングします。logging-category パラメーターは org.jboss.jdbc に設定する必要があります。
|
use-ccm | キャッシュ接続マネージャーを有効化 |
new-connection-sql | 接続プールに接続が追加された場合に実行する SQL ステートメント |
transaction-isolation |
以下のいずれかになります。
|
url-delimiter | 高可用性 (HA) のクラスターデータベース に関する connection-url にある URL の区切り文字 |
url-selector-strategy-class-name | org.jboss.jca.adapters.jdbc.URLSelectorStrategy インターフェースを実装するクラス |
security |
セキュリティー設定である子要素が含まれます。表6.8「セキュリティパラメーター」 を参照してください。
|
validation |
検証設定である子要素が含まれます。表6.9「検証パラメーター」 を参照してください。
|
timeout |
タイムアウト設定である子要素が含まれます。表6.10「タイムアウトパラメーター」 を参照してください。
|
statement |
ステートメント設定である子要素が含まれます。表6.11「ステートメントのパラメーター」 を参照してください。
|
表6.4 非 XA データソースのパラメーター
パラメーター | 説明 |
---|---|
jta | 非 XA データソースの JTA 統合を有効にします。XA データソースには適用されません。 |
connection-url | JDBC ドライバーの接続 URL |
driver-class | JDBC ドライバークラスの完全修飾名 |
connection-property | Driver.connect(url,props) メソッドに渡される任意の接続プロパティー。各 connection-property は、文字列名と値のペアを指定します。プロパティー名は名前、値は要素の内容に基づいています。
|
pool |
プーリング設定である子要素が含まれます。表6.6「非 XA および XA データソースに共通のプールパラメーター」 を参照してください。
|
表6.5 XA データソースのパラメーター
パラメーター | 説明 |
---|---|
xa-datasource-property |
実装クラス
XADataSource に割り当てるプロパティー。name=value で指定。 setName という形式で setter メソッドが存在する場合、プロパティーは setName(value) という形式の setter メソッドを呼び出すことで設定されます。
|
xa-datasource-class |
実装クラス
javax.sql.XADataSource の完全修飾名
|
driver |
JDBC ドライバーを含むクラスローダーモジュールへの一意参照。driverName#majorVersion.minorVersion. の形式にのみ対応しています。
|
xa-pool |
プーリング設定である子要素が含まれます。表6.6「非 XA および XA データソースに共通のプールパラメーター」 および 表6.7「XA プールパラメーター」 を参照してください。
|
recovery |
リカバリー設定である子要素が含まれます。表6.12「リカバリーパラメーター」 を参照してください。
|
表6.6 非 XA および XA データソースに共通のプールパラメーター
パラメーター | 説明 |
---|---|
min-pool-size | プールが保持する最小接続数 |
max-pool-size | プールが保持可能な最大接続数 |
prefill | 接続プールのプレフィルを試行するかどうか。要素が空の場合は true を示します。デフォルトは、false です。 |
use-strict-min | pool-size が厳密かどうか。デフォルトは false に設定されています。 |
flush-strategy |
エラーがある場合にプールをフラッシュするかどうか。有効値は次の通りです。
デフォルトは
FailingConnectionOnly です。
|
allow-multiple-users | 複数のユーザーが getConnection (user, password) メソッドを使いデータソースへアクセスするか、また内部プールタイプがこの動作に対応するかを指定します。 |
表6.7 XA プールパラメーター
パラメーター | 説明 |
---|---|
is-same-rm-override | javax.transaction.xa.XAResource.isSameRM(XAResource) クラスが true あるいは false のどちらを返すか |
interleaving | XA 接続ファクトリのインターリービングを有効にするかどうか |
no-tx-separate-pools | コンテキスト毎に sub-pool を作成するかどうか。これには Oracle のデータソースが必要ですが、このデータソースは JTA トランザクションの内部、外部に関わらず、XA 接続の利用ができなくなります。 |
pad-xid | Xid のパディングを行うかどうか |
wrap-xa-resource | org.jboss.tm.XAResourceWrapper インスタンスの XAResource をラップするかどうか
|
表6.8 セキュリティパラメーター
パラメーター | 説明 |
---|---|
user-name | 新規接続の作成に使うユーザー名 |
password | 新規接続の作成に使うパスワード |
security-domain | 認証処理を行う JAAS security-manager 名が入ります。この名前は、JAAS ログイン設定のapplication-policy/name 属性を相関します。 |
reauth-plugin | 物理接続の再認証に使う再認証プラグインを定義します。 |
表6.9 検証パラメーター
パラメーター | 説明 |
---|---|
valid-connection-checker | SQLException.isValidConnection(Connection e) 設定を渡し接続の検証を行う org.jboss.jca.adaptors.jdbc.ValidConnectionChecker インターフェースの実装。接続が破棄されると例外となります。このパラメーターがある場合、check-valid-connection-sql よりもこのパラメーターが優先されます。
|
check-valid-connection-sql | プール接続の妥当性を確認する SQL ステートメント。これは、管理接続をプールから取得し利用する場合に呼び出される場合があります。 |
validate-on-match |
接続ファクトリが、指定セットと管理接続がマッチするか確認しようとした場合に、接続レベルの検証を実行するかを指定します。
background validation とは相互排他的です。
|
background-validation |
接続が利用前の認証ではなく、バッググラウンドのスレッドで認証済みであることを指定します。
validate-on-match とは相互排他的です。
|
background-validation-minutes | バックグラウンド認証を実行する時間数 (分)。 |
use-fast-fail |
true の場合、接続が無効であれば1回目の試行で接続割り当てを失敗させます。デフォルトは
false です。
|
stale-connection-checker | org.jboss.jca.adapters.jdbc.StaleConnectionChecker のインスタンスで、Boolean isStaleConnection(SQLException e) メソッドを渡します。このメソッドが true を返す場合、例外は、SQLException のサブクラスである、org.jboss.jca.adapters.jdbc.StaleConnectionException でラップされます。
|
exception-sorter | org.jboss.jca.adapters.jdbc.ExceptionSorter のインスタンスで、ブール変数 isExceptionFatal(SQLException e) メソッドを渡します。このメソッドは、例外が connectionErrorOccurred メッセージとして、javax.resource.spi.ConnectionEventListener のインスタンスすべてにブロードキャストされるべきかを検証します。
|
表6.10 タイムアウトパラメーター
パラメーター | 説明 |
---|---|
blocking-timeout-millis | 接続待機中にブロックする最大時間数 (ミリ秒)。この時間を超過すると、例外が送出されます。これは、接続許可の待機中にブロックするだけで、新規接続の作成に長時間要している場合は例外を送出しません。デフォルトは 30000 (3分) です。 |
idle-timeout-minutes |
アイドル接続が切断されるまでの最大時間 (分)。実際の最大時間は、idleRemover のスキャン時間 (プールの最小
idle-timeout-minutes の半分) に左右されます。
|
set-tx-query-timeout |
トランザクションがタイムアウトされるまでの残存時間数をもとにクエリのタイムアウトを設定するかどうか。トランザクションが存在しない場合は設定済みのクエリタイムアウトのいずれかを利用します。デフォルトは
false です。
|
query-timeout | クエリのタイムアウト (秒)。デフォルトはタイムアウトなしです。 |
allocation-retry | 例外を送出する前に接続割り当ての再試行をする回数。デフォルトは 0 で、初回の失敗後に例外が送出されます。 |
allocation-retry-wait-millis |
接続割り当てまで待機する時間数 (ミリ秒)。デフォルトは 5000 で、5秒です。
|
xa-resource-timeout |
ゼロ以外の場合、この値は
XAResource.setTransactionTimeout メソッドに渡されます。
|
表6.11 ステートメントのパラメーター
パラメーター | 説明 |
---|---|
track-statements |
接続がプールに返され、ステートメントが準備済みステートメントのキャッシュに返された時点で、ステートメントが閉じられていることを確認するかどうか。false の場合、ステートメントはトラッキングされません。
有効な値
|
prepared-statement-cache-size | Least Recently User (LRU) キャッシュ内の接続毎の準備済みステートメント数。 |
share-prepared-statements |
ステートメントを閉じずに同じステートメントを2回リクエストする場合に、基盤となる準備済みステートメントは同じものを使うのかどうか。デフォルトは
false です。
|
表6.12 リカバリーパラメーター
パラメーター | 説明 |
---|---|
recover-credential | リカバリーに利用するユーザー名とパスワードのペアあるいは、セキュリティドメイン。 |
recover-plugin |
リカバリーに利用する
org.jboss.jca.core.spi.recoveryRecoveryPlugin の実装クラス。
|
6.6.2. データソース接続 URL
表6.13
データソース | 接続 URL |
---|---|
PostgreSQL | jdbc:postgresql://SERVER_NAME:PORT/DATABASE_NAME |
MySQL | jdbc:mysql://SERVER_NAME:PORT/DATABASE_NAME |
Oracle | jdbc:oracle:thin:@ORACLE_HOST:PORT:ORACLE_SID |
IBM DB2 | jdbc:db2://SERVER_NAME:PORT/DATABASE_NAME |
Microsoft SQLServer | jdbc:microsoft:sqlserver://SERVER_NAME:PORT;DatabaseName=DATABASE_NAME |
6.6.3. データソースの拡張
表6.14 データソースの拡張
データソースの拡張 | 設定パラメーター | 詳細 |
---|---|---|
org.jboss.jca.adapters.jdbc.spi.ExceptionSorter | <exception-sorter> | SQLException が発生した接続にとってこの例外は致命的かどうかを確認します。 |
org.jboss.jca.adapters.jdbc.spi.StaleConnection | <stale-connection-checker> | org.jboss.jca.adapters.jdbc.StaleConnectionException の古くなった SQLException をラップします。 |
org.jboss.jca.adapters.jdbc.spi.ValidConnection | <valid-connection-checker> | 接続がアプリケーション利用にも有効かどうかを確認します。 |
拡張の実装
- 汎用
- org.jboss.jca.adapters.jdbc.extensions.novendor.NullExceptionSorter
- org.jboss.jca.adapters.jdbc.extensions.novendor.NullStaleConnectionChecker
- org.jboss.jca.adapters.jdbc.extensions.novendor.NullValidConnectionChecker
- org.jboss.jca.adapters.jdbc.extensions.novendor.JDBC4ValidConnectionChecker
- PostgreSQL
- org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLExceptionSorter
- org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLValidConnectionChecker
- MySQL
- org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLExceptionSorter
- org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLReplicationValidConnectionChecker
- org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLValidConnectionChecker
- IBM DB2
- org.jboss.jca.adapters.jdbc.extensions.db2.DB2ExceptionSorter
- org.jboss.jca.adapters.jdbc.extensions.db2.DB2StaleConnectionChecker
- org.jboss.jca.adapters.jdbc.extensions.db2.DB2ValidConnectionChecker
- Sybase
- org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseExceptionSorter
- org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseValidConnectionChecker
- Microsoft SQLServer
- org.jboss.jca.adapters.jdbc.extensions.mssql.MSSQLValidConnectionChecker
- Oracle
- org.jboss.jca.adapters.jdbc.extensions.oracle.OracleExceptionSorter
- org.jboss.jca.adapters.jdbc.extensions.oracle.OracleExceptionSorter
- org.jboss.jca.adapters.jdbc.extensions.oracle.OracleValidConnectionChecker
6.7. データソース例
6.7.1. PostgreSQL のデータソースの例
例6.9
<datasources> <datasource jndi-name="java:jboss/PostgresDS" pool-name="PostgresDS"> <connection-url>jdbc:postgresql://localhost:5432/postgresdb</connection-url> <driver>postgresql</driver> <security> <user-name>admin</user-name> <password>admin</password> </security> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLValidConnectionChecker"></valid-connection-checker> <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLExceptionSorter"></exception-sorter> </validation> </datasource> <drivers> <driver name="postgresql" module="org.postgresql"> <xa-datasource-class>org.postgresql.xa.PGXADataSource</xa-datasource-class> </driver> </drivers> </datasources>
module.xml
ファイルの例は次の通りです。
<module xmlns="urn:jboss:module:1.1" name="org.postgresql"> <resources> <resource-root path="postgresql-9.1-902.jdbc4.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
6.7.2. PostgreSQL XA のデータソースの例
例6.10
<datasources> <xa-datasource jndi-name="java:jboss/PostgresXADS" pool-name="PostgresXADS"> <driver>postgresql</driver> <xa-datasource-property name="ServerName">localhost</xa-datasource-property> <xa-datasource-property name="PortNumber">5432</xa-datasource-property> <xa-datasource-property name="DatabaseName">postgresdb</xa-datasource-property> <xa-datasource-property name="User">admin</xa-datasource-property> <xa-datasource-property name="Password">admin</xa-datasource-property> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLValidConnectionChecker"> </valid-connection-checker> <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLExceptionSorter"> </exception-sorter> </validation> </xa-datasource> <drivers> <driver name="postgresql" module="org.postgresql"> <xa-datasource-class>org.postgresql.xa.PGXADataSource</xa-datasource-class> </driver> </drivers> </datasources>
module.xml
ファイルの例は次の通りです。
<module xmlns="urn:jboss:module:1.1" name="org.postgresql"> <resources> <resource-root path="postgresql-9.1-902.jdbc4.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
6.7.3. MySQL のデータソースの例
例6.11
<datasources> <datasource jndi-name="java:jboss/MySqlDS" pool-name="MySqlDS"> <connection-url>jdbc:mysql://mysql-localhost:3306/jbossdb</connection-url> <driver>mysql</driver> <security> <user-name>admin</user-name> <password>admin</password> </security> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLValidConnectionChecker"></valid-connection-checker> <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLExceptionSorter"></exception-sorter> </validation> </datasource> <drivers> <driver name="mysql" module="com.mysql"> <xa-datasource-class>com.mysql.jdbc.jdbc2.optional.MysqlXADataSource</xa-datasource-class> </driver> </drivers> </datasources>
module.xml
ファイルの例は次の通りです。
<module xmlns="urn:jboss:module:1.1" name="com.mysql"> <resources> <resource-root path="mysql-connector-java-5.0.8-bin.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
6.7.4. MySQL XA のデータソースの例
例6.12
<datasources> <xa-datasource jndi-name="java:jboss/MysqlXADS" pool-name="MysqlXADS"> <driver>mysql</driver> <xa-datasource-property name="ServerName">localhost</xa-datasource-property> <xa-datasource-property name="DatabaseName">mysqldb</xa-datasource-property> <xa-datasource-property name="User">admin</xa-datasource-property> <xa-datasource-property name="Password">admin</xa-datasource-property> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLValidConnectionChecker"></valid-connection-checker> <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLExceptionSorter"></exception-sorter> </validation> </xa-datasource> <drivers> <driver name="mysql" module="com.mysql"> <xa-datasource-class>com.mysql.jdbc.jdbc2.optional.MysqlXADataSource</xa-datasource-class> </driver> </drivers> </datasources>
module.xml
ファイルの例は次の通りです。
<module xmlns="urn:jboss:module:1.1" name="com.mysql"> <resources> <resource-root path="mysql-connector-java-5.0.8-bin.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
6.7.5. Oracle のデータソースの例
注記
例6.13
<datasources> <datasource jndi-name="java:/OracleDS" pool-name="OracleDS"> <connection-url>jdbc:oracle:thin:@localhost:1521:XE</connection-url> <driver>oracle</driver> <security> <user-name>admin</user-name> <password>admin</password> </security> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleValidConnectionChecker"></valid-connection-checker> <stale-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleStaleConnectionChecker"></stale-connection-checker> <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleExceptionSorter"></exception-sorter> </validation> </datasource> <drivers> <driver name="oracle" module="com.oracle"> <xa-datasource-class>oracle.jdbc.xa.client.OracleXADataSource</xa-datasource-class> </driver> </drivers> </datasources>
module.xml
ファイルの例は次のとおりです。
<module xmlns="urn:jboss:module:1.1" name="com.oracle"> <resources> <resource-root path="ojdbc6.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
6.7.6. Oracle XA のデータソースの例
例6.14
<datasources> <xa-datasource jndi-name="java:/XAOracleDS" pool-name="XAOracleDS"> <driver>oracle</driver> <xa-datasource-property name="URL">jdbc:oracle:oci8:@tc</xa-datasource-property> <xa-datasource-property name="User">admin</xa-datasource-property> <xa-datasource-property name="Password">admin</xa-datasource-property> <xa-pool> <is-same-rm-override>false</is-same-rm-override> <no-tx-separate-pools /> </xa-pool> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleValidConnectionChecker"></valid-connection-checker> <stale-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleStaleConnectionChecker"></stale-connection-checker> <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.oracle.OracleExceptionSorter"></exception-sorter> </validation> </xa-datasource> <drivers> <driver name="oracle" module="com.oracle"> <xa-datasource-class>oracle.jdbc.xa.client.OracleXADataSource</xa-datasource-class> </driver> </drivers> </datasources>
module.xml
ファイルの例は次の通りです。
<module xmlns="urn:jboss:module:1.1" name="com.oracle"> <resources> <resource-root path="ojdbc6.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
6.7.7. Microsoft SQLServer のデータソースの例
例6.15
<datasources> <datasource jndi-name="java:/MSSQLDS" pool-name="MSSQLDS"> <connection-url>jdbc:microsoft:sqlserver://localhost:1433;DatabaseName=MyDatabase</connection-url> <driver>sqlserver</driver> <security> <user-name>admin</user-name> <password>admin</password> </security> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.mssql.MSSQLValidConnectionChecker"></valid-connection-checker> </validation> </datasource> <drivers> <driver name="sqlserver" module="com.microsoft"> <xa-datasource-class>com.microsoft.sqlserver.jdbc.SQLServerXADataSource</xa-datasource-class> </driver> </datasources>
module.xml
ファイルの例は次の通りです。
<module xmlns="urn:jboss:module:1.1" name="com.microsoft"> <resources> <resource-root path="sqljdbc4.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
6.7.8. Microsoft SQLServer XA のデータソースの例
例6.16
<datasources> <xa-datasource jndi-name="java:/MSSQLXADS" pool-name="MSSQLXADS"> <driver>sqlserver</driver> <xa-datasource-property name="ServerName">localhost</xa-datasource-property> <xa-datasource-property name="DatabaseName">mssqldb</xa-datasource-property> <xa-datasource-property name="SelectMethod">cursor</xa-datasource-property> <xa-datasource-property name="User">admin</xa-datasource-property> <xa-datasource-property name="Password">admin</xa-datasource-property> <xa-pool> <is-same-rm-override>false</is-same-rm-override> </xa-pool> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.mssql.MSSQLValidConnectionChecker"></valid-connection-checker> </validation> </xa-datasource> <drivers> <driver name="sqlserver" module="com.microsoft"> <xa-datasource-class>com.microsoft.sqlserver.jdbc.SQLServerXADataSource</xa-datasource-class> </driver> </drivers> </datasources>
module.xml
ファイルの例は次の通りです。
<module xmlns="urn:jboss:module:1.1" name="com.microsoft"> <resources> <resource-root path="sqljdbc4.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
6.7.9. IBM DB2 のデータソースの例
例6.17
<datasources> <datasource jndi-name="java:/DB2DS" pool-name="DB2DS"> <connection-url>jdbc:db2:ibmdb2db</connection-url> <driver>ibmdb2</driver> <pool> <min-pool-size>0</min-pool-size> <max-pool-size>50</max-pool-size> </pool> <security> <user-name>admin</user-name> <password>admin</password> </security> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2ValidConnectionChecker"></valid-connection-checker> <stale-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2StaleConnectionChecker"></stale-connection-checker> <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2ExceptionSorter"></exception-sorter> </validation> </datasource> <drivers> <driver name="ibmdb2" module="com.ibm"> <xa-datasource-class>com.ibm.db2.jdbc.DB2XADataSource</xa-datasource-class> </driver> </drivers> </datasources>
module.xml
ファイルの例は次の通りです。
<module xmlns="urn:jboss:module:1.1" name="com.ibm"> <resources> <resource-root path="db2jcc.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
6.7.10. IBM DB2 XA のデータソースの例
例6.18
<datasources> <xa-datasource jndi-name="java:/DB2XADS" pool-name="DB2XADS"> <driver>ibmdb2</driver> <xa-datasource-property name="DatabaseName">ibmdb2db</xa-datasource-property> <xa-datasource-property name="User">admin</xa-datasource-property> <xa-datasource-property name="Password">admin</xa-datasource-property> <xa-pool> <is-same-rm-override>false</is-same-rm-override> </xa-pool> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2ValidConnectionChecker"></valid-connection-checker> <stale-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2StaleConnectionChecker"></stale-connection-checker> <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.db2.DB2ExceptionSorter"></exception-sorter> </validation> </xa-datasource> <drivers> <driver name="ibmdb2" module="com.ibm"> <xa-datasource-class>com.ibm.db2.jdbc.DB2XADataSource</xa-datasource-class> </driver> </drivers> </datasources>
module.xml
ファイルの例は次の通りです。
<module xmlns="urn:jboss:module:1.1" name="com.ibm"> <resources> <resource-root path="db2jcc.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
6.7.11. Sybase データソースの例
例6.19
<datasources xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.jboss.org/ironjacamar/schema/datasources_1_0.xsd"> <datasource jndi-name="java:jboss/SybaseDB" pool-name="SybaseDB" enabled="true"> <connection-url>jdbc:sybase:Tds:host.at.some.domain:5000/db_name?JCONNECT_VERSION=6</connection-url> <security> <user-name>user</user-name> <password>pwd</password> </security> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseValidConnectionChecker"></valid-connection-checker> <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseExceptionSorter"></exception-sorter> </validation> </datasource> <drivers> <driver name="sybase" module="com.sybase"> <datasource-class>com.sybase.jdbc2.jdbc.SybDataSource</datasource-class> <xa-datasource-class>com.sybase.jdbc3.jdbc.SybXADataSource</xa-datasource-class> </driver> </drivers> </datasources>
6.7.12. Sybase XA データソースの例
例6.20
<datasources xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.jboss.org/ironjacamar/schema/datasources_1_0.xsd"> <xa-datasource jndi-name="java:jboss/SybaseXADS" pool-name="SybaseXADS" enabled="true"> <xa-datasource-property name="NetworkProtocol">Tds</xa-datasource-property> <xa-datasource-property name="ServerName">myserver</xa-datasource-property> <xa-datasource-property name="PortNumber">4100</xa-datasource-property> <xa-datasource-property name="DatabaseName">mydatabase</xa-datasource-property> <xa-datasource-property name="User">user</xa-datasource-property> <xa-datasource-property name="Password">password</xa-datasource-property> <validation> <valid-connection-checker class-name="org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseValidConnectionChecker"></valid-connection-checker> <exception-sorter class-name="org.jboss.jca.adapters.jdbc.extensions.sybase.SybaseExceptionSorter"></exception-sorter> </validation> </xa-datasource> <drivers> <driver name="sybase" module="com.sybase"> <datasource-class>com.sybase.jdbc2.jdbc.SybDataSource</datasource-class> <xa-datasource-class>com.sybase.jdbc3.jdbc.SybXADataSource</xa-datasource-class> </driver> </drivers> </datasources>
第7章 モジュールの設定
7.1. はじめに
7.1.1. モジュール
- 静的モジュール
- 静的モジュールは、アプリケーションサーバーの
EAP_HOME/modules/
ディレクトリに事前定義されます。各サブディレクトリは 1 つのモジュールを表し、1 つまたは複数の JAR ファイルと設定ファイル (module.xml
) が含まれます。モジュールの名前は、module.xml
ファイルで定義されます。アプリケーションサーバーで提供されるすべての API (Java EE API や JBoss Logging などの他の API を含む) は、静的モジュールとして提供されます。カスタム静的モジュールの作成は、同じサードパーティーライブラリを使用する同じサーバー上に多くのアプリケーションがデプロイされる場合に役立ちます。これらのライブラリを各アプリケーションとバンドルする代わりに、JBoss 管理者はこれらのライブラリが含まれるモジュールを作成およびインストールできます。アプリケーションは、カスタム静的モジュールで明示的な依存関係を宣言できます。 - 動的モジュール
- 動的モジュールは、各 JAR または WAR デプロイメント (または、EAR 内のサブデプロイメント) に対してアプリケーションサーバーによって作成およびロードされます。動的モジュールの名前は、デプロイされたアーカイブの名前から派生されます。デプロイメントはモジュールとしてロードされるため、依存関係を設定でき、他のデプロイメントが依存関係として使用できます。
7.1.2. グローバルモジュール
7.1.3. モジュールの依存関係
例7.1 モジュールの依存関係
- モジュール A がモジュール C への明示的な依存関係を宣言する場合。
- または、モジュール B がモジュール B の依存関係をモジュール C でエクスポートする場合。
7.1.4. サブデプロイメントクラスローダーの分離
7.2. すべてのデプロイメントに対してサブデプロイメントモジュール隔離を無効化
警告
サーバーを停止する
JBoss Enterprise Application Platform サーバーを停止します。サーバー設定ファイルを開く
サーバー設定ファイルをテキストエディターで開きます。このファイルは、管理ドメインまたはスタンドアロンサーバーによって異なります。また、デフォルト以外の場所とファイル名が使用されることがあります。デフォルトの設定ファイルは、domain/configuration/domain.xml
(管理ドメインの場合) とstandalone/configuration/standalone.xml
(スタンドアロンサーバー) です。EE サブシステム設定を特定する
設定ファイルの EE サブシステム設定要素を特定します。設定ファイルの<profile>
要素には、複数のサブシステム要素が含まれます。EE サブシステム要素にはurn:jboss:domain:ee:1.0
のネームスペースがあります。<profile> ... <subsystem xmlns="urn:jboss:domain:ee:1.0" /> ...
デフォルト設定は単一の自己終了タグを持ちますが、カスタム設定は、以下のような個別の開始タグと終了タグ (タグ間に別の要素が含まれることがあります) を持つことがあります。<subsystem xmlns="urn:jboss:domain:ee:1.0" ></subsystem>
自己終了タグを置き換える (必要な場合)
EE サブシステム要素が単一の自己終了タグである場合は、以下のように適切な開始タグと終了タグで置き換えます。<subsystem xmlns="urn:jboss:domain:ee:1.0" ></subsystem>
ear-subdeployments-isolated 要素を追加する
以下のように、ear-subdeployments-isolated
要素を EE サブシステム要素の子として追加し、false
の内容を追加します。<subsystem xmlns="urn:jboss:domain:ee:1.0" ><ear-subdeployments-isolated>false</ear-subdeployments-isolated></subsystem>
サーバーを起動する
JBoss Enterprise Application Platform サーバーを再起動し、新しい設定で実行します。
サーバーが、すべてのデプロイメントに対して無効化されたサブデプロイメントモジュール隔離で実行されます。
7.3. すべてのデプロイメントへのモジュールの追加
前提条件
- グローバルモジュールとして設定するモジュールの名前を覚えておく必要があります。JBoss Enterprise Application Platform 6 に含まれる静的モジュールのリストは 「含まれるモジュール」 を参照してください。モジュールが他のデプロイメントにある場合は 「動的モジュールの名前付け」 を参照してモジュール名を判断してください。
手順7.1 グローバルモジュールのリストへモジュールを追加する
- 管理コンソールへログインします。「管理コンソールへログイン」
- EE Subsystem パネルへ移動します。
図7.1 EE Subsystem パネル
- Global Modules にある Add ボタンをクリックすると、Create Module ダイアログが表示されます。
- モジュールの名前と任意でモジュールスロットを入力します。
- Save ボタンをクリックして新しいグローバルモジュールを追加するか、 Cancel リンクをクリックしてキャンセルします。
- Save ボタンをクリックすると、ダイアログが閉じられ指定のモジュールがグローバルモジュールのリストに追加されます。
- Cancel をクリックするとダイアログが閉じられ、何も変更されません。
グローバルモジュールのリストに追加されたモジュールは各デプロイメントへの依存関係に追加されます。
7.4. 参考資料
7.4.1. 含まれるモジュール
asm.asm
ch.qos.cal10n
com.google.guava
com.h2database.h2
com.sun.jsf-impl
com.sun.jsf-impl
com.sun.xml.bind
com.sun.xml.messaging.saaj
gnu.getopt
javaee.api
javax.activation.api
javax.annotation.api
javax.api
javax.ejb.api
javax.el.api
javax.enterprise.api
javax.enterprise.deploy.api
javax.faces.api
javax.faces.api
javax.inject.api
javax.interceptor.api
javax.jms.api
javax.jws.api
javax.mail.api
javax.management.j2ee.api
javax.persistence.api
javax.resource.api
javax.rmi.api
javax.security.auth.message.api
javax.security.jacc.api
javax.servlet.api
javax.servlet.jsp.api
javax.servlet.jstl.api
javax.transaction.api
javax.validation.api
javax.ws.rs.api
javax.wsdl4j.api
javax.xml.bind.api
javax.xml.jaxp-provider
javax.xml.registry.api
javax.xml.rpc.api
javax.xml.soap.api
javax.xml.stream.api
javax.xml.ws.api
jline
net.sourceforge.cssparser
net.sourceforge.htmlunit
net.sourceforge.nekohtml
nu.xom
org.antlr
org.apache.ant
org.apache.commons.beanutils
org.apache.commons.cli
org.apache.commons.codec
org.apache.commons.collections
org.apache.commons.io
org.apache.commons.lang
org.apache.commons.logging
org.apache.commons.pool
org.apache.cxf
org.apache.httpcomponents
org.apache.james.mime4j
org.apache.log4j
org.apache.neethi
org.apache.santuario.xmlsec
org.apache.velocity
org.apache.ws.scout
org.apache.ws.security
org.apache.ws.xmlschema
org.apache.xalan
org.apache.xerces
org.apache.xml-resolver
org.codehaus.jackson.jackson-core-asl
org.codehaus.jackson.jackson-jaxrs
org.codehaus.jackson.jackson-mapper-asl
org.codehaus.jackson.jackson-xc
org.codehaus.woodstox
org.dom4j
org.hibernate
org.hibernate.envers
org.hibernate.infinispan
org.hibernate.validator
org.hornetq
org.hornetq.ra
org.infinispan
org.infinispan.cachestore.jdbc
org.infinispan.cachestore.remote
org.infinispan.client.hotrod
org.jacorb
org.javassist
org.jaxen
org.jboss.as.aggregate
org.jboss.as.appclient
org.jboss.as.cli
org.jboss.as.clustering.api
org.jboss.as.clustering.common
org.jboss.as.clustering.ejb3.infinispan
org.jboss.as.clustering.impl
org.jboss.as.clustering.infinispan
org.jboss.as.clustering.jgroups
org.jboss.as.clustering.service
org.jboss.as.clustering.singleton
org.jboss.as.clustering.web.infinispan
org.jboss.as.clustering.web.spi
org.jboss.as.cmp
org.jboss.as.connector
org.jboss.as.console
org.jboss.as.controller
org.jboss.as.controller-client
org.jboss.as.deployment-repository
org.jboss.as.deployment-scanner
org.jboss.as.domain-add-user
org.jboss.as.domain-http-error-context
org.jboss.as.domain-http-interface
org.jboss.as.domain-management
org.jboss.as.ee
org.jboss.as.ee.deployment
org.jboss.as.ejb3
org.jboss.as.embedded
org.jboss.as.host-controller
org.jboss.as.jacorb
org.jboss.as.jaxr
org.jboss.as.jaxrs
org.jboss.as.jdr
org.jboss.as.jmx
org.jboss.as.jpa
org.jboss.as.jpa.hibernate
org.jboss.as.jpa.hibernate
org.jboss.as.jpa.hibernate.infinispan
org.jboss.as.jpa.openjpa
org.jboss.as.jpa.spi
org.jboss.as.jpa.util
org.jboss.as.jsr77
org.jboss.as.logging
org.jboss.as.mail
org.jboss.as.management-client-content
org.jboss.as.messaging
org.jboss.as.modcluster
org.jboss.as.naming
org.jboss.as.network
org.jboss.as.osgi
org.jboss.as.platform-mbean
org.jboss.as.pojo
org.jboss.as.process-controller
org.jboss.as.protocol
org.jboss.as.remoting
org.jboss.as.sar
org.jboss.as.security
org.jboss.as.server
org.jboss.as.standalone
org.jboss.as.threads
org.jboss.as.transactions
org.jboss.as.web
org.jboss.as.webservices
org.jboss.as.webservices.server.integration
org.jboss.as.webservices.server.jaxrpc-integration
org.jboss.as.weld
org.jboss.as.xts
org.jboss.classfilewriter
org.jboss.com.sun.httpserver
org.jboss.common-core
org.jboss.dmr
org.jboss.ejb-client
org.jboss.ejb3
org.jboss.iiop-client
org.jboss.integration.ext-content
org.jboss.interceptor
org.jboss.interceptor.spi
org.jboss.invocation
org.jboss.ironjacamar.api
org.jboss.ironjacamar.impl
org.jboss.ironjacamar.jdbcadapters
org.jboss.jandex
org.jboss.jaxbintros
org.jboss.jboss-transaction-spi
org.jboss.jsfunit.core
org.jboss.jts
org.jboss.jts.integration
org.jboss.logging
org.jboss.logmanager
org.jboss.logmanager.log4j
org.jboss.marshalling
org.jboss.marshalling.river
org.jboss.metadata
org.jboss.modules
org.jboss.msc
org.jboss.netty
org.jboss.osgi.deployment
org.jboss.osgi.framework
org.jboss.osgi.resolver
org.jboss.osgi.spi
org.jboss.osgi.vfs
org.jboss.remoting3
org.jboss.resteasy.resteasy-atom-provider
org.jboss.resteasy.resteasy-cdi
org.jboss.resteasy.resteasy-jackson-provider
org.jboss.resteasy.resteasy-jaxb-provider
org.jboss.resteasy.resteasy-jaxrs
org.jboss.resteasy.resteasy-jsapi
org.jboss.resteasy.resteasy-multipart-provider
org.jboss.sasl
org.jboss.security.negotiation
org.jboss.security.xacml
org.jboss.shrinkwrap.core
org.jboss.staxmapper
org.jboss.stdio
org.jboss.threads
org.jboss.vfs
org.jboss.weld.api
org.jboss.weld.core
org.jboss.weld.spi
org.jboss.ws.api
org.jboss.ws.common
org.jboss.ws.cxf.jbossws-cxf-client
org.jboss.ws.cxf.jbossws-cxf-factories
org.jboss.ws.cxf.jbossws-cxf-server
org.jboss.ws.cxf.jbossws-cxf-transports-httpserver
org.jboss.ws.jaxws-client
org.jboss.ws.jaxws-jboss-httpserver-httpspi
org.jboss.ws.native.jbossws-native-core
org.jboss.ws.native.jbossws-native-factories
org.jboss.ws.native.jbossws-native-services
org.jboss.ws.saaj-impl
org.jboss.ws.spi
org.jboss.ws.tools.common
org.jboss.ws.tools.wsconsume
org.jboss.ws.tools.wsprovide
org.jboss.xb
org.jboss.xnio
org.jboss.xnio.nio
org.jboss.xts
org.jdom
org.jgroups
org.joda.time
org.junit
org.omg.api
org.osgi.core
org.picketbox
org.picketlink
org.python.jython.standalone
org.scannotation.scannotation
org.slf4j
org.slf4j.ext
org.slf4j.impl
org.slf4j.jcl-over-slf4j
org.w3c.css.sac
sun.jdk
7.4.2. 動的モジュールの名前付け
- WAR および JAR ファイルのデプロイメントは次の形式で名前が付けられます。
deployment.DEPLOYMENT_NAME
例えば、inventory.war
のモジュール名はdeployment.inventory.war
となり、store.jar
のモジュール名はdeployment.store.jar
となります。 - エンタープライズアーカイブ内のサブデプロイメントは次の形式で名前が付けられます。
deployment.EAR_NAME.SUBDEPLOYMENT_NAME
例えば、エンタープライズアーカイブaccounts.ear
内にあるreports.war
のサブデプロイメントのモジュール名はdeployment.accounting.ear.reports.war
になります。
第8章 アプリケーションデプロイメント
8.1. アプリケーションデプロイメントについて
管理
開発
8.2. 管理コンソールでのデプロイ
8.2.1. 管理コンソースでのアプリケーションデプロイメント管理
8.2.2. 管理コンソールを使いアプリケーションをデプロイ
手順8.1 タスク
管理コンソールの Manage Deployments パネルに移動します。
- コンソールの右上から Runtime タブを選択します。
- コンソールの左側のメニューから Deployments → Manage Deployments オプションを選択します。
アプリケーションのデプロイ
デプロイメントの方法は、スタンドアローンサーバーインスタンス、管理ドメインにデプロイするかにより違います。スタンドアローンサーバーインスタンスへデプロイ
Deployments の表で利用可能なアプリケーションデプロイメントとそのステータスが表示されます。図8.1 利用可能なデプロイメント
スタンドアローンサーバーインスタンスでアプリケーションを有効化
Deployments の表のEnable ボタンをクリックしアプリケーションデプロイメントを有効にします。確定
confirm ボタンをクリックし、サーバーインスタンスでアプリケーションを有効にすることを確定します。図8.2 スタンドアローンサーバーで利用可能なデプロイメント
管理ドメインへデプロイ
Deployment Content セクションには、 Content Repository の表が含まれており、利用可能なアプリケーションデプロイメントとそのステータスがすべて表示されます。図8.3 管理ドメインで利用可能なデプロイメント
管理ドメインのアプリケーションを有効化
Content Repository の表から Add to Groups ボタンをクリックします。サーバーグループの選択
アプリケーションを追加したいサーバーグループのボックスをそれぞれにチェックマークを付け、Save ボタンをおして継続します。図8.4 アプリケーションデプロイメントでのサーバーグループを選択
確定
Server Group Deployments タブをクリックし Server Groups の表を表示します。お使いのアプリケーションはさきほど選択したサーバーグループにデプロイされています。図8.5 サーバーグループにアプリケーションがデプロイされているか確認
該当のサーバーあるいはサーバーグループにアプリケーションがデプロイされます。
8.2.3. 管理コンソールを使いアプリケーションをアンデプロイ
手順8.2 タスク
管理コンソールの Manage Deployments パネルに移動します。
- コンソールの右上から Runtime タブを選択します。
- コンソールの左側のメニューから Deployments → Manage Deployments オプションを選択します。
アプリケーションのアンデプロイ
アンデプロイメントの方法は、スタンドアローンサーバーインスタンス、管理ドメインにデプロイするかにより違います。スタンドアローンサーバーインスタンスからアンデプロイ
Deployments の表で利用可能なアプリケーションデプロイメントとそのステータスが表示されます。図8.6 利用可能なデプロイメント
スタンドアローンサーバーインスタンスでアプリケーションを無効化
Deployments の表の Disable ボタンをクリックしアプリケーションデプロイメントを有効にします。アプリケーションの無効化を確定
confirm ボタンをクリックし、サーバーインスタンスでアプリケーションを無効にすることを確定します。図8.7 アプリケーションの無効化を確定
管理ドメインからアンデプロイ
Deployment Content セクションには、 Content Repository の表が含まれており、利用可能なアプリケーションデプロイメントとそのステータスがすべて表示されます。図8.8 管理ドメインで利用可能なデプロイメント
管理ドメインのアプリケーションを無効化
Server Group Deployments をクリックするとサーバーグループとそのグループにデプロイされたアプリケーションのステータスが表示されます。図8.9 サーバーグループのデプロイメント
サーバーグループの選択
Server Group の表からサーバー名をクリックしサーバーグループからアプリケーションをアンデプロイします。選択したサーバーからアプリケーションを無効化
disableボタンをクリックし選択したサーバーのアプリケーションを無効にします。アプリケーションの無効化を確定
confirm ボタンをクリックし、サーバーインスタンスでアプリケーションを無効にすることを確定します。図8.10 アプリケーションの無効化を確定
残りのサーバーグループで繰り返しアンデプロイする手順
他のサーバーグループに対しても随時、繰り返し設定を行います。アプリケーションステータスは Deployments の表でサーバーグループごとに確認されます。図8.11 サーバーグループからアプリケーションがアンデプロイされているか確認
該当のサーバーあるいはサーバーグループからアプリケーションがアンデプロイされます。
8.3. 管理 CLI でのデプロイ
8.3.1. 管理 CLI でのアプリケーションデプロイメントの管理
8.3.2. 管理 CLI を使用した管理対象ドメインでのアプリケーションのデプロイ
手順8.3 タスク
deploy
コマンドの実行管理 CLI で、アプリケーションデプロイメントへのパスとともにdeploy
コマンドを入力します。すべてのサーバーグループをデプロイするために--all-server-groups
パラメーターを含めます。[domain@localhost:9999 /]
deploy ~/path/to/test-application.war --all-server-groups
'test-application.war' deployed successfully.- または、
--server-groups
パラメーターを使用して、デプロイメントに固有なサーバーグループを定義します。[domain@localhost:9999 /]
deploy ~/path/to/test-application.war --server-groups server_group_1, server_group_2
'test-application.war' deployed successfully.
指定されたアプリケーションが、管理対象ドメインのサーバーグループにデプロイされます。
8.3.3. 管理 CLI を使用した管理対象ドメインでのアプリケーションのデプロイ解除
手順8.4 タスク
undeploy
コマンドの実行管理 CLI で、アプリケーションデプロイメントのファイル名とともにundeploy
コマンドを入力します。--all-relevant-server-groups
パラメーターを追加することにより、アプリケーションは最初にデプロイされたサーバーグループからデプロイ解除できます。[domain@localhost:9999 /]
undeploy
test-application.war--all-relevant-server-groups
Successfully undeployed test-application.war.
指定されたアプリケーションが、デプロイ解除されます。
8.3.4. 管理 CLI を使用したスタンドアロンサーバーでのアプリケーションのデプロイ
手順8.5 タスク
deploy
コマンドの実行管理 CLI で、アプリケーションデプロイメントへのパスとともに、deploy
コマンドを入力します。[standalone@localhost:9999 /]
deploy ~/path/to/test-application.war
'test-application.war' deployed successfully.
指定されたアプリケーションが、スタンドアロンサーバーにデプロイされます。
8.3.5. 管理 CLI を使用したスタンドアロンサーバーでのアプリケーションのデプロイ解除
手順8.6 タスク
undeploy
コマンドの実行管理 CLI で、アプリケーションデプロイメントのファイル名とともに、undeploy
コマンドを入力します。[standalone@localhost:9999 /]
undeploy test-application.war
Successfully undeployed test-application.war.
指定されたアプリケーションが、デプロイ解除されます。
8.4. デプロイメントスキャナーでのデプロイ
8.4.1. デプロイメントスキャナーでのアプリケーションデプロイメント管理
8.4.2. デプロイメントスキャナーを使用してスタンドアロンサーバーインスタンスにアプリケーションをデプロイ
このタスクは、デプロイメントスキャナーを使用してスタンドアロンサーバーインスタンスにアプリケーションをデプロイする方法を示します。「アプリケーションデプロイメントについて」トピックで示されているように、この方法は開発者の利便性のために保持され、本番稼働環境でのアプリケーション管理には管理コンソールと管理 CLI の方法が推奨されます。
手順8.7 タスク
デプロイメントフォルダーへのコンテンツのコピー
アプリケーションファイルを、EAP_HOME/standalone/deployments/
にあるデプロイメントフォルダーにコピーします。デプロイメントスキャンモード
アプリケーションデプロイメントは、デプロイメントスキャナーモードが自動か、手動かによって異なります。自動デプロイメント
デプロイメントスキャナーは、フォルダーのステータスの変更を検出し、「デプロイメントスキャナーマーカーファイルのリファレンス」トピックで定義されたようにマーカーファイルを作成します。手動デプロイメント
デプロイメントスキャナーでは、デプロイメントプロセスをトリガーするマーカーファイルが必要です。以下の例では、Unixtouch
コマンドを使用して新しい.dodeploy
ファイルを作成します。例8.1
touch
コマンドを使用したデプロイ[user@host bin]$
touch
$EAP_HOME/standalone/deployments/example.war.dodeploy
アプリケーションファイルがアプリケーションサーバーにデプロイされます。マーカーファイルがデプロイメントフォルダーで作成され、デプロイメントの成功を示します。アプリケーションは、管理コンソールで、Enabled
と示されます。
例8.2 デプロイメント後のデプロイメントフォルダーコンテンツ
example.war example.war.deployed
8.4.3. デプロイメントスキャナーを使用してスタンドアロンサーバーインスタンスにアプリケーションをデプロイ解除
このタスクは、デプロイメントスキャナーを使用してデプロイされたスタンドアロンサーバーインスタンスからアプリケーションをデプロイ解除する方法を示します。「アプリケーションデプロイメントについて」トピックで示されているように、この方法は開発者の利便性のために保持され、本番稼働環境でのアプリケーション管理には管理コンソールと管理 CLI の方法が推奨されます。
注記
手順8.8 タスク
アプリケーションの再デプロイ
デプロイメントフォルダーからアプリケーションを削除するか、デプロイメントステータスのみを変更するかに応じて、アプリケーションをデプロイ解除するには 2 つの方法があります。マーカーファイルの削除によるデプロイ解除
デプロイされたアプリケーションのexample.war.deployed
マーカーファイルを削除して、ランタイムからのアプリケーションのデプロイ解除を開始するためにデプロイメントスキャナーをトリガーします。- 結果
- デプロイメントスキャナーは、アプリケーションをデプロイ解除し、
example.war.undeployed
マーカーファイルを作成します。アプリケーションは、デプロイメントフォルダーに維持されます。
アプリケーションの削除によるデプロイ解除
デプロイメントディレクトリーからアプリケーションを削除して、ランタイムからのアプリケーションのデプロイ解除を開始するためにデプロイメントスキャナーをトリガーします。- 結果
- デプロイメントスキャナーは、アプリケーションをデプロイ解除し、
filename.filetype.undeployed
マーカーファイルを作成します。アプリケーションは、デプロイメントフォルダーにありません。
アプリケーションファイルは、アプリケーションサーバーからデプロイ解除され、管理コンソールの Deployments 画面に表示されません。
8.4.4. デプロイメントスキャナーを使用してスタンドアロンサーバーインスタンスにアプリケーションを再デプロイ
このタスクは、デプロイメントスキャナーを使用してデプロイされたスタンドアロンサーバーインスタンスにアプリケーションを再デプロイする方法を示します。「アプリケーションデプロイメントについて」トピックで示されているように、この方法は開発者の利便性のために保持され、本番稼働環境でのアプリケーション管理には管理コンソールと管理 CLI の方法が推奨されます。
手順8.9 タスク
アプリケーションの再デプロイ
デプロイメントスキャナーでデプロイされたアプリケーションを再デプロイするには、3 つの方法があります。これらの方法はデプロイメントサイクルを開始するためにデプロイメントスキャナーをトリガーし、個々の設定に応じて選択できます。マーカーファイルの変更による再デプロイ
マーカーファイルのアクセスと変更タイムスタンプを変更して、デプロイメントスキャナーの再デプロイメントをトリガーします。次の Linux の例では、touch
コマンドが使用されます。例8.3
touch
コマンドを使用した再デプロイ[user@host bin]$
touch
$EAP_HOME/standalone/deployments/example.war.dodeploy結果デプロイメントスキャナーは、マーカーファイルの変更を検出し、アプリケーションを再デプロイします。新しい
.deployed
ファイルマーカーは以前のものを置き換えます。新しい
.dedeploy
マーカーファイルの作成による再デプロイ新しい.dodeploy
マーカーファイルを作成することにより、デプロイメントスキャナー再デプロイメントをトリガーします。「デプロイメントスキャナーを使用してスタンドアロンサーバーインスタンスにアプリケーションをデプロイ」に記載された手動デプロイメント手順を参照してください。マーカーファイルの削除による再デプロイ
「デプロイメントスキャナーマーカーファイルのリファレンス」で説明されているように、デプロイされたアプリケーションの.deployed
マーカーファイルを削除すると、デプロイメント解除がトリガーされ、.undeployed
マーカーが作成されます。デプロイメント解除マーカーを削除すると、デプロイメントサイクルが再びトリガーされます。詳細については、「デプロイメントスキャナーを使用してスタンドアロンサーバーインスタンスにアプリケーションをデプロイ解除」を参照してください。
アプリケーションファイルが再デプロイされます。
8.4.5. デプロイメントスキャナーマーカーファイルのリファレンス
マーカーファイルは、デプロイメントスキャナーサブシステムの一部です。これらのファイルは、スタンドアロンサーバーインスタンスのデプロイメントディレクリー内にあるアプリケーションの状態をマークします。マーカーファイルは、アプリケーションと同じ名前を持ち、ファイル接尾辞はアプリケーションのデプロイメントの状態を示します。以下の表に、各マーカーファイルのタイプおよび応答の定義を示します。
例8.4 マーカーファイル例
testapplication.war
という名前のアプリケーションの正常にデプロイされたインスタンスのマーカーファイルを示します。
testapplication.war.deployed
表8.1 マーカーファイルタイプ定義
ファイル名接尾辞 | 生成元 | 説明 |
---|---|---|
.dodeploy | ユーザー生成 | コンテンツをランタイムにデプロイまたは再デプロイする必要があることを示します。 |
.skipdeploy | ユーザー生成 | アプリケーションの自動デプロイを無効にします。展開されたコンテンツの自動デプロイメントを一時的にブロックする方法として役に立ち、不完全なコンテンツ編集がライブでプッシュされることを防ぎます。スキャナーは zip 形式のコンテンツに対する処理中の変更を検出し、完了するまで待機しますが、zip 形式のコンテンツとともに使用できます。 |
.isdeploying | システム生成 | デプロイメントの開始を示します。デプロイメントプロセスが完了すると、マーカーファイルが削除されます。 |
.deployed | システム生成 | コンテンツがデプロイされたことを示します。このファイルが削除された場合、コンテンツはアンデプロイされます。 |
.failed | システム生成 | デプロイメントの失敗を示します。マーカーファイルには、失敗の原因に関する情報が含まれます。マーカーファイルが削除された場合、コンテンツは自動デプロイメントで再び可視状態になります。 |
.isundeploying | システム生成 | .deployed ファイルの削除に対する応答を示します。コンテンツはアンデプロイされ、完了時にマーカーは自動的に削除されます。 |
.undeployed | システム生成 | コンテンツがアンデプロイされたことを示します。マーカーファイルを削除しても、コンテンツの再デプロイメントには影響ありません。 |
.pending | システム生成 | デプロイメントの指示が、検出された問題の解決を待っているサーバーに送信されます。このマーカーは、グローバルデプロイメントロードブロックとして機能します。この状態が存在する場合、スキャナーは他のコンテンツをデプロイまたはデプロイ解除するようサーバーに指示しません。 |
8.4.6. デプロイメントスキャナー属性のリファレンス
write-attribute
操作を使用して設定できます。設定オプションの詳細については、トピック 「管理 CLI でのデプロイメントスキャナーの設定」 を参照してください。
表8.2 デプロイメントスキャナー属性
名前 | 説明 | タイプ | デフォルト値 |
---|---|---|---|
auto-deploy-exploded | .dodeploy マーカーファイルなしで、展開されたコンテンツの自動デプロイメントを許可します。基本的な開発シナリオに対してのみ推奨され、開発者またはオペレーティングシステムによる変更中に、展開されたアプリケーションデプロイメントが行われないようにします。 | Boolean | False |
auto-deploy-xml | .dodeploy マーカーファイルなしでの XML コンテンツの自動デプロイメントを許可します。 | Boolean | True |
auto-deploy-zipped | .dodeploy マーカーファイルなしでの zip 形式のコンテンツの自動デプロイメントを許可します。 | Boolean | True |
deployment-timeout | デプロイメントスキャナーでデプロイメントをキャンセルするまでのデプロイメント試行許可時間 (秒単位)。 | Long | 60 |
path | スキャンする実際のファイルシステムパスを定義します。relative-to 属性が指定された場合は、path 値が、そのディレクトリーまたはパスに対する相対追加分として機能します。 | String | Deployments |
relative-to | サーバー設定 XML ファイルの paths セクションで定義されたファイルシステムパスの参照。 | String | jboss.server.base.dir |
scan-enabled | scan-interval により起動時にアプリケーションの自動スキャンを許可します。 | Boolean | True |
scan-interval | リポジトリーのスキャン間の時間 (ミリ秒単位)。値が 1 未満の場合は、スキャナーが起動時にのみ動作します。 | Int | 5000 |
8.4.7. デプロイメントスキャナーの設定
8.4.8. 管理 CLI でのデプロイメントスキャナーの設定
前提条件
デプロイメントスキャナーを設定するには複数の方法がありますが、管理 CLI を使用すると、バッチスクリプトを使用して、またはリアルタイムで属性を公開および変更できます。read-attribute
および write-attribute
グローバルコマンドライン操作を使用することにより、デプロイメントスキャナーの動作を変更できます。デプロイメントスキャナー属性に関する詳細は、トピック「デプロイメントスキャナー属性のリファレンス」で定義されています。
standalone.xml
で参照できます。
<subsystem xmlns="urn:jboss:domain:deployment-scanner:1.1"> <deployment-scanner path="deployments" relative-to="jboss.server.base.dir" scan-enabled="true" scan-interval="5000" auto-deploy-exploded="true"/> </subsystem>
手順8.10 タスク
設定するデプロイメントスキャナー属性を決定
管理 CLI を使用してデプロイメントスキャナーを設定するには、最初に正しい属性名を公開する必要があります。これは、ルートノードでread-resources
操作を使用するか、またはcd
コマンドを使用してサブシステム子ノードに移動することにより、行えます。また、このレベルでls
コマンドを使用して属性を表示することもできます。read-resource
操作を使用して、デプロイメントスキャナー属性を公開します。read-resource
操作を使用して、デフォルトのデプロイメントスキャナーリソースで定義された属性を公開します。[standalone@localhost:9999 /]/subsystem=deployment-scanner/scanner=default:read-resource { "outcome" => "success", "result" => { "auto-deploy-exploded" => true, "auto-deploy-xml" => true, "auto-deploy-zipped" => true, "deployment-timeout" => 60, "path" => "deployments", "relative-to" => "jboss.server.base.dir", "scan-enabled" => true, "scan-interval" => 5000 } }
ls
コマンドを使用してデプロイメントスキャナー属性を公開ls
コマンドを-l
オプション引数を使用して、サブシステムノード属性、値、およびタイプを含む結果の表を表示します。ls
コマンドとその引数の詳細は、ls --help
と入力して CLI ヘルプエントリを表示して学習できます。管理 CLI のヘルプメニューの詳細については、トピック「管理 CLI でのヘルプの使用」を参照してください。[standalone@localhost:9999 scanner=default] ls -l ATTRIBUTE VALUE TYPE auto-deploy-exploded true BOOLEAN auto-deploy-xml true BOOLEAN auto-deploy-zipped true BOOLEAN deployment-timeout 60 LONG path deployments STRING relative-to jboss.server.base.dir STRING scan-enabled true BOOLEAN scan-interval 5000 INT
write-attribute
操作を使用してデプロイメントスキャナーを設定変更する属性の名前を決定したら、write-attribute
を使用して、書き込む属性名と新しい値を指定します。以下のサンプルは、すべて子ノードレベルで実行され、cd
コマンドと Tab 補完を使用してデフォルトスキャナーノードに公開および移動できます。[standalone@localhost:9999 /] cd subsystem=deployment-scanner/scanner=default
展開されたコンテンツの自動デプロイメントを有効化
write-attribute
操作を使用して、展開されたアプリケーションコンテンツの自動デプロイメントを有効にします。[standalone@localhost:9999 scanner=default] :write-attribute(name=auto-deploy-exploded,value=true) {"outcome" => "success"}
XML コンテンツの自動デプロイメントを無効化
write-attribute
操作を使用して XML アプリケーションコンテンツの自動デプロイメントを無効にします。[standalone@localhost:9999 scanner=default] :write-attribute(name=auto-deploy-xml,value=false) {"outcome" => "success"}
zip 形式のコンテンツの自動デプロイメントを無効化
write-attribute
コマンドを使用して zip 形式のアプリケーションコンテンツの自動デプロイメントを無効にします。[standalone@localhost:9999 scanner=default] :write-attribute(name=auto-deploy-zipped,value=false) {"outcome" => "success"}
パス属性の設定
write-attribute
操作を使用して、パス属性を変更し、例のnewpathname
値を監視するデプロイメントスキャナーの新しいパス名に置き換えます。変更を反映するにはサーバーでリロードする必要があります。[standalone@localhost:9999 scanner=default] :write-attribute(name=path,value=newpathname) { "outcome" => "success", "response-headers" => { "operation-requires-reload" => true, "process-state" => "reload-required" } }
相対パス属性の設定
write-attribute
操作を使用して設定 XML ファイルのパスセクションで定義されたファイルシステムパスに対する相対参照を変更します。変更を反映するには、サーバーでリロードする必要があります。[standalone@localhost:9999 scanner=default] :write-attribute(name=relative-to,value=new.relative.dir) { "outcome" => "success", "response-headers" => { "operation-requires-reload" => true, "process-state" => "reload-required" } }
デプロイメントスキャナーの無効化
write-attribute
操作を使用して、scan-enabled
値を false に設定することにより、デプロイメントスキャナーを無効にします。[standalone@localhost:9999 scanner=default] :write-attribute(name=scan-enabled,value=false) {"outcome" => "success"}
スキャン間隔の変更
write-attribute
操作を使用してスキャン間隔を 5000 ミリ秒から 10000 ミリ秒に変更します。[standalone@localhost:9999 scanner=default] :write-attribute(name=scan-interval,value=10000) {"outcome" => "success"}
設定の変更が、デプロイメントスキャナーに保存されます。
8.5. Maven でのデプロイ
8.5.1. Maven によるアプリケーションデプロイメントの管理
8.5.2. Maven によるアプリケーションのデプロイ
このタスクは、Maven を使用してアプリケーションをデプロイする方法を示します。示された例では、Jboss Enterprise Application Platform 6 Quick Starts コレクションに含まれる jboss-as-helloworld.war
アプリケーションを使用します。helloworld
プロジェクトには、jboss-as-maven-plugin
を初期化する POM ファイルが含まれます。このプラグインは、アプリケーションサーバーに対してアプリケーションをデプロイおよびデプロイ解除する単純な操作を提供します。
手順8.11 Maven によるアプリケーションのデプロイ
ターミナルセッションで Maven デプロイコマンドを実行
ターミナルセッションを開き、quickstart サンプルを含むディレクリーに移動します。- Maven デプロイコマンドを実行してアプリケーションをデプロイします。アプリケーションがすでに実行されている場合、アプリケーションはデプロイ解除されます。
[localhost]$ mvn package jboss-as:deploy
アプリケーションデプロイメントの確認
ターミナルウィンドウでの結果の参照
デプロイメントは、ターミナルウィンドウで操作ログを参照して確認できます。例8.5 Maven での helloworld アプリケーションの確認
[INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESSFUL [INFO] ------------------------------------------------------------------------ [INFO] Total time: 3 seconds [INFO] Finished at: Mon Oct 10 17:22:05 EST 2011 [INFO] Final Memory: 21M/343M [INFO] ------------------------------------------------------------------------
サーバーターミナルウィンドウでの結果の参照
また、デプロイメントは、アクティブアプリケーションサーバーインスタンスのステータスストリームで確認することもできます。例8.6 アプリケーションサーバーでの helloworld アプリケーションの確認
17:22:04,922 INFO [org.jboss.as.server.deployment] (pool-1-thread-3) Content added at location /home/dryan/EAP_Home/standalone/data/content/2c/39607b0c8dbc6a36585f72866c1bcfc951f3ff/content 17:22:04,924 INFO [org.jboss.as.server.deployment] (MSC service thread 1-1) Starting deployment of "jboss-as-helloworld.war" 17:22:04,954 INFO [org.jboss.weld] (MSC service thread 1-3) Processing CDI deployment: jboss-as-helloworld.war 17:22:04,973 INFO [org.jboss.weld] (MSC service thread 1-2) Starting Services for CDI deployment: jboss-as-helloworld.war 17:22:04,979 INFO [org.jboss.weld] (MSC service thread 1-4) Starting weld service 17:22:05,051 INFO [org.jboss.web] (MSC service thread 1-2) registering web context: /jboss-as-helloworld 17:22:05,064 INFO [org.jboss.as.server.controller] (pool-1-thread-3) Deployed "jboss-as-helloworld.war"
アプリケーションが、アプリケーションサーバーにデプロイされます。
8.5.3. Maven によるアプリケーションのデプロイ解除
このタスクは、Maven を使用してアプリケーションをデプロイする方法を示します。示された例では、Enterprise Application Server Quick Starts コレクションに含まれる jboss-as-helloworld.war
アプリケーションを使用します。helloworld
プロジェクトには、jboss-as-maven-plugin
を初期化する POM ファイルが含まれます。このプラグインは、アプリケーションサーバーに対してアプリケーションをデプロイおよびデプロイ解除する単純な操作を提供します。
手順8.12 Maven によるアプリケーションのデプロイ解除
ターミナルウィンドウで Maven デプロイコマンドを実行
ターミナルセッションを開き、quickstart サンプルを含むディレクリーに移動します。例8.7 helloworld アプリケーションディレクリーに移動します。
[localhost]$ cd ~/EAP_Quickstarts/helloworld
- Maven デプロイ解除コマンドを実行してアプリケーションをデプロイ解除します。
[localhost]$ mvn jboss-as:undeploy
アプリケーションデプロイ解除の確認
ターミナルウィンドウでの結果の参照
デプロイメント解除は、ターミナルウィンドウの操作ログを参照して確認できます。例8.8 Maven での helloworld アプリケーションの確認
[INFO] ------------------------------------------------------------------------ [INFO] Building JBoss AS Quickstarts: Helloworld [INFO] task-segment: [jboss-as:undeploy] [INFO] ------------------------------------------------------------------------ [INFO] [jboss-as:undeploy {execution: default-cli}] [INFO] Executing goal undeploy for /home/dryan/EAP_Quickstarts/helloworld/target/jboss-as-helloworld.war on server localhost (127.0.0.1) port 9999. Oct 10, 2011 5:33:02 PM org.jboss.remoting3.EndpointImpl <clinit> INFO: JBoss Remoting version 3.2.0.Beta2 Oct 10, 2011 5:33:02 PM org.xnio.Xnio <clinit> INFO: XNIO Version 3.0.0.Beta2 Oct 10, 2011 5:33:02 PM org.xnio.nio.NioXnio <clinit> INFO: XNIO NIO Implementation Version 3.0.0.Beta2 [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESSFUL [INFO] ------------------------------------------------------------------------ [INFO] Total time: 1 second [INFO] Finished at: Mon Oct 10 17:33:02 EST 2011 [INFO] Final Memory: 11M/212M [INFO] ------------------------------------------------------------------------
サーバーターミナルウィンドウでの結果の参照
また、デプロイメント解除は、アクティブアプリケーションサーバーインスタンスのステータスストリームで確認することもできます。例8.9 アプリケーションサーバーでの helloworld アプリケーションの確認
17:33:02,334 INFO [org.jboss.weld] (MSC service thread 1-3) Stopping weld service 17:33:02,342 INFO [org.jboss.as.server.deployment] (MSC service thread 1-3) Stopped deployment jboss-as-helloworld.war in 15ms 17:33:02,352 INFO [org.jboss.as.server.controller] (pool-1-thread-5) Undeployed "jboss-as-helloworld.war"
アプリケーションが、アプリケーションサーバーからデプロイ解除されます。
第9章 JBoss Enterprise Application Platform のセキュア化
9.1. セキュリティーサブシステムについて
ディープコピーサブジェクトモードが無効化されている場合 (デフォルト)、セキュリティデータ構造をコピーすると、データ構造全体をコピーするのではなく、オリジナルが参照されます。この動作はより効率的ですが、フラッシュまたはログアウトの操作によって同一の ID の複数のスレッドで件名を消去すると、データ破損が発生する傾向があります。
java.security.Security
クラスに適用されるシステム全体のセキュリティープロパティーを設定できます。
jboss-ejb-policy
、jboss-web-policy
、および other
の 3 つのセキュリティードメインが含まれます。管理 API、管理コンソール、および管理 CLI は、other
セキュリティードメインを使用します。アプリケーションのニーズに対応するために、セキュリティードメインを必要な数作成できます。
9.2. セキュリティーサブシステムの構造
例9.1 セキュリティーサブシステムの設定例
<subsystem xmlns="urn:jboss:domain:security:1.1"> <security-management> ... </security-management> <subject-factory> ... </subject-factory> <security-domains> <security-domain name="other" cache-type="default"> <authentication> <login-module code="Remoting" flag="optional"> <module-option name="password-stacking" value="useFirstPass"/> </login-module> <login-module code="RealmUsersRoles" flag="required"> <module-option name="usersProperties" value="${jboss.domain.config.dir}/application-users.properties"/> <module-option name="rolesProperties" value="${jboss.domain.config.dir}/application-roles.properties"/> <module-option name="realm" value="ApplicationRealm"/> <module-option name="password-stacking" value="useFirstPass"/> </login-module> </authentication> </security-domain> <security-domain name="jboss-web-policy" cache-type="default"> <authorization> <policy-module code="Delegating" flag="required"/> </authorization> </security-domain> <security-domain name="jboss-ejb-policy" cache-type="default"> <authorization> <policy-module code="Delegating" flag="required"/> </authorization> </security-domain> </security-domains> <security-properties> ... </security-properties> </subsystem>
<security-management>
、 <subject-factory>
、 <security-properties>
要素はデフォルト設定で空になっています。
- <security-management>
- このセクションはセキュリティーサブシステムのハイレベルの挙動を上書きします。各設定は任意になります。ディープコピーサブジェクトモードを除き、これらの設定を変更することはあまりありません。
オプション 説明 deep-copy-subject-mode スレッドの安全性を高めるためセキュリティートークンへコピーまたはリンクするかどうかを指定します。authentication-manager-class-name 使用する代替の AuthenticationManager 実装クラス名を指定します。default-callback-handler-class-name ログインモジュール内で使用される CallbackHandler 実装のグローバルクラス名を指定します。authorization-manager-class-name 使用する代替の AuthorizationManager 実装クラス名を指定します。audit-manager-class-name 使用する代替の AuditManager 実装クラス名を指定します。identity-trust-manager-class-name 使用する代替の IdentityTrustManager 実装クラス名を指定します。mapping-manager-class-name 使用する MappingManager 実装クラス名を指定します。 - <subject-factory>
- サブジェクトファクトリはサブジェクトインスタンスの作成を制御します。呼び出し側を検証するため認証マネージャーを使用することがあります。サブジェクトを確立するため、サブジェクトファクトリは主に JCA コンポーネントに対して使用されます。サブジェクトファクトリを変更する必要があることはあまりありません。
- <security-domains>
- 複数のセキュリティードメインを保持するコンテナ要素です。セキュリティードメインには認証、承認、マッピング、監査モジュールおよび JASPI 認証、JSSE 設定の情報が含まれることがあります。アプリケーションはセキュリティードメインを指定してセキュリティー情報を管理します。
- <security-properties>
- java.security.Security クラスに設定されるプロパティーの名前と値が含まれます。
9.3. セキュリティサブシステムの設定
security
サブシステムのトップレベル設定には、単一の属性 deep-copy-subject-mode
が含まれます。この属性には、security-domains
および security-properties
の子要素が含まれます。セキュリティサブシステムをの設定には、管理 CLI または Web ベースの管理コンソールを使用することができます。
ディープコピーサブジェクトモードが無効化されている場合 (デフォルト)、セキュリティデータ構造をコピーすると、全データ構造をコピーするのではなく、オリジナルが参照されます。この振る舞いはより効率的ですが、フラッシュまたはログアウトの操作によって同一の ID が付いた複数のスレッドで件名を消去すると、データ破損が発生する傾向があります。
java.security.Security
クラスに適用するシステム全体のセキュリティプロパティを設定することが可能です。
セキュリティドメインとは、認証、承認、セキュリティ監査、セキュリティマッピングを制御するために単一または複数のアプリケーションが使用する、 Java Authentication and Authorization Service (JAAS) 宣言型セキュリティ設定のセットです。デフォルトでは、jboss-ejb-policy
、jboss-web-policy
、および other
の 3 つのセキュリティドメインが含まれています。管理 API、管理コンソール、および管理 CLI は、other
セキュリティドメインを使用します。セキュリティドメインは必要に応じていくつでも作成して、ご使用のアプリケーションのニーズに対応することができます。
9.4. ディープコピーサブジェクトモードについて
9.5. ディープコピーサブジェクトモードの有効化
手順9.1 管理コンソールからディープコピーセキュリティーモードを有効にする
管理コンソールへログインします。
通常、管理コンソールは http://127.0.0.1:9990/ のような URL で使用できます。環境に合わせて適切な URL を使用してください。管理ドメイン: 適切なプロファイルを選択します。
管理ドメインではプロファイルごとにセキュリティーサブシステムが設定されているため、各プロファイルに対して個別にディープコピーセキュリティーモードを有効または無効にすることができます。プロファイルを選択するには、コンソール表示の右上にある プロファイル ラベルをクリックし、右上にある プロファイル 選択ボックスより変更したいプロファイルを選択します。Security Subsystem 設定メニューを開きます。
管理コンソールの右にある セキュリティー メニュー項目を拡大し、セキュリティーサブシステム リンクをクリックします。deep-copy-subject-mode の値を変更します。
編集 ボタンをクリックします。Deep Copy Subjects: の横にあるボックスにチェックを入れ、ディープコピーサブジェクトモードを有効にします。
管理 CLI を使用してこのオプションを有効にしたい場合、以下のコマンドの 1 つを使用します。
例9.2 管理ドメイン
/profile=full/subsystem=security:write-attribute(name=deep-copy-subject-mode,value=TRUE)
例9.3 スタンドアロンサーバー
/subsystem=security:write-attribute(name=deep-copy-subject-mode,value=TRUE)
9.6. セキュリティードメイン
9.6.1. セキュリティードメインについて
9.6.2. Picketbox
- 「承認について」およびアクセス制御
- プリンシパル、ロール、および属性の 「セキュリティーマッピングについて」
9.6.3. 認証について
9.6.4. セキュリティードメインでの認証の設定
手順9.2 タスク
セキュリティードメインの詳細ビューを開きます。
管理コンソールの右上にある Profiles ラベルをクリックします。管理対象ドメインで、Profile ビューの左上にある Profile 選択ボックスから変更するプロファイルを選択します。左側の Security メニュー項目をクリックし、展開されたメニューで Security Domains をクリックします。編集するセキュリティードメインの View リンクをクリックします。認証サブシステム設定に移動します。
ビューの最上部の Authentication ラベルをクリックします (まだ設定されていない場合)。設定領域が Login Modules と Details の 2 つの領域に分割されます。ログインモジュールは、設定の基本単位です。セキュリティードメインには複数のログインモジュールを含めることができ、各ログインモジュールには複数の属性とオプションを含めることができます。認証モジュールを追加します。
Add ボタンをクリックして JAAS 認証モジュールを追加します。モジュールの詳細を記入します。Code がモジュールのクラス名です。Flags は、モジュールが同じセキュリティードメイン内で他の認証モジュールにどのように関係するかを制御します。フラグの説明Java Enterprise Edition 6 の仕様では、セキュリティーモジュールの次の説明が提供されます。次のリストは、http://docs.oracle.com/javase/6/docs/technotes/guides/security/jaas/JAASRefGuide.html#AppendixA から取得されました。詳細については、そのドキュメントを参照してください。
フラグ 詳細 required LoginModule は成功する必要があります。成功または失敗すると、LoginModule リストで認証が引き続き続行されます。requisite LoginModule は成功する必要があります。成功すると、LoginModule リストで認証が続行されます。失敗すると、制御がアプリケーションにすぐに戻ります (認証は LoginModule リストで続行されません)。sufficient LoginModule は成功する必要がありません。成功した場合は、制御がアプリケーションにすぐに戻ります (認証は LoginModule リストで続行されません)。失敗すると、認証は LoginModule リストで続行されます。optional LoginModule は成功する必要がありません。成功または失敗した場合、認証は LoginModule リストで続行されます。モジュールを追加したら、画面の Details セクションで Edit をクリックすることにより、Code または Flags を変更できます。Attributes タブが選択されていることを確認します。モジュールオプションを追加、編集、または削除します (任意)。
モジュールにオプションを追加する必要がある場合は、Login Modules リストのエントリーをクリックし、ページの Details セクションの Module Options タブを選択します。Add ボタンをクリックし、オプションのキーと値を提供します。すでに存在するオプションを編集するには、キーをクリックするか、変更します。Remove ボタンを使用してオプションを削除します。
認証モジュールは、セキュリティードメインに追加され、セキュリティードメインを使用するアプリケーションですぐに利用できます。
9.6.5. 承認について
9.6.6. セキュリティードメインでの承認の設定
手順9.3 タスク
セキュリティードメインの詳細ビューを開きます。
管理コンソールの右上にある Profiles ラベルをクリックします。管理対象ドメインで、Profile ビューの左上にある Profile 選択ボックスから変更するプロファイルを選択します。左側の Security メニュー項目をクリックし、展開されたメニューで Security Domains をクリックします。編集するセキュリティードメインの View リンクをクリックします。承認サブシステム設定に移動します。
ビューの最上部の Authorization ラベルをクリックします (まだ設定されていない場合)。設定領域が Policies と Details の 2 つの領域に分割されます。ログインモジュールは、設定の基本単位です。セキュリティードメインには複数の承認ポリシーを含めることができ、各ログインモジュールには複数の属性とオプションを含めることができます。ポリシーを追加します。
Add ボタンをクリックして JAAS 承認ポリシーモジュールを追加します。モジュールの詳細を記入します。Code がモジュールのクラス名です。Flags は、モジュールが同じセキュリティードメイン内で他の承認ポリシーモジュールにどのように関係するかを制御します。フラグの説明Java Enterprise Edition 6 の仕様では、セキュリティーモジュールの次の説明が提供されます。次のリストは、http://docs.oracle.com/javase/6/docs/technotes/guides/security/jaas/JAASRefGuide.html#AppendixA から取得されました。詳細については、そのドキュメントを参照してください。
フラグ 詳細 required LoginModule は成功する必要があります。成功または失敗すると、LoginModule リストで承認が引き続き続行されます。requisite LoginModule は成功する必要があります。成功すると、LoginModule リストで承認が続行されます。失敗すると、制御がアプリケーションにすぐに戻ります (承認は LoginModule リストで続行されません)。sufficient LoginModule は成功する必要がありません。成功した場合は、制御がアプリケーションにすぐに戻ります (承認は LoginModule リストで続行されません)。失敗すると、承認は LoginModule リストで続行されます。optional LoginModule は成功する必要がありません。成功または失敗すると、LoginModule リストで承認が引き続き続行されます。モジュールを追加したら、画面の Details セクションで Edit をクリックすることにより、Code または Flags を変更できます。Attributes タブが選択されていることを確認します。モジュールオプションを追加、編集、または削除します (任意)。
モジュールにオプションを追加する必要がある場合は、Login Modules リストのエントリーをクリックし、ページの Details セクションの Module Options タブを選択します。Add ボタンをクリックし、オプションのキーと値を提供します。すでに存在するオプションを編集するには、キーをクリックするか、変更します。Remove ボタンを使用してオプションを削除します。
承認ポリシーモジュールは、セキュリティードメインに追加され、セキュリティードメインを使用するアプリケーションですぐに利用できます。
9.6.7. セキュリティー監査について
9.6.8. セキュリティー監査の設定
手順9.4 タスク
セキュリティードメインの詳細ビューを開きます。
管理コンソールの右上にある Profiles ラベルをクリックします。管理対象ドメインで、Profile ビューの左上にある Profile 選択ボックスから変更するプロファイルを選択します。左側の Security メニュー項目をクリックし、展開されたメニューで Security Domains をクリックします。編集するセキュリティードメインの View リンクをクリックします。監査サブシステム設定に移動します。
ビューの最上部の Audit ラベルをクリックします (まだ設定されていない場合)。設定領域が Provider Modules と Details の 2 つの領域に分割されます。プロバイダーモジュールは、設定の基本単位です。セキュリティードメインには複数のプロバイダーモジュールを含めることができ、各ログインモジュールには属性とオプションを含めることができます。プロバイダーモジュールを追加します。
Add ボタンをクリックしてプロアクティブモジュールを追加します。Code セクションに、プロバイダーモジュールのクラス名を入力します。モジュールを追加したら、画面の Details セクションで Edit をクリックすることにより、Code を変更できます。Attributes タブが選択されていることを確認します。モジュールオプションを追加、編集、または削除します (任意)。
モジュールにオプションを追加する必要がある場合は、Modules リストのエントリーをクリックし、ページの Details セクションの Module Options タブを選択します。Add ボタンをクリックし、オプションのキーと値を提供します。すでに存在するオプションを編集するには、Remove ラベルをクリックして削除するか、Add ボタンをクリックして正しいオプションで再び追加します。
セキュリティー監査モジュールは、セキュリティードメインに追加され、セキュリティードメインを使用するアプリケーションですぐに利用できます。
9.6.9. セキュリティーマッピングについて
9.6.10. セキュリティードメインでのセキュリティーマッピングの設定
手順9.5 タスク
セキュリティードメインの詳細ビューを開きます。
管理コンソールの右上にある Profiles ラベルをクリックします。管理対象ドメインで、Profile ビューの左上にある Profile 選択ボックスから変更するプロファイルを選択します。左側の Security メニュー項目をクリックし、展開されたメニューで Security Domains をクリックします。編集するセキュリティードメインの View リンクをクリックします。マッピングサブシステム設定に移動します。
ビューの最上部の Mapping ラベルをクリックします (まだ設定されていない場合)。設定領域が Modules と Details の 2 つの領域に分割されます。マッピングモジュールは、設定の基本単位です。セキュリティードメインには複数のマッピングモジュールを含めることができ、各ログインモジュールには複数の属性とオプションを含めることができます。モジュールを追加します。
Add ボタンをクリックしてセキュリティーマッピングモジュールを追加します。モジュールの詳細を記入します。Code がモジュールのクラス名です。Type フィールドは、このモジュールが実行するマッピングのタイプを示します。許可される値は、principal、role、attribute、または credential です。モジュールを追加したら、画面の Details セクションで Edit をクリックすることにより、Code または Type を変更できます。Attributes タブが選択されていることを確認します。モジュールオプションを追加、編集、または削除します (任意)。
モジュールにオプションを追加する必要がある場合は、Modules リストのエントリーをクリックし、ページの Details セクションの Module Options タブを選択します。Add ボタンをクリックし、オプションのキーと値を提供します。すでに存在するオプションを編集するには、Remove ラベルキーをクリックして削除するか、新しい値で再び追加します。Remove ボタンを使用してオプションを削除します。
セキュリティーマッピングモジュールは、セキュリティードメインに追加され、セキュリティードメインを使用するアプリケーションですぐに利用できます。
9.6.11. アプリケーションでのセキュリティードメインの使用
アプリケーションでセキュリティードメインを使用するには、最初にサーバーの設定ファイルまたはアプリケーションの記述子ファイルのいずれかにドメインを設定する必要があります。その後、使用する EJB に必要なアノテーションを追加する必要があります。ここでは、アプリケーションでセキュリティードメインを使用するために必要な手順について取り上げます。
手順9.6 セキュリティードメインを使用するようアプリケーションを設定
セキュリティードメインの定義
セキュリティードメインは、サーバーの設定ファイルまたはアプリケーションの記述子ファイルのいずれかに定義できます。サーバーの設定ファイルへセキュリティードメインを設定
セキュリティードメインは、サーバーの設定ファイルのsecurity
サブシステムに設定されます。JBoss Enterprise Application Platform インスタンスが管理対象ドメインで実行されている場合、domain/configuration/domain.xml
ファイルになります。JBoss Enterprise Application Platform インスタンスがスタンドアロンサーバーとして実行されている場合はstandalone/configuration/standalone.xml
ファイルになります。other
、jboss-web-policy
およびjboss-ejb-policy
セキュリティードメインはデフォルトとして JBoss Enterprise Application Platform 6 に提供されます。次の XML の例は、サーバーの設定ファイルのsecurity
サブシステムよりコピーされました。<subsystem xmlns="urn:jboss:domain:security:1.2"> <security-domains> <security-domain name="other" cache-type="default"> <authentication> <login-module code="Remoting" flag="optional"> <module-option name="password-stacking" value="useFirstPass"/> </login-module> <login-module code="RealmDirect" flag="required"> <module-option name="password-stacking" value="useFirstPass"/> </login-module> </authentication> </security-domain> <security-domain name="jboss-web-policy" cache-type="default"> <authorization> <policy-module code="Delegating" flag="required"/> </authorization> </security-domain> <security-domain name="jboss-ejb-policy" cache-type="default"> <authorization> <policy-module code="Delegating" flag="required"/> </authorization> </security-domain> </security-domains> </subsystem>
管理コンソールまたは CLI を使用して、追加のセキュリティードメインを必要に応じて設定することができます。アプリケーションの記述子ファイルにセキュリティードメインを設定
セキュリティードメインはアプリケーションのWEB-INF/web.xml
ファイルにある<jboss-web>
要素の<security-domain>
子要素に指定されます。次の例はmy-domain
という名前のセキュリティードメインを設定します。<jboss-web> <security-domain>my-domain</security-domain> </jboss-web>
これがWEB-INF/jboss-web.xml
記述子に指定できる多くの設定の 1 つになります。
EJB へ必要なアノテーションを追加
@SecurityDomain
および@RolesAllowed
アノテーションを使用してセキュリティーを EJB に設定します。次の EJBコードの例は、guest
ロールのユーザーによるother
セキュリティードメインへのアクセスを制限します。package example.ejb3; import java.security.Principal; import javax.annotation.Resource; import javax.annotation.security.RolesAllowed; import javax.ejb.SessionContext; import javax.ejb.Stateless; import org.jboss.ejb3.annotation.SecurityDomain; /** * Simple secured EJB using EJB security annotations * Allow access to "other" security domain by users in a "guest" role. */ @Stateless @RolesAllowed({ "guest" }) @SecurityDomain("other") public class SecuredEJB { // Inject the Session Context @Resource private SessionContext ctx; /** * Secured EJB method using security annotations */ public String getSecurityInfo() { // Session context injected using the resource annotation Principal principal = ctx.getCallerPrincipal(); return principal.toString(); } }
その他のコード例は、Red Hat カスタマーポータルより入手できる JBoss Enterprise Application Platform 6 Quickstarts バンドルのejb-security
クイックスタートを参照してください。
9.6.12. JACC (Java Authorization Contract for Containers)
9.6.12.1. JACC (Java Authorization Contract for Containers) について
9.6.12.2. JACC (Java Authorization Contract for Containers) のセキュリティーの設定
jboss-web.xml
を編集する必要があります。
セキュリティードメインに JACC サポートを追加するには、required
フラグセットで JACC
承認ポリシーをセキュリティードメインの承認スタックへ追加します。以下は JACC サポートを持つセキュリティードメインの例になりますが、セキュリティードメインは 直接 XML には設定されず、管理コンソールまたは管理 CLI で設定されます。
<security-domain name="jacc" cache-type="default"> <authentication> <login-module code="UsersRoles" flag="required"> </login-module> </authentication> <authorization> <policy-module code="JACC" flag="required"/> </authorization> </security-domain>
jboss-web.xml
は デプロイメントの META-INF/
または WEB-INF/
ディレクトリに存在し、Web コンテナに対する追加の JBoss 固有の設定を格納し、上書きします。JACC が有効になっているセキュリティードメインを使用するには、<security-domain>
要素が含まれるようにし、 さらに <use-jboss-authorization>
要素を true
に設定する必要があります。以下は、上記の JACC セキュリティードメインを使用するよう適切に設定されているアプリケーションになります。
<jboss-web> <security-domain>jacc</security-domain> <use-jboss-authorization>true</use-jboss-authorization> </jboss-web>
セキュリティードメインと JACC を使用するよう EJB を設定する方法は Web アプリケーションの場合とは異なります。EJB の場合、ejb-jar.xml
記述子にてメソッドまたはメソッドのグループ上でメソッドパーミッションを宣言できます。<ejb-jar>
要素内では、すべての子 <method-permission>
要素に JACC ロールに関する情報が含まれます。詳細は設定例を参照してください。EJBMethodPermission
クラスは Java Enterprise Edition 6 API の一部で、http://docs.oracle.com/javaee/6/api/javax/security/jacc/EJBMethodPermission.html で説明されています。
例9.4 EJB の JACC メソッドパーミッション例
<ejb-jar> <method-permission> <description>The employee and temp-employee roles may access any method of the EmployeeService bean </description> <role-name>employee</role-name> <role-name>temp-employee</role-name> <method> <ejb-name>EmployeeService</ejb-name> <method-name>*</method-name> </method> </method-permission> </ejb-jar>
<security>
子要素の jboss-ejb3.xml
記述子に宣言されます。セキュリティードメインの他に、EJB が実行されるプリンシパルを変更する run-as プリンシパル を指定することもできます。
例9.5 EJB におけるセキュリティードメイン宣言の例
<security> <ejb-name>*</ejb-name> <security-domain>myDomain</s:security-domain> <run-as-principal>myPrincipal</s:run-as-principal> </s:security>
9.6.13. JASPI (Java Authentication SPI for Containers)
9.6.13.1. JASPI (Java Authentication SPI for Containers) のセキュリティーについて
9.6.13.2. JASPI (Java Authentication SPI for Containers) のセキュリティーの設定
<authentication-jaspi>
要素をセキュリティードメインに追加します。設定は標準的な認証モジュールと似ていますが、ログインモジュール要素は <login-module-stack>
要素で囲まれています。設定の構成は次のとおりです。
例9.6 authentication-jaspi
要素の構成
<authentication-jaspi> <login-module-stack name="..."> <login-module code="..." flag="..."> <module-option name="..." value="..."/> </login-module> </login-module-stack> <auth-module code="..." login-module-stack-ref="..."> <module-option name="..." value="..."/> </auth-module> </authentication-jaspi>
EAP_HOME/domain/configuration/domain.xml
または EAP_HOME/standalone/configuration/standalone.xml
へ直接追加する必要があります。
9.7. 管理インターフェースセキュリティー
9.7.1. デフォルトのユーザーセキュリティー設定
JBoss Enterprise Application Platform 6 のすべての管理インターフェースはデフォルトで保護されます。このセキュリティーには 2 つの異なる形式があります。
- ローカルインターフェースは、ローカルクライアントとローカルクライアントが接続するサーバーとの間の SASL コントラクトによって保護されます。このセキュリティーメカニズムは、ローカルファイルシステムにアクセスするクライアントの機能に基づきます。ローカルシステムへアクセスできるとクライアントによるユーザーの追加が可能で、他のセキュリティーメカニズムを無効にするよう設定を変更できるからです。これにより、ファイルシステムへ物理的にアクセスできると、他のセキュリティーメカニズムが不要になるという原則が厳守されます。このメカニズムは 4 つの手順で実現されます。
注記
HTTP を使用してローカルホストへ接続する場合でも、HTTP のアクセスはリモートと見なされます。- ローカル SASL メカニズムを用いて認証する要求が含まれるメッセージをクライアントがサーバーに送信します。
- サーバーはワンタイムトークンを生成し、固有のファイルに書き込み、ファイルのフルパスが含まれるメッセージをクライアントへ送信します。
- クライアントはファイルよりトークンを読み取り、サーバーへ送信し、ファイルシステムへローカルアクセスできるかを検証します。
- サーバーはトークンを検証し、ファイルを削除します。
- ローカル HTTP クライアントを含むリモートクライアントはレルムベースのセキュリティーを使用します。管理インターフェースを使用して JBoss Enterprise Application Platform 6 をリモートで設定するパーミッションを持つデフォルトのレルムは
ManagementRealm
です。このレルム (またはユーザーが作成したレルム) にユーザーを追加できるスクリプトが提供されます。ユーザーの追加の詳細については、JBoss Enterprise Application Platform 6 のインストールガイドの章「Getting Started」を参照してください。ユーザーごとに、ユーザー名、ハッシュ化されたパスワード、およびレルムがファイルに格納されます。JBoss Enterprise Application Platform 6 が管理対象ドメインまたはスタンドアロンサーバーとして設定されている場合、ファイルは別の場所に存在します。- 管理対象ドメイン
EAP_HOME/domain/configuration/mgmt-users.properties
- スタンドアロンサーバー
EAP_HOME/standalone/configuration/mgmt-users.properties
mgmt-users.properties
の内容はマスクされていますが、機密ファイルとして取り扱うようにしてください。ファイルモードを、ファイル所有者による読み書きアクセスのみが許可される600
に設定することが推奨されます。
9.7.2. 管理インターフェースの詳細設定の概要
EAP_HOME/domain/configuration/host.xml
または EAP_HOME/standalone/configuration/standalone.xml
の管理インターフェース設定は、ホストコントローラープロセスのバインド先となるネットワークインターフェース、利用可能な管理インターフェースのタイプ、各インターフェースでユーザー認証に使用する認証システムのタイプを制御します。本トピックでは、ご使用の環境に合わせて管理インターフェースを設定する方法について説明します。
<management>
要素と、以下の 3 つの設定可能な子要素で構成されます。セキュリティーレルムと送信接続はそれぞれ最初に定義されてから、管理インターフェースに属性として適用されます。
<security-realms>
<outbound-connections>
<management-interfaces>
セキュリティーレルムは、管理 API、管理 CLI、または Web ベースの管理コンソールを介して JBoss Enterprise Application Platform の管理を許可されているユーザーの認証と認証を行います。
ManagementRealm
と ApplicationRealm
です。これらのセキュリティレルムはそれぞれ -users.properties
ファイルを使用してユーザーおよびハッシュ化されたパスワードを保管し、-roles.properties
でユーザーとロール間のマッピングを保管します。サポートは LDAP 対応のセキュリティーレルムにも含まれています
注記
一部のセキュリティーレルムは、LDAP サーバーなどの外部インターフェースに接続します。送信接続は、この接続の確立方法を定義します。 事前に定義された接続タイプ ldap-connection
は、LDAP サーバーに接続して資格情報を検証するための必須およびオプションの属性をすべて設定します。
管理インターフェースには、JBoss Enterprise Application Platform の接続および設定方法に関するプロパティーが含まれています。この情報には、名前付きのネットワークインターフェース、ポート、セキュリティーレルム、およびインターフェースに関するその他の設定可能な情報が含まれます。デフォルトのインストールには 2 つのインターフェースが含まれています。
http-interface
は Web ベースの管理コンソールの設定です。native-interface
はコマンドライン管理 CLI および REST ライクな管理 API の設定です。
9.7.3. LDAP について
9.7.4. 管理インターフェースに対する LDAP を使用した認証
- LDAP サーバーへの送信接続を作成します。
- LDAP 対応のセキュリティレルムを作成します。
- 管理インターフェースの新規セキュリティドメインを参照します。
LDAP 送信接続には、以下の属性を使用することができます。
表9.1 LDAP 送信接続の属性
属性 | 必須 | 説明 |
---|---|---|
名前 | はい |
この接続を識別するための名前。この名前はセキュリティレルムの定義に使用されます。
|
url | はい |
ディレクトリサーバーの URL アドレス
|
search-dn | はい |
検索の実行を許可されているユーザーの完全識別名 (DN)
|
search-credentials | はい |
検索の実行を許可されているユーザーのパスワード
|
initial-context-factory | いいえ |
接続を確立する際に使用する初期コンテキストファクトリ。デフォルトでは
com.sun.jndi.ldap.LdapCtxFactory に設定されています。
|
例9.7 LDAP 送信接続の追加
- Search DN:
cn=search,dc=acme,dc=com
- Search Credential:
myPass
- URL:
http://127.0.0.1
/host=master/core-service=management/ldap-connection=ldap_connection/:add(search-credential=myPass,url=http://127.0.0.1,search-dn=cn=search,dc=acme,dc=com)
例9.8 LDAP 送信出力を示す XML
<outbound-connections> <ldap name="ldap_connection" url="ldap://127.0.0.1" search-dn="cn=search,dc=acme,dc=com" search-credential="myPass /> </outboundconnections>
管理インターフェースは、デフォルトで設定されているプロパティファイルをベースとするセキュリティレルムの代わりに LDAP サーバーに対して認証を行うことができます。LDAP 認証システムは、最初にリモートのディレクトリサーバーとの接続を確立することによって機能します。次に、ユーザーが認証システムに渡したユーザー名を使用して検索を実行し、LDAP レコードで完全修飾識別名 (DN) を探します。資格情報としてユーザーの DN とユーザーによって提供されたパスワードを使用して、新規接続が確立されます。 LDAP サーバーに対してこの認証が成功すると、DN が有効であることが確認されます。
- connection
<outbound-connections>
で定義されている接続名。LDAP ディレクトリへの接続に使用します。- base-dn
- ユーザー検索を開始するためのコンテキストの識別名
- recursive
- LDAP ディレクトリツリー全体にわたって再帰的に検索を行うか、指定のコンテキストのみを検索するかの指定。デフォルトでは
false
に設定されています。 - user-dn
- 識別名を持つするユーザーの属性。これは、後で認証のテストに使用されます。デフォルトでは
dn
に設定されています。 - 子要素として、
username-filter
またはadvanced-filter
のいずれか一方。 username-filter
はattribute
と呼ばれる単一の属性を取ります。その値はuserName
やsambaAccountName
などのユーザー名を格納する LDAP の属性名です。advanced-filter
はfilter
と呼ばれる単一の属性を取ります。この属性には、(&(sAMAccountName={0})(memberOf=cn=admin,cn,useres,dc=acme,dc=com))
のような標準的な LDAP 構文のフィルタークエリが含まれています。
例9.9 LDAP 対応のセキュリティレルムを示す XML
- connection -
ldap_connection
- base-dn -
cn=users,dc=acme,dc=com
. - username-filter -
attribute="sambaAccountName"
<security-realm name="TestRealm"> <authentication> <ldap connection="ldap_connection" base-dn="cn=users,dc=acme,dc=com"> <username-filter-attribute="sambaAccountName" /> </ldap> </authentication> </security-realm>
例9.10 LDAP セキュリティレルムの追加
/host=master/core-service=management/security-realm=ldap_security_realm/:add
/host=master/core-service=management/security-realm=ldap_security_realm/authentication=ldap/:write-attribute(name=connection,value=ldap_connection)
/host=master/core-service=management/security-realm=ldap_security_realm/authentication=ldap/:write-attribute(name=base-dn,value=cn=users,dc=acme,dc=com)
/host=master/core-service=management/security-realm=ldap_security_realm/authentication=ldap/:write-attribute(name=recursive,value=false)
/host=master/core-service=management/security-realm=ldap_security_realm/authentication=ldap/:write-attribute(name=user-dn,value=dn)
/host=master/core-service=management/security-realm=ldap_security_realm/authentication=ldap/:write-attribute(name=username-attribute,value=sambaAccountName)
セキュリティドメインの作成が完了したら、管理インターフェースの設定でそのドメインを参照する必要があります。管理インターフェースは、HTTP ダイジェスト認証用のセキュリティレルムを使用します。
例9.11 HTTP インターフェースへのセキュリティレルム適用
/host=master/core-service=management/management-interface=http-interface/:write-attribute(name=security-realm,value=TestRealm)
9.7.5. HTTP 管理インターフェースの無効化
注記
console-enabled-attribute
を false
に設定できます。
/host=master/core-service=management/management-interface=http-interface/:write-attribute(name=console-enabled,value=false)
例9.12 HTTP インターフェースの設定の読み込み
/host=master/core-service=management/management-interface=http-interface/:read-resource(recursive=true,proxies=false,include-runtime=false,include-defaults=true)
{
"outcome" => "success",
"result" => {
"console-enabled" => true,
"interface" => "management",
"port" => expression "${jboss.management.http.port:9990}",
"secure-port" => undefined,
"security-realm" => "ManagementRealm"
}
}
例9.13 HTTP インターフェースの削除
/host=master/core-service=management/management-interface=http-interface/:remove
例9.14 HTTP インターフェースの再作成
/host=master/core-service=management/management-interface=http-interface/:write-attribute(name=console-enabled,value=true)
/host=master/core-service=management/management-interface=http-interface/:write-attribute(name=interface,value=management)
/host=master/core-service=management/management-interface=http-interface/:write-attribute(name=port,value=${jboss.management.http.port:9990})
/host=master/core-service=management/management-interface=http-interface/:write-attribute(name=security-realm,value=ManagementRealm)
9.7.6. デフォルトセキュリティーレルムからのサイレント認証の削除
JBoss Enterprise Application Platform 6 には、ローカル管理 CLI ユーザーに対するサイレント認証方法が含まれます。これにより、ローカルユーザーは、ユーザー名またはパスワード認証なしで管理 CLI にアクセスできるようになります。この機能は、利便性のために有効であり、ローカルユーザーが認証なしで管理 CLI スクリプトを実行する場合に役に立ちます。この機能は、ローカル設定へのアクセスにより、ユーザーが独自のユーザー詳細を追加できる (または、セキュリティーチェックを無効にする) ため、役に立つ機能です。
security-realm
セクション内で local
要素を削除することにより、実現できます。これは、スタンドアロンサーバーインスタンス用の standalone.xml
と管理対象ドメイン用の host.xml
の両方に適用されます。特定のサーバー設定に与える可能性がある影響を考えると、local
要素を削除することをお勧めします。
local
要素を直接削除することです。
例9.15 security-realm
の local
要素の例
<security-realms> <security-realm name="ManagementRealm"> <authentication> <local default-user="$local"/> <properties path="mgmt-users.properties" relative-to="jboss.server.config.dir"/> </authentication> </security-realm> <security-realm name="ApplicationRealm"> <authentication> <local default-user="$local" allowed-users="*"/> <properties path="application-users.properties" relative-to="jboss.server.config.dir"/> </authentication> <authorization> <properties path="application-roles.properties" relative-to="jboss.server.config.dir"/> </authorization> </security-realm> </security-realms>
手順9.7 タスク
管理 CLI でのサイレント認証の削除
必要に応じて、管理レルムとアプリケーションレルムからlocal
要素を削除します。- 管理レルムから
local
要素を削除します。/core-service=management/security-realm=ManagementRealm/authentication=local:remove
- アプリケーションレルムから
local
要素を削除します。/core-service=management/security-realm=ApplicationRealm/authentication=local:remove
サイレント認証モードが、ManagementRealm
と ApplicationRealm
から削除されます。
9.7.7. JMX サブシステムへのリモートアクセスの無効化
/profile=default
の部分を変更します。スタンドアロンサーバーの場合には、この部分を完全に削除してください。
注記
例9.16 JMX サブシステムからのリモートコネクターの削除
/profile=default/subsystem=jmx/remoting-connector=jmx/:remove
例9.17 JMX サブシステムの削除
/profile=default/subsystem=jmx/:remove
9.7.8. 管理インターフェースのセキュリティレルムの設定
以下の例は、ManagementRealm
セキュリティレルムのデフォルト設定を示しています。mgmt-users.properties
というファイルを使用して設定情報を保管します。
例9.18 デフォルトの ManagementRealm
/host=master/core-service=management/security-realm=ManagementRealm/:read-resource(recursive=true,proxies=false,include-runtime=false,include-defaults=true)
{
"outcome" => "success",
"result" => {
"authorization" => undefined,
"server-identity" => undefined,
"authentication" => {"properties" => {
"path" => "mgmt-users.properties",
"plain-text" => false,
"relative-to" => "jboss.domain.config.dir"
}}
}
}
以下のコマンドは TestRealm
というセキュリティレルムを作成し、関連プロパティファイルの名前とディレクトリを設定します。
例9.19 セキュリティレルムの書き込み
/host=master/core-service=management/security-realm=TestRealm/:add
/host=master/core-service=management/security-realm=TestRealm/authentication=properties/:write-attribute(name=path,value=TestUsers.properties)
/host=master/core-service=management/security-realm=TestRealm/authentication=properties/:write-attribute(name=relative-to,value=jboss.domain.config.dir)
セキュリティレルムを追加したら、その名前を管理インターフェースにリファレンスとして提供します。
例9.20 管理インターフェースへのセキュリティレルム追加
host=master/core-service=management/management-interface=http-interface/:write-attribute(name=security-realm,value=TestRealm)
9.8. ネットワークセキュリティー
9.8.1. 管理インターフェースのセキュア化
テスト環境で、管理インターフェース (管理コンソール、管理 CLI、および他のすべての API 実装から構成されます) にセキュリティーレイヤーがない状態で Enterprise Application Platform 6 を実行することは一般的です。これにより、開発と設定変更を素早く行えるようになります。
9.8.2. JBoss Enterprise Application Platform が使用するネットワークインターフェースの指定
サービスを必要なクライアントにのみアクセスできるようサービスを隔離すると、ネットワークのセキュリティーが強化されます。JBoss Enterprise Application Platform には、デフォルト設定の 2 つのインターフェースが含まれ、どちらもデフォルトで IP アドレス 127.0.0.1
または localhost
にバインドされます。インターフェースの 1 つは management
と呼ばれ、管理コンソール、CLI、および API によって使用されます。他のインターフェースは public
と呼ばれ、アプリケーションをデプロイするために使用されます。これらのインターフェースは、特別なものではありませんが、作業を始める土台として提供されます。
management
インターフェースはデフォルトでポート 9990 と 9999 を使用し、public
インターフェースはポート 8080 または 8443 (HTTPS を使用する場合) を使用します。
警告
JBoss Enterprise Application Platform を停止します。
オペレーティングシステムに適切な方法で割り込みを送信して JBoss Enterprise Application Platform を停止します。JBoss Enterprise Application Platform をフォアグラウンドアプリケーションとして実行している場合、通常は Ctrl+C を押してこれを行います。バインドアドレスを指定して JBoss Enterprise Application Platform を再起動します。
-b
コマンドラインスイッチを使用して特定のインターフェースで JBoss Enterprise Application Platform を起動します。例9.21 パブリックインターフェースを指定します。
EAP_HOME/bin/domain.sh -b 10.1.1.1
例9.22 管理インターフェースを指定します。
EAP_HOME/bin/domain.sh -bmanagement=10.1.1.1
例9.23 各インターフェースに異なるアドレスを指定します。
EAP_HOME/bin/domain.sh -bmanagement=127.0.0.1 -b 10.1.1.1
例9.24 すべてのネットワークインターフェースにパブリックインターフェースをバインドします。
EAP_HOME/bin/domain.sh -b 0.0.0.0
-b
コマンドラインスイッチを使用してランタイム時に IP アドレスを指定できなくなるため、お勧めしません。この作業を行う場合は、XML ファイルを編集する前に JBoss Enterprise Application Platform を完全に停止する必要があります。
9.8.3. JBoss Enterprise Application Platform 6 で動作するようネットワークファイアウォールを設定
ほとんどの本番稼動環境では、ネットワークセキュリティー全体の方針の一部としてファイアウォールを使用します。複数のインスタンスがお互い通信したり、Web サーバーやデータベースなどの外部サービスと通信したりする必要がある場合は、ファイアウォールでこのことを考慮する必要があります。良く管理されたファイアウォールでは、操作する必要があるポートのみが開かれ、特定の IP アドレス、サブネット、およびネットワークプロトコルに対するポートへのアクセスが制限されます。
前提条件
- 開く必要があるポートを決定します。それぞれの環境のポートのリストを決定するには、「JBoss Enterprise Application Platform 6 により使用されるネットワークポート」を参照してください。
- ファイアウォールソフトウェアについて理解する必要があります。この手順では、Red Hat Enterprise Linux 6 の
system-config-firewall
コマンドを使用します。Microsoft Windows Server には、ファイアウォールが組み込まれ、各プラットフォーム用の複数のサードパーティー製ファイアウォールソリューションが利用可能です。
この手順では、以下の前提で環境のファイアウォールを設定します。
- オペレーティングシステムが Red Hat Enterprise Linux 6 です。
- JBoss Enterprise Application Platform 6 がホスト
10.1.1.2
で実行されます。オプションで、サーバーには独自のファイアウォールがあります。 - ネットワークファイアウォールサーバーは、ホスト
10.1.1.1
のインターフェースeth0
で実行され、外部インターフェースeth1
を持ちます。 - ポート 5445 (JMS で使用されるポート) のトラフィックを JBoss Enterprise Application Platform 6 に転送します。ネットワークファイアウォールで他のトラフィックは許可されません。
手順9.8 タスク
管理コンソールにログインします。
管理コンソールにログインします。デフォルトでは、http://localhost:9990/console/ で実行されます。管理対象ドメイン: サーバーグループが使用するソケットバインディンググループを決定します。
各サーバーグループは、ソケットバインディングの集まりであるソケットバインディンググループを使用します。ソケットバインディングはポート名と番号の名前/値ペアです。サーバーがグループ化するソケットバインディンググループを決定するには、画面の右上にある Server Groups ラベルをクリックします。次に、Available server group configurations テーブルでサーバーグループの名前をクリックします。画面下部の Server attributes 領域に、サーバーグループが使用するプロファイルとソケットバインディンググループが入力されます。ソケットバインディンググループが使用するソケットバインディングを決定します。
管理コンソールの右上にある Profiles ラベルをクリックします。画面の左側に一連のメニューが表示されます。下部のメニュー見出しは General Configuration です。この見出しの下の Socket Binding Groups 項目をクリックします。Socket Binding Declarations 画面が表示されます。最初に、standard-sockets
グループが表示されます。異なるグループは、右側のコンボボックスで選択することにより選択できます。注記
スタンドアロンサーバーを使用する場合は、1 つのソケットバインディンググループのみが存在します。ソケット名とポートのリストが表示されます (1 ページあたり 6 つの値)。テーブルの矢印ナビゲーションを使用してページを移動できます。開く必要があるポートを決定します。
お使いの環境の特別なポートの機能とニーズによっては、一部のポートがファイアウォールを介してアクセスできる必要があります。ソケットバインディングの目的がわからない場合は、「JBoss Enterprise Application Platform 6 により使用されるネットワークポート」を参照して、デフォルトのソケットバインディングとその目的のリストを確認してください。JBoss Enterprise Application Platform 6 にトラフィックを転送するようファイアウォールを設定します。
以下の手順を実行して、必要なポートでトラフィックを許可するようネットワークファイアウォールを設定します。- root ユーザーとしてファイアウォールマシンにログインし、コマンドプロンプトにアクセスします。
system-config-firewall
コマンドを実行してファイアウォール設定ユーティリティーを起動します。ファイアウォールシステムにログインした方法に応じて、GUI またはコマンドラインユーティリティーが起動します。このタスクでは、SSH 経由でコマンドラインインターフェースを使用してログインしていることを前提とします。- キーボードで TAB キーを使用して Customize ボタンに移動し、ENTER キーを押します。Trusted Services 画面が表示されます。
- どの値も変更せずに、TAB キーを使用して Forward ボタンに移動し、ENTER を押して次の画面に進みます。Other Ports 画面が表示されます。
- TAB キーを使用して <Add> ボタンに移動し、ENTER を押します。Port and Protocol 画面が表示されます。
- Port / Port Range フィールドに
5445
と入力し、TAB キーを使用して Protocol フィールドに移動し、tcp
と入力します。TAB キーを使用して OK ボタンに移動し、ENTER を押します。 - TAB キーを使用して、Forward ボタンに移動し、Port Forwarding 画面にアクセスします。
- TAB キーを使用して <Add> ボタンに移動し、ENTER キーを押します。
- 以下の値を入力してポート 5445 のポート転送を設定します。
- 送信元インターフェース: eth1
- プロトコル: tcp
- ポート/ポート範囲: 5445
- 送信先 IP アドレス: 10.1.1.2
- ポート/ポート範囲: 5445
TAB キーを使用して OK ボタンに移動し、ENTER を押します。 - TAB キーを使用して Close ボタンに移動し、ENTER を押します。
- TAB キーを使用して OK ボタンに移動し、ENTER を押します。変更内容を適用するには、警告を読み、Yes をクリックします。
JBoss Enterprise Application Platform 6 ホストでファイアウォールを設定します。
一部の組織では、JBoss Enterprise Application Platform 6 サーバー自体でファイアウォールを設定し、運用に必要ないすべてのポートを閉じます。「JBoss Enterprise Application Platform 6 により使用されるネットワークポート」 を参照して開くポートを決定し、残りのポートを閉じます。Red Hat Enterprise Linux 6 のデフォルトの設定では、22 (Secure Shell (SSH) 用) と 5353 (マルチキャスト DNS 用) 以外のすべてのポートが閉じられます。ポートを設定する場合は、間違ってロックアウトされないよう物理的にアクセスしてください。
ファイアウォールが、ファイアウォール設定で指定したように、内部 JBoss Enterprise Application Platform 6 サーバーにトラフィックを転送します。サーバーでファイアウォールを有効にした場合は、アプリケーションを実行するために必要なポート以外のすべてのポートが閉じられます。
9.8.4. JBoss Enterprise Application Platform 6 により使用されるネットワークポート
- 管理対象ドメインまたはスタンドアロンサーバー設定のいずれを使用するか。
- サーバーグループがデフォルトのソケットバインディンググループのいずれかを使用するか、またはカスタムグループを使用するかどうか。
- 個別デプロイメントの要件。
注記
デフォルトのソケットバインディンググループ
full-ha-sockets
full-sockets
ha-sockets
standard-sockets
表9.2 デフォルトのソケットバインディングの参照
名前 | ポート | マルチキャストポート | 詳細 | full-ha-sockets | full-sockets | ha-socket | standard-socket |
---|---|---|---|---|---|---|---|
ajp | 8009 | Apache JServ プロトコル。HTTP クラスタリングおよび負荷分散に使用します。 | はい | はい | はい | はい | |
http | 8080 | デプロイされた Web アプリケーションのデフォルトポート。 | はい | はい | はい | はい | |
https | 8443 | デプロイされた Web アプリケーションとクライアント間の SSL 暗号化接続。 | はい | はい | はい | はい | |
jacorb | 3528 | JTS トランザクションおよび他の ORB 依存サービス用の CORBA サービス。 | はい | はい | いいえ | いいえ | |
jacorb-ssl | 3529 | SSL 暗号化 CORBA サービス。 | はい | はい | いいえ | いいえ | |
jgroups-diagnostics | 7500 | マルチキャスト。HA クラスターでピア検出に使用されます。 | はい | いいえ | はい | いいえ | |
jgroups-mping | 45700 | マルチキャスト。HA クラスタでの初期メンバーシップを検出するために使用されます。 | はい | いいえ | はい | いいえ | |
jgroups-tcp | 7600 | TCP を使用した、HA クラスター内でのユニキャストピア検出。 | はい | いいえ | はい | いいえ | |
jgroups-tcp-fd | 57600 | TCP を介した HA 障害検出に使用されます。 | はい | いいえ | はい | いいえ | |
jgroups-udp | 55200 | 45688 | UDP を使用した、HA クラスター内でのユニキャストピア検出。 | はい | いいえ | はい | いいえ |
jgroups-udp-fd | 54200 | UDP を介した HA 障害検出に使用されます。 | はい | いいえ | はい | いいえ | |
messaging | 5445 | JMS サービス。 | はい | はい | いいえ | いいえ | |
messaging-group | HornetQ JMS ブロードキャストと検出グループにより参照されます。 | はい | はい | いいえ | いいえ | ||
messaging-throughput | 5455 | JMS Remoting により使用されます。 | はい | はい | いいえ | いいえ | |
mod_cluster | 23364 | JBoss Enterprise Application Platform と HTTP ロードバランサー間の通信に対するマルチキャストポート。 | はい | いいえ | はい | いいえ | |
osgi-http | 8090 | OSGi サブシステムを使用する内部コンポーネントにより使用されます。 | はい | はい | はい | はい | |
remoting | 4447 | リモート EJB の呼び出しに使用されます。 | はい | はい | はい | はい | |
txn-recovery-environment | 4712 | JTA トランザクションリカバリーマネージャー。 | はい | はい | はい | はい | |
txn-status-manager | 4713 | JTA / JTS トランザクションマネージャー。 | はい | はい | はい | はい |
ソケットバインディンググループ以外に、各ホストコントローラーは管理用にさらに 2 つのポートを開きます。
- 9990 - Web 管理コンソールポート
- 9999 - 管理コンソールと管理 API により使用されるポート
9.9. Java セキュリティマネージャー
9.9.1. Java Security Manager
Java Security Manager は、Java 仮想マシン (JVM) サンドボックスの外部境界を管理するクラスで、JVM 内で実行するコードが JVM 外のリソースと対話する方法を制御します。Java Security Manager が有効な場合、Java API は安全でない可能性のある操作を行う前に Security Manager が承認するか確認します。
様々なコードのクラスに対する定義済みのパーミッションセット。Java Security Manager はアプリケーションが要求したアクションとこのセキュリティポリシーを比較します。ポリシーでアクションが許可された場合、Security Manager により、アクションの実行が許可されます。ポリシーによりアクションが許可されない場合、Security Manager はこのアクションを拒否します。セキュリティポリシーは、コードの場所やコードのシグネチャーを基にパーミッションを定義することができます。
java.security.manager
や java.security.policy
を使用して設定されます。
9.9.2. Java Security Manager 内での JBoss Enterprise Application Platform の実行
domain.sh
スクリプトまたは standalone.sh
スクリプトにパラメーターをオプションとして渡すことはできません。次の手順を実行すると、インスタンスが Java Security Manager ポリシー内で実行されるよう設定できます。
前提条件
- この手順を実行する前に、Java Development Kit (JDK) に含まれる
policytool
コマンドを使用してセキュリティーポリシーを記述する必要があります。この手順では、ポリシーがEAP_HOME/bin/server.policy
にあることを前提としています。 - 設定ファイルを編集する前に、ドメインまたはスタンドアロンサーバーを完全に停止する必要があります。
手順9.9 タスク
設定ファイルを編集します。
編集のために設定ファイルを開きます。このファイルは、管理対象ドメインを使用しているか、スタンドアロンサーバーを使用しているかに応じて、2 つの場所のいずれかに存在します。これは、サーバーまたはドメインを起動するために使用される実行可能ファイルではありません。管理対象ドメイン
EAP_HOME/bin/domain.conf
スタンドアロンサーバー
EAP_HOME/bin/standalone.conf
ファイルの最後に Java オプションを追加します。
以下の行をファイルの最後に追加します。-Djava.security.policy
値を変更してセキュリティーポリシーの場所を指定できます。改行をせず 1 つの行のみで指定する必要があります。デバッグレベルを指定して-Djava.security.debug
を変更し、さらに多くの情報または少ない情報をログに記録できます。最も冗長なのは verbose isfailure,access,policy
です。JAVA_OPTS="$JAVA_OPTS -Djava.security.manager -Djboss.home.dir=$PWD/.. -Djava.security.policy==$PWD/server.policy -Djava.security.debug=failure"
ドメインサーバーを起動します。
ドメインまたはサーバーを通常どおり起動します。
9.9.3. Java Security Manager ポリシー
java.security.manager
や java.security.policy
を使用して設定されます。
9.9.4. Java Security Manager ポリシーの記述
ほとんどの JDK および JRE ディストリビューションには、Java Security Manager セキュリティーポリシーを作成および編集するための policytool
という名前のアプリケーションが含まれます。policytool
の詳細については、http://docs.oracle.com/javase/6/docs/technotes/tools/ を参照してください。
セキュリティーポリシーは、次の設定要素から構成されます。
- CodeBase
- コードの元の URL の場所 (ホストとドメイン情報を除外)。このパラメーターはオプションです。
- SignedBy
- コードを署名するためにプライベートキーが使用された署名者を参照するキーストアで使用されたエイリアス。これは、単一値またはカンマ区切りの値リストになります。このパラメーターはオプションです。省略された場合は、署名があってもなくても Java Security Manager に影響はありません。
- Principals
- principal_type/principal_name ペアのリスト。これは、実行スレッドのプリンシパルセット内に存在する必要があります。Principals エントリはオプションです。省略された場合は、「任意のプリンシパル」を意味します。
- Permissions
- パーミッションは、コードに与えられるアクセスです。多くのパーミッションは、Java Enterprise Edition 6 (Java EE 6) 仕様の一部として提供されます。本書では、JBoss Enterprise Application Platform で提供される追加のパーミッションについてのみ説明します。
手順9.10 タスク
policytool
を起動します。policytool
ツールを次のいずれかの方法で起動します。Red Hat Enterprise Linux
GUI またはコマンドプロンプトで、/usr/bin/policytool
を実行します。Microsoft Windows Server
スタート メニューまたは Java インストールのbin\
から、policytool.exe
を実行します。場所は異なることがあります。
新しいポリシーを作成します。
新しいポリシーを作成するには、Add Policy Entry を選択します。必要なパラメーターを追加し、Done をクリックします。既存のポリシーの編集
既存のポリシーのリストからポリシーを選択し、Edit Policy Entry ボタンを選択します。必要に応じて、パラメーターを編集します。既存のポリシーを削除します。
既存のポリシーのリストからポリシーを選択し、Delete Policy Entry ボタンを選択します。
JBoss Enterprise Application Platform に固有なパーミッション
- org.jboss.security.SecurityAssociation.getPrincipalInfo
org.jboss.security.SecurityAssociation
メソッドとgetPrincipal()
andgetCredential()
メソッドにアクセスを提供します。このランタイムパーミッションを使用する危険は、現在のスレッド呼び出し元とクレデンシャルを見ることができることです。- org.jboss.security.SecurityAssociation.getSubject
org.jboss.security.SecurityAssociation
getSubject()
メソッドにアクセスを提供します。- org.jboss.security.SecurityAssociation.setPrincipalInfo
org.jboss.security.SecurityAssociation
setPrincipal()
メソッド、setCredential()
,setSubject()
メソッド、pushSubjectContext()
メソッド、およびpopSubjectContext()
メソッドにアクセスを提供します。このランタイムパーミッションを使用する危険は、現在のスレッド呼び出し元とクレデンシャルを設定できることです。- org.jboss.security.SecurityAssociation.setServer
org.jboss.security.SecurityAssociation
setServer
メソッドにアクセスを提供します。このランタイムパーミッションを使用する危険は、呼び出し元プリンシパルとクレデンシャルのマルチスレッドストレージを有効または無効にできることです。- org.jboss.security.SecurityAssociation.setRunAsRole
org.jboss.security.SecurityAssociation
pushRunAsRole
メソッド、popRunAsRole
メソッド,pushRunAsIdentity
メソッド、およびpopRunAsIdentity
メソッドにアクセスを提供します。このランタイムパーミッションを使用する危険は、現在の呼び出し元の run-as ロールプリンシパルを変更できることです。- org.jboss.security.SecurityAssociation.accessContextInfo
org.jboss.security.SecurityAssociation
accessContextInfo
およびaccessContextInfo
の getter および setter メソッドにアクセスを提供します。これにより、現在のセキュリティーコンテキスト情報を設定および取得できます。- org.jboss.naming.JndiPermission
- 特別なパーミッションを、指定された JNDI ツリーパスのファイルおよびディレクトリーに提供するか、またはすべてのファイルとディレクトリーに対して再帰的に提供しjます。JndiPermission は、ファイルまたはディレクトリーに関連するパス名および有効なパーミッションセットから構成されます。利用可能なパーミッションには以下のものがあります。
- bind
- rebind
- unbind
- lookup
- list
- listBindings
- createSubcontext
- all
/*
で終わるパス名は、指定されたパーミッションがパス名のすべてのファイルとディレクトリーに適用されることを示します。/-
で終わるパス名は、パス名のすべてのファイルとサブディレクトリーに対する再帰的なパーミッションを示します。パス名は、任意のディレクトリーの任意のファイルに一致する特別なトークン <<ALL BINDINGS>> から構成されます。 - org.jboss.security.srp.SRPPermission
- プライベートセッションキーやプライベートキーなどの機密性の高い SRP 情報へのアクセスを保護するカスタムパーミッションクラス。
getSessionKey
ターゲットは、SRP ネゴシエーションの結果得られるプライベートセッションへのアクセスを提供します。このキーへのアクセスでは、セッションキーで暗号化されたメッセージを暗号化および復号化できます。 - org.hibernate.secure.HibernatePermission
- このパーミッションクラスは、Hibernate セッションをセキュアにする基本的なパーミッションを提供します。このプロパティーのターゲットはエンティティー名です。利用可能なアクセスには以下のものがあります。
- insert
- delete
- update
- read
- * (all)
- org.jboss.metadata.spi.stack.MetaDataStackPermission
- 読み出し元がメタデータスタックと対話する方法を制御するカスタムパーミッションクラスを提供します。利用可能なパーミッションは以下のとおりです。
- modify
- push (スタックに対する)
- pop (スタックから)
- peek (スタックに対する)
- * (all)
- org.jboss.config.spi.ConfigurationPermission
- 設定プロパティーの設定をセキュアにします。パーミッションターゲット名のみを定義し、アクションを定義しません。このプロパティーのターゲットには以下のものが含まれます。
- <property name> (このコードが設定するパーミッションを持つプロパティー)
- * (すべてのプロパティー)
- org.jboss.kernel.KernelPermission
- カーネル設定へのアクセスをセキュアにします。パーミッションターゲット名のみを定義し、アクションを定義しません。このプロパティーのターゲットには以下のものが含まれます。
- access (カーネル設定に対する)
- 設定 (アクセスを暗黙的に)
- * (all)
- org.jboss.kernel.plugins.util.KernelLocatorPermission
- カーネルへのアクセスをセキュアにします。パーミッションターゲット名のみを定義し、アクションを定義しません。このプロパティーのターゲットには以下のものが含まれます。
- kernel
- * (all)
9.9.5. Security Manager ポリシーのデバッグ
java.security.debug
オプションは、報告されたセキュリティー関連情報のレベルを設定します。コマンド java -Djava.security.debug=help
は、すべてのデバッグオプションのヘルプ出力を表示します。デバッグレベルを all
に設定すると、原因がまったくわからないセキュリティー関連の障害をトラブルシューティングするときに役に立ちますが、一般的な使用には多すぎる量の情報が表示されます。一般的に適切なデフォルト値は access:failure
です。
手順9.11 一般的なデバッグの有効化
この手順を実行すると、セキュリティー関連デバッグ情報の一般的な機密レベルを有効にすることができます。
次の行をサーバー設定ファイルに追加します。- 管理対象ドメインで JBoss Enterprise Application Platform インスタンスが実行されている場合、以下の行は Linux では
bin/domain.conf
ファイル、Windows ではbin/domain.conf.bat
ファイルに追加されます。 - JBoss Enterprise Application Platform インスタンスがスタンドアロンサーバーとして実行されている場合、以下の行は Linux では
bin/standalone.conf
ファイル、Windows ではbin\standalone.conf.bat
ファイルに追加されます。
Linux
JAVA_OPTS="$JAVA_OPTS -Djava.security.debug=access:failure"
Windows
JAVA_OPTS="%JAVA_OPTS% -Djava.security.debug=access:failure"
セキュリティー関連デバッグ情報の一般的なレベルが有効になります。
9.10. アプリケーションのセキュリティー
9.10.1. 記述子ベースのプロパティー置換の有効化/無効化
記述子プロパティー置換の有限制御が、jboss-as-ee_1_1.xsd
に導入されました。このタスクには、記述子ベースのプロパティー置換を設定するのに必要な手順が含まれます。
true
に設定された場合は、プロパティー置換が有効になります。false
に設定された場合は、プロパティー置換が無効になります。
手順9.12 jboss-descriptor-property-replacement
jboss-descriptor-property-replacement
は、次の記述子でプロパティー置換を有効または無効にするために使用されます。
jboss-ejb3.xml
jboss-app.xml
jboss-web.xml
*-jms.xml
*-ds.xml
jboss-descriptor-property-replacement
のデフォルト値は true
です。
- 管理 CLI では、次のコマンドを実行して
jboss-descriptor-property-replacement
の値を決定します。/subsystem=ee:read-attribute(name="jboss-descriptor-property-replacement")
- 次のコマンドを実行して動作を設定します。
/subsystem=ee:write-attribute(name="jboss-descriptor-property-replacement",value=VALUE)
手順9.13 spec-descriptor-property-replacement
spec-descriptor-property-replacement
は、次の記述子でプロパティー置換を有効または無効にするために使用されます。
ejb-jar.xml
persistence.xml
spec-descriptor-property-replacement
のデフォルト値は false
です。
- 管理 CLI では、次のコマンドを実行して
spec-descriptor-property-replacement
の値を確認します。/subsystem=ee:read-attribute(name="spec-descriptor-property-replacement")
- 次のコマンドを実行して動作を設定します。
/subsystem=ee:write-attribute(name="spec-descriptor-property-replacement",value=VALUE)
記述子ベースのプロパティー置換が正常に設定されます。
9.11. 機密性の高い文字列のパスワードボールト
9.11.1. クリアテキストファイルでの機密性が高い文字列のセキュア化について
9.11.2. 機密性が高い文字列を格納する Java キーストアの作成
前提条件
keytool
コマンドを使用出来る必要があります。これは Java Runtime Environment (JRE) により提供されます。このファイルのパスを見つけます。Red Hat Enterprise Linux では、これは/usr/bin/keytool
にインストールされます。
手順9.14 タスク
キーストアと他の暗号化された情報を格納するディレクトリーを作成します。
キーストアと他の重要な情報を保持するディレクトリーを作成します。この残りの手順では、ディレクトリーが/home/USER/vault/
であることを前提とします。keytool
で使用するパラメーターを決定します。以下のパラメーターを決定します。- alias
- エイリアスは資格情報コンテナまたはキーストアに格納された他のデータの一意の ID です。この手順の最後にあるコマンド例のエイリアスは
vault
です。エイリアスは大文字と小文字を区別します。 - keyalg
- 暗号化に使用するアルゴリズム。デフォルト値は
DSA
です。この手順の例ではRSA
です。利用可能な他の選択肢については、JRE およびオペレーティングシステムのドキュメンテーションを参照してください。 - keysize
- 暗号化キーのサイズにより、ブルート フォース攻撃により復号化する困難さが影響を受けます。キーのデフォルトサイズは 1024 です。これは 512 〜 1024 の範囲にあり、64 の倍数である必要があります。この手順の例では
1024
を使用します。 - keystore
- 暗号化された情報と暗号化方法に関する情報を保持するデータベースのキーストア。キーストアを指定しない場合、使用するデフォルトのキーストアはホームディレクトリーの
.keystore
という名前のファイルです。これは、キーストアにデータを初めて追加したときに作成されます。この手順の例では、vault.keystore
キーストアを使用します。
keystore
コマンドには他の多くのオプションがあります。詳細については、JRE またはオペレーティングシステムのドキュメンテーションを参照してください。keystore
コマンドが尋ねる質問の回答を決定します。keystore
は、キーストアエントリに値を入力するために次の情報を必要とします。- キーストアパスワード
- キーストアを作成する場合は、パスワードを設定する必要があります。将来キーストアを使用するために、パスワードを提供する必要があります。覚えやすい強度の高いパスワードを作成します。キーストアは、パスワードや、キーストアが存在するファイルシステムおよびオペレーティングシステムのセキュリティーと同程度にセキュアです。
- キーパスワード (任意設定)
- キーストアパスワードに加え、保持する各キーにパスワードを指定することが可能です。このようなキーを使用するには、使用するたびにパスワードを提供する必要があります。通常、このファシリティーは使用されません。
- 名前 (名) と 名字 (姓)
- この情報と一覧の他の情報は、一意にキーを識別して他のキーの階層に置くのに役立ちます。名前である必要はありませんが、キーに一意な 2 つの言葉である必要があります。この手順の例では、
Enterprise Application Platform Vault
を使用します。これが証明書のコモンネームになります。 - 組織単位
- 証明書を使用する人物を特定する単一の言葉です。アプリケーションユニットやビジネスユニットである場合もあります。この手順の例では
enterprise_application_platform
を使用します。通常、1 つのグループやアプリケーションによって使用されるキーストアはすべて同じ組織単位を使用します。 - 組織
- 通常、所属する組織名を表す単一の言葉になります。一般的に、1 つの組織で使用されるすべての証明書で同じになります。この例では
acme
を使用します。 - 市または自治体
- お住まいの市名。
- 州または県
- お住まいの州や県、または同等の行政区画
- 国
- 2 文字の国コード
これらすべての情報によってキーストアや証明書の階層が作成され、一貫性のある一意な名前付け構造が確実に使用されるようにします。keytool
コマンドを実行し、収集した情報を提供します。例9.25
keystore
コマンドの入出力例$ keytool -genkey -alias vault -keyalg RSA -keysize 1024 -keystore /home/USER/vault/vault.keystore Enter keystore password: vault22 Re-enter new password:vault22 What is your first and last name? [Unknown]:
Enterprise Application Platform vault
What is the name of your organizational unit? [Unknown]:enterprise_application_platform
What is the name of your organization? [Unknown]:acme
What is the name of your City or Locality? [Unknown]:raleigh
What is the name of your State or Province? [Unknown]:nc
What is the two-letter country code for this unit? [Unknown]:us
Is CN=Enterprise Application Platform vault, OU=enterprise_application_platform, O=acme, L=raleigh, ST=nc, C=us correct? [no]:yes
Enter key password for <vault> (RETURN if same as keystore password):
/home/USER/vault/
ディレクトリに vault.keystore
という名前のファイルが作成されます。Enterprise Application Platform のパスワードなど、暗号化された文字列を格納するため使用される vault
という 1 つのキーがこのファイルに保存されます。
9.11.3. キーストアパスワードのマスキングとパスワード vault の初期化
要件
EAP_HOME/bin/vault.sh
アプリケーションはコマンドラインインターフェースからアクセスできる必要があります。
vault.sh
コマンドを実行します。EAP_HOME/bin/vault.sh
を実行します。0
を入力して新しい対話セッションを開始します。暗号化されたファイルが保存されるディレクトリを入力します。
このディレクトリはある程度保護されている必要がありますが、JBoss Enterprise Application Platform がアクセスできなければなりません。「機密性が高い文字列を格納する Java キーストアの作成」 の手順に従うと、キーストアはホームディレクトリにあるvault/
というディレクトリの中にあります。この例では/home/USER/vault/
を使用します。注記
必ずディレクトリ名の最後にスラッシュが含まれるようにしてください。ご使用のオペレーティングシステムに応じて/
または\
を使用します。キーストアへのパスを入力します。
キーストアファイルへの完全パスを入力します。この例では/home/USER/vault/vault.keystore
を使用します。キーストアパスワードを暗号化します。
次の手順に従って、設定ファイルやアプリケーションで安全に使用できるようキーストアのパスワードを暗号化します。キーストアパスワードを入力します。
入力を促されたらキーストアのパスワードを入力します。salt 値を入力します。
8 文字の salt 値を入力します。salt 値は反復回数(下記) と共にハッシュ値の作成に使用されます。反復回数を入力します。
反復回数の値を入力します。マスクされたパスワード情報を書き留めておきます。
マスクされたパスワード と salt、反復回数は標準出力へ書き出されます。これらの情報を安全な場所に書き留めておきます。攻撃者がこれらの情報を使用してパスワードを復号化する可能性があるからです。vault のエイリアスを入力します。
入力を促されたら、vault のエイリアスを入力します。「機密性が高い文字列を格納する Java キーストアの作成」 に従って vault を作成した場合、エイリアスはvault
になります。
対話コンソールを終了します。
exit
を入力して対話コンソールを終了します。
設定ファイルとデプロイメントで使用するため、キーストアパスワードがマスキングされます。また、vault が完全設定され、すぐ使用できる状態になります。
9.11.4. パスワード vault を使用するよう Enterprise Application Platform を設定する
設定ファイルにあるパスワードや機密性の高いその他の属性をマスキングする前に、これらを保存し復号化するパスワード vault を Enterprise Application Platform が認識するようにする必要があります。現在、この作業を行うには Enterprise Application Platform を停止し、設定を直接編集する必要があります。
前提条件
- 設定を編集する前に Enterprise Application Platform を停止する必要があります。
手順9.15 タスク
テキストエディターで設定ファイルを開きます。
Enterprise Application Platform が停止した後、エディターで設定ファイルを開きます。デフォルトの設定ファイルへのパスは次の 1 つになります。- 管理ドメイン -
EAP_HOME/domain/configuration/domain.xml
- スタンドアローンサーバー -
EAP_HOME/standalone/configuration/standalone.xml
ボールト設定を挿入します。
extensions
section:</extensions>
の end-tag を探し、その下に次のコードを張り付けます。以下の値は 「機密性が高い文字列を格納する Java キーストアの作成」 と 「キーストアパスワードのマスキングとパスワード vault の初期化」 の独自の値に置き換えます。<vault> <vault-option name="KEYSTORE_URL" value="/home/<replaceable>USER</replaceable>/vault/vault.keystore"/> <vault-option name="KEYSTORE_PASSWORD" value="MASK-3y28rCZlcKR"/> <vault-option name="KEYSTORE_ALIAS" value="vault"/> <vault-option name="SALT" value="12438567"/> <vault-option name="ITERATION_COUNT" value="50"/> <vault-option name="ENC_FILE_DIR" value="${user.home}/vault/"/> </vault>
Enterprise Application Platform を再起動します。
ファイルを保存してから終了し、Enterprise Application Platform を再起動します。
パスワード vault を使用してマスキングされた文字列を復号化するよう Enterprise Application Platform が設定されます。ボールトに文字列を追加し、設定で使用する場合は 「Java キーストアに暗号化された機密性の高い文字列を保存し読み出しする」 を参照してください。
9.11.5. Java キーストアに暗号化された機密性の高い文字列を保存し読み出しする
パスワードや機密性の高いその他の文字列が平文の設定ファイルに含まれるのは安全ではありません。Enterprise Application Platform には、このような機密性の高い文字列をマスキングして暗号化されたキーストアに保存する機能や、設定ファイルでマスクされた値を使用する機能が含まれています。
前提条件
EAP_HOME/bin/util/vault.sh
アプリケーションはコマンドラインインターフェースよりアクセス可能である必要があります。
手順9.16 タスク
vault.sh
コマンドを実行します。EAP_HOME/bin/util/vault.sh
を実行します。0
を入力して新しい対話セッションを開始します。暗号化されたファイルが保存されるディレクトリを入力します。
「機密性が高い文字列を格納する Java キーストアの作成」 に従って作業を行った場合はキーストアはホームディレクトリのvault/
というディレクトリにあります。ほとんどの場合では、暗号化されたすべての情報をキーストアとして同じ場所に保存するのが普通です。この例では/home/USER/vault/
ディレクトリを使用します。注記
必ずディレクトリ名の最後にスラッシュが含まれるようにしてください。ご使用のオペレーティングシステムに応じて/
または\
を使用します。キーストアへのパスを入力します。
キーストアファイルへの完全パスを入力します。この例では/home/USER/vault/vault.keystore
を使用します。キーストアパスワード、ボールト名、ソルト、反復回数を入力します。
入力を促されたら、キーストアパスワード、ボールト名、ソルト、反復回数を入力します。ハンドシェイクが実行されます。パスワードを保存するオプションを選択します。
オプション0
を選択して、パスワードや機密性の高い他の文字列を保存します。値を入力します。
入力を促されたら、値を 2 回入力します。値が一致しない場合は再度入力するよう要求されます。ボールトブロックを入力します。
同じリソースに関連する属性のコンテナであるボールトブロックを入力します。属性名の例としてはds_ExampleDS
などが挙げられます。データソースまたは他のサービス定義で、暗号化された文字列への参照の一部を形成します。属性名を入力します。
保存する属性の名前を入力します。password
が属性名の例の 1 つになります。結果以下のようなメッセージが属性が保存されたことを示します。
Attribute Value for (ds_ExampleDS, password) saved
暗号化された文字列に関する情報を書き留めます。
メッセージはボールトブロック、属性名、共有キー、設定で文字列を使用する場合のアドバイスを示す標準出力を出力します。安全な場所にこの情報を書き留めておいてください。出力例は次の通りです。******************************************** Vault Block:ds_ExampleDS Attribute Name:password Shared Key:N2NhZDYzOTMtNWE0OS00ZGQ0LWE4MmEtMWNlMDMyNDdmNmI2TElORV9CUkVBS3ZhdWx0 Configuration should be done as follows: VAULT::ds_ExampleDS::password::N2NhZDYzOTMtNWE0OS00ZGQ0LWE4MmEtMWNlMDMyNDdmNmI2TElORV9CUkVBS3ZhdWx0 ********************************************
設定で暗号化された文字列を使用します。
プレーンテキストの文字列の代わりに前の設定手順の文字列を使用します。上記の暗号化されたパスワードを使用するデータソースが以下に示されています。... <subsystem xmlns="urn:jboss:domain:datasources:1.0"> <datasources> <datasource jndi-name="java:jboss/datasources/ExampleDS" enabled="true" use-java-context="true" pool-name="H2DS"> <connection-url>jdbc:h2:mem:test;DB_CLOSE_DELAY=-1</connection-url> <driver>h2</driver> <pool></pool> <security> <user-name>sa</user-name> <password>VAULT::ds_ExampleDS::password::N2NhZDYzOTMtNWE0OS00ZGQ0LWE4MmEtMWNlMDMyNDdmNmI2TElORV9CUkVBS3ZhdWx0</password> </security> </datasource> <drivers> <driver name="h2" module="com.h2database.h2"> <xa-datasource-class>org.h2.jdbcx.JdbcDataSource</xa-datasource-class> </driver> </drivers> </datasources> </subsystem> ...
ドメインまたはスタンドアローン設定ファイルのどこにでも暗号化された文字列を使用することができます。文字列をキーストアに保存した後、次の構文を使用してクリアテキストの文字列を暗号化された文字列に置き換えます。${VAULT::<replaceable>VAULT_BLOCK</replaceable>::<replaceable>ATTRIBUTE_NAME</replaceable>::<replaceable>ENCRYPTED_VALUE</replaceable>
実環境の値の例は次の通りです。ボールトブロックはds_ExampleDS
、属性はpassword
です。<password>${VAULT::ds_ExampleDS::password::N2NhZDYzOTMtNWE0OS00ZGQ0LWE4MmEtMWNlMDMyNDdmNmI2TElORV9CUkVBS3ZhdWx0}</password>
9.11.6. アプリケーションで機密性の高い文字列を保存し解決する
Enterprise Application Platform の設定要素は、セキュリティーボールトメカニズムを通じて Java キーストアに保存される値に対して暗号化された文字列を解決する機能をサポートしています。この機能に対するサポートを独自のアプリケーションに追加することができます。
この手順を実行する前に、ボールトファイルを格納するディレクトリが存在することを確認してください。JBoss Enterprise Application Platform を実行するユーザーがボールトファイルを読み書きできるパーミッションを持っていれば、ボールトファイルの場所はどこでも構いません。この例では、vault/
ディレクトリを /home/USER/vault/
ディレクトリに置きます。ボールト自体は vault/
ディレクトリの中にある vault.keystore
と呼ばれるファイルになります。
例9.26 ボールトへパスワードの文字列を追加する
EAP_HOME/bin/vault.sh
コマンドを用いて文字列をボールトへ追加します。次のセッションに完全セッションが含まれています。ユーザー入力の値は強調文字で表されています。出力の一部は書式設定のため削除されています。Microsoft Windows ではコマンド名は vault.bat
になります。Microsoft Windows のファイルパスでは、/
ではなく \
文字がディレクトリの分離記号として使用されることに注意してください。
[user@host bin]$ ./vault.sh ********************************** **** JBoss Vault ******** ********************************** Please enter a Digit:: 0: Start Interactive Session 1: Remove Interactive Session 2: Exit0
Starting an interactive session Enter directory to store encrypted files:/home/user/vault/
Enter Keystore URL:/home/user/vault/vault.keystore
Enter Keystore password:...
Enter Keystore password again:...
Values match Enter 8 character salt:12345678
Enter iteration count as a number (Eg: 44):25
Enter Keystore Alias:vault
Vault is initialized and ready for use Handshake with Vault complete Please enter a Digit:: 0: Store a password 1: Check whether password exists 2: Exit0
Task: Store a password Please enter attribute value:sa
Please enter attribute value again:sa
Values match Enter Vault Block:DS
Enter Attribute Name:thePass
Attribute Value for (DS, thePass) saved Please make note of the following: ******************************************** Vault Block:DS Attribute Name:thePass Shared Key:OWY5M2I5NzctYzdkOS00MmZhLWExZGYtNjczM2U5ZGUyOWIxTElORV9CUkVBS3ZhdWx0 Configuration should be done as follows: VAULT::DS::thePass::OWY5M2I5NzctYzdkOS00MmZhLWExZGYtNjczM2U5ZGUyOWIxTElORV9CUkVBS3ZhdWx0 ******************************************** Please enter a Digit:: 0: Store a password 1: Check whether password exists 2: Exit2
VAULT
で始まる行です。
例9.27 ボールトされたパスワードを使用するサーブレット
package vaulterror.web; import java.io.IOException; import java.io.Writer; import javax.annotation.Resource; import javax.annotation.sql.DataSourceDefinition; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import javax.sql.DataSource; /*@DataSourceDefinition( name = "java:jboss/datasources/LoginDS", user = "sa", password = "sa", className = "org.h2.jdbcx.JdbcDataSource", url = "jdbc:h2:tcp://localhost/mem:test" )*/ @DataSourceDefinition( name = "java:jboss/datasources/LoginDS", user = "sa", password = "VAULT::DS::thePass::OWY5M2I5NzctYzdkOS00MmZhLWExZGYtNjczM2U5ZGUyOWIxTElORV9CUkVBS3ZhdWx0", className = "org.h2.jdbcx.JdbcDataSource", url = "jdbc:h2:tcp://localhost/mem:test" ) @WebServlet(name = "MyTestServlet", urlPatterns = { "/my/" }, loadOnStartup = 1) public class MyTestServlet extends HttpServlet { private static final long serialVersionUID = 1L; @Resource(lookup = "java:jboss/datasources/LoginDS") private DataSource ds; @Override protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { Writer writer = resp.getWriter(); writer.write((ds != null) + ""); } }
第10章 セキュリティー管理リファレンス
10.1. 含まれる認証モジュール
Role
が Code
名に含まれます。
Code
値を使用します。
表10.1 クライアント
コード | クライアント |
クラス | org.jboss.security.ClientLoginModule
|
詳細 |
このログインモジュールは、Enterprise Application Platform がクライアントと対話するときに呼び出し元 ID とクレデンシャルを確立するよう設定されています。これは、実際のサーバー認証に使用されるセキュリティードメインの一部として使用しないでください。
|
表10.2 クライアントモジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
マルチスレッド | ブール値 | false
|
各スレッドが独自のプリンシパルとクレデンシャルストレージを持つ場合は、true に設定します。VM 内のすべてのスレッドが同じ ID とクレデンシャルを共有するよう指定する場合は false に設定します。
|
password-stacking | useFirstPass または false
| false
|
このログインモジュールが ID として使用する LoginContext に格納された情報を探すよう指定する場合は、useFirstPass に設定します。このオプションは、他のログインモジュールをスタックする場合に使用できます。
|
restore-login-identity | ブール値 | false
|
() メソッドの先頭に示された ID とクレデンシャルを logout() メソッドの呼び出し後に復元する必要がある場合は true に設定します。
|
表10.3 証明書
コード | 証明書 |
クラス | org.jboss.security.auth.spi.BaseCertLoginModule
|
詳細 |
このログインモジュールは、X509 証明書に基づいてユーザーを認証するよう設計されています。この使用例は、Web アプリケーションの CLIENT-CERT 認証です。
|
表10.4 証明書モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
securityDomain | 文字列 |
|
信頼済み証明書を保持するトラストストア用 JSSE 設定を持つセキュリティードメインの名前。
|
verifier | クラス |
|
ログイン証明書の検証に使用する org.jboss.security.auth.certs.X509CertificateVerifier のクラス名。
|
表10.5 CertificateUsers
コード | CertificateUsers |
クラス | org.jboss.security.auth.spi.UsersRolesLoginModule
|
詳細 |
ユーザー名とパスワード、ユーザー名とロールをそれぞれマップするために 2 つのプロパティーリソースを使用します。
|
表10.6 CertificateUsers モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
unauthenticatedIdentity | 文字列 |
|
認証情報を含まない要求に割り当てる必要があるプリンシパル名を定義します。これにより、保護されていないサーブレットは特定のロールを必要としない EJB でメソッドを呼び出すことができるようになります。このようなプリンシパルでは、ロールが割り当てられず、
unchecked permission 制約に関連付けられたセキュアでない EJB または EJB メソッドにのみアクセスできます。
|
password-stacking | useFirstPass または false
| false
|
このログインモジュールが ID として使用する LoginContext に格納された情報を探すよう指定する場合は、useFirstPass に設定します。このオプションは、他のログインモジュールをスタックする場合に使用できます。
|
hashAlgorithm | 文字列 |
|
パスワードをハッシュ化するために使用する
java.security.MessageDigest アルゴリズムの名前。デフォルト値はないため、ハッシュを有効にするためにこのオプションを明示的に設定する必要があります。hashAlgorithm が指定された場合は、inputPassword 引数として UsernamePasswordLoginModule.validatePassword に渡す前に CallbackHandler から取得されたクリアテキストパスワードがハッシュ化されます。users.properties ファイルに格納された expectedPassword も、同様にハッシュ化する必要があります。
|
hashEncoding | base64 または hex
| base64
|
ハッシュ化されたパスワードの文字列形式 (hashAlgorithm も設定された場合)。
|
hashCharSet | 文字列 |
コンテナーの環境で設定されたデフォルトエンコーディング
|
クリアテキストパスワードをバイトアレイに変換するために使用されるエンコーディング。
|
usersProperties |
プロパティーファイルまたはリソース
| users.properties
|
ユーザーとパスワード間のマッピングを含むファイル。ファイルの各プロパティーの形式は
username=password です。
|
rolesProperties | プロパティーファイルまたはリソース | roles.properties
|
ユーザーとロール間のマッピングを含むファイル。ファイルの各プロパティーの形式は
username=role1,role2,...,roleN です。
|
ignorePasswordCase | ブール値 | false
|
パスワード比較で大文字と小文字の区別を無視するかどうか。これは、ハッシュ化されたパスワードが大文字であるか小文字であるかが重要でない、ハッシュ化パスワードエンコーディングの場合に役に立ちます。
|
principalClass | クラス |
|
プリンシパル名として String 引数を取るコンストラクターを含む
Principal 実装クラス。
|
roleGroupSeparator |
単一の文字
| . (単一の期間)
|
rolesGroup ファイルでユーザー名とロールグループ名を区別するために使用される文字。
|
defaultUsersProperties | 文字列 | defaultUsers.properties
|
使用するリソースまたはファイルの名前 (usersProperties ファイルが見つからない場合)。
|
defaultRolesProperties | 文字列 | defaultRoles.properties
|
使用するリソースまたはファイルの名前 (rolesProperties ファイルが見つからない場合)。
|
hashUserPassword | ブール値 | true
|
ユーザーが入力したパスワードをハッシュ化するかどうか (
hashAlgorithm が指定された場合)。デフォルトで true に設定されます。
|
hashStorePassword | ブール値 | true
| getUsersPassword() から返されたストアパスワードをハッシュ化するかどうか (hashAlgorithm が指定された場合)。
|
digestCallback | classname |
|
ソルト値などのプレ/ポストダイジェストコンテンツを含む
org.jboss.crypto.digest.DigestCallback 実装のクラス名。hashAlgorithm が指定された場合にのみ使用されます。
|
storeDigestCallback | classname |
|
ストアパスワードをハッシュ化するソルト値などのプレ/ポストダイジェストコンテンツを含む
org.jboss.crypto.digest.DigestCallback 実装のクラス名。hashStorePassword が true であり、hashAlgorithm が指定された場合にのみ使用されます。
|
callback.option... | なし | なし | callback.option. の前に指定されたすべてのオプションは、DigestCallback.init(Map) メソッドに渡されます。入力されたユーザー名は、常に javax.security.auth.login.name オプションを介して渡され、入力/ストアパスワードは、javax.security.auth.login.password オプションを介して digestCallback または storeDigestCallback に渡されます。
|
表10.7 CertificateRoles
コード | CertificateRoles |
クラス | org.jboss.security.auth.spi.CertRolesLoginModule
|
詳細 |
このログインモジュールは、Certificate ログインモジュールを拡張して、プロパティーファイルからロールマッピング機能を追加します。同じすべてのオプションを Certificate ログインモジュールとして取得し、これらのオプションを追加します。
|
表10.8 CertificateRoles モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
rolesProperties | 文字列 | roles.properties
|
各ユーザーに割り当てるロールを含むリソースまたはファイルの名前。ロールプロパティーファイルの形式は username=role1,role2 である必要があります。ここで、username は、証明書の DN であり、すべての等記号やスペース文字をエスケープします。次の例が正しい形式です。
CN\=unit-tests-client,\ OU\=Red\ Hat\ Inc.,\ O\=Red\ Hat\ Inc.,\ ST\=North\ Carolina,\ C\=US=JBossAdmin |
defaultRolesProperties | 文字列 | defaultRoles.properties
|
rolesProperties ファイルが見つからない場合に使用するリソースまたはファイルの名前。
|
roleGroupSeparator | 単一の文字 | . (単一の期間)
|
ロールプロパティーファイルでどの文字をロールグループセパレーターとして使用するか。
|
表10.9 データベース
コード | データベース |
クラス | org.jboss.security.auth.spi.DatabaseServerLoginModule
|
詳細 |
認証とロールマッピングをサポートする JDBC ベースのログインモジュール。これは、次の定義を使用して、2 つの論理テーブルに基づきます。
|
表10.10 データベースモジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
dsJndiName | JNDI リソース |
|
認証情報を保持する JNDI リソースの名前。このオプションは必須です。
|
principalsQuery | SQL ステートメント | select Password from Principals where PrincipalID=?
|
プリンシパルに関する情報を取得するために準備された SQL クエリー。
|
rolesQuery | SQL ステートメント | select Role, RoleGroup from Roles where PrincipalID=?
|
ロールに関する情報を取得するために準備された SQL クエリー。
|
表10.11 DatabaseCertificate
コード | DatabaseCertificate |
クラス | org.jboss.security.auth.spi.DatabaseCertLoginModule
|
詳細 |
このログインモジュールは、Certificate ログインモジュールを拡張して、データベーステーブルからロールマッピング機能を追加します。同じオプションと次の追加オプションが存在します。
|
表10.12 DatabaseCertificate モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
dsJndiName | JNDI リソース |
|
認証情報を保持する JNDI リソースの名前。このオプションは必須です。
|
rolesQuery | SQL ステートメント | select Role,RoleGroup from Roles where PrincipalID=?
|
ロールをマップするために実行される SQL 準備ステートメント。これは、
select Role, RoleGroup from Roles where PrincipalID=? と同じである必要があります。ここで、Role はロール名であり、RoleGroup 列の値は常に R が大文字である Roles . である必要があります。
|
suspendResume | ブール値 | true
|
データベース操作中に既存の JTA トランザクションを一時停止するかどうか。
|
表10.13 Identity
コード | Identity |
クラス | org.jboss.security.auth.spi.IdentityLoginModule
|
詳細 |
モジュールオプションで指定されたプリンシパルをモジュールに対して認証されたサブジェクトと関連付けます。使用される Principal クラスのタイプは
org.jboss.security.SimplePrincipal. です。プリンシパルオプションが指定されない場合は、名前が guest のプリンシパルが使用されます。
|
表10.14 Identity モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
プリンシパル | 文字列 | guest
|
プリンシパルに使用する名前。
|
ロール | カンマ区切りの文字列リスト |
|
サブジェクトに割り当てられるロールのカンマ区切りリスト。
|
表10.15 Ldap
コード | Ldap |
クラス | org.jboss.security.auth.spi.LdapLoginModule
|
詳細 |
ユーザー名とパスワードが、JNDI LDAP プロバイダーを使用してアクセスできる LDAP サーバーに格納された場合に、LDAP サーバーに対して認証します。多くのオプションは、LDAP プロバイダーまたは環境によって決定されるため、必須ではありません。
|
表10.16 Ldap モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
java.naming.factory.initial | クラス名 | com.sun.jndi.ldap.LdapCtxFactory
|
InitialContextFactory 実装クラス名。
|
java.naming.provider.url | ldap:// URL
| ####
|
LDAP サーバー用 URL。
|
java.naming.security.authentication | none 、simple 、または SASL メカニズムの名前
| simple
|
LDAP サーバーにバインドするために使用するセキュリティーレベル。
|
java.naming.security.protocol | トランスポートプロトコル |
指定されない場合は、プロバイダーによって決定されます。
|
SSL などの、セキュアアクセスに使用するトランスポートプロトコル。
|
java.naming.security.principal | 文字列 |
|
サービスに対する呼び出し元を認証するプリンシパルの名前。これは、以下に示された他のプロパティーから構築されます。
|
java.naming.security.credentials | クレデンシャルタイプ |
|
認証スキームにより使用されるクレデンシャルのタイプ。一部の例には、ハッシュ化されたパスワード、クリアテキストパスワード、キー、または証明書が含まれます。このプロパティーが指定されない場合は、動作がサービスプロバイダーにより決定されます。
|
principalDNPrefix | 文字列 |
|
ユーザー DN を形成するユーザー名に追加されるプレフィックス。ユーザーにユーザー名の指定を要求したり、principalDNPrefix と principalDNSuffix を使用して完全修飾 DN を構築したりできます。
|
principalDNSuffix | 文字列 |
|
ユーザー DN を形成するユーザー名に追加されるサフィックス。ユーザーにユーザー名の指定を要求したり、principalDNPrefix と principalDNSuffix を使用して完全修飾 DN を構築したりできます。
|
useObjectCredential | ブール値 |
|
JAAS PasswordCallback を使用した char[] パスワードではなく Callback の
org.jboss.security.auth.callback.ObjectCallback タイプを使用した不透明なオブジェクトとしてクレデンシャルを取得するかどうか。これにより、non-char[] クレデンシャル情報を LDAP サーバーに渡すことができるようになります。
|
rolesCtxDN | 完全修飾 DN |
|
ユーザーロールを検索するコンテキスト用完全修飾 DN。
|
userRolesCtxDNAttributeName | 属性 |
|
ユーザーロールを検索するコンテキスト用 DN を含むユーザーオブジェクトの属性。これは、rolesCtxDN と異なるため、ユーザーのロールを検索するコンテキストは各ユーザーに対して一意になることがあります。
|
rolesAttributeID | 属性 | roles
|
ユーザーロールを含む属性の名前。
|
rolesAttributeIsDN | ブール値 | false
|
roleAttributeID にロールオブジェクトの完全修飾 DN が含まれるかどうか。false の場合は、ロール名がコンテキスト名の roleNameAttributeId 属性の値から取得されます。Active Directory などの特定のディレクトリースキーマでは、この属性を true に設定する必要があります。
|
rolesNameAttributeID | 属性 | group
|
ロール名を含む roleCtxDN コンテキスト内の属性の名前。roleAttributeIsDN プロパティーが true に設定された場合、このプロパティーはロールオブジェクトの名前属性を見つけるために使用されます。
|
uidAttributeID | 属性 | uid
|
ユーザー ID に対応する UserRolesAttributeDN の属性の名前。これは、ユーザーロールを見つけるために使用されます。
|
matchOnUserDN | ブール値 | false
|
ユーザーロールの検索でユーザーの完全識別 DN またはユーザー名のみに一致するかどうか。true の場合、完全 userDN は一致する値として使用されます。false の場合は、ユーザー名のみが uidAttributeName 属性に対して一致する値として使用されます。
|
allowEmptyPasswords | ブール値 | true
|
空白のパスワードを許可するかどうか。ほとんどの LDAP サーバーでは、空白のパスワードが匿名ログイン試行として扱われます。空のパスワードを拒否するには、これを false に設定します。
|
表10.17 LdapExtended
コード | LdapExtended |
クラス | org.jboss.security.auth.spi.LdapExtLoginModule
|
詳細 |
検索を使用してバインドユーザーと関連するロールを見つける別の LDAP ログインモジュール実装。ロールクエリーは再帰的に DN に従い、階層ロール構造をナビゲートします。同じ
java.naming オプションを Ldap モジュールとして使用し、Ldap モジュールの他のオプションの代わりに次のオプションを使用します。
認証は 2 つのステップで行われます。
|
表10.18 LdapExtended モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
baseCtxDN | 完全修飾 DN |
|
ユーザー検索を開始する最上位コンテキストの固定 DN。
|
BindDN | 完全修飾 DN |
|
ユーザーおよびロールクエリーのために LDAP サーバーに対してバインドするために使用される DN。この DN は baseCtxDN および rolesCtxDN の値に対する読み取りおよび検索パーミッションを必要とします。
|
bindCredential | 文字列、オプションで暗号化 |
|
bindDN のパスワード。これは、jaasSecurityDomain が指定された場合に暗号化できます。
|
jaasSecurityDomain | JMX ObjectName |
|
bindCredential を暗号化するために使用する JaasSecurityDomain の JMX ObjectName。パスワードの暗号化形式は、
JaasSecurityDomain.encrypt64(byte[]) メソッドにより返された形式です。また、org.jboss.security.plugins.PBEUtils クラスを使用して暗号化形式を生成することもできます。
|
baseFilter | LDAP フィルター文字列 |
|
認証するユーザーのコンテキストを見つけるために使用される検索フィルター。ログインモジュールコールバックから取得された入力ユーザー名/userDN が、
{0} 式が使用されたフィルターに置換されます。検索フィルターの一般的な例は (uid={0}) です。
|
rolesCtxDN | 完全修飾 DN |
|
ユーザーロールを検索するコンテキストの固定 DN。これは、実際のロールが存在する DN ではなく、ユーザーロールを含むオブジェクトが存在する DN です。たとえば、Active Directory サーバーでは、これは、ユーザーアカウントが存在する DN です。
|
roleFilter | LDAP フィルター文字列 |
|
認証済みユーザーと関連付けられたロールを検索するために使用される検索フィルター。ログインモジュールコールバックから取得された入力ユーザー名/userDN が
{0} 式が使用されたフィルターに置換されます。認証済み userDN は、{1} が使用されたフィルターに置換されます。入力ユーザー名に一致する検索フィルター例は、(member={0}) です。認証済み userDN に一致する代わりの例は (member={1}) です。
|
roleAttributeIsDN | ブール値 | false
|
roleAttributeID にロールオブジェクトの完全修飾 DN が含まれるかどうか。false の場合は、ロール名がコンテキスト名の roleNameAttributeId 属性の値から取得されます。Active Directory などの特定のディレクトリースキーマでは、この属性を true に設定する必要があります。
|
roleNameAttributeID | 属性 | group
|
ロール名を含む roleCtxDN コンテキスト内の属性の名前。roleAttributeIsDN プロパティーが true に設定された場合、このプロパティーはロールオブジェクトの名前属性を見つけるために使用されます。
|
distinguishedNameAttribute | 属性 | distinguishedName
|
ユーザーの DN を含むユーザーエントリーの属性の名前。これは、ユーザー自身の DN に正しいユーザーマッピングを防ぐ特殊文字 (バックスラッシュなど) が含まれる場合に、必要になることがあります。属性が存在しない場合は、エントリーの DN が使用されます。
|
roleRecursion | 整数 | 0
|
ロール検索が一致するコンテキストで行われる再帰のレベル数。再帰を無効にするには、これを
0 に設定します。
|
searchTimeLimit | 整数 | 10000 (10 秒)
|
ユーザー/ロール検索のタイムアウト (ミリ秒単位)。
|
searchScope |
次のいずれか:
OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE
| SUBTREE_SCOPE
|
使用する検索スコープ。
|
allowEmptyPasswords | ブール値 | true
|
空白のパスワードを許可するかどうか。ほとんどの LDAP サーバーでは、空白のパスワードが匿名ログイン試行として扱われます。空のパスワードを拒否するには、これを false に設定します。
|
表10.19 RoleMapping
コード | RoleMapping |
クラス | org.jboss.security.auth.spi.RoleMappingLoginModule
|
詳細 |
認証プロセスの結果であるロールを宣言ロールに対してマップします。このモジュールは、セキュリティードメインに追加する場合に
optional とフラグ付けする必要があります。
|
表10.20 RoleMapping モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
rolesProperties | プロパティーファイルまたはリソース | roles.properties
|
ロールを置換ロールに対してマップするプロパティーファイルまたはリソースの名前。形式は
original_role=role1,role2,role3 になります。
|
replaceRole | ブール値 | false
|
現在のロールを追加するか、現在のロールを、マップされたロールに置き換えるか。true に設定された場合は、置き換えられます。
|
表10.21 RunAs
コード | RunAs |
クラス | Class: org.jboss.security.auth.spi.RunAsLoginModule
|
詳細 | run as ロールを、認証のログイン段階の間スタックにプッシュし、コミットまたはアボート段階でスタックから run as ロールをポップするヘルパーモジュール。このログインモジュールは、セキュアな EJB にアクセスするログインモジュールなどの、認証を実行するためにセキュアなリソースにアクセスする必要がある他のログインモジュール用ロールを提供します。run as ロールを確立する必要があるログインモジュールの前に、RunAsLoginModule を設定する必要があります。
|
表10.22 RunAs オプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
roleName | ロール名。 | nobody
|
ログイン段階で
run as ロールとして使用するロールの名前。
|
表10.23
コード | Simple |
クラス | org.jboss.security.auth.spi.SimpleServerLoginModule
|
詳細 |
テスト目的でセキュリティーを素早くセットアップするモジュール次の単純なアルゴリズムが実装されます。
|
Simple
モジュールにはオプションがありません。
表10.24
コード | RoleMapping |
クラス |
|
詳細 | |
表10.25
コード | ConfiguredIdentity |
クラス | org.picketbox.datasource.security.ConfiguredIdentityLoginModule
|
詳細 |
モジュールオプションで指定されたプリンシパルをモジュールに対して認証されたサブジェクトに関連付けます。使用される Principal クラスのタイプは
org.jboss.security.SimplePrincipal です。
|
表10.26 ConfiguredIdentity モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
プリンシパル | プリンシパルの名前。 | guest
|
モジュールに対して認証されるサブジェクトに関連付けられるプリンシパル。
|
表10.27 SecureIdentity
コード | SecureIdentity |
クラス | org.picketbox.datasource.security.SecureIdentityLoginModule
|
詳細 |
このモジュールは、レガシーのために提供されます。このモジュールを使用すると、パスワードを暗号化し、暗号化されたパスワードを最適なプリンシパルで使用します。アプリケーションが
SecureIdentity を使用する場合は、パスワード vault メカニズムを代わりに使用することを検討してください。
|
表10.28 モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
username | 文字列 | none | 認証のユーザー名 |
password | 暗号化文字列 | none |
認証に使用するパスワード。パスワードを暗号化するには、コマンドラインで直接モジュールを使用します。
このコマンドの結果をモジュールオプションの値フィールドに貼り付けます。
|
managedConnectionFactoryName | JCA リソース | none |
データソース用 JCA 接続ファクトリーの名前。
|
表10.29 PropertiesUsers
コード | PropertiesUsers |
クラス | org.jboss.security.auth.spi.PropertiesUsersLoginModule
|
詳細 |
認証用ユーザー名およびパスワードを格納するプロパティーファイルを使用します。認証 (ロールマッピング) は提供されません。このモジュールは、テスト向けに限定されます。
|
表10.30 PropertiesUsers モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
プロパティー | Java プロパティーファイルまたはリソース。 | none |
認証に使用するユーザー名とクリアテキストパスワードを含むプロパティーファイル。
|
表10.31
コード | SimpleUsers |
クラス | org.jboss.security.auth.spi.SimpleUsersLoginModule
|
詳細 |
このログインモジュールは、ユーザー名とクリアテキストパスワードを Java プロパティーファイルに格納します。これは、テスト用に提供され、本番稼働環境には適しません。
|
表10.32 SimpleUsers モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
username | 文字列 | none | 認証に使用するユーザー名。 |
password | 文字列 | none | 認証に使用するクリアテキストパスワード。 |
表10.33 LdapUsers
コード | LdapUsers |
クラス | org.jboss.security.auth.spi.LdapUsersLoginModule
|
詳細 | |
表10.34 Kerberos
コード | Kerberos |
クラス | com.sun.security.auth.module.Krb5LoginModule
|
詳細 |
GSSAPI を使用して Kerberos ログイン認証を実行します。このモジュールは、Sun Microsystems により提供された API のセキュリティーフレームワークの一部です。詳細については、http://docs.oracle.com/javase/1.4.2/docs/guide/security/jaas/spec/com/sun/security/auth/module/Krb5LoginModule.html を参照してください。このモジュールは、認証とロールのマッピングを処理する別のモジュールと組み合わせる必要があります。
|
表10.35 モジュールオプション
オプション | タイプ | デフォルト | 詳細 |
---|---|---|---|
storekey | true または false のブール値
| false | KerberosKey をサブジェクトのプライベートクレデンシャルに追加するかどうか。
|
doNotPrompt | true または false のブール値
| false | true に設定された場合、ユーザーはパスワードを要求されません。
|
useTicketCache | true または false のブール値
| false | true の場合、GTG はチケットキャッシュから取得されます。false の場合、チケットキャッシュは使用されません。
|
ticketcache | Kerberos チケットキャッシュを表すファイルまたはリソース。 |
デフォルト値は、使用するオペレーティングシステムによって異なります。
| チケットキャッシュの場所。 |
useKeyTab | true または false のブール値
| false | keytab からプリンシパルのキーを取得するかどうか。 |
keytab | Kerberos keytab を表すファイルまたはリソース。 |
オペレーティングシステムの Kerberos 設定ファイルの場所または
/home/user/krb5.keytab
| keytab の場所。 |
プリンシパル | 文字列 | none |
プリンシパルの名前。これは、
host/testserver.acme.com などの単純なユーザー名またはサービス名のいずれかになります。これは、keytab からプリンシパルを取得する代わり、または keytab に複数のプリンシパルが含まれる場合に使用します。
|
useFirstPass | true または false のブール値
| false |
Whether to retrieve the username and password from the module's shared state, using
javax.security.auth.login.name および javax.security.auth.login.password をキーとして使用して、モジュールの共有状態からユーザー名とパスワードを取得するかどうか。認証が失敗した場合、再試行は行われません。
|
tryFirstPass | true または false のブール値
| false | useFirstPass と同じです。ただし、認証が失敗した場合、モジュールは CallbackHandler を使用して新しいユーザー名とパスワードを取得します。2 番目の認証が失敗した場合、失敗は読み出し元アプリケーションに報告されます。
|
storePass | true または false のブール値
| false |
モジュールの共有状態でユーザー名とパスワードを格納するかどうか。これは、キーが共有状態にすでにある場合、または認証に失敗した場合は、行われません。
|
clearPass | true または false のブール値
| false |
これを
true に設定して、認証段階が完了した後に供給状態からユーザー名とパスワードを削除します。
|
SPNEGOUsers org.jboss.security.negotiation.spnego.SPNEGOLoginModule 説明: Active Directory サーバーまたは SPNEGO をサポートする他の環境に対する SPNEGO 認証を許可するモジュール。 SPNEGO は、Kerberos クレデンシャルにも対応しています。このモジュールは、認証とロールマッピングを処理する別のモジュールと組み合わせる必要があります。 オプション: オプション: storeKey 値: true | false デフォルト: 説明: キーを格納するかどうか。 オプション: useKeyTab 値: true | false デフォルト: 説明: キーテーブルを使用するかどうか。 オプション: プリンシパル 値: Kerberos 認証用プリンシパル デフォルト: 説明: 認証用プリンシパルの名前。 オプション: keyTab 値: ファイルまたはリソースの名前。 デフォルト: 説明: キーテーブルの場所。 オプション: doNotPrompt 値: true | false デフォルト: 説明: オプション: debug 値: true | false デフォルト: false 説明: デバッグ情報を記録するかどうか。
AdvancedLdap org.jboss.security.negotiation.AdvancedLdapLoginModule 説明: オプション: オプション: 値: デフォルト: 説明:
AdvancedADLdap org.jboss.security.negotiation.AdvancedADLoginModule 説明: オプション: オプション: 値: デフォルト: 説明:
コード: UsersRoles クラス: org.jboss.security.auth.spi.UsersRolesLoginModule 説明: Java プロパティーファイルからロードされる複数のユーザーとユーザーロールをサポートする単純なログインモジュール オプション: オプション: usersProperties 値: ファイルまたはリソースの名前 デフォルト: users.properties 説明: ユーザーとパスワードのマッピングを含むファイルまたはリソース。 オプション: rolesProperties 値: ファイルまたはリソースの名前 デフォルト: roles.properties 説明: ユーザーとパスワードのマッピングを含むファイルまたはリソース。ファイルの形式はusername=role1,role2,role3
です。 オプション: password-stacking 値: useFirstPass / false デフォルト: false 説明: このログインモジュールが ID として使用する LoginContext に格納された情報を検索するよう指定する場合は、useFirstPass に設定されます。このオプションは、他のログインモジュールをこのモジュールとスタックする場合に使用できます。 オプション: hashAlgorithm 値: 文字列 デフォルト: 説明: パスワードをハッシュ化するために使用するjava.security.MessageDigest
アルゴリズム。デフォルト値はないため、ハッシュを有効にするにはこのオプションを明示的に設定する必要があります。hashAlgorithm が指定された場合、CallbackHandler
から取得されたクリアテキストパスワードは、UsernamePasswordLoginModule.validatePassword
に inputPassword 引数として渡される前にハッシュ化されます。同様に、users.properties
ファイルに格納されたexpectedPassword
は、ハッシュ化する必要があります。 オプション: hashEncoding 値: "base64" / "hex" デフォルト: "base64" 説明: ハッシュ化されたパスワードの文字列形式 (hashAlgorithm も設定された場合)。 オプション: hashCharset 値: 文字列 デフォルト: コンテナーの環境のデフォルトエンコーディングセット。 説明: クリアテキストパスワードをバイトアレイに変換するために使用されるエンコーディング。 オプション: unauthenticatedIdentity 値: プリンシパル名 デフォルト: 説明: 認証情報を含まない要求に割り当てる必要があるプリンシパル名を定義します。これにより、保護されていないサーブレットが特定のロールを必要としない EJB でメソッドを呼び出すことができるようになります。このようなプリンシパルではロールが割り当てられず、unchecked permission
制約に関連付けられたセキュアでない EJB または EJB メソッドにのみアクセスできます。
認証モジュールは、org.jboss.security.LoginModule
の実装です。カスタム認証モジュールの作成の詳細については、API ドキュメンテーションを参照してください。
10.2. 含まれる承認モジュール
コード | クラス |
---|---|
DenyAll | org.jboss.security.authorization.modules.AllDenyAuthorizationModule |
PermitAll | org.jboss.security.authorization.modules.AllPermitAuthorizationModule |
Delegating | org.jboss.security.authorization.modules.DelegatingAuthorizationModule |
Web | org.jboss.security.authorization.modules.WebAuthorizationModule |
JACC | org.jboss.security.authorization.modules.JACCAuthorizationModule |
10.3. 含まれるセキュリティーマッピングモジュール
コード | クラス |
---|---|
PropertiesRoles | org.jboss.security.mapping.providers.role.PropertiesRolesMappingProvider |
SimpleRoles | org.jboss.security.mapping.providers.role.SimpleRolesMappingProvider |
DeploymentRoles | org.jboss.security.mapping.providers.DeploymentRolesMappingProvider |
DatabaseRoles | org.jboss.security.mapping.providers.role.DatabaseRolesMappingProvider |
LdapRoles | org.jboss.security.mapping.providers.role.LdapRolesMappingProvider |
10.4. 含まれるセキュリティー監査プロバイダーモジュール
コード | クラス |
---|---|
LogAuditProvider | org.jboss.security.audit.providers.LogAuditProvider |
第11章 ロギングサブシステム
11.1. はじめに
11.1.1. ロギングの概要
java.util.logging
)、および JBoss Logging を含む複数のアプリケーションロギングフレームワークをサポートします。
11.1.2. JBoss LogManager でサポートされるアプリケーションロギングフレームワーク
- JBoss Logging - JBoss Enterprise Application Platform 6 に含まれています。
- Apache Commons Logging - http://commons.apache.org/logging/
- Simple Logging Facade for Java (SLF4J) - http://www.slf4j.org/
- Apache log4j - http://logging.apache.org/log4j/1.2/
- Java SE Logging (java.util.logging) - http://download.oracle.com/javase/6/docs/api/java/util/logging/package-summary.html
11.1.3. ブートロギングの設定
logging.properties
ファイルを編集して設定できます。このファイルは、標準的な Java プロパティーファイルであり、テキストエディターで編集できます。ファイルの各行の形式は property=value
です。
logging.properties
ファイルへの完全パスは EAP_HOME/domain/configuration/logging.properties
または EAP_HOME/standalone/configuration/logging.properties
のいずれかになります。これは JBoss Enterprise Application Platform を管理対象ドメインまたはスタンドアロンサーバーとして稼動しているかどうかによって異なります。
11.1.4. デフォルトログファイルの場所
表11.1 スタンドアローンサーバー用デフォルトログファイル
ログファイル | 説明 |
---|---|
EAP_HOME/standalone/log/boot.log |
サーバーブートログには、サーバーの起動に関するログメッセージが含まれます。
|
EAP_HOME/standalone/log/server.log |
サーバーログには、サーバーが起動された後のすべてのログメッセージが含まれます。
|
表11.2 管理対象ドメイン用デフォルトログファイル
ログファイル | 説明 |
---|---|
EAP_HOME/domain/log/host-controller/boot.log |
ホストコントローラーブートログには、ホストコントローラーの起動に関するログメッセージが含まれます。
|
EAP_HOME/domain/log/process-controller/boot.log |
プロセスコントローラーブートログには、ホストコントローラーの起動に関するログメッセージが含まれます。
|
EAP_HOME/domain/servers/SERVERNAME/log/boot.log |
指定されたサーバーのサーバーブートログには、指定されたサーバーの起動に関するログメッセージが含まれます。
|
EAP_HOME/domain/servers/SERVERNAME/log/server.log |
指定されたサーバーのサーバーログには、指定されたサーバーが起動された後のすべてのログメッセージが含まれます。
|
11.1.5. ログレベルとは
TRACE
、DEBUG
、INFO
、WARN
、ERROR
、FATAL
WARN
レベルのログハンドラーは、WARN
、ERROR
、および FATAL
のレベルのメッセージのみを記録します。
11.1.6. サポートされているログレベル
表11.3 サポートされているログレベル
ログレベル | 説明 |
---|---|
FATAL |
クリティカルなサービス障害やアプリケーションのシャットダウンをもたらしたり、JBoss Enterprise Application Platform 6 のシャットダウンを引き起こす可能性があるイベントを表示するのに使用します。
|
ERROR |
発生したエラーの中で、現在のアクティビティや要求の完了を妨げる可能性があるが、アプリケーション実行の妨げにはならないエラーを表示するのに使用します。
|
WARN |
エラーではないが、理想的とは見なされない状況を表示するのに使用します。将来的にエラーをもたらす可能性のある状況を示す場合もあります。
|
INFO |
アプリケーションの全体的な進捗状況を示すメッセージに使用します。多くの場合、アプリケーションの起動、シャットダウン、およびその他の主要なライフサイクルイベントに使用されます。
|
DEBUG |
アプリケーションの個別の要求またはアクティビティの進捗状況を表示するメッセージに使用します。
DEBUG のログメッセージは通常アプリケーションのデバッグ時のみにキャプチャーされます。
|
TRACE |
アプリケーションの実行状態に関する詳細情報を提供するメッセージに使用します。通常、
TRACE のログメッセージはアプリケーションのデバッグ時のみにキャプチャーされます。
|
11.1.7. ログカテゴリとは
11.1.8. ルートロガーについて
server.log
ファイルに書き込むように設定されています。このファイルはサーバーログと呼ばれる場合もあります。
11.1.9. ログハンドラーとは
Console
、File
、Periodic
、Size
、Async
、Custom
11.1.10. ログハンドラーのタイプ
- コンソール
- コンソールログハンドラーは、ログメッセージをホストオペレーティングシステムの標準出力 (stdout) または標準エラー (stderr) ストリームに書き込みます。これらのメッセージは、JBoss Enterprise Application Platform 6 がコマンドラインプロンプトから実行された場合に表示されます。オペレーティングシステムで標準出力または標準エラーストリームをキャプチャーするように設定されていない限りは、コンソールログハンドラーからのメッセージは保存されません。
- ファイル
- ファイルログハンドラーは、ログメッセージを指定のファイルに書き込む、最もシンプルなログハンドラーです。
- 定期
- 定期ファイルハンドラーは、指定した時間が経過するまで、ログメッセージを指定ファイルに書き込みます。その時間が経過した後には、指定のタイムスタンプが追記されてファイルの名前が変更され、 ハンドラーは元の名前で新規作成されたログファイルに書き込みを継続します。
- サイズ
- サイズログハンドラーは、指定ファイルが指定したサイズに達するまで、そのファイルにログメッセージを書き込みます。ファイルが指定したサイズに達すると、数値のプレフィックスが付いて名前が変更され、ハンドラーは元の名前で新規作成されたログファイルに書き込みを継続します。各サイズログハンドラーは、この方式で保管されるファイルの最大数を指定する必要があります。
- 非同期
- 非同期ログハンドラーは、 単一または複数のログハンドラーを対象とする非同期動作を提供するラッパーログハンドラーです。非同期ログハンドラーは高レイテンシ、もしくはネットワークファイルシステムへのログファイル書き込みなどにおけるその他のパフォーマンス上の問題があるログハンドラーに有用です。
- カスタム
- カスタムログハンドラーにより、実装された新たなタイプのログハンドラーを設定することができます。カスタムハンドラーは、
java.util.logging.Handler
を拡張する Java クラスとして実装し、モジュール内に格納する必要があります。
11.1.11. ログフォーマッターについて
java.util.Formatter
クラスを基にした構文を使用する文字列です。
%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n
は次のようなログメッセージを作成します。
15:53:26,546 INFO [org.jboss.as] (Controller Boot Thread) JBAS015951: Admin console listening on http://127.0.0.1:9990
11.1.12. ログフォーマッター構文
表11.4 ログフォーマッター構文
記号 | 説明 |
---|---|
%c | ロギングイベントのカテゴリー |
%p | ログエントリーのレベル (情報やデバッグなど) |
%P | ログエントリーのローカライズレベル |
%d | 現在の日付/時刻 (yyyy-MM-dd HH:mm:ss,SSS 形式) |
%r | 相対時間 (ログが初期化された以降のミリ秒単位の時間) |
%z | タイムゾーン |
%k | ログリソースキー (ログメッセージのローカリゼーションに使用) |
%m | ログメッセージ (例外トレースを除外) |
%s | 単純なログメッセージ (例外トレースなし) |
%e | 例外スタックトレース (拡張モジュール情報なし) |
%E | 例外スタックトレース (拡張モジュール情報あり) |
%t | 現在のスレッドの名前 |
%n | 改行文字 |
%C | ログメソッドを呼び出すコードのクラス (低速) |
%F | ログメソッドを呼び出すクラスのファイル名 (低速) |
%l | ログメソッドを呼び出すコードのソースロケーション (低速) |
%L | ログメソッドを呼び出すコードの行番号 (低速) |
%M | ログメソッドを呼び出すコードのメソッド (低速) |
%x | Log4J ネスト化診断コンテキスト |
%X | Log4J メッセージ診断コンテキスト |
%% | リテラルパーセント記号 (エスケープ) |
11.2. 管理コンソールでのロギングの設定
- 管理コンソールへログインします。
- ロギングサブシステム設定に移動します。この手順は、スタンドアロンサーバーとして実行されているサーバーと管理対象ドメインで実行されているサーバーとで異なります。
スタンドアロンサーバー
Profile をクリックし、Profile ペインの Core を展開し、Logging をクリックします。管理対象ドメイン
Profile をクリックし、編集するプロファイルを選択し、Logging をクリックします。
図11.1 管理コンソールのロギング設定
- ログレベルを編集します。
- ログハンドラーを追加および削除します。
- ログカテゴリーを追加および削除します。
- ログカテゴリープロパティーを編集します。
- カテゴリーのログハンドラーを追加および削除します。
- 新しいハンドラーの追加。
- ハンドラーの設定。
11.3. CLI でのロギング設定
11.3.1. CLI での root ロガー設定
手順11.1 root ロガーの設定内容の表示
- 次の構文で
read-resource
オペレーションを使用します。/subsystem=logging/root-logger=ROOT:read-resource
例11.1 root ロガーの read-resource オペレーション
[standalone@localhost:9999 /] /subsystem=logging/root-logger=ROOT:read-resource { "outcome" => "success", "result" => { "filter" => {"match" => "names"}, "handlers" => [ "CONSOLE", "FILE" ], "level" => "INFO" } }
手順11.2 root ロガーのログレベルの設定
- 次の構文で
write-attribute
オペレーションを使用します。LEVEL はサポートされているログレベルの 1 つです。/subsystem=logging/root-logger=ROOT:write-attribute(name="level", value="LEVEL")
例11.2 root ロガーの write-attribute オペレーションによるログレベルの設定
[standalone@localhost:9999 /] /subsystem=logging/root-logger=ROOT:write-attribute(name="level", value="DEBUG") {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.3 root ロガーへの log ハンドラーの追加
- 次の構文で
root-logger-assign-handler
オペレーションを使用します。HANDLER は追加するログハンドラーの名前です。/subsystem=logging/root-logger=ROOT:root-logger-assign-handler(name="HANDLER")
ログハンドラーは、root ロガーに追加する前に作成済みである必要があります。例11.3 root ロガーの root-logger-assign-handler オペレーション
[standalone@localhost:9999 /] /subsystem=logging/root-logger=ROOT:root-logger-assign-handler(name="AccountsNFSAsync") {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.4 root ロガーからのログハンドラーの削除
- 次の構文で
root-logger-unassign-handler
を使用します。HANDLER は削除するログハンドラーの名前です。/subsystem=logging/root-logger=ROOT:root-logger-unassign-handler(name="HANDLER")
例11.4
[standalone@localhost:9999 /] /subsystem=logging/root-logger=ROOT:root-logger-unassign-handler(name="AccountsNFSAsync") {"outcome" => "success"} [standalone@localhost:9999 /]
11.3.2. CLI でのログカテゴリ設定
手順11.5 ログカテゴリの設定の表示
- 次の構文で
read-resource
オペレーションを使用します。CATEGORY はカテゴリ名に置き換えます。/subsystem=logging/logger=CATEGORY:read-resource
例11.5 ログカテゴリの read-resource オペレーション
[standalone@localhost:9999 /] /subsystem=logging/logger=org.apache.tomcat.util.modeler:read-resource { "outcome" => "success", "result" => { "filter" => undefined, "handlers" => undefined, "level" => "WARN", "use-parent-handlers" => true } } [standalone@localhost:9999 /]
手順11.6 ログカテゴリの追加
- 次の構文で
add
オペレーションを使用します。CATEGORY は追加するカテゴリに置き換えます。/subsystem=logging/logger=CATEGORY:add
例11.6 新規カテゴリの追加
[standalone@localhost:9999 /] /subsystem=logging/logger=com.company.accounts.rec:add {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.7 ログレベルの設定
- 次の構文で
write-attribute
オペレーションを使用します。CATEGORY の箇所はログカテゴリ名に、LEVEL は設定するログレベルに置き換えます。/subsystem=logging/logger=CATEGORY:write-attribute(name="level", value="LEVEL")
例11.7 ログレベルの設定
[standalone@localhost:9999 /] /subsystem=logging/logger=com.company.accounts.rec:write-attribute(name="level", value="DEBUG") {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.8 root ロガーのログハンドラーを使用するためのログカテゴリの設定
- 次の構文で
write-attribute
オペレーションを使用します。CATEGORY はログカテゴリ名に置き換えます。root ロガーのハンドラーを使用するためのこのログカテゴリには、BOOLEAN を true に置き換えます。独自の割り当てられたハンドラーのみを使用する場合には false に置き換えてください。/subsystem=logging/logger=CATEGORY:write-attribute(name="use-parent-handlers", value="BOOLEAN")
例11.8 use-parent-handlers の設定
[standalone@localhost:9999 /] /subsystem=logging/logger=com.company.accounts.rec:write-attribute(name="use-parent-handlers", value="true") {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.9 ログカテゴリへのログハンドラ追加
- 次の構文で
assign-handler
オペレーションを使用します。CATEGORY はカテゴリ名に、HANDLER は追加するハンドラーの名前に置き換えます。/subsystem=logging/logger=CATEGORY:assign-handler(name="HANDLER")
ログハンドラーは、root ロガーに追加する前に作成済みである必要があります。例11.9 ログハンドラーの追加
[standalone@localhost:9999 /] /subsystem=logging/logger=com.company.accounts.rec:assign-handler(name="AccountsNFSAsync") {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.10 ログカテゴリからのログハンドラの削除
- 次の構文で
unassign-handler
オペレーションを使用します。CATEGORY はカテゴリ名に、HANDLER は削除するログハンドラーの名前に置き換えます。/subsystem=logging/logger=CATEGORY:unassign-handler(name="HANDLER")
例11.10 ログハンドラーの削除
[standalone@localhost:9999 /] /subsystem=logging/root-logger=ROOT:root-logger-unassign-handler(name="AccountsNFSAsync") {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.11 カテゴリーの削除
- 次の構文で
remove
オペレーションを使用します。CATEGORY は削除するカテゴリーの名前に置き換えます。/subsystem=logging/logger=CATEGORY:remove
例11.11 ログカテゴリの削除
[standalone@localhost:9999 /] /subsystem=logging/logger=com.company.accounts.rec:remove {"outcome" => "success"} [standalone@localhost:9999 /]
11.3.3. CLI でのコンソールログハンドラー設定
手順11.12 コンソールログハンドラーの設定の表示
- 次の構文で
read-resource
オペレーションを使用します。HANDLERはコンソールログハンドラーの名前に置き換えます。/subsystem=logging/console-handler=HANDLER:read-resource
例11.12
[standalone@localhost:9999 /] /subsystem=logging/console-handler=CONSOLE:read-resource { "outcome" => "success", "result" => { "autoflush" => true, "encoding" => undefined, "filter" => undefined, "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n", "level" => "INFO", "target" => "System.out" } } [standalone@localhost:9999 /]
手順11.13 コンソールログハンドラーの追加
- 次の構文で
add
オペレーションを使用します。HANDLER は追加するコンソールログハンドラーに置き換えます。/subsystem=logging/console-handler=HANDLER:add
例11.13
[standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:add {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.14 ログレベルの設定
- 次の構文で
change-log-level
オペレーションを使用します。HANDLER はコンソールログハンドラーの名前に、LEVEL は設定するログレベルに置き換えてください。/subsystem=logging/console-handler=HANDLER:change-log-level(level="LEVEL")
例11.14
[standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:change-log-level(level="TRACE") {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.15 ターゲットの設定
- 次の構文で
write-attribute
オペレーションを使用します。HANDLER はコンソールログハンドラーの名前に置き換えます。TARGET は、システムエラーストリームの場合にはSystem.err
に、標準出力ストリームの場合にはSystem.out
に置き換えてください。/subsystem=logging/console-handler=HANDLER:write-attribute(name="target", value="TARGET")
例11.15
[standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:write-attribute(name="target", value="System.err") {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.16 エンコーディングの設定
- 次の構文で
write-attribute
オペレーションを使用します。HANDLER はコンソールログハンドラーの名前に置き換えます。ENCODING は必要な文字エンコーディングシステムの名前に置き換えます。/subsystem=logging/console-handler=HANDLER:write-attribute(name="encoding", value="ENCODING")
例11.16
[standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:write-attribute(name="encoding", value="utf-8") {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.17 フォーマッターの設定
- 次の構文で
write-attribute
オペレーションを使用します。HANDLER はコンソールログハンドラーの名前に置き換えます。FORMAT は必要なフォーマッターの文字列に置き換えます。/subsystem=logging/console-handler=HANDLER:write-attribute(name="formatter", value="FORMAT")
例11.17
[standalone@l/subsystem=logging/console-handler=ERRORCONSOLE:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n")) {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.18 自動フラッシュの設定
- 次の構文で
write-attribute
オペレーションを使用します。HANDLER はコンソールログハンドラーの名前に置き換えます。このハンドラーが出力を直ちに書き込むようにするには、BOOLEAN はtrue
に置き換えます。/subsystem=logging/console-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN")
例11.18
[standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:write-attribute(name="autoflush", value="true") {"outcome" => "success"} [standalone@localhost:9999 /]
手順11.19 コンソールログハンドラーの削除
- 次の構文で
remove
オペレーションを使用します。HANDLER は削除するコンソールログハンドラーの名前に置き換えます。/subsystem=logging/console-handler=HANDLER:remove
例11.19
[standalone@localhost:9999 /] /subsystem=logging/console-handler=ERRORCONSOLE:remove {"outcome" => "success"} [standalone@localhost:9999 /]
11.3.4. CLI でのファイルログハンドラーの設定
- ファイルログハンドラーの設定を表示します。
- 新しいファイルログハンドラーを追加します。
- ハンドラーのログレベルを設定します。
- ハンドラーの追加動作を設定します。
- ハンドラーが自動フラッシュを使用するかどうかを設定します。
- ハンドラーの出力に使用されるエンコーディングを設定します。
- ログハンドラーが書き込むファイルを指定します。
- ハンドラーの出力に使用されるフォーマッターを設定します。
- ファイルログハンドラーを削除します。
- ファイルログハンドラー設定の表示
- 次の構文で
read-resource
操作を使用します。HANDLER はファイルログハンドラーの名前に置き換えます。/subsystem=logging/file-handler=HANDLER:read-resource
例11.20 read-resource 操作の使用
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:read-resource { "outcome" => "success", "result" => { "append" => true, "autoflush" => true, "encoding" => undefined, "file" => { "path" => "accounts.log", "relative-to" => "jboss.server.log.dir" }, "filter" => undefined, "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n", "level" => undefined } } [standalone@localhost:9999 /]
- ファイルログハンドラーの追加
- 次の構文で
add
操作を使用します。PATH を、ログが書き込まれるファイルのファイル名で置き換えます。DIR を、ファイルを格納するディレクトリーの名前に置き換えます。DIR の値はパス変数に指定できます。/subsystem=logging/file-handler=HANDLER:add(file={"path"=>"PATH", "relative-to"=>"DIR"})
例11.21 ファイルログハンドラーの追加
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:add(file={"path"=>â€accounts.log", "relative-to"=>"jboss.server.log.dir"}) {"outcome" => "success"} [standalone@localhost:9999 /]
- ログレベルの設定
- 次の構文で
change-log-level
操作を使用します。HANDLER はファイルログハンドラーの名前と置き換えます。LEVEL は設定するログレベルと置き換えます。/subsystem=logging/file-handler=HANDLER:change-log-level(level="LEVEL")
例11.22 ログレベルの変更
/subsystem=logging/file-handler=accounts_log:change-log-level(level="DEBUG"){"outcome" => "success"} [standalone@localhost:9999 /]
- 追加動作の設定
- 次の構文で
write-attribute
操作を使用します。HANDLER はファイルログハンドラーの名前に置き換えます。アプリケーションサーバーが起動されるたびに新しいログファイルを作成する必要がある場合は、BOOLEAN を false に置き換えます。アプリケーション・サーバーが同じファイルを使用し続ける必要がある場合は、BOOLEAN をtrue
に置き換えます。/subsystem=logging/file-handler=HANDLER:write-attribute(name="append", value="BOOLEAN")
例11.23 追加プロパティーの変更
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="append", value="true") { "outcome" => "success", "response-headers" => { "operation-requires-reload" => true, "process-state" => "reload-required" } } [standalone@localhost:9999 /]
この変更を反映するには、JBoss Enterprise Application Platform 6 を再起動する必要があります。 - 自動フラッシュの設定
- 次の構文で
write-attribute
操作を使用します。HANDLER はファイルログハンドラーの名前に置き換えます。このハンドラーが出力を直ちに書き込むようにするには、BOOLEAN をtrue
に置き換えます。/subsystem=logging/file-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN")
例11.24 自動フラッシュプロパティーの変更
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="autoflush", value="false") { "outcome" => "success", "response-headers" => {"process-state" => "reload-required"} } [standalone@localhost:9999 /]
この変更を反映するには、JBoss Enterprise Application Platform 6 を再起動する必要があります。 - エンコーディングの設定
- 次の構文で
write-attribute
操作を使用します。HANDLER はファイルログハンドラーの名前に置き換えます。ENCODING は必要な文字エンコーディングシステムの名前に置き換えます。/subsystem=logging/file-handler=HANDLER:write-attribute(name="encoding", value="ENCODING")
例11.25 エンコーディングの設定
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="encoding", value="utf-8") {"outcome" => "success"} [standalone@localhost:9999 /]
- ログハンドラーが書き込むファイルの変更
- 次の構文で
change-file
操作を使用します。PATH を、ログが書き込まれるファイルのファイル名で置き換えます。DIR を、ファイルを格納するディレクトリーの名前に置き換えます。DIR の値はパス変数に指定できます。/subsystem=logging/file-handler=HANDLER:change-file(file={"path"=>"PATH", "relative-to"=>"DIR"})
例11.26 ログハンドラーが書き込むファイルの変更
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:change-file(file={"path"=>"accounts-debug.log", "relative-to"=>"jboss.server.log.dir"}) {"outcome" => "success"} [standalone@localhost:9999 /]
- フォーマッターの設定
- 次の構文で
write-attribute
操作を使用します。HANDLER はコンソールログハンドラーの名前に置き換えます。FORMAT は必要なフォーマッターの文字列に置き換えます。/subsystem=logging/file-handler=HANDLER:write-attribute(name="formatter", value="FORMAT")
例11.27 フォーマッターの設定
[standalone@l/subsystem=logging/file-handler=accounts-log:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n")) {"outcome" => "success"} [standalone@localhost:9999 /]
- ファイルログハンドラーの削除
- 次の構文で
remove
操作を使用します。HANDLER は削除するファイルログハンドラーの名前に置き換えます。/subsystem=logging/file-handler=HANDLER:remove
例11.28 コンソールログハンドラーの削除
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:remove {"outcome" => "success"} [standalone@localhost:9999 /]
ログハンドラーは、ログカテゴリーまたは非同期ログハンドラーによって参照されていない場合にのみ削除できます。
11.3.5. CLI での周期ログハンドラーの設定
- 周期ログハンドラーの設定を表示します。
- 新しい周期ログハンドラーを追加します。
- ハンドラーのログレベルを設定します。
- ハンドラーの追加動作を設定します。
- ハンドラーが自動フラッシュを使用するかどうかを設定します。
- ハンドラーの出力に使用されるエンコーディングを設定します。
- ログハンドラーが書き込むファイルを指定します。
- ハンドラーの出力に使用されるフォーマッターを設定します。
- ローテーションされるログの接尾辞の設定
- 周期ログハンドラーを削除します。
- 周期ローテーションファイルログハンドラー設定の表示
- 次の構文で
read-resource
操作を使用します。/subsystem=logging/periodic-rotating-file-handler=HANDLER:read-resource
HANDLER をファイルログハンドラーの名前と置き換えます。例11.29 read-resource 操作の使用
[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:read-resource { "outcome" => "success", "result" => { "append" => true, "autoflush" => true, "encoding" => undefined, "file" => { "path" => "daily-debug.log", "relative-to" => "jboss.server.log.dir" }, "filter" => undefined, "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n", "level" => undefined } } [standalone@localhost:9999 /]
- 新しい周期ローテーションファイルログハンドラーの追加
- 次の構文で
add
操作を使用します。/subsystem=logging/periodic-rotating-file-handler=HANDLER:add(file={"path"=>"PATH", "relative-to"=>"DIR"}, suffix="SUFFIX")
HANDLER をログハンドラーの名前と置き換えます。PATH をログが書き込まれるファイルのファイル名と置き換えます。DIR をファイルが存在するディレクトリーの名前と置き換えます。DIR の値をパス変数に指定できます。SUFFIX を、使用するファイルローテーション接尾辞と置き換えます。例11.30 新しいハンドラーの追加
[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:add(file={"path"=>"daily-debug.log", "relative-to"=>"jboss.server.log.dir"}, suffix=".yyyy.MM.dd") {"outcome" => "success"} [standalone@localhost:9999 /]
- ログレベルの設定
- 次の構文で
change-log-level
操作を使用します。/subsystem=logging/periodic-rotating-file-handler=HANDLER:change-log-level(level="LEVEL")
HANDLER を周期ログハンドラーの名前と置き換えます。LEVEL を、設定するログレベルと置き換えます。例11.31 ログレベルの設定
[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:change-log-level(level="DEBUG") {"outcome" => "success"} [standalone@localhost:9999 /]
- 追加動作の設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/periodic-rotating-handler=HANDLER:write-attribute(name="append", value="BOOLEAN")
HANDLER を周期ログハンドラーの名前と置き換えます。アプリケーション・サーバーが起動されるたびに新しいログファイルを作成する必要がある場合は、BOOLEAN をfalse
と置き換えます。アプリケーションサーバーが同じファイルを使用し続ける必要がある場合は、BOOLEAN をtrue
に置き換えます。この変更を反映するには、JBoss Enterprise Application Platform 6 を再起動する必要があります。例11.32 追加動作の設定
[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="append", value="true") { "outcome" => "success", "response-headers" => { "operation-requires-reload" => true, "process-state" => "reload-required" } } [standalone@localhost:9999 /]
- 自動フラッシュの設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/periodic-rotating-file-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN")
HANDLER を周期ログハンドラーの名前と置き換えます。このハンドラーがすぐに出力を書き込む場合は、BOOLEAN をtrue
に置き換えます。この変更を反映するには、JBoss Enterprise Application Platform 6 を再起動する必要があります。例11.33 自動フラッシュ動作の設定
[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="autoflush", value="false") { "outcome" => "success", "response-headers" => {"process-state" => "reload-required"} } [standalone@localhost:9999 /]
- エンコーディングの設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/periodic-rotating-file-handler=HANDLER:write-attribute(name="encoding", value="ENCODING")
HANDLER を周期ログハンドラーの名前と置き換えます。ENCODING を必要な文字エンコーディングシステムの名前と置き換えます。例11.34 エンコーディングの設定
[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="encoding", value="utf-8") {"outcome" => "success"} [standalone@localhost:9999 /]
- ログハンドラーが書き込むファイルの変更
- 次の構文で
change-file
操作を使用します。/subsystem=logging/periodic-rotating-file-handle=HANDLER:change-file(file={"path"=>"PATH", "relative-to"=>"DIR"})
HANDLER を周期ログハンドラーの名前と置き換えます。PATH をログが書き込まれるファイルのファイル名と置き換えます。DIR をファイルが存在するディレクトリーの名前と置き換えます。DIR の値をパス変数に指定できます。例11.35 ログハンドラーが書き込むファイルの変更
[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handle=HOURLY_DEBUG:change-file(file={"path"=>"daily-debug.log", "relative-to"=>"jboss.server.log.dir"}) {"outcome" => "success"} [standalone@localhost:9999 /]
- フォーマッターの設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/periodic-rotating-file-handle=HANDLER:write-attribute(name="formatter", value="FORMAT")
HANDLER を周期ログハンドラーの名前と置き換えます。FORMAT を必要なフォーマッター文字列に置き換えます。例11.36 フォーマッターの設定
[standalone@l/subsystem=logging/periodic-rotating-file-handle=HOURLY_DEBUG:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n")) {"outcome" => "success"} [standalone@localhost:9999 /]
- ローテーションされるログの接尾辞の設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/periodic-rotating-file-handle=HANDLER:write-attribute(name="suffix", value="SUFFIX")
HANDLER をコンソールログハンドラーの名前と置き換えます。SUFFIX を必要なフォーマッター文字列に置き換えます。例11.37
[standalone@l/subsystem=logging/periodic-rotating-file-handle=HOURLY_DEBUG:write-attribute(name="suffix", value=".yyyy-MM-dd-HH")) {"outcome" => "success"} [standalone@localhost:9999 /]
- 周期ログハンドラーの削除
- 次の構文で
remove
操作を使用します。/subsystem=logging/periodic-rotating-file-handler=HANDLER:remove
HANDLER を周期ログハンドラーの名前と置き換えます。例11.38 周期ログハンドラーの削除
[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:remove {"outcome" => "success"} [standalone@localhost:9999 /]
11.3.6. CLI でのサイズログハンドラーの設定
- ログハンドラーの設定の表示
- 新しいログハンドラーの追加
- ハンドラーのログレベルの設定
- ハンドラーの追加動作の設定
- ハンドラーが自動フラッシュを使用するかどうかの設定
- ハンドラーの出力に使用されるエンコーディングの設定
- ログハンドラーが書き込むファイルの指定
- ハンドラーの出力に使用されるフォーマッターの設定
- 各ログファイルの最大サイズの設定
- 保持するバックアップログの最大数の設定
- ログハンドラーの削除
- ログハンドラーの設定の表示
- 次の構文で
read-resource
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:read-resource
HANDLER とログハンドラーの名前を置き換えます。例11.39 ログハンドラーの設定の表示
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:read-resource { "outcome" => "success", "result" => { "append" => true, "autoflush" => true, "encoding" => undefined, "file" => { "path" => "accounts_trace.log", "relative-to" => "jboss.server.log.dir" }, "filter" => undefined, "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n", "level" => undefined, "max-backup-index" => 1, "rotate-size" => "2m" } } [standalone@localhost:9999 /]
- 新しいログハンドラーの追加
- 次の構文で
add
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:add(file={"path"=>"accounts_trace.log", "relative-to"=>"jboss.server.log.dir"})
HANDLER をログハンドラーの名前と置き換えます。PATH をログが書き込まれるファイルのファイル名と置き換えます。DIR をファイルが存在するディレクトリーの名前と置き換えます。DIR の値をパス変数に指定できます。例11.40 新しいログハンドラーの追加
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:add(file={"path"=>"accounts_trace.log", "relative-to"=>"jboss.server.log.dir"}) {"outcome" => "success"} [standalone@localhost:9999 /]
- ハンドラーのログレベルの設定
- 次の構文で
change-log-level
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:change-log-level(level="TRACE")
HANDLER をログハンドラーの名前と置き換えます。LEVEL を、設定するログレベルと置き換えます。例11.41 ハンドラーのログレベルの設定
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:change-log-level(level="TRACE") {"outcome" => "success"} [standalone@localhost:9999 /]
- ハンドラーの追加動作の設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="append", value="BOOLEAN")
HANDLER をログハンドラーの名前と置き換えます。アプリケーション・サーバーが起動されるたびに新しいログファイルを作成する必要がある場合は、BOOLEAN をfalse
と置き換えます。アプリケーションサーバーが同じファイルを使用し続ける必要がある場合は、BOOLEAN をtrue
に置き換えます。この変更を反映するには、JBoss Enterprise Application Platform 6 を再起動する必要があります。例11.42 ハンドラーの追加動作の設定
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="append", value="true") { "outcome" => "success", "response-headers" => { "operation-requires-reload" => true, "process-state" => "reload-required" } } [standalone@localhost:9999 /]
- ハンドラーが自動フラッシュを使用するかどうかを設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN")
HANDLER をログハンドラーの名前と置き換えます。このハンドラーがすぐに出力を書き込む場合は、BOOLEAN をtrue
に置き換えます。例11.43 ハンドラーが自動フラッシュを使用するかどうかを設定
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="autoflush", value="true") {"outcome" => "success"} [standalone@localhost:9999 /]
- ハンドラーの出力に使用されるエンコーディングの設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="encoding", value="ENCODING")
HANDLER をログハンドラーの名前と置き換えます。ENCODING を必要な文字エンコーディングシステムの名前と置き換えます。例11.44 ハンドラーの出力に使用されるエンコーディングの設定
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="encoding", value="utf-8") {"outcome" => "success"} [standalone@localhost:9999 /]
- ログハンドラーが書き込むファイルの指定
- 次の構文で
change-file
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:change-file(file={"path"=>"PATH", "relative-to"=>"DIR"})
HANDLER をログハンドラーの名前と置き換えます。PATH をログが書き込まれるファイルのファイル名と置き換えます。DIR をファイルが存在するディレクトリーの名前と置き換えます。DIR の値をパス変数に指定できます。例11.45 ログハンドラーが書き込むファイルの指定
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:change-file(file={"path"=>"accounts_trace.log", "relative-to"=>"jboss.server.log.dir"}) {"outcome" => "success"} [standalone@localhost:9999 /]
- ハンドラーの出力に使用されるフォーマッターの設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="formatter", value="FORMATTER")
HANDLER をログハンドラーの名前と置き換えます。FORMAT を必要なフォーマッター文字列に置き換えます。例11.46 ハンドラーの出力に使用されるフォーマッターの設定
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p (%c) [%t] %s%E%n") {"outcome" => "success"} [standalone@localhost:9999 /]
- 各ログファイルの最大サイズの設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="rotate-size", value="SIZE")
HANDLER をログハンドラーの名前と置き換えます。SIZE を最大ファイルサイズと置き換えます。例11.47 各ログファイルの最大サイズの設定
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="rotate-size", value="50m") {"outcome" => "success"} [standalone@localhost:9999 /]
- 保持するバックアップログの最大数の設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:write-attribute(name="max-backup-index", value="NUMBER")
HANDLER をログハンドラーの名前と置き換えます。NUMBER を、保持するログファイルの必要な数に置き換えます。例11.48 保持するバックアップログの最大数の設定
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:write-attribute(name="max-backup-index", value="5") {"outcome" => "success"} [standalone@localhost:9999 /]
- ログハンドラーの削除
- 次の構文で
remove
操作を使用します。/subsystem=logging/size-rotating-file-handler=HANDLER:remove
HANDLER とログハンドラーの名前を置き換えます。例11.49 ログハンドラーの削除
[standalone@localhost:9999 /] /subsystem=logging/size-rotating-file-handler=ACCOUNTS_TRACE:remove {"outcome" => "success"} [standalone@localhost:9999 /]
11.3.7. CLI での非同期ログハンドラーの設定
- 非同期ログハンドラーの設定の表示
- 新しい非同期ログハンドラーの追加
- ログレベルの変更
- キューの長さの設定
- オーバーフローアクションの設定
- サブハンドラーの追加
- サブハンドラーの削除
- 非同期ログハンドラーの削除
- 非同期ログハンドラーの設定の表示
- 次の構文で
read-resource
操作を使用します。/subsystem=logging/async-handler=HANDLER:read-resource
HANDLER をログハンドラーの名前に置き換えます。例11.50
[standalone@localhost:9999 /] /subsystem=logging/async-handler=NFS_LOGS:read-resource { "outcome" => "success", "result" => { "encoding" => undefined, "filter" => undefined, "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n", "level" => undefined, "overflow-action" => "BLOCK", "queue-length" => "50", "subhandlers" => undefined } } [standalone@localhost:9999 /]
- 新しい非同期ログハンドラーの追加
- 次の構文で
add
操作を使用します。/subsystem=logging/async-handler=HANDLER:add(queue-length="LENGTH")
HANDLER をログハンドラーの名前と置き換えます。LENGTH を、キューに保持できるログ要求の最大数と置き換えます。例11.51
[standalone@localhost:9999 /] /subsystem=logging/async-handler=NFS_LOGS:add(queue-length="10") {"outcome" => "success"} [standalone@localhost:9999 /]
- ログレベルの変更
- 次の構文で
change-log-level
操作を使用します。/subsystem=logging/async-handler=HANDLER:change-log-level(level="LEVEL")
HANDLER をログハンドラーの名前と置き換えます。LEVEL を、設定するログレベルと置き換えます。例11.52
[standalone@localhost:9999 /] /subsystem=logging/async-handler=NFS_LOGS:change-log-level(level="INFO") {"outcome" => "success"} [standalone@localhost:9999 /]
- キューの長さの設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/async-handler=HANDLER:write-attribute(name="queue-length", value="LENGTH")
HANDLER をログハンドラーの名前と置き換えます。LENGTH を、キューに保持できるログ要求の最大数と置き換えます。この変更を反映するには、JBoss Enterprise Application Platform 6 を再起動する必要があります。例11.53
[standalone@localhost:9999 /] /subsystem=logging/async-handler=NFS_LOGS:write-attribute(name="queue-length", value="150") { "outcome" => "success", "response-headers" => { "operation-requires-reload" => true, "process-state" => "reload-required" } } [standalone@localhost:9999 /]
- オーバーフローアクションの設定
- 次の構文で
write-attribute
操作を使用します。/subsystem=logging/async-handler=HANDLER:write-attribute(name="overflow-action", value="ACTION")
HANDLER をログハンドラーの名前と置き換えます。ACTION を DISCARD または BLOCK と置き換えます。例11.54
[standalone@localhost:9999 /] /subsystem=logging/async-handler=NFS_LOGS:write-attribute(name="overflow-action", value="DISCARD") {"outcome" => "success"} [standalone@localhost:9999 /]
- サブハンドラーの追加
- 次の構文で
assign-subhandler
操作を使用します。/subsystem=logging/async-handler=HANDLER:assign-subhandler(name="SUBHANDLER")
HANDLER をログハンドラーの名前と置き換えます。SUBHANDLER を、この非同期ハンドラーのサブハンドラーとして追加するログハンドラーの名前と置き換えます。例11.55
[standalone@localhost:9999 /] /subsystem=logging/async-handler=NFS_LOGS:assign-subhandler(name="NFS_FILE") {"outcome" => "success"} [standalone@localhost:9999 /]
- サブハンドラーの削除
- 次の構文で
unassign-subhandler
操作を使用します。/subsystem=logging/async-handler=HANDLER:unassign-subhandler(name="SUBHANDLER")
HANDLER をログハンドラーの名前と置き換えます。SUBHANDLER を、削除するサブハンドラーの名前と置き換えます。例11.56
[standalone@localhost:9999 /] /subsystem=logging/async-handler=NFS_LOGS:unassign-subhandler(name="NFS_FILE") {"outcome" => "success"} [standalone@localhost:9999 /]
- 非同期ログハンドラーの削除
- 次の構文で
remove
操作を使用します。/subsystem=logging/async-handler=HANDLER:remove
HANDLER をログハンドラーの名前に置き換えます。例11.57
[standalone@localhost:9999 /] /subsystem=logging/async-handler=NFS_LOGS:remove {"outcome" => "success"} [standalone@localhost:9999 /]
11.4. ロギング設定プロパティー
11.4.1. ルートロガーのプロパティー
表11.5 ルートロガーのプロパティー
プロパティー | データタイプ | 説明 |
---|---|---|
level | 文字列 |
ルートロガーが記録するログメッセージの最大レベル。
|
handlers | 文字列の一覧 |
ルートロガーによって使用されるログハンドラーの一覧。
|
11.4.2. ログカテゴリのプロパティ
表11.6
プロパティ | データタイプ | 説明 |
---|---|---|
level | 文字列 |
ログカテゴリが記録するログメッセージの最大レベル
|
handlers | 文字列の一覧 |
root ロガーによって使用されるログハンドラーの一覧
|
use-parent-handlers | ブール値 |
true に設定した場合、このカテゴリは割り当てられた他のハンドラー以外にも、root ロガーのログハンドラーを使用します。
|
category | 文字列 |
ログメッセージがキャプチャーされるログカテゴリ
|
11.4.3. コンソールログハンドラーのプロパティー
表11.7 コンソールログハンドラーのプロパティー
プロパティー | データタイプ | 説明 |
---|---|---|
level | 文字列 |
ログハンドラーが記録するログメッセージの最大レベル。
|
encoding | 文字列 |
出力に使用される文字エンコーディングスキーム。
|
formatter | 文字列 |
このログハンドラーで使用するログフォーマッター。
|
target | 文字列 |
ログハンドラーの出力先となるシステム出力ストリーム。これは システムエラーストリームの場合は System.err、標準出力ストリームの場合は System.out とすることができます。
|
autoflush | ブール値 |
true に設定すると、ログメッセージは受信直後にハンドラーのターゲットに送信されます。
|
name | 文字列 |
このログハンドラーの一意の ID。
|
11.4.4. ファイルログハンドラープロパティー
表11.8 ファイルログハンドラープロパティー
プロパティー | タイプ | 詳細 |
---|---|---|
level | 文字列 |
ログハンドラーが記録するログメッセージの最大レベル。
|
encoding | 文字列 |
出力に使用する文字エンコーディングスキーム。
|
formatter | 文字列 |
このログハンドラーが使用するログフォーマッター。
|
append | ブール値 |
true に設定された場合、このハンドラーが書き込んだすべてのメッセージがファイル (すでに存在する場合) に追加されます。false に設定された場合、アプリケーション・サーバーが起動されるたびに、新しいファイルが作成されます。
append に対する変更を反映するには、サーバーを再起動する必要があります。
|
autoflush | ブール値 |
true に設定された場合は、受信直後にハンドラーにより割り当てられたファイルに送信されます。
autoflush に対する変更を反映するには、サーバーを再起動する必要があります。
|
name | 文字列 |
このログハンドラーの一意の ID
|
file | オブジェクト |
このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、
relative-to と path の 2 つの設定プロパティーが含まれます。
|
relative-to | 文字列 |
これは、ファイルオブジェクトのプロパティーであり、ログファイルが書き込まれるディレクトリーです。ここでは、JBoss Enterprise Application Platform 6 ファイルパス変数を指定できます。
jboss.server.log.dir 変数はサーバーの log/ ディレクトリーを示します。
|
path | 文字列 |
これは、ファイルオブジェクトのプロパティーであり、ログメッセージが書き込まれるファイルの名前です。これは、完全パスを決定するために、
relative-to プロパティーの値に追加されます。
|
11.4.5. 周期ログハンドラープロパティー
表11.9 周期ログハンドラープロパティー
プロパティー | タイプ | 詳細 |
---|---|---|
append | boolean |
true に設定された場合は、このハンドラーが記述したすべてのメッセージがファイル (すでに存在する場合) に追加されます。false に設定された場合は、アプリケーションサーバーが起動されるたびに、新しいファイルが作成されます。append に対する変更を反映するには、サーバーを再起動する必要があります。
|
autoflush | boolean |
true に設定された場合は、受信直後にハンドラーにより割り当てられたファイルに送信されます。append に対する変更を反映するには、サーバーを再起動する必要があります。
|
encoding | string |
出力に使用する文字エンコーディングスキーム
|
formatter | string |
このログハンドラーが使用するログフォーマッター
|
level | string |
ログハンドラーが記録するログメッセージの最大レベル
|
name | string |
こログハンドラーの一意の ID
|
file | object |
このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、
relative-to と path の 2 つの設定プロパティーが含まれます。
|
relative-to | string |
これは、ファイルオブジェクトのプロパティーであり、ログファイルが書き込まれるディレクトリーです。ここでは、ファイルパス変数を指定できます。
jboss.server.log.dir 変数はサーバーの log/ ディレクトリーを参照します。
|
path | string |
これは、ファイルオブジェクトのプロパティーであり、ログメッセージが書き込まれるファイルの名前です。これは、完全パスを決定するために、
relative-to プロパティーの値に追加される相対パス名です。
|
suffix | string |
これは、ローテーションされたログのファイル名に追加され、ローテーションの周期を決定するために使用される文字列です。この接尾辞の形式では、ドット (.) の後に、
java.text.SimpleDateFormat クラスで解析できる日付文字列が指定されます。ログは接尾辞で定義された最小時間単位に基づいてローテーションされます。たとえば、接尾辞が .yyyy-MM-dd の場合は、毎日ログがローテーションされます。
|
11.4.6. サイズログハンドラープロパティー
表11.10 サイズログハンドラープロパティー
プロパティー | タイプ | 詳細 |
---|---|---|
append | boolean |
true に設定された場合、このハンドラーが書き込んだすべてのメッセージがファイル (すでに存在する場合) に追加されます。false に設定された場合、アプリケーション・サーバーが起動されるたびに、新しいファイルが作成されます。append に対する変更を反映するには、サーバーを再起動する必要があります。
|
autoflush | boolean |
true に設定された場合は、受信直後にハンドラーにより割り当てられたファイルに送信されます。append に対する変更を反映するには、サーバーを再起動する必要があります。
|
encoding | 文字列 |
出力に使用する文字エンコーディングスキーム。
|
formatter | 文字列 |
このログハンドラーが使用するログフォーマッター。
|
level | 文字列 |
ログハンドラーが記録するログメッセージの最大レベル。
|
name | 文字列 |
このログハンドラーの一意の ID。
|
file | オブジェクト |
このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、
relative-to と path の 2 つの設定プロパティーが含まれます。
|
relative-to | 文字列 |
これは、ファイルオブジェクトのプロパティーであり、ログファイルが書き込まれるディレクトリーです。ここでは、ファイルパス変数を指定できます。
jboss.server.log.dir 変数はサーバーの log/ ディレクトリーを示します。
|
path | 文字列 |
これは、ファイルオブジェクトのプロパティーであり、ログメッセージが書き込まれるファイルの名前です。これは、完全パスを決定するために、
relative-to プロパティーの値に追加されます。
|
rotate-size | 整数 |
ログ・ファイルがローテーションされる前に到達できる最大サイズ。数字に追加された単一文字はサイズ単位を示します。バイトの場合は
b 、キロバイトの場合は k 、メガバイトの場合は m 、ギガバイトの場合は g になります。たとえば、50 メガバイトの場合は、50m になります。
|
max-backup-index | 整数 |
保持されるローテーションログの最大数。この数字に達すると、最も古いログが再利用されます。
|
11.4.7. 同期ログハンドラープロパティー
表11.11 同期ログハンドラープロパティー
プロパティー | タイプ | 詳細 |
---|---|---|
level | 文字列 |
ログハンドラーが記録するログメッセージの最大レベル。
|
name | 文字列 |
このログハンドラーの一意の ID。
|
Queue-length | 整数 |
サブハンドラーが応答するときに、このハンドラーが保持するログメッセージの最大数。
|
overflow-action | 文字列 |
キューの長さを超えたときにこのハンドラーがどのように応答するか。これは
BLOCK または DISCARD に設定できます。BLOCK により、キューでスペースが利用可能になるまでロギングアプリケーションが待機します。これは、非同期でないログハンドラーと同じ動作です。DISCARD により、ロギングアプリケーションは動作し続けますが、ログメッセージは削除されます。
|
subhandlers | 文字列の一覧 |
これは、この非同期ハンドラーがログメッセージを渡すログハンドラーの一覧です。
|
11.5. ロギング用 XML 設定例
11.5.1. Root Logger の XML 設定例
<subsystem xmlns="urn:jboss:domain:logging:1.1"> <root-logger> <level name="INFO"/> <handlers> <handler name="CONSOLE"/> <handler name="FILE"/> </handlers> </root-logger> </subsystem>
11.5.2. ログカテゴリーの XML 設定例
<subsystem xmlns="urn:jboss:domain:logging:1.1"> <logger category="com.company.accounts.rec"> <handlers> <handler name="accounts-rec"/> </handlers> </logger> </subsystem>
11.5.3. コンソールログハンドラーの XML 設定例
<subsystem xmlns="urn:jboss:domain:logging:1.1"> <console-handler name="CONSOLE"> <level name="INFO"/> <formatter> <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/> </formatter> </console-handler> </subsystem>
11.5.4. ファイルログハンドラーの XML 設定例
<file-handler name="accounts-rec-trail" autoflush="true"> <level name="INFO"/> <file relative-to="jboss.server.log.dir" path="accounts-rec-trail.log"/> <append value="true"/> </file-handler>
11.5.5. 定期ログハンドラーの XML 設定例
<periodic-rotating-file-handler name="FILE"> <formatter> <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/> </formatter> <file relative-to="jboss.server.log.dir" path="server.log"/> <suffix value=".yyyy-MM-dd"/> <append value="true"/> </periodic-rotating-file-handler>
11.5.6. サイズログハンドラーの XML 設定例
<size-rotating-file-handler name="accounts_debug" autoflush="false"> <level name="DEBUG"/> <file relative-to="jboss.server.log.dir" path="accounts-debug.log"/> <rotate-size value="500k"/> <max-backup-index value="5"/> <append value="true"/> </size-rotating-file-handler>
11.5.7. 非同期ログハンドラーの XML 設定例
<async-handler name="Async_NFS_handlers"> <level name="INFO"/> <queue-length value="512"/> <overflow-action value="block"/> <subhandlers> <handler name="FILE"/> <handler name="accounts-record"/> </subhandlers> </async-handler>
第12章 JVM
12.1. JVM について
12.1.1. JVM 設定について
host.xml
および domain.xml
設定ファイルで宣言され、サーバープロセスを起動および停止するドメインコントローラーコンポーネントにより決定されます。スタンドアロンサーバーインスタンスでは、サーバー起動プロセスで起動時にコマンドライン設定を渡すことができます。これらは、管理コンソールのコマンドラインまたは System Properties 画面で宣言できます。
監理対象ドメインの重要な機能は、JVM 設定を複数のレベルで定義できることです。サーバーグループまたはサーバーインスタンスによって、ホストレベルでカスタム JVM 設定を指定できます。特別な子要素は親設定よりも優先され、グループまたはホストレベルで除外せずに特定のサーバー設定を宣言できます。これにより、設定が設定ファイルで宣言されるか、実行時に渡されるまで、親設定は他のレベルで継承できます。
例12.1 ドメイン設定ファイルの JVM 設定
domain.xml
設定ファイルの、サーバーグループに対する JVM 宣言を示しています。
<server-groups> <server-group name="main-server-group" profile="default"> <jvm name="default"> <heap size="64m" max-size="512m"/> </jvm> <socket-binding-group ref="standard-sockets"/> </server-group> <server-group name="other-server-group" profile="default"> <jvm name="default"> <heap size="64m" max-size="512m"/> </jvm> <socket-binding-group ref="standard-sockets"/> </server-group> </server-groups>
main-server-group
という名前のサーバーグループが 64 メガバイトのヒープサイズと 512 メガバイトの最大ヒープサイズを宣言しています。このグループに属するすべてのサーバーは、これらの設定を継承します。これらの設定は、グループ全体、ホスト、または個別サーバーで変更できます。
例12.2 ホスト設定ファイルのドメイン設定
host.xml
設定ファイルの、サーバーグループに対する JVM 宣言を示しています。
<servers> <server name="server-one" group="main-server-group" auto-start="true"> <jvm name="default"/> </server> <server name="server-two" group="main-server-group" auto-start="true"> <jvm name="default"> <heap size="64m" max-size="256m"/> </jvm> <socket-binding-group ref="standard-sockets" port-offset="150"/> </server> <server name="server-three" group="other-server-group" auto-start="false"> <socket-binding-group ref="standard-sockets" port-offset="250"/> </server> </servers>
server-two
おちう名前のサーバーが、main-server-group
という名前のサーバーグループに属し、default
JVM グループから JVM 設定を継承します。以前の例では、main-server-group
のメインヒープサイズは 512 メガバイトに設定されていました。256 メガバイトの小さい最大ヒープサイズを宣言すると、server-two
が domain.xml
設定よりも優先され、必要に応じてパフォーマンスを微調整できます。
スタンドアロンサーバーインスタンスの JVM 設定は、実行時にコマンドライン引数として宣言できます。または、JVM 設定は、JVM に渡すオプションのサンプルが含まれる EAP_HOME/bin
フォルダーにある standalone.conf
ファイルに追加できます。
12.1.2. 管理コンソールで JVM の状態を表示する
要件
表12.1 JVM 状態属性
タイプ | 説明 |
---|---|
Max | メモリー管理に使用できるメモリーの最大量 (バイト単位) です。 |
Used | 使用されたメモリーの量 (メガバイト単位) です。 |
Committed | Java 仮想マシンが使用するために確保されたメモリー量 (バイト単位) です。 |
Init | メモリー管理に関し、Java 仮想マシンが最初にオペレーティングシステムより要求するバイト単位のメモリー量です。 |
JVM の状態の表示
JVM の状態はスタンドアロンサーバーか管理ドメインに表示することができます。スタンドアロンサーバーインスタンスに対して JVM の状態を表示する
Runtime 画面上の Server Status メニューより JVM Status を選択します。図12.1 スタンドアロンサーバーインスタンスの JVM の状態
管理ドメインに対して JVM の状態を表示する
ランタイムスクリーンのドメイン状態メニューより JVM 状態を選択します。- 管理ドメインはサーバーグループの全サーバーインスタンスを表示できますが、サーバーメニューより選択し、一度に 1 つのサーバーのみを表示することができます。サーバーグループの他のサーバーの状態を表示するには、画面の左上にあるドロップダウンボックスをクリックしてグループに表示されるホストとサーバーより選択を行い、Done ボタンをクリックして結果をロードします。
図12.2 管理ドメインの JVM 状態サーバーメニュー
サーバーインスタンスに対する JVM 設定の状態が表示されます。
第13章 HTTP クラスタリングおよび負荷分散
13.1. はじめに
13.1.1. 高可用性および負荷分散クラスターについて
- アプリケーションサーバーのインスタンス
- Web サーバー (内部 JBoss Web サーバー、Apache HTTPD、 Microsoft IIS、 Oracle iPlanet Web Server、Apache Tomcat)
- ステートフル、ステートレス、およびエンティティー Enterprise JavaBean (EJB)
- JNDI サービス
- シングルサインオン (SSO) メカニズム
- 分散キャッシュ
- HTTP セッション
- JMS サービスおよびメッセージ駆動型 Bean (MDB)
13.1.2. 高可用性が有益なコンポーネント
エンタープライズアプリケーションサーバーのインスタンス (スタンドアローンサーバーとして実行) あるいはサーバーグループのメンバー (管理ドメインの一部として実行) を高可用として設定することができます。つまり、インスタンスあるいはメンバーを停止した場合、あるいはクラスターから消えた場合、そのFUKA がピアに移行されます。負荷は、負荷分散機能を提供するかたちで管理できるため、リソースを多く持つあるいは、より良いリソースを持つサーバーやサーバーグループが他よりも大きい負荷を取ることができるようになるか、あるいは負荷が高い時間には容量を追加できるようになります。
互換性のある負荷分散メカニズムの1つを使うことで、Web サーバー自体も HA 用にクラスター化できます。最も柔軟なのはmod_cluster
コネクターで Enterprise Application Platform のコンテナーと密統合されています。他の選択肢として、Apache mod_jk
あるいは mod_proxy
コネクタあるいは ISAPI および NSAPI コネクターなどがあります。
データソースおよび他のリソースも高可用とすることができます。シリアル化可能なオブジェクトをバインドでき、クラスター内の全ノードで利用できるように、HA-JNDI はグローバルコンテキストを提供します。
Java Enterprise Edition 6 (Java EE 6) 仕様があるため、デプロイされたアプリケーションを高可用にすることができます。作業に関わったノードが消えた場合に別のノードが引き継げるように、ステートレスあるいはステートフルセッション EJB はクラスター化が可能です。ステートフルセッション Bean の場合はステータスが保たれます。
13.1.3. HTTP コネクターの概要
表13.1 HTTP コネクター機能および制約
コネクター | Web サーバー | サポート対象オペレーティングシステム | サポート対象プロトコル | デプロイメント ステータスへの変更 | スティッキーセッションのサポート |
---|---|---|---|---|---|
mod_cluster | JBoss Enterprise Web Server HTTPD | Red Hat Enterprise Linux、Microsoft Windows Server | HTTP、HTTPS | はい。アプリケーションのデプロイメントとデプロイメント解除を検出し、アプリケーションがそのサーバーにデプロイされたかどうかに基づいて、サーバーにクライアント要求を送信するかどうかを動的に決定します。 | はい |
mod_jk | JBoss Enterprise Web Server HTTPD、Apache HTTPD | Red Hat Enterprise Linux、Microsoft Windows Server(JBoss Enterprise Web Server を使用している場合) | AJP | いいえ。アプリケーションステータスに関係なく、コンテナーが利用可能な限り、クライアント要求をコンテナーに送信します。 | はい |
mod_proxy | JBoss Enterprise Web Server HTTPD、Apache HTTPD | Red Hat Enterprise Linux、Microsoft Windows Server(JBoss Enterprise Web Server を使用している場合) | HTTP、HTTPS | いいえ。アプリケーションステータスに関係なく、コンテナーが利用可能な限り、クライアント要求をコンテナーに送信します。 | はい |
ISAPI | Microsoft IIS | Microsoft Windows Server | AJP | いいえ。アプリケーションステータスに関係なく、コンテナーが利用可能な限り、クライアント要求をコンテナーに送信します。 | はい |
NSAPI | Sun Java System Web Server | Oracle Solaris | AJP | いいえ。アプリケーションステータスに関係なく、コンテナーが利用可能な限り、クライアント要求をコンテナーに送信します。 | はい |
各 HTTP コネクターの詳細について
13.1.4. ワーカーノード
ワーカーノードは、1 つまたは複数のクライアント向け HTTPD サーバーから要求を受け入れる JBoss Enterprise Application Platform サーバーで、単に ノード と呼ばれることもあります。JBoss Enterprise Application Platform は独自の HTTPD、JBoss Enterprise Web Server に同梱された HTTPD、Apache HTTPD、Microsoft IIS、または Oracle iPlanet Web Server (以前の Netscape Web Server) から要求を受け入れることができます。
クラスターノードはサーバーのクラスターのメンバーです。このようなクラスターは、負荷分散、高可用性、またはその両方です。負荷分散クラスターでは、中央マネージャーが状況固有の均等性の単位を使用してノード間で負荷を均等に分散します。高可用性クラスターでは、一部のノードがアクティブに処理を行い、他のノードはアクティブなノードのいずれかがクラスターから離れるまで待機します。
13.2. 全般設定
13.2.1. サブシステム設定の概要
JBoss Enterprise Application Platform 6 は単純化された設定を使用します (ドメインごとまたはスタンドアロンサーバーごとに 1 つの設定ファイルを使用)。スタンドアロンドメインでは、各ホストコントローラーに対しても個別のファイルが存在します。設定の変更は自動的に保持されるため、XML を手動で編集する必要はありません。設定は、管理 API により自動的にスキャンされ、上書きされます。コマンドラインベースの管理 CLI および Web ベースの管理コンソールにより、JBoss Enterprise Application Platform の各側面を設定することができます。
EAP_HOME/domain/configuration/domain.xml
、スタンドアロンサーバーの場合には EAP_HOME/standalone/configuration/standalone.xml
という統合設定ファイルに保管されます。多くのサブシステムには、以前の JBoss Enterprise Application Platform の旧バージョンでデプロイメント記述子に追加された設定詳細が含まれます。
各サブシステムの設定は XML スキーマで定義されます。設定スキーマは、ご使用のインストールの EAP_HOME/docs/schema/
ディレクトリにあります。
簡易サブシステム
ee
– Java EE 6 API 実装ejb
– Enterprise JavaBeans (EJB) サブシステムjaxrs
– RESTeasy によって提供される JAX-RS APIsar
– サービスアーカイブをサポートするサブシステムthreads
– プロセススレッドをサポートするサブシステムweld
– Weld によって提供される Contexts and Dependency Injection API
13.2.2. Web サブシステムの設定
Web ベース管理コンソールを使用して Web サブシステムを設定するには、右上の Profiles タブをクリックします。監理対象ドメインの場合は、左上の Profile 選択ボックスから設定するサーバープロファイルを選択します。Subsystems メニューを展開し、Web メニューを展開します。Web サブシステムの設定可能な各部分が表示されます。
注記
ha
または full-ha
である場合、またはstandalone-ha
プロファイルでスタンドアロンサーバーを起動する場合にのみ利用できます。mod_cluster 設定については、「mod_cluster
サブシステムの設定」 を参照してください。
JSP コンテナー、HTTP コネクター、および仮想 HTTP サーバーを設定するには、Servlet/HTTP メニューエントリーをクリックします。Edit ボタンをクリックして任意の値を変更します。Advanced ボタンをクリックして高度なオプションを表示します。これらのオプションについては以下で説明されています。HTTP コネクターおよび仮想サーバーのオプションは、別の表で示されます。
表13.2 サーブレット/HTTP 設定オプション
オプション | 説明 | CLI コマンド |
---|---|---|
無効になっていますか? | true の場合は、Java ServerPages (JSP) コンテナーを無効にします。デフォルトで false に設定されます。これは、Java ServerPages (JSPs) を使用しない場合に役に立ちます。
|
/profile=full-ha/subsystem=web/configuration=jsp-configuration/:write-attribute(name=disabled,value=false) |
開発ですか? |
true の場合は、Development Mode を有効にします。この場合、より冗長なデバッグ情報が生成されます。デフォルトで
false に設定されます。
|
/profile=full-ha/subsystem=web/configuration=jsp-configuration/:write-attribute(name=development,value=false) |
生成しますか? |
Advanced をクリックしてオプションを確認します (非表示である場合)。
true の場合は、生成されたサーブレットを保持します。デフォルトで有効になります。
|
/profile=full-ha/subsystem=web/configuration=jsp-configuration/:write-attribute(name=keep-generated,value=true) |
間隔をチェックしますか? |
Advanced をクリックしてオプションを確認します (非表示である場合)。バックグラウンドプロセスを使用して JSP の更新をチェックする頻度を決める値 (秒単位)。デフォルトで
0 に設定されます。
|
/profile=full-ha/subsystem=web/configuration=jsp-configuration/:write-attribute(name=check-interval,value=0) |
ソースを表示しますか? |
Advanced をクリックしてこのオプションを確認します (非表示である場合)。
true の場合、ランタイムエラーが発生すると、JSP ソース断片が表示されます。デフォルトで true に設定されます。
|
/profile=full-ha/subsystem=web/configuration=jsp-configuration/:write-attribute(name=display-source-fragment,value=true) |
mod_cluster
、mod_jk
、mod_proxy
、ISAPI
、NSAPI
などの高可用性クラスターのために使用されます。HTTP コネクターを設定するには、Connectors タブを選択し、Add をクリックします。HTTP コネクターを削除するには、エントリーを選択し、Remove をクリックします。HTTP コネクターを編集するには、エントリーを選択し、Edit をクリックします。
例13.1 新しいコネクターの作成
/profile=full-ha/subsystem=web/connector=ajp/:add(socket-binding=ajp,scheme=http,protocol=AJP/1.3,secure=false,name=ajp,max-post-size=2097152,enabled=true,enable-lookups=false,redirect-port=8433,max-save-post-size=4096)
表13.3 コネクターオプション
オプション | 説明 | CLI コマンド |
---|---|---|
名前 |
表示目的のコネクターの一意な名前。
|
/profile=full-ha/subsystem=web/connector=ajp/:write-attribute(name=name,value=ajp) |
ソケットバインディング |
コネクターがバインドする必要がある名前付きソケットバインディング。ソケットバインディングは、ソケット名とネットワークポート間のマッピングです。各スタンドアロンサーバーのためにソケットバインディングが設定されます (または、監理対象ドメインのソケットバインディンググループを使用)。ソケットバインディンググループはサーバーグループに適用されます。
|
/profile=full-ha/subsystem=web/connector=ajp/:write-attribute(name=socket-binding,value=ajp) |
スキーム |
HTTP や HTTPS などの Web コネクタースキーム。
|
/profile=full-ha/subsystem=web/connector=ajp/:write-attribute(name=scheme,value=http) |
プロトコル |
AJP や HTTP などの、使用する Web コネクタープロトコル。
|
/profile=full-ha/subsystem=web/connector=ajp/:write-attribute(name=protocol,value=AJP/1.3) |
有効 |
この Web コネクターが有効であるかどうか。
|
/profile=full-ha/subsystem=web/connector=ajp/:write-attribute(name=enabled,value=true) |
例13.2 新しい仮想サーバーの追加
/profile=full-ha/subsystem=web/virtual-server=default-host/:add(enable-welcome-root=true,default-web-module=ROOT.war,alias=["localhost","example.com"],name=default-host)
表13.4 仮想サーバーオプション
オプション | 説明 | CLI コマンド |
---|---|---|
名前 |
表示目的の仮想サーバーの一意な名前。
|
/profile=full-ha/subsystem=web/virtual-server=default-host/:write-attribute(name=name,value=default-host) |
エイリアス |
この仮想サーバーに一致する必要があるホスト名のリスト。管理コンソールで、1 行あたり 1 つのホスト名を使用します。
|
/profile=full-ha/subsystem=web/virtual-server=default-host/:write-attribute(name=alias,value=["localhost","example.com"]) |
デフォルトモジュール |
Web アプリケーションをこの仮想サーバーのルートノードにデプロイする必要があるモジュールであり、ディレクトリーが HTTP 要求で提供されない場合に表示されます。
|
/profile=full-ha/subsystem=web/virtual-server=default-host/:write-attribute(name=default-web-module,value=ROOT.war) |
Web サービスオプションを設定するには、Web Services メニュー項目をクリックします。オプションは、以下の表で説明されます。
表13.5 Web サービス設定オプション
オプション | 説明 | CLI コマンド |
---|---|---|
WSDL アドレスの変更 |
WSDL アドレスをアプリケーションで変更できるかどうか。デフォルトで
true に設定されます。
|
/profile=full-ha/subsystem=webservices/:write-attribute(name=modify-wsdl-address,value=true) |
WSDL ホスト |
JAX-WS Web サービスの WSDL コントラクトには、エンドポイントの場所を示す <soap:address< 要素が含まれます。 <soap:address> の値が有効な URL の場合は、
modify-wsdl-address が true に設定されない限り、上書きされません。<soap:address> の値が有効な URL の場合は、wsdl-host の値と wsdl-port または wsdl-secure-port を使用して上書きされます。wsdl-host が jbossws.undefined.host に設定されている場合は、<soap-address> が書き換えられたときに要求側のホストアドレスが使用されます。デフォルトで ${jboss.bind.address:127.0.0.1} に設定されます。JBoss Enterprise Application Platform が起動されたときにバインドアドレスが指定されてない場合は、127.0.0.1 を使用します。
|
/profile=full-ha/subsystem=webservices/:write-attribute(name=wsdl-host,value=${jboss.bind.address:127.0.0.1}) |
WSDL ポート |
SOAP アドレスを書き換えるために使用されるセキュアでないポート。これが
0 (デフォルト値) に設定された場合、ポートはインストール済みコネクターのリストを問い合わせることにより識別されます。
|
/profile=full-ha/subsystem=webservices/:write-attribute(name=wsdl-port,value=80) |
WSDL セキュアポート |
SOAP アドレスを書き換えるために使用されるセキュアポート。これが
0 (デフォルト値) に設定された場合、ポートはインストール済みコネクターのリストを問い合わせることにより識別されます。
|
/profile=full-ha/subsystem=webservices/:write-attribute(name=wsdl-secure-port,value=443) |
13.2.3. JBoss Enterprise Application Platform Web Server での SSL 暗号化の実装
多くの Web アプリケーションでは、クライアントとサーバー間で SSL 暗号化接続 (HTTPS
接続とも呼ばれます) が必要です。以下の手順を使用すると、サーバーまたはサーバーグループで HTTPS
を有効にできます。
前提条件
- SSL 暗号化キーセットっと SSL 暗号化証明書が必要です。これらは、証明書署名認証局から購入したり、コマンドラインユーティリティーを使用して生成したりできます。Red Hat Enterprise Linux ユーティリティーを使用して暗号化キーを生成するには、「SSL 暗号化キーおよび証明書の生成」を参照してください。
- 特定の環境とセットアップについて以下の詳細を知る必要があります。
- 証明書ファイルに対する完全ディレクトリー名およびパス。
- 暗号化キーの暗号化パスワード。
- 管理 CLI を実行し、ドメインコントローラまたはスタンドアロンサーバーに接続する必要があります。
注記
/profile=default
を削除して管理 CLI コマンドを変更します。
手順13.1 JBoss Web Server が HTTPS を使用するよう設定
Web 設定領域に移動します。
Web ベースの管理 CLI を使用して、右上にある Profiles 項目 (スタンドアロンサーバーでは Profile と示されます) を選択します。管理対象ドメインを使用する場合は、左上にある選択ボックスから正しいプロファイルを選択します。Subsystems メニューの Web サブメニューをクリックします。メニューが展開されたら、Servlet/HTTP 項目をクリックします。新しい HTTPS コネクターを追加します。
コマンドライン管理 CLI スクリプトEAP_HOME/bin/jboss-cli.sh
を使用して、以下のコマンドを実行して、プロファイルを適切に変更します。これにより、HTTPS
という名前の新しいセキュアコネクターが作成されます。これはhttps
スキーム、https
ソケットバインディング (デフォルト値は8443
) を使用し、セキュアに設定されます。例13.3 管理 CLI コマンド
/profile=default/subsystem=web/connector=HTTPS/:write-attribute(name=name,value=HTTPS) /profile=default/subsystem=web/connector=HTTPS/:write-attribute(name=socket-binding,value=https) /profile=default/subsystem=web/connector=HTTPS/:write-attribute(name=protocol,value=HTTP/1.1) /profile=default/subsystem=web/connector=HTTPS/:write-attribute(name=scheme,value=https) /profile=default/subsystem=web/connector=HTTPS/:write-attribute(name=secure,value=true)
SSL 暗号化証明書およびキーを設定します。
以下の CLI コマンドを実行して SSL 証明書を設定し、例の独自の値を置換します。例13.4 管理 CLI コマンド
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=name,value=https) /profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=password,value=password) /profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=certificate-key-file,value=../domain/configuration/server.keystore)
コネクターの SSL プロパティーに設定できるパラメーターの完全な一覧については、「SSL コネクターリファレンス」を参照してください。オプション: 仮想サーバーの追加
必要な場合は、セキュアなコンテンツを提供する仮想サーバーを追加します。以下のコマンドにより、以下で説明された値が設定されます。- 名前:
secure-example
- エイリアス:
secure.example.com
- デフォルトモジュール:
ROOT.war
例13.5 管理 CLI コマンド
/profile=default/subsystem=web/virtual-server=secure-example/:write-attribute(name=name,value=secure-example) /profile=default/subsystem=web/virtual-server=secure-example/:write-attribute(name=alias,value=["secure.example.com"]) /profile=default/subsystem=web/virtual-server=secure-example/:write-attribute(name=default-web-module,value=ROOT.war)
アプリケーションをデプロイします。
設定したプロファイルを使用するサーバーグループにアプリケーションをデプロイします。スタンドアロンサーバーを使用する場合、アプリケーションをサーバーにデプロイします。アプリケーションに対する HTTP 要求は新しい SSL 暗号化接続を使用します。
13.2.4. SSL 暗号化キーおよび証明書の生成
前提条件
- Java 開発キット実装で提供される
keytool
ユーティリティーが必要です。このコマンドは、Red Hat Enterprise Linux 上の OpenJDK により/usr/bin/keytool
にインストールされます。 keytool
コマンドの構文およびパラメーターについて理解してください。この手順では、非常に一般的な手順を実行します。本書では、SSL 証明書またはkeytool
コマンドの固有な説明は範囲外です。
手順13.2 タスク
パブリックキーおよびプライベートキーでキーストアを生成します。
以下のコマンドを実行して、現在のディレクトリーでserver.keystore
という名前のキーストアを生成し、エイリアスtomcat
で新しいキーを作成します。値server.keystore
およびtomcat
は、任意ですが、エイリアスtomcat
は JBoss Web サーバーにより使用されるデフォルト値です。keytool -genkey -alias tomcat -keyalg RSA -keystore server.keystore
キーのデータベースであるキーストアにキーのエントリを入力するために、次の情報を入力するよう求められます。値は任意でありませんが、以下で説明されています。オプション 説明 パスワード このパスワードは、キーストアに対する認証を行うために使用されます (結果的に、キーを読み取ることができます)。これはセキュアな方法であることに注意してください。 名と姓 証明書名が使用される URL に一致するよう、これは、Web サーバーのドメイン名に一致する必要があります。 キーパスワード これは、設定できるオプションのセカンダリパスワードです。設定すると、キーを使用するたびに入力する必要があります。通常、これは推奨されません。 ファイルserver.keystore
には、エイリアスがtomcat
の単一キーが含まれます。キーを検証します。
以下のコマンドを使用して、キーが正常に動作することを検証します。keytool -list -keystore server.keystore
キーストアのパスワードを入力するよう求められます。キーストアの内容 (この場合は、tomcat
という名前の単一キー) が表示されます。tomcat
キーの種類がkeyEntry
であることに注意してください。これは、キーストアにこのキーのパブリックおよびプライベートエントリが含まれることを示します。暗号化キーを使用して証明書を生成します。
以下のコマンドを実行し、作成した暗号化キーを使用して署名された証明書を生成します。keytool -certreq -keyalg RSA -alias tomcat -file certreq.csr -keystore server.keystore
キーストアに対する認証を行うために、パスワードを入力するよう求められます。keytool
コマンドにより、現在の作業ディレクトリーにcertreq.csr
という名前の新しい署名済み証明書が作成されます。新しく生成された証明書をテストします。
以下のコマンドを使用して証明書の内容をテストします。openssl req -in certreq.csr -noout -text
証明書の詳細が表示されます。オプション: 証明書を認証局 (CA) に送信します。
認証局 (CA) は、証明書を認証できます。この結果、証明書は、サードパーティークライアントが信用できると見なされます。CA により、署名済み証明書が提供されます。また、オプションで 1 つまたは複数の中間証明書が提供されます。オプションで: 証明書を自己署名します。
テストまたは内部使用のためにのみ証明書が必要な場合は、証明書を自己署名できます。以下のコマンドを使用して署名の有効期限が 365 日後に切れるようにします。openssl x509 -req -days 365 -in server.csr -signkey server.keystore -out server.crt
server.crt
という名前の自己署名証明書が、現在の作業ディレクトリーに作成されます。署名済み証明書を中間証明書とともにインポートします。
CA で指示された順序で各証明書をインポートします。各証明書をインポートするには、intermediate.ca
またはserver.crt
を実際のファイル名に置き換えます。証明書が別のファイルとして提供されない場合は、各証明書に対して個別のファイルを作成し、その内容をファイルに貼り付けます。注記
署名済み証明書および証明書キーは機密情報です。サーバー間での転送方法に注意してください。keytool -import -keystore server.keystore -alias intermediateCA -file intermediate.ca
keytool -import -alias tomcat -keystore server.keystore -file server.crt
証明書が正常にインポートされたことをテストします。
以下のコマンドを実行し、要求された場合にキーストアパスワードを入力します。キーストアの内容が表示され、証明書がリストの一部になります。keytool -list -keystore server.keystore
署名済み証明書はキーストアに含まれ、HTTPS Web サーバー通信を含む SSL 接続を暗号化するために使用できます。
13.2.5. SSL コネクターリファレンス
default
を使用した監理対象ドメイン向けに設計されています。プロファイル名を、監理対象ドメインに対して設定する名前に変更するか、コマンドの /profile=default
部分を省略します (スタンドアロンサーバーの場合)。
表13.6 SSL コネクター属性
属性 | 説明 | CLI コマンド |
---|---|---|
name |
SSL コネクターの表示名。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=name,value=https) |
verify-client |
接続を受け入れる前にクライアントから有効な証明書チェーンが必要な場合は、
true に設定します。SSL スタックでクライアント証明書を要求し、クライアント証明書が表示されない場合にエラーを発生させない場合は、want に設定します。証明書チェーンを必要としない場合は、false (デフォルト値) に設定します (クライアントが CLIENT-CERT 認証を使用するセキュリティー制約により保護されたリソースを要求しないとき)。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=verify-client,value=want) |
verify-depth |
クライアントが有効な証明を持たないと判断するまでにチェックされる中間証明書発行者の最大数。デフォルト値は
10 です。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=verify-depth,value=10) |
certificate-key-file |
署名済みサーバー証明書が格納されるキーストアの完全ファイルパスおよびファイル名。JSSE 暗号化の場合、この証明書ファイルが唯一のファイルになり、OpenSSL は複数のファイルを使用します。デフォルト値は JBoss Enterprise Application Platform を実行しているユーザーのホームディレクトリー内にある
.keystore ファイルになります。keystoreType がファイルを使用しない場合は、パラメーターを空の文字列に設定します。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=certificate-key-file,value=../domain/configuration/server.keystore) |
certificate-file |
OpenSSL 暗号化を使用する場合は、このパラメーターの値を、サーバー証明書を含むファイルに対するパスに設定します。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=certificate-file,value=server.crt) |
password |
トラストストアおよびキーストアに対するパスワード。デフォルト値は
changeit であるため、設定が動作するためにはキーストアのパスワードに一致するようこの値を変更する必要があります。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=password,value=changeit) |
protocol |
使用する SSL プロトコルのバージョン。サポートされる値には、
SLv2 、SSLv3 、TLSv1 、SSLv2+SSLv3 、および ALL があります。デフォルト値は ALL です。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=protocol,value=ALL) |
ciphers |
許可される暗号のカンマ区切りのリスト。JSSE の JVM デフォルト値には、強度が低い暗号が含まれるため、この値は許可されません。SSL の使用時は、SSLCipherSuite が許可されます。指定しない場合は、利用可能な安全な暗号を使用できます。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=cipher-suite,value=SSLCipherSuite) |
key-alias |
キーストア内のサーバー証明書に使用されるエイリアス。デフォルト値は、
tomcat です。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=key-alias,value=tomcat) |
ca-certificate-file |
CA 証明書が含まれるファイル。JSSE の場合、これは
truststoreFile であり、キーストアと同じパスワードを使用します。クライアント証明書を検証するには、ca-certificate-file ファイルが使用されます。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=certificate-file,value=ca.crt) |
ca-revocation-url |
呼び出しリストが含まれるファイルまたは URL。JSSE の場合は、
crlFile を参照し、SSL の場合は、SSLCARevocationFile を参照します。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=ca-revocation-url,value=ca.crl) |
session-cache-size |
SSLSession キャッシュのサイズ。デフォルト値は、
0 であり、セッションキャッシュを無効にします。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=session-cache-size,value=100) |
session-timeout |
キャッシュされた SSLSession の有効期限が切れるまでの秒数。デフォルト値は
86400 秒 (24 時間) です。
|
/profile=default/subsystem=web/connector=HTTPS/ssl=configuration/:write-attribute(name=truststore-type,value=43200) |
13.2.6. Web サービスエンドポイントについて
- JBossWS ホームページ: http://www.jboss.org/jbossws
- プロジェクトドキュメンテーション: https://docs.jboss.org/author/display/JBWS
13.2.7. デフォルトの Welcome Web アプリケーションの置き換え
手順13.3 タスク
Welcome アプリケーションを無効にします。
管理 CLI スクリプトEAP_HOME/bin/jboss-cli.sh
を使用して次のコマンドを実行します。異なる管理ドメインのプロファイルを変更する必要があったり、スタンドアローンサーバーの場合はコマンドの/profile=default
の部分を削除する必要がある場合があります。/profile=default/subsystem=web/virtual-server=default-host:write-attribute(name=enable-welcome-root,value=false)
ルートコンテキストを使用するよう Web アプリケーションを設定します。
Web アプリケーションを設定してルートコンテキストを (/) を URL アドレスとして使用するには、META-INF/
またはWEB-INF/
ディレクトリにあるjboss-web.xml
を変更します。<context-root>
ディレクティブを次のようなディレクティブに置き換えます。<jboss-web> <context-root>/</context-root> </jboss-web>
アプリケーションをデプロイします。
サーバーグループか最初に変更したサーバーにアプリケーションをデプロイします。アプリケーションはhttp://SERVER_URL:PORT/
で使用できるようになります。
13.2.8. スタンドアロン HTTPD について
13.2.9. JBoss Enterprise Application Platform 6 に含まれる Apache HTTPD のインストール
前提条件
- このタスクを完了するには root または管理者権限が必要です。
注記
手順13.4 タスク
Red Hat カスタマーサービスポータル上でご使用のプラットフォームの JBoss Enterprise Application Platform ダウンロードリストへ移動します。
http://access.redhat.com の Red Hat カスタマーポータルへログインします。上部のメニューより ダウンロード、JBoss Enterprise Middleware、ダウンロード と選択します。コンボボックスより Application Platform を選択すると、別のコンボボックスが表示されます。Enterprise Application Platform のバージョンを選択し、そのバージョンに対応するダウンロードを確認します。一覧より HTTPD バイナリを選択します。
ご使用のオペレーティングシステムとアーキテクチャーに対応する HTTPD バイナリを探します。ダウンロード リンクをクリックすると、HTTPD ディストリビューションが含まれる ZIP ファイルがコンピューターにダウンロードされます。HTTPD バイナリを実行するシステムに ZIP を解凍します。
希望の Web サーバーの任意の場所に ZIP を解凍します。通常、JBoss Enterprise Application Platform をインストールしたディレクトリ (EAP_HOME) の中で ZIP を解凍することが多いでしょう。この場合、HTTPD はEAP_HOME/httpd/
に保存されます。この場所を他の Enterprise Application Platform のドキュメントに記載されている HTTPD_HOME として使用することができます。HTTPD を設定します。
組織のニーズに合わせて HTTPD を設定します。一般的な手順については http://httpd.apache.org/ の Apache Foundation にあるドキュメントを参照してください。Enterprise Application Platform 固有の設定は本トピックの最後に記載されているタスクのリンクを参照してください。HTTPD を起動します。
次のコマンドを使用して HTTPD を起動します。EAP_HOME/sbin/apachectl start
HTTPD を停止します。
HTTPD を停止するには次のコマンドを実行します。EAP_HOME/sbin/apachectl stop
13.2.10. 外部 HTTPD を JBoss Enterprise Application Platform アプリケーションの Web フロントエンドとして使用
外部 HTTPD を Web フロントエンドとして使用する理由と、JBoss Enterprise Application Platform でサポートされるさまざまな HTTP コネクターの利点と欠点については、「HTTP コネクターの概要 」 を参照してください。状況によっては、オペレーティングシステムに同梱される HTTPD を使用できます。それ以外の場合は、JBoss Enterprise Web Server の一部として同梱される HTTPD を使用できます。
13.2.11. Enterprise Application Platformが外部 HTTPD から要求を受け入れるように設定
Enterprise Application Platform は、要求を受け入れるプロキシを認識する必要がなく、検索するポートとプロトコルのみを認識する必要があります。これは、 mod_cluster
の場合は該当しません。この場合は、Enterprise Application Platform の設定に密接に関係します。ただし、 mod_jk
、 mod_proxy
、 ISAPI
、および NSAPI
には以下のタスクが有効です。設定する必要があるプロトコルとポートを例のプロトコルとポートに置き換えます。
mod_cluster
を使用するよう設定するには、「mod_cluster ワーカーノードの設定」を参照してください。
前提条件
- このタスクを実行するには、管理 CLI または管理コンソールにログインする必要があります。タスクの実際の手順では、管理 CLI を使用しますが、管理コンソールでは同じ基本的な手順が使用されます。
- 使用するプロトコル (HTTP、HTTPS、または AJP) のリストが必要です。
手順13.5 タスク
Web サブシステムで利用可能なコネクターをリストします。
外部 HTTPD が Enterprise Application Platform の Web サーバーに接続できるようにするには、Web サブシステムでコネクターが必要です。各プロトコルでは、ソケットグループに関連付けられた独自のコネクターが必要です。現在利用なコネクターをリストするには、以下のコマンドを発行します。[standalone@localhost:9999 /]
/subsystem=web:read-children-names(child-type=connector)
必要なコネクター (HTTP、HTTPS、AJP) を示す行がない場合は、コネクターを追加する必要があります。コネクターの設定を確認します。
コネクターの設定方法の詳細については、その設定を確認してください。以下のコマンドは AJP コネクターの設定を読み取ります。他のコネクターは同様の設定出力を持ちます。[standalone@localhost:9999 /]
/subsystem=web/connector=ajp:read-resource(recursive=true)
{ "outcome" => "success", "result" => { "enable-lookups" => false, "enabled" => true, "max-post-size" => 2097152, "max-save-post-size" => 4096, "protocol" => "AJP/1.3", "redirect-port" => 8443, "scheme" => "http", "secure" => false, "socket-binding" => "ajp", "ssl" => undefined, "virtual-server" => undefined } }必要なコネクターを Web サブシステムに追加します。
コネクターを Web サブシステムに追加するには、ソケットバインディングが必要です。ソケットバインディングは、サーバーまたはサーバーグループによって使用されるソケットバインディンググループに追加されます。以下の手順では、サーバーグループがserver-group-one
であり、ソケットバインディンググループがstandard-sockets
であることを前提とします。ソケットをソケットバインディンググループに追加します。
ソケットをソケットバインディンググループに追加するには、以下のコマンドを発行し、プロトコルとポートを必要なものに置き換えます。[standalone@localhost:9999 /]
/socket-binding-group=standard-sockets/socket-binding=ajp:add(port=8009)
ソケットバインディングを Web サブシステムに追加します。
以下のコマンドを発行してコネクターを Web サブシステムに追加し、ソケットバインディング名とプロトコルを必要なものに置き換えます。[standalone@localhost:9999 /]
/subsystem=web/connector=ajp:add(socket-binding=ajp, protocol="AJP/1.3", enabled=true)
13.2.12. クラスタリングサブシステムに TCP 通信を使用
TCPPING
プロトコルスタックを追加し、デフォルトのメカニズムとして使用できます。このような設定オプションはコマンドラインベースの管理 CLI で使用可能です。
mod_cluster
サブシステムもデフォルトで UDP 通信を使用しますが、TCP の使用を選択できます。
13.2.13. TCP を使用するよう JGroups サブシステムを設定
mod_cluster
サブシステムは、クラスターでのノードの脱退、参加、およびフェイルオーバーを管理および追跡するために JGroups サブシステムに依存します。デフォルトでは、JGroups サブシステムはマルチキャスト UDP を使用して通信します。以下の手順を実行して JGroups サブシステムがユニキャスト TCP を代わりに使用するよう設定します。
mod_cluster
サブシステムが TCP も使用するよう設定するには、「TCP を使用するよう mod_cluster
サブシステムを設定」を参照してください。
Management CLI を実行します。
EAP_HOME/bin/jboss-cli.sh
コマンド (Linux) またはEAP_HOME\bin\jboss-cli.bat
コマンド (Microsoft Windows Server の場合) を使用して管理 CLI を起動します。connect
と入力して localhost 上のドメインコントローラーに接続するか、connect IP_ADDRESS
と入力してリモートサーバー上のドメインコントローラーに接続します。お使いの環境に合わせて以下のスクリプトを変更します。
以下のスクリプトをテキストエディターにコピーします。管理対象ドメインで異なるプロファイルを使用する場合は、プロファイル名を変更します。スタンドアロンサーバーを使用する場合は、コマンドの/profile=full-ha
部分を削除します。以下のように、コマンドの最下部にリストされたプロパティーを変更します。これらの各プロパティーはオプションです。- initial_hosts
- 既知と見なされたホストのカンマ区切りのリストであり、初期メンバーシップを検索するために使用できます。
- port_range
- 必要な場合は、ポート範囲を割り当てることができます。2 のポート範囲を割り当て、初期ポートが 7600 である場合は、TCPPING がポート 7600 〜 7601 の各ホストに通信しようとします。このプロパティーはオプションです。
- timeout
- クラスターメンバーのオプションタイムアウト値 (ミリ秒単位)
- num_initial_members
- クラスターが完了したと見なされるまでのノード数。このプロパティーはオプションです。
/profile=full-ha/subsystem=jgroups/stack=tcpping:add(transport={"type" => "TCP", "socket-binding" => "jgroups-tcp"}) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=FD_SOCK,socket-binding=jgroups-tcp-fd) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=pbcast.FLUSH) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=FD) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=VERIFY_SUSPECT) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=BARRIER) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=FRAG2) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=MERGE2) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=pbcast.GMS) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=pbcast.STATE_TRANSFER) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=UNICAST2) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=TCPPING) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=UFC) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=MFC) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=pbcast.NAKACK) /profile=full-ha/subsystem=jgroups/stack=tcpping/:add-protocol(type=pbcast.STABLE) /profile=full-ha/subsystem=jgroups:write-attribute(name=default-stack,value=tcpping) /profile=full-ha/subsystem=jgroups/stack=tcpping/protocol=TCPPING/property=initial_hosts/:add(value="HostA[7600],HostB[7600]") /profile=full-ha/subsystem=jgroups/stack=tcpping/protocol=TCPPING/property=port_range/:add(value=0) /profile=full-ha/subsystem=jgroups/stack=tcpping/protocol=TCPPING/property=timeout/:add(value=3000) /profile=full-ha/subsystem=jgroups/stack=tcpping/protocol=TCPPING/property=num_initial_members/:add(value=3)
スクリプトをバッチモードで実行します。
警告
バッチファイルを実行する前に、プロファイルを実行しているサーバーをシャットダウンする必要があります。管理 CLI プロンプトで、batch
と入力し、Enter キーを押します。プロンプトはハッシュ (#
) 記号を含むよう変更され、バッチモードであることが示されます。これにより、一連のコマンドを入力できるようになります。これらのいずれかが失敗した場合は、操作全体がロールバックされます。以前の手順の変更されたスクリプトを貼り付け、最後に新しい行を追加します。run-batch
と入力してバッチを実行します。すべてのコマンドが実行されたら、メッセージ「The batch executed successfully
」が表示されます。
TCPPING
スタックが JGroups サブシステムで利用できるようになります。JGroups サブシステムは、すべてのネットワーク通信に TCP を使用します。mod_cluster
サブシステムが TCP も使用するよう設定するには、「TCP を使用するよう mod_cluster
サブシステムを設定」を参照してください。
13.2.14. TCP を使用するよう mod_cluster
サブシステムを設定
mod_cluster
サブシステムはネットワーク通信に UDP を使用します。必要な場合は、代わりにユニキャスト TCP 通信を使用できます。以下の手順を実行して、この動作を設定します。
mod_cluster
サブシステムは、クラスターノードおよびフェイルオーバーの動作を管理するために JGroups に依存します。JGroups サブシステムが TCP も使用するよう設定できます。「TCP を使用するよう JGroups サブシステムを設定」を参照してください。
手順13.6
HTTPD 設定を変更します。
サーバーアドバタイジングを無効にし、代わりにプロキシリストを使用するよう HTTPD 設定を変更します。プロキシリストはワーカーで設定され、ワーカーが対話できるmod_cluster
が有効なすべての HTTPD サーバーを含みます。HTTPD サーバーのmod_cluster
設定は通常は HTTPD インストール内の/etc/httpd/
またはetc/httpd/
ディレクトリーにあります (標準以外の場所にインストールされた場合)。そのファイルの詳細については、「Apache HTTPD または Enterprise Web Server HTTPD への mod_cluster モジュールのインストール」と「mod_cluster が有効な HTTPD に対してサーバーアドバタイズメントプロパティーを設定」を参照してください。 MCPM 要求をリッスンする仮想ホストを含むファイルを開き (EnableMCPMReceive
ディレクティブを使用)、次のようにServerAdvertise
ディレクティブを変更してサーバーアドバタイジングを無効にします。ServerAdvertise Off
JBoss Enterprise Application Platform の
mod_cluster
サブシステム内でアドバタイジングを無効にし、プロキシのリストを提供します。Web ベースの管理コンソールまたはコマンドライン管理 CLI を使用して、mod_cluster
サブシステムのアドバタイジングを無効にし、プロキシのリストを提供できます。アドバタイジングが無効な場合は、mod_cluster
サブシステムがプロキシを自動的に検出できないため、プロキシのリストが必要です。管理コンソール
- 管理対象ドメインを使用する場合は、管理対象が有効なプロファイル (
ha
プロファイルやfull-ha
プロファイルなど) でのみmod_cluster
を設定できます。 - 管理コンソールにログインし、画面の右上にある Profiles ラベルを選択します。管理対象ドメインを使用する場合は、Profiles ページの左上にある Profiles 選択ボックスから
ha
またはfull-ha
プロファイルを選択します。 - Subsystems メニューをクリックして展開します。Web サブメニューを展開し、Modcluster を選択します。
- 最上部の Edit ボタンをクリックして、
mod_cluster
サブシステム全体に関連するオプションを編集します。Advertise の値をfalse
に変更します。Save ボタンを使用して設定を保存します。 - 画面の最下部にある Proxies というラベルのタブをクリックします。Proxies サブページの Edit ボタンをクリックし、プロキシサーバーのリストを入力します。正しい構文は、次のような
HOSTNAME:PORT
文字列のカンマ区切りのリストです。10.33.144.3:6666,10.33.144.1:6666
Save ボタンをクリックして変更を保存します。
管理 CLI
次の 2 つの管理 CLI コマンドは、上記の管理コンソールの指示と同じ設定を作成します。管理対象ドメインを実行し、サーバーグループがfull-ha
プロファイルを使用することが前提となります。異なるプロファイルを使用する場合は、コマンドで名前を変更します。standalone-ha
プロファイルを使用してスタンドアロンサーバーを使用する場合は、コマンドの/profile=full-ha
部分を削除します。/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=advertise,value=false) /profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=proxy-list,value="10.33.144.3:6666,10.33.144.1:6666")
デフォルトでは、mod_cluster
通信に TCP プロトコルが使用されます。
13.3. Web、HTTP コネクター、および HTTP クラスタリング
13.3.1. mod_cluster
HTTP コネクターについて
- mod_cluster Management Protocol (MCMP) は、アプリケーションサーバーノードと httpd (サーバーサイド負荷分散ファクターとライフサイクルイベントを HTTP メソッドのカスタムセットを介して Web コンテナーに伝送するアプリケーションサーバーノードにより使用される) 間の追加の接続です。
- HTTPD プロキシの動的な設定により、JBoss Enterprise Application Platform の動作を追加設定なしで柔軟に変更できます。
- アプリケーションサーバーは負荷分散ファクターの計算を実行します。これにより、負荷分散メトリックスが他のコネクターよりも正確になります。
- mod_cluster により、アプリケーションライフサイクルを細かく制御できるようになります。各サーバーはすべての Web アプリケーションコンテキストライフサイクルイベントをプロキシに転送し、サーバーの該当するコンテキストで要求のルーティングを開始または停止するよう通知します。これにより、リソースが利用不可であるため、エンドユーザーに 404 エラーが表示されることを防ぐことができます。
- AJP はオプションです。Apache HTTP では AJP を使用する必要があります。ただし、mod_cluster では HTTP、HTTPS、または AJP を使用できます。
13.3.2. mod_cluster
サブシステムの設定
mod_cluster
オプションが Web サブシステム設定領域で利用可能になります。左上の Profiles タブをクリックします。監理対象ドメインを使用する場合は、設定する適切なプロファイルを、右上にある Profile 選択ボックスから選択します。デフォルトで、ha
プロファイルと full-ha
プロファイルでは、mod_cluster
サブシステムが有効になります。スタンドアロンサーバーを使用する場合は、standalone-ha プロファイルを使用してサーバーを起動する必要があります。左側のメニューの Web 項目をクリックし、サブメニューから Modcluster を選択します。これらのオプションについては、以下の表で説明されています。最初に設定全体が示され、次にセッション、Web コンテキスト、プロキシ、SSL、およびネットワーキングの設定が示されます。これらの各設定の独自のタブが Modcluster 設定画面に示されます。
注記
ha
および full-ha
(監理対象ドメインドメイン) または standalone-ha
(スタンドアロンサーバー) のいずれかです。
表13.7 mod_cluster
設定オプション
オプション | 説明 | CLI コマンド |
---|---|---|
負荷分散グループ |
これが null でない場合、要求はロードバランサーの特定の負荷分散グループに送信されます。負荷分散グループを使用しない場合は、これを空白のままにしてください。これはデフォルトでは設定されません。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=load-balancing-group,value=myGroup) |
バランサー |
バランサーの名前。これは、HTTPD プロキシの設定に一致する必要があります。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=balancer,value=myBalancer) |
ソケットのアドバタイズ |
クラスターアドバタイズに使用するソケットバインディングの名前。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=advertise-socket,value=modcluster) |
キーのアドバタイズ |
アドバタイズ用のセキュリティーキーを含む文字列。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=advertise-security-key,value=myKey) |
アドバタイズ |
アドバタイズが有効かどうかを指定します。デフォルト値は
true です。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=advertise,value=true) |
表13.8 mod_cluster
セッション設定オプション
オプション | 説明 | CLI コマンド |
---|---|---|
スティッキーセッション |
要求にスティッキーセッションを使用するかどうかを指定します。つまり、クライアントが特定のクラスターノードに接続すると、クラスターノードが利用不可でない限り、それ以降の通信は同じノードにルーティングされます。このデフォルト値は
true であり、推奨される設定です。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=sticky-session,value=true) |
スティッキーセッションの強制 | true の場合、要求は新しいクラスターノードにリダイレクトされません (最初のノードが利用不可である場合)。要求は代わりに失敗します。このデフォルト値は false です。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=sticky-session-force,value=false) |
スティッキーセッションの削除 |
フェールオーバー時にセッション情報を削除します。デフォルトで無効になります。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=sticky-session-remove,value=false) |
表13.9 mod_cluster
Web コンテキスト設定オプション
オプション | 説明 | CLI コマンド |
---|---|---|
コンテキストの自動有効化 |
デフォルトで
mod_cluster に新しいコンテンツを追加するかどうかを指定します。このデフォルト値は true です。デフォルト値を変更し、コンテキストを手動で有効にする必要がある場合は、Web アプリケーションで enable() MBean メソッドまたは mod_cluster マネージャー (HTTPD の設定で指定された名前付き仮想ホストまたはポートの HTTPD プロキシで実行される Web アプリケーション) を使用してコンテキストを有効にできます。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=auto-enable-contexts,value=true) |
除外されたコンテキスト | mod_cluster が無視する必要がある、コンテキストのカンマ区切りリスト。ホストが指定されない場合、ホストは localhost と見なされます。ROOT は Web アプリケーションのルートコンテキストを示します。デフォルト値は ROOT,invoker,jbossws,juddi,console です。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=excluded-contexts,value="ROOT,invoker,jbossws,juddi,console") |
表13.10 mod_cluster
プロキシー設定オプション
オプション | 説明 | CLI コマンド |
---|---|---|
プロキシ URL |
定義された場合、この値は MCMP コマンドの URL の前に付加されます。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=proxy-url,value=myhost) |
プロキシリスト |
HTTPD プロキシアドレスのカンマ区切りリスト (
hostname:port 形式)。これは、mod_cluster プロせうが最初に通信しようとするリストを示します。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=proxy-list,value="127.0.0.1,127.0.0.2") |
mod_cluster
に対する SSL 通信の設定
デフォルトでは、mod_cluster
通信は暗号化されていない HTTP リンクを介して行われます。コネクタースキームを HTTPS
(表13.8「mod_cluster
セッション設定オプション」 を参照) に設定する場合、以下の設定では、mod_cluster
に、接続を暗号化する情報を見つける場所が通知されます。
表13.11 mod_cluster
SSL 設定オプション
オプション | 説明 | CLI コマンド |
---|---|---|
キーエイリアス |
証明書が作成されたときに選択されたキーエイリアス。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/ssl=configuration/:write-attribute(name=key-alias,value=jboss) |
パスワード |
証明書が作成されたときに選択されたパスワード。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/ssl=configuration/:write-attribute(name=password,value=changeit) |
証明書ファイル |
証明書ファイルの場所。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/ssl=configuration/:write-attribute(name=ca-certificate-file,value=${user.home}/jboss.crt) |
キーファイル |
証明書用キーファイルの場所。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/ssl=configuration/:write-attribute(name=certificate-key-file,value=${user.home}/.keystore) |
暗号スイート |
許可された暗号スイート。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/ssl=configuration/:write-attribute(name=cipher-suite,value=ALL) |
失効 URL |
認証局失効リストの URL。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/ssl=configuration/:write-attribute(name=ca-revocation-url,value=jboss.crl) |
プロトコル |
有効な SSL プロトコル。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/ssl=configuration/:write-attribute(name=protocol,value=SSLv3) |
mod_cluster
ネットワーキングオプションの設定
利用可能な mod_cluster
ネットワーキングオプションは、mod_cluster
サービスが通信するさまざまな種類のサービスに対するさまざまなタイムアウト動作を制御します。
表13.12 mod_cluster
ネットワーキング設定オプション
オプション | 説明 | CLI コマンド |
---|---|---|
ノードタイムアウト |
ノードに対するプロキシ接続のタイムアウト (秒単位)。これは、
mod_cluster がバックエンド応答を待機する時間です。この時間が経過するとエラーが返されます。これはワーカー mod_proxy ドキュメンテーションのタイムアウトに対応します。値が -1 の場合は、タイムアウトがないことを示します。mod_cluster は要求を転送する前に cping/cpong を常に使用し、mod_cluster により使用される connectiontimeout 値は ping 値であることに注意してください。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=node-timeout,value=-1) |
ソケットタイムアウト |
MCMP コマンドに対する httpd プロキシからの応答を待機する時間 (ミリ秒単位)。この時間が経過すると、タイムアウトになり、プロキシでエラーが発生していると示されます。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=socket-timeout,value=20) |
停止コンテキストタイムアウト |
コンテキストがクリーンにシャットアウトされるまでの、stopContextTimeoutUnit で指定された単位の時間 (配布可能なコンテキストに対する保留中の要求の完了、または配布可能でないコンテキストに対するアクティブなセッションの破棄/期限切れ)。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=stop-context-timeout,value=10) |
最大試行回数 |
HTTPD プロキシが該当する要求を送信しようとする回数。最小値は、
1 であり、試行回数は 1 回だけです。mod_proxy のデフォルト値も 1 であり、再試行は行われません。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=max-attempts,value=1) |
パケットのフラッシュ |
HTTPD サーバーへのパケットのフラッシュを有効にするかどうかを指定しますデフォルト値は
false です。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=flush-packets,value=false) |
待機のフラッシュ |
HTTPD サーバーにパケットをフラッシュするまでの時間 (秒単位)。デフォルト値は
-1 です。値が -1 の場合は、パケットをフラッシュするまで永遠に待機します。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=flush-wait,value=-1) |
Ping |
ping に対するクラスターノードからの応答を待機する時間 (秒数単位)。デフォルト値は
10 秒です。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=ping,value=10) |
TTL |
smax より上のアイドル状態の接続の残存時間 (秒数単位)。デフォルト値は 60
nodeTimeout が定義されていない場合は、ProxyTimeout ディレクティブの Proxy が使用されます。ProxyTimeout が定義されていない場合は、サーバータイムアウト Timeout が使用されます。このデフォルト値は 300 秒です。nodeTimeout 、ProxyTimeout 、および Timeout はソケットレベルで設定されます。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=ttl,value=-1) |
ワーカータイムアウト |
外部 HTTPD サーバーの利用可能なワーカープロセスが要求を処理するまで待機する時間 (秒数単位)。デフォルト値は
-1 であり、Modcluster は HTTPD ワーカーが要求を処理するまで永遠に待機します。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/:write-attribute(name=worker-timeout,value=-1) |
mod_cluster
ロードプロバイダー設定オプション
以下の mod_cluster
設定オプションは Web ベース管理コンソールで利用できませんが、コマンドライン管理 CLI を使用して設定できます。
1
を提供し、負荷分散アルゴリズムをまったく考慮せずに負荷を均等に分散します。これを追加するには、次の CLI コマンド /profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/simple-load-provider:add
を使用します。
busyness
を使用します。使用可能な係数のリストは以下のとおりです。個々の環境に合わせて独自のロードプロバイダーを作成できます。動的なロードプロバイダーの以下のオプションを変更できます。
表13.13 mod_cluster
動的ロードプロバイダーオプション
オプション | 説明 | CLI コマンド |
---|---|---|
低減 |
履歴関連のメトリクスの重要度を低くする係数。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/dynamic-load-provider=configuration/:write-attribute(name=decay,value=2) |
履歴 |
ロードを決定する際に考慮する、ロードメトリックの履歴記録数。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/dynamic-load-provider=configuration/:write-attribute(name=history,value=9) |
ロードメトリック |
動的ロードプロバイダーに含まれる唯一のロードメトリックは
busyness であり、負荷が最も低いワーカーに新しい要求を送信しようとします。ワーカーの容量 (1 は 100% の容量を意味します) と busyness メトリック全体に割り当てられる重みを設定できます。
|
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/dynamic-load-provider=configuration/load-metric=busyness/:write-attribute(name=capacity,value=1.0) /profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/dynamic-load-provider=configuration/load-metric=busyness/:write-attribute(name=type,value=busyness) /profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/dynamic-load-provider=configuration/load-metric=busyness/:write-attribute(name=weight,value=1) |
ロードメトリックアルゴリズム
- cpu
- cpu ロードメトリックは、平均 CPU ロードを使用して次のワークロードを受け取るクラスターノードを決定します。
- mem
- mem ロードメトリックは空きネイティブ RAM をロード係数として使用します。このメトリックの使用は推奨されません。これは、バッファーとキャッシュを含む値が提供され、メモリー管理が優れたシステムで値が常に非常に小さくなるためです。
- heap
- ヒープロードメトリックは、ヒープ使用率を使用して次のワークロードを受け取るクラスターを決定します。
- セッション
- セッションロードメトリックは、アクティブセッションの数をメトリックとして使用します。
- 要求
- 要求ロードメトリックは、クライアント要求の数を使用して次のワークロードを受け取るクラスターノードを決定します。たとえば、容量 1000 の場合、 1000 要求数/秒は「フルロード」と見なされます。
- send-traffic
- send-traffic ロードメトリックは、ワーカーノードからクライアントに送信されるトラフィックの量を使用します。たとえば、デフォルト容量が 512 の場合は、平均送信トラフィックが 512 KB/秒以上のとき、ノードがフルロードであると見なされます。
- receive-traffic
- receive-traffic ロードメトリックは、クライアントからワーカーノードに送信されるトラフィックの量を使用します。たとえば、デフォルト容量が 1024 の場合は、平均受信トラフィックが 1024 KB/秒以上のとき、ノードがフルロードであると見なされます。
- busyness
- このメトリックは、要求の処理で負荷が大きいスレッドプールからのスレッドの量を表します。
例13.6 ロードバランサーメトリックの設定
/profile=full-ha/subsystem=modcluster/mod-cluster-config=configuration/dynamic-load-provider=configuration/load-metric=cpu/:write-attribute(name="weight",value="3")
13.3.3. Apache HTTPD または Enterprise Web Server HTTPD への mod_cluster モジュールのインストール
前提条件
- このタスクを実行するには、Red Hat Enterprise Linux 6 または JBoss Enterprise Web Server にインストールされた Apache HTTPD を使用するか、JBoss Enterprise Application Platform 6 のダウンロード可能な個別コンポーネントとして含まれるスタンドアロン HTTPD を使用する必要があります。
- Red Hat Enterprise Linux 6 に Apache HTTPD をインストールする必要がある場合は、https://access.redhat.com/knowledge/docs/ で入手可能な『『Red Hat Enterprise Linux 6 デプロイメントガイド (Red Hat Enterprise Linux 6 Deployment Guid)』』に記載された手順を実行します。
- JBoss Enterprise Application Platform 6 のダウンロード可能な個別コンポーネントとして同梱されたスタンドアロン HTTPD をインストールする必要がある場合は、「JBoss Enterprise Application Platform 6 に含まれる Apache HTTPD のインストール」を参照してください。
- JBoss Enterprise Web Server をインストールする必要がある場合は、https://access.redhat.com/knowledge/docs/ で入手可能な『『JBoss Enterprise Web Server インストールガイド(JBoss Enterprise Web Server Installation Guide)』』に記載された手順を実行します。
- Red Hat カスタマーポータル (https://access.redhat.com) からお使いのオペレーティングシステムとアーキテクチャー用の Webserver Connecter Natives パッケージをダウンロードします。このパッケージには、お使いのオペレーティングシステム用に事前にコンパイルされた mod_cluster バイナリー HTTPD モジュールが含まれます。アーカイブの抽出後に、モジュールは
modules/native/lib/httpd/modules/
ディレクトリーに配置されます。etc/
には、いくつかのサンプル設定ファイルが含まれ、share/
ディレクトリーには、いくつかの補足ドキュメントが含まれます。 - 管理 (root) 権限を使用してログインする必要があります。
手順13.7 タスク
HTTPD 設定の場所を決定します。
HTTPD 設定の場所は、Red Hat Enterprise Linux の Apache HTTPD を使用しているか、JBoss Enterprise Application Platform 6 でダウンロード可能な個別コンポーネントとして同梱されたスタンドアロン HTTPD を使用しているか、JBoss Enterprise Web Server で利用可能な HTTPD を使用しているかによって異なります。これは以下の 3 つのいずれかのオプションであり、このタスクの残りでは、HTTPD_HOME と呼ばれます。- Apache HTTPD -
/etc/httpd/
- JBoss Enterprise Application Platform HTTPD - この場所は、使用しているインフラストラクチャーの要件に基づいて、ユーザーにより選択されます。
- JBoss Enterprise Web Server HTTPD -
EWS_HOME/httpd/
モジュールを HTTPD モジュールディレクトリーにコピーします。
4 つのモジュール (拡張子が.so
のファイル) を、抽出された Webserver Natives アーカイブのmodules/native/lib/httpd/modules/
ディレクトリーからHTTPD_HOME/modules/
ディレクトリーにコピーします。Enterprise Web Server の場合は、
mod_proxy_balancer
モジュールを無効にします。JBoss Enterprise Web Server を使用する場合は、mod_proxy_balancer
モジュールがデフォルトで有効になります。これには mod_cluster との互換性がありません。これを無効にするには、HTTPD_HOME/conf/httpd.conf
を編集し、モジュールをロードする行の前に#
(ハッシュ) 記号を置いて以下の行をコメントアウトします。この行はコメントなしで表示されたり、コメントありで表示されたりします (以下参照)。LoadModule proxy_balancer_module modules/mod_proxy_balancer.so
# LoadModule proxy_balancer_module modules/mod_proxy_balancer.so
ファイルを保存し、閉じます。mod_cluster モジュールを設定します。
- テキストエディターで
HTTPD_HOME/conf/httpd.conf
を開き、以下の内容をファイルの最後に追加します。# Include mod_cluster's specific configuration file Include conf/JBoss_HTTP.conf
ファイルを保存し、終了します。 HTTPD_HOME/httpd/conf/JBoss_HTTP.conf
という名前の新しいファイルを作成し、以下の内容をそのファイルに追加します。LoadModule slotmem_module modules/mod_slotmem.so LoadModule manager_module modules/mod_manager.so LoadModule proxy_cluster_module modules/mod_proxy_cluster.so LoadModule advertise_module modules/mod_advertise.so
これにより、Apache HTTPD は、mod_cluster
が機能するために必要なモジュールを自動的にロードします。
プロキシサーバーリスナーを作成します。
HTTPD_HOME/httpd/conf/JBoss_HTTP.conf
の編集を続行し、大文字の値をシステムに適切な値に置き換えることにより以下の最小の設定を追加します。Listen IP_ADDRESS:PORT <VirtualHost IP_ADDRESS:PORT> <Location /> Order deny,allow Deny from all Allow from *.MYDOMAIN.COM </Location> KeepAliveTimeout 60 MaxKeepAliveRequests 0 EnableMCPMReceive On ManagerBalancerName mycluster ServerAdvertise On </VirtualHost>
これらのディレクティブにより、IP_ADDRESS:PORT
でリッスンする新しい仮想サーバーが作成され、MYDOMAIN.COM
からの接続が許可され、仮想サーバー自体がmycluster
という名前のバランサーとしてアドバタイズされます。これらのディレクティブの詳細は、Apache Web Server 向けドキュメントに記載されています。ServerAdvertise
およびEnableMCPMReceive
ディレクティブの詳細と、サーバーアドバタイジングの影響については、「mod_cluster が有効な HTTPD に対してサーバーアドバタイズメントプロパティーを設定」を参照してください。ファイルを保存し、終了します。HTTPD を再起動します。
HTTPD の再起動方法は、Red Hat Enterprise Linux の Apache HTTPD を使用しているか、JBoss Enterprise Web Server に含まれる HTTPD を使用しているかによって異なります。以下の 2 つのいずれかの方法を選択します。Red Hat Enterprise Linux 6 Apache HTTPD
以下のコマンドを発行します。[root@host]#
service httpd restart
JBoss Enterprise Web Server HTTPD
JBoss Enterprise Web Server は、Red Hat Enterprise Linux と Microsoft Windows Server の両方で実行されます。HTTPD の再起動方法はそれぞれ異なります。Red Hat Enterprise Linux
Red Hat Enterprise Linux では、Enterprise Web Server によって HTTPD はサービスとしてインストールされます。HTTPD を再起動するには、以下の 2 つのコマンドを発行します。[root@host ~]# service httpd stop
[4oot@host ~]# service httpd start
Microsoft Windows Server
コマンドプロンプトで以下のコマンドを管理権限で発行します。C:\> net stop httpd
C:\> net start httpd
Apache HTTPD が、ロードバランサーとして設定され、JBoss Enterprise Application Platform 6 が実行されている mod_cluster
サブシステムと連携できます。Enterprise Application Platform が mod_cluster を認識するよう設定するには、「mod_cluster ワーカーノードの設定」を参照してください。
13.3.4. mod_cluster が有効な HTTPD に対してサーバーアドバタイズメントプロパティーを設定
HTTPD が mod_cluster ロードバランサーと対話するよう設定する手順については、「Apache HTTPD または Enterprise Web Server HTTPD への mod_cluster モジュールのインストール」を参照してください。詳細な説明が必要な設定の側面の 1 つはサーバーアドバタイズメントです。
手順13.8 タスク
AdvertiseFrequency
パラメーターを無効にします (存在する場合)。<VirtualHost>
ステートメントに以下のような行がある場合は、最初の文字の前に#
(ハッシュ) 記号を置いて、コメントアウトします。この値は5
とは異なることがあります。AdvertiseFrequency 5
サーバーアドバタイズメントを無効にするディレクティブを追加します。
<VirtualHost>
ステートメント内部に以下のディレクティブを追加してサーバーアドバタイズメントを無効にします。ServerAdvertisement Off
HTTPD サーバーを再起動します。
Red Hat Enterprise Linux を使用するか、または Microsoft Windows Server を使用するかに応じて、HTTPD サーバーを再起動します。Red Hat Enterprise Linux
[root@host ]# service httpd restart
Microsoft Windows Server
C:\> net service http C:\> net service httpd start
HTTPD が mod_cluster プロキシの IP アドレスとポートをアドバタイズしなくなります。繰り返すには、ワーカーノードが静的アドレスとポートを使用してプロキシと通信するよう設定する必要があります。詳細については、「mod_cluster ワーカーノードの設定」を参照してください。
13.3.5. mod_cluster ワーカーノードの設定
mod_cluster ワーカーノードは、Enterprise Application Platform サーバーから構成されます。このサーバーは、監理対象ドメインまたはスタンドアロンサーバーのサーバーグループの一部になることができます。JBoss Enterprise Application Platform 内では、クラスターのすべてのノードを管理する別のプロセスが実行されます。これはマスターと呼ばれます。ワーカーノードの概念的な情報については、「ワーカーノード」を参照してください。HTTPD 負荷分散の概要については、「HTTP コネクターの概要 」を参照してください。
mod_cluster
サブシステムを介して 1 度だけ設定されます。mod_cluster
サブシステムを設定するには、「mod_cluster
サブシステムの設定」を参照してください。各ワーカーノードは別々に設定されるため、クラスターを追加する各ノードに対してこの手順を繰り返してください。
ワーカーノード設定
- スタンドアロンサーバーを使用する場合は、スタンドアロンサーバーを
standalone-ha
プロファイルで起動する必要があります。 - 管理対象ドメインを使用する場合、サーバーグループは
ha
またはfull-ha
プロファイルとha-sockets
またはfull-ha-sockets
ソケットバインディンググループを使用する必要があります。JBoss Enterprise Application Platform には、これらの要件を満たすother-server-group
という名前のクラスター対応サーバーグループが同梱されます。
注記
/profile=full-ha
部分を削除します。
手順13.9 ワーカーノードの設定
ネットワークインターフェースの設定
デフォルトでは、ネットワークインターフェースがすべて127.0.0.1
に設定されます。スタンドアロンサーバーまたはサーバーグループ内の 1 つまたは複数のサーバーをホストする各物理ホストでは、インターフェースが他のサーバーが見つけることができるパブリック IP アドレスを使用するよう設定する必要があります。JBoss Enterprise Application Platform ホストの IP アドレスを変更するには、ホストをシャットダウンし、設定ファイルを直接編集する必要があります。これは、管理コンソールと管理 CLI を駆動する管理 API は固定管理アドレスに依存するためです。クラスター内の各サーバーの IP アドレスをマスターのパブリック IP アドレスに変更するには、次の手順を実行します。- サーバーを完全にシャットダウンします。
EAP_HOME/domain/configuration/
内にある管理対象ドメイン用のhost.xml
またはEAP_HOME/standalone/configuration/
内にあるスタンドアロンサーバー用のstandalone-ha.xml
を編集します。<interfaces>
要素を見つけます。management
、public
、およびunsecured
の 3 つのインターフェースが設定されます。これらそれぞれに対して、値127.0.0.1
をホストの外部 IP アドレスに変更します。- 管理対象ドメインに参加し、マスターでないホストの場合は、
<host
要素を見つけます。この要素には>
閉じ記号がないことに注意してください。これはこの要素が属性を含むためです。名前属性の値をmaster
から一意の名前 (スレーブごとに異なる名前) 変更します。この名前は、スレーブがクラスター対して身元を示すためにも使用されるため、注意してください。 - 管理対象ドメインを参加する必要がある新しく設定されたホストの場合は、
<domain-controller>
要素を見つけます。<local />
要素をコメントアウトまたは削除し、次の行を追加して、IP アドレス (X.X.X.X
) をドメインコントローラーのアドレスに変更します。この手順は、スタンドアロンサーバーには適用されません。<remote host="X.X.X.X" port="${jboss.domain.master.port:9999}" security-realm="ManagementRealm"/>
- ファイルを保存し、終了します。
各スレーブサーバーの認証を設定します。
各スレーブサーバーでは、ドメインコントローラーまたはスタンドアロンマスターのManagementRealm
で作成されたユーザー名とパスワードが必要です。ドメインコントローラーまたはスタンドアロンマスターで、EAP_HOME/add-user.sh
コマンドを実行します。同じユーザー名を持つユーザーをスレーブとしてManagementRealm
に追加します。このユーザーが外部 JBoss AS インスタンスに対して認証する必要があるかどうか尋ねられた場合は、yes
と回答します。パスワードchangeme
を使用した、slave1
という名前のスレーブに対するコマンドの入力および出力の例は以下のとおりです。user:bin user$ ./add-user.sh What type of user do you wish to add? a) Management User (mgmt-users.properties) b) Application User (application-users.properties) (a):
a
Enter the details of the new user to add. Realm (ManagementRealm) : Username :slave1
Password :changeme
Re-enter Password :changeme
About to add user 'slave1' for realm 'ManagementRealm' Is this correct yes/no?yes
Added user 'slave1' to file '/home/user/jboss-eap-6.0/standalone/configuration/mgmt-users.properties' Added user 'slave1' to file '/home/user/jboss-eap-6.0/domain/configuration/mgmt-users.properties' Is this new user going to be used for one AS process to connect to another AS process e.g. slave domain controller? yes/no? yes To represent the user add the following to the server-identities definition <secret value="Y2hhbmdlbWU=" />add-user.sh
出力からの<secret>
要素をコピーします。add-user.sh
出力の最後の行から値をコピーします。この値は、次の手順でスレーブの設定ファイルに追加する必要があります。新しい認証を使用するようスレーブホストのセキュリティーレルムを変更します。
スレーブホストのhost.xml
またはstandalone-ha.xml
ファイルを再び開き、<security-realms>
要素を見つけます。XML コードの次のブロックを<security-realm name="ManagementRealm">
行のすぐ下に追加し、<secret value="Y2hhbmdlbWU="/>
行を前の手順のものに置き換えます。<server-identities> <secret value="Y2hhbmdlbWU="/> </server-identities>
ファイルを保存し、終了します。サーバーを再起動します。
スレーブが、ホスト名をユーザー名として使用し、暗号化された文字列をパスワードとして使用してマスターに対して認証されます。
スタンドアロンサーバーまたは監理対象ドメインのサーバーグループ内のサーバーが mod_cluster ワーカーノードとして設定されます。クラスター化されたアプリケーションをデプロイする場合、セッションはフェイルオーバーのためにすべてのクラスターサーバーに複製され、外部の HTTPD サーバーまたはロードバランサーから要求を受け入れることができます。クラスターの各ノードは、デフォルトで自動検出を使用して他のノードを検出します。自動検出と mod_cluster
サブシステムの他の固有設定値を設定するには、「mod_cluster
サブシステムの設定」を参照してください。Apache HTTPD サーバーを設定するには、「外部 HTTPD を JBoss Enterprise Application Platform アプリケーションの Web フロントエンドとして使用」を参照してください。
13.4. Apache mod_jk
13.4.1. Mod_jk、Apache Tomcat コネクター
mod_cluster
HTTP コネクターについて」 を参照してください。
次のステップ:Enterprise Application Platform を設定し mod_jk 負荷分散グループに参加します。
13.4.2. Enterprise Application Platform が Apache Mod_jk と通信するよう設定
mod_jk HTTP コネクターには、HTTPD によりロードされる単一のコンポーネント mod_jk.so
モジュールがあります。このモジュールは、クライアント要求を受け取り、コンテナー (この場合は Enterprise Application Platform) に転送します。また、これらの要求を受け取り、返信を HTTPD に送信するよう Enterprise Application Platform を設定する必要があります。
前提条件
- このタスクを実行するには、Enterprise Application Platform が実行されているサーバーで管理 CLI にアクセスする必要があります。以下の手順では、管理 CLI を使用します。この手順は、管理コンソールを使用する場合に単純化されます。
- Enterprise Application Platform が実行されている必要があります。
手順13.10 Enterprise Application Platform が mod_jk を使用するよう設定
管理 CLI を起動します。
EAP_HOME/bin/
ディレクトリーに移動します。- 以下のいずれかのコマンドを実行して、管理 CLI を起動します。
例13.7 Red Hat Enterprise Linux
[user@host bin]$
./jboss-admin.sh
例13.8 Microsoft Windows Server
C:\>
jboss-admin.bat
- ローカル ホストのサーバーに接続するには、
connect
と入力し、ENTER キーを押します。リモートホストのサーバーに接続するには、connect IP_ADDRESS:PORT
と入力します。ドメインコントローラー (監理対象ドメインの場合) またはサーバー (スタンドアロン設定の場合) に接続されます。
AJP13 コネクターが存在するかどうかをチェックします。
以下のコマンドを発行して、AJP13 コネクターが存在するかどうかをチェックします。[standalone@localhost:9999 /]
/subsystem=web:read-children-names(child-type=connector)
結果出力に、
"ajp"
行が含まれる場合、コネクターがすでに設定されています。{ "outcome" => "success", "result" => [ "ajp", "http" ] }
AJP コネクターが設定された場合は、その設定を読み取ります。
以下のコマンドを発行して、AJP コネクターの設定を読み取ります。[standalone@localhost:9999 /]
/subsystem=web/connector=ajp:read-resource(recursive=true)
結果AJP コネクターが設定された場合は、その設定が表示されます。以下に出力例を示します。
{ "outcome" => "success", "result" => { "enable-lookups" => false, "enabled" => true, "max-post-size" => 2097152, "max-save-post-size" => 4096, "protocol" => "AJP/1.3", "redirect-port" => 8443, "scheme" => "http", "secure" => false, "socket-binding" => "ajp", "ssl" => undefined, "virtual-server" => undefined } }
これは、redirect-port
が8443
に設定され、コネクターがajp
というラベルのソケットバインディングのネットワーク情報を使用することを示します。この場合は、このタスクを完了する必要はありません。AJP コネクターの新しいソケットバインディングを追加します。
新しいコネクターを追加する前に、ソケットバインディングをソケットバインディンググループに含める必要があります。ポート8009
のajp
というラベルのソケットバインディングを追加するには、以下のコマンドを発行します。[standalone@localhost:9999 /]
/socket-binding-group=standard-sockets/socket-binding=ajp:add(port=8009)
管理コンソールで、これらの同じ設定が、Profiles → Socket Bindings で利用可能になります。AJP13 コネクターをソケットバインディンググループに追加します。
以下のコマンドを発行して、新しく作成されたソケットバインディングに AJP コネクターをバインドします。[standalone@localhost:9999 /]
/subsystem=web/connector=ajp:add(socket-binding=ajp, protocol="AJP/1.3", enabled=true)
新しい設定を読み取ります。
ステップ 3 でコマンドを再発行して、設定がアクティブであることを確認します。管理コンソールで、これらの同じ設定が、Profiles → Subsystem → Web で利用可能になります。
Enterprise Application Platform は、使用するよう設定したソケットバインディンググループのポート 8009 で mod_jk コネクターから要求を受け取るよう設定されます。監理対象ドメインでは、ソケットバインディンググループを使用するすべてのサーバが要求を受け入れることができます。
13.4.3. Apache HTTPD または Enterprise Web Server HTTPD への Mod_jk モジュールのインストール
前提条件
- このタスクを実行する場合は、Red Hat Enterprise Linux にインストールされた Apache HTTPD または JBoss Enterprise Web Server にインストールされた HTTPD を使用する必要があります。
- Apache HTTPD をインストールする必要がある場合は、http://docs.redhat.com で入手可能な『『Red Hat Enterprise Linux デプロイメントガイド (Red Hat Enterprise Linux Deployment Guide)』』に記載された手順を実行します。
- JBoss Enterprise Web Server をインストールする必要がある場合は、http://docs.redhat.com で入手可能な『『JBoss Enterprise Web Server インストールガイド(JBoss Enterprise Web Server Installation Guide)』』に記載された手順を実行します。
- Apache HTTPD を使用する場合は、Red Hat カスタマーサービスポータル (http://access.redhat.com) で Enterprise Application Platform ネイティブコンポーネントパッケージをダウンロードします。このパッケージには、Red Hat Enterprise Linux 向けにプリコンパイルされた mod_jk および mod_cluster バイナリーが含まれます。JBoss Enterprise Web Server を使用している場合は、すでに mod_jk のバイナリーは含まれます。
- 管理 (root) 権限を使用してログインする必要があります。
手順13.11 タスク
HTTPD 設定の場所を決定します。
HTTPD 設定の場所は、Red Hat Enterprise Linux の Apache HTTPD を使用しているか、JBoss Enterprise Web Platform で利用可能な HTTPD を使用しているかによって異なります。これは以下の 2 つのいずれかのオプションであり、このタスクの残りでは、HTTPD_HOME と呼ばれます。- Apache HTTPD -
/etc/httpd/
- JBoss Enterprise Web Server HTTPD -
EWS_HOME/httpd/
mod_jk モジュールを設定します。
- テキストエディターで
HTTPD_HOME/conf/httpd.conf
を開き、以下の内容をファイルの最後に追加します。# Include mod_jk's specific configuration file Include conf/mod-jk.conf
HTTPD_HOME/etc/httpd/conf/mod-jk.conf
という名前の新しいファイルを作成し、以下の内容をそのファイルに追加します。注記
JkMount
ディレクティブは、Apache が mod_jk モジュールに転送する必要がある URL を指定します。ディレクティブの設定に基づいて、mod_jk は、受け取った URL を正しい Servlet コンテナーに転送します。静的なコンテンツを直接提供し、Java アプリケーションにのみロードバランサーを使用するには、URL パスが/application/*
である必要があります。mod_jk をロードバランサーとして使用するには、値/*
を使用してすべての URL を mod_jk に転送します。# Load mod_jk module # Specify the filename of the mod_jk lib LoadModule jk_module modules/mod_jk.so # Where to find workers.properties JkWorkersFile conf/workers.properties # Where to put jk logs JkLogFile logs/mod_jk.log # Set the jk log level [debug/error/info] JkLogLevel info # Select the log format JkLogStampFormat "[%a %b %d %H:%M:%S %Y]" # JkOptions indicates to send SSK KEY SIZE JkOptions +ForwardKeySize +ForwardURICompat -ForwardDirectories # JkRequestLogFormat JkRequestLogFormat "%w %V %T" # Mount your applications # The default setting only sends Java application data to mod_jk. # Use the commented-out line to send all URLs through mod_jk. # JkMount /* loadbalancer JkMount /application/* loadbalancer # Add shared memory. # This directive is present with 1.2.10 and # later versions of mod_jk, and is needed for # for load balancing to work properly JkShmFile logs/jk.shm # Add jkstatus for managing runtime data <Location /jkstatus/> JkMount status Order deny,allow Deny from all Allow from 127.0.0.1 </Location>
値を見て、セットアップに適切であることを確認します。適切な場合は、ファイルを保存します。JKMountFile ディレクティブの指定
mod-jk.conf
の JKMount ディレクティブに加えて、mod_jk に転送される複数の URL パターンを含むファイルを指定できます。- 以下の内容を
HTTPD_HOME/conf/mod-jk.conf
ファイルに追加します。# You can use external file for mount points. # It will be checked for updates each 60 seconds. # The format of the file is: /url=worker # /examples/*=loadbalancer JkMountFile conf/uriworkermap.properties
- 照合される各 URL パターンに対する行を含む
HTTPD_HOME/conf/uriworkermap.properties
という名前の新しいファイルを作成します。以下の例は、ファイルの構文の例を示しています。# Simple worker configuration file /jmx-console=loadbalancer /jmx-console/*=loadbalancer /web-console=loadbalancer /web-console/*=loadbalancer
HTTPD のモジュールディレクトリーへの mod_jk.so ファイルのコピー
注記
これは、mod_jk.so
が HTTPD のmodules/
ディレクトリーに含まれない場合にのみ必要です。ネイティブコンポーネント ZIP パッケージを抽出します。オペレーティングシステムが 32 ビットであるか、64 ビットであるかに応じて、native/lib/httpd/modules/
またはnative/lib64/httpd/modules/
ディレクトリーにあるmod_jk.so
ファイルを見つけます。このファイルをHTTPD_HOME/modules/
ディレクトリーにコピーします。
mod_jk ワーカーノードを設定します。
HTTPD_HOME/conf/workers.properties
という名前の新しいファイルを作成します。以下の例を土台として使用し、ニーズに応じてファイルを変更します。# Define list of workers that will be used # for mapping requests worker.list=loadbalancer,status # Define Node1 # modify the host as your host IP or DNS name. worker.node1.port=8009 worker.node1.host=node1.mydomain.com worker.node1.type=ajp13 worker.node1.ping_mode=A worker.node1.lbfactor=1 # Define Node2 # modify the host as your host IP or DNS name. worker.node2.port=8009 worker.node2.host=node2.mydomain.com worker.node2.type=ajp13 worker.node2.ping_mode=A worker.node2.lbfactor=1 # Load-balancing behavior worker.loadbalancer.type=lb worker.loadbalancer.balance_workers=node1,node2 worker.loadbalancer.sticky_session=1 # Status worker for managing load balancer worker.status.type=status
workers.properties
ファイルの構文と高度な設定オプションの詳細については、「Apache Mod_jk ワーカーの設定リファレンス」を参照してください。
HTTPD を再起動します。
HTTPD の再起動方法は、Red Hat Enterprise Linux の Apache HTTPD を使用しているか、JBoss Enterprise Web Server に含まれる HTTPD を使用しているかによって異なります。以下の 2 つのいずれかの方法を選択します。Red Hat Enterprise Linux の Apache HTTPD
以下のコマンドを発行します。[root@host]#
service httpd restart
JBoss Enterprise Web Server HTTPD
JBoss Enterprise Web Server は、Red Hat Enterprise Linux と Microsoft Windows Server の両方で実行されます。HTTPD の再起動方法はそれぞれ異なります。Red Hat Enterprise Linux
Red Hat Enterprise Linux では、Enterprise Web Server によって HTTPD はサービスとしてインストールされます。HTTPD を再起動するには、以下の 2 つのコマンドを発行します。[root@host ~]# service httpd stop [root@host ~]# service httpd start
Microsoft Windows Server
コマンドプロンプトで以下のコマンドを管理権限で発行します。C:\> net stop httpd C:\> net start httpd
Apache HTTPD が mod_jk ロードバランサーを使用するよう設定されます。Enterprise Application Platform が mod_jk を認識するよう設定するには、「Enterprise Application Platformが外部 HTTPD から要求を受け入れるように設定」を参照してください。
13.4.4. Apache Mod_jk ワーカーの設定リファレンス
workers.properties
ファイルはfile defines the behavior of the worker nodes which mod_jk がクライアント要求を渡すワーカーノードの動作を定義します。Red Hat Enterprise Linux では、このファイルは /etc/httpd/conf/workers.properties
にあります。workers.properties
ファイルは、異なるサーブレットコンテナーが存在する場所と、負荷をコンテナー全体で分散する方法を定義します。
worker.WORKER_NAME です。WORKER_NAME がワーカーの一意な名前である DIRECTIVE
と DIRECTIVE は、ワーカーに適用される設定です。
ノードテンプレートは、デフォルトの各ノードの設定を指定します。ノード設定内のテンプレート自体を上書きできます。ノードテンプレートの例は、例13.9「workers.properties
サンプルファイル」 で参照できます。
表13.14 グローバルプロパティー
プロパティ | 説明 |
---|---|
worker.list | mod_jk で使用されるワーカー名のリスト。これらのワーカーは要求を受信できます。 |
表13.15 各ワーカーのプロパティー
プロパティ | 説明 |
---|---|
タイプ |
ワーカーのタイプ。デフォルトのタイプは
ajp13 です。他の可能な値は ajp14 、lb 、status です。
これらのディレクティブの詳細については、『Apache Tomcat Connector AJP Protocol Reference』(http://tomcat.apache.org/connectors-doc/ajp/ajpv13a.html) を参照してください。
|
balance_workers |
ロードバランサーが管理する必要があるワーカーノードを指定します。同じロードバランサーに対してディレクティブを複数回使用できます。ディレクティブは、カンマで区切られたワーカー名のリストから構成されます。これはワーカーごとに設定され、ノードごとには設定されません。このワーカータイプにより調整されるすべてのノードが影響を受けます。
|
sticky_session |
同じセッションからの要求を常に同じワーカーにルーティングするかどうかを指定します。デフォルト値は
0 であり、スティッキーセションが無効になります。スティッキーセッションを有効にするには、1 に設定します。すべての要求が実際にステートレスでない限り、スティッキーセッションは通常有効にする必要があります。これは、ワーカーごとに設定され、ノードごとに設定されません。そのワーカータイプにより調整されるすべてのノードが影響を受けます。
|
表13.16 各ノードのプロパティー
プロパティ | 説明 |
---|---|
ホスト |
ワーカーのホスト名または IP アドレス。ワーカーノードは
ajp プロトコルスタックをサポートする必要があります。デフォルト値は localhost です。
|
ポート |
定義されたプロトコル要求をリッスンしているリモートサーバーインスタンスのポート番号。デフォルト値は、AJP13 ワーカーのデフォルトリッスンポートである
8009 です。AJP14 ワーカーのデフォルト値は 8011 です。
|
ping_mode |
ネットワークステータスがプローブされる接続の状態。プローブは CPing に空の AJP13 パケットを使用し、応答で CPong を期待します。ディレクティブフラグの組み合わせを使用して状態を指定します。フラグはカンマまたはスペースで区切られません。ping_mode は、
C 、P 、I 、および A の任意の組み合わせです。
|
ping_timeout、connect_timeout、prepost_timeout、connection_ping_interval |
上記の接続プローブ設定のタイムアウト値。値はミリ秒単位で指定され、
ping_timeout のデフォルト値は 10000 です。
|
lbfactor |
各ワーカーの負荷分散係数を指定し、ロードバランサーのメンバーワーカーにのみ適用します。これは、より強力なサーバーにより多くの負荷を割り当てる場合に役に立ちます。ワーカーにデフォルトの 3 倍の負荷を割り当てるには、これを
3 に設定します (worker.my_worker.lbfactor=3 )。
|
例13.9 workers.properties
サンプルファイル
worker.list=ajp13,lb worker.balancer1.sticky_sessions=1 worker.balancer1.balance_workers=node1 worker.balancer2.sticky_session=1 worker.balancer2.balance_workers=node2,node3 worker.nodetemplate.type=ajp13 worker.nodetemplate.port=8009 worker.node1.template=nodetemplate worker.node1.host=localhost worker.node1.ping_mode=CI worker.node1.connection_ping_interval=9000 worker.node1.lbfactor=1 worker.node1.template=nodetemplate worker.node2.host=192.168.1.1 worker.node2.ping_mode=A worker.node1.template=nodetemplate worker.node3.host=192.168.1.2
13.5. Apache mod_proxy
13.5.1. Apache Mod_proxy HTTP コネクター
mod_cluster
と mod_jk
を提供します。mod_jk
の詳細については、「Mod_jk、Apache Tomcat コネクター」を参照してください。Enterprise Application Platform はこれらのいずれかの使用をサポートします。ただし、mod_cluster
、JBoss HTTP コネクターは Enterprise Application Platform と外部 HTTPD を密接に接続し、推奨される HTTP コネクターになります。利点と欠点を含むすべてのサポート対象 HTTP コネクターの概要については、「HTTP コネクターの概要 」を参照してください。
mod_jk
とは異なり、mod_cluster
は、HTTP および HTTPS プロトコルを介して接続をサポートします。これらはそれぞれ AJP プロトコルもサポートします。
mod_proxy
は、スタンドアロンまたは負荷分散設定で指定でき、スティッキーセッションをサポートします。
13.5.2. Apache HTTPD への Mod_proxy HTTP コネクターのインストール
mod_proxy
は、Apache により提供される負荷分散モジュールです。このタスクは、基本的な設定を提供します。高度な設定または詳細については、Apache の mod_proxy
ドキュメンテーション (http://httpd.apache.org/docs/2.2/mod/mod_proxy.html) を参照してください。Enterprise Application Platform の観点からの mod_proxy
の詳細については、「Apache Mod_proxy HTTP コネクター」と「HTTP コネクターの概要 」を参照してください。
前提条件
- Enterprise Web Server HTTPD または Apache HTTPD をインストールする必要があります。
mod_proxy
モジュールをインストールする必要があります。Apache HTTPD は、通常、すでに同梱されたmod_proxy
モジュールで提供されます。これは、Red Hat Enterprise Linux のケースです (JBoss Enterprise Web Server で提供される HTTPD と Microsoft Windows で提供される Apache HTTPD)。- HTTPD 設定を変更するには、
root
または管理者権限が必要です。 - HTTPD 設定ディレクトリーを決定します。これは、Apache HTTPD 用の
conf/
およびmodules/
ディレクトリーを含むディレクトリーです。このタスクの残りでは、これはHTTPD_CONF
と示されます。通常の値は以下のとおりです。/etc/httpd/
EWS_HOME/httpd/
(Enterprise Web Server がインストールされた場所から起動されます)
HTTPD での
mod_proxy
モジュールの有効化HTTPD_CONF/conf/httpd.conf
ファイルで次の行を探します。これらの行が存在しない場合は、行を最下部に追加します。これらの行が存在し、行がコメント (#) 文字始まる場合は、この文字を削除します。後でファイルを保存します。通常は、モジュールはすでに存在し、有効になります。LoadModule proxy_module modules/mod_proxy.so LoadModule proxy_balancer_module modules/mod_proxy_balancer.so LoadModule proxy_http_module modules/mod_proxy_http.so # Uncomment these to proxy FTP or HTTPS #LoadModule proxy_ftp_module modules/mod_proxy_ftp.so #LoadModule proxy_connect_module modules/mod_proxy_connect.so
非負荷分散プロキシーを追加します。
以下の設定を、他の<VirtualHost>
ディレクトリーの直下にあるHTTPD_CONF/conf/httpd.conf
ファイルに追加します。値をセットアップに適切な値に置き換えます。この例では、仮想ホストを使用します。デフォルトの HTTPD 設定を使用するには、次の手順を参照してください。<VirtualHost *:80> # Your domain name ServerName Domain_NAME_HERE ProxyPreserveHost On # The IP and port of the Enterprise Application Platform # These represent the default values, if your HTTPD is on the same host # as your Enterprise Application Platform managed domain or server ProxyPass / http://localhost:8080/ ProxyPassReverse / http://localhost:8080/ # The location of the HTML files, and access control information DocumentRoot /var/www <Directory /var/www> Options -Indexes Order allow,deny Allow from all </Directory> </VirtualHost>
変更後に、ファイルを保存します。負荷分散プロキシーを追加します。
mod_proxy
をロードバランサーとして使用し、複数の Enterprise Application Platform サーバーに負荷を送信するには、以下の設定をHTTPD_CONF/conf/httpd.conf
ファイルに追加します。<Proxy balancer://mycluster> Order deny,allow Allow from all # Add each Enterprise Application Server by IP address and port. # If the route values are unique like this, one node will not fail over to the other. BalancerMember http://host1:8080 route=node1 BalancerMember http://host2:8180 route=node2 </Proxy> # Use the balancer as a single proxy, as in the <VirtualHost> example above. ProxyPass /://mycluster ProxyPassReverse / http://host1:8080/ ProxyPassReverse / http://host2:8180/ # Only proxy a specific application ProxyPass /MyApp://mycluster ProxyPassReverse /MyApp http://host3:8280/MyApp
上記の例では、すべて HTTP プロトコルを使用して通信します。 適切なmod_proxy
モジュールをロードする場合は、AJP または HTTPS プロトコルを代わりに使用できます。詳細については、Apache mod_cluster ドキュメンテーションを参照してください。スティッキーセッションを有効にします。
スティッキーセッションを使用すると、クライアント要求が特定の JBoss Enterprise Application Platform ノードに送信された場合に、ノードが利用不可にならない限り、すべての将来の要求が同じノードに送信されます。これは、ほとんど常に正しい動作です。mod_proxy
のスティッキーセッションを有効にするには、stickysession
パラメーターをProxyPass
ステートメントに追加します。この例では、使用できる他のいくつかのパラメーターも示されます。詳細については、Apache のmod_proxy
ドキュメンテーション (http://httpd.apache.org/docs/2.2/mod/mod_proxy.html) を参照してください。ProxyPass /MyApp balancer://mycluster stickysession=JSESSIONID lbmethod=bytraffic nofailover=Off
HTTPD を再起動します。
HTTPD サーバーを再起動して変更を反映します。
HTTPD が、標準または負荷分散設定で mod_proxy
を使用してクライアント要求を Enterprise Application Platform サーバーまたはクラスターに送信するよう設定されます。Enterprise Application Platform がこれらの要求に応答するよう設定するには、「Enterprise Application Platformが外部 HTTPD から要求を受け入れるように設定」を参照してください。
13.6. Microsoft ISAPI
13.6.1. インターネットサーバー API (ISAPI) HTTP コネクターについて
13.6.2. Microsoft IIS が ISAPI リダイレクターを使用するよう設定する
前提条件
- ISAPI は、Microsoft Windows Server 2003 以降で実行されます。サポート対象のオペレーティングシステムを使用し、IIS サーバーをインストールしてください。
手順13.12 タスク
ネイティブコンポーネントパッケージをダウンロードし、解凍します。
Microsoft Windows 用 JBoss ネイティブコンポーネントパッケージをカスタマーサポートポータル (http://access.redhat.com) からダウンロードします。Downloads 、JBoss Middleware、Application Platform の順に移動します。i386
またはx86_64
を選択します。ファイルを解凍します。このファイルには、sbin/
ディレクトリー内の ISAPI リダイレクト DLL が含まれます。ネイティブコンポーネントをインストールします。
ネイティブコンポーネント zip ファイルをディレクトリーに抽出します。このタスクの残りでは、C:\Connectors\
を使用していることを前提とします。IIS マネージャー を使用して IIS リダイレクターを設定します。
IIS 設定の手順は、IIS 6 と IIS 7 では異なります。お使いの IIS のバージョンに応じて、正しい手順を選択してください。IIS 7
- Start → Run をクリックし、
inetmgr
と入力して、IIS マネージャーを開きます。 - 左側のツリービューペインで、IIS 7 を展開します。
- ISAPI and CGI Registrations をダブルクリックして新しいウィンドウで開きます。
- Actions ペインで、Add をクリックします。Add ISAPI or CGI Restriction ウィンドウが開きます。
- 以下の値を指定します。
- ISAPI or CGI Path:
c:\connectors\jboss-ep-6.0\native\sbin\isapi_redirect.dll
- Description:
jboss
- Allow extension path to execute: チェックボックスを選択します。
- OK をクリックして Add ISAPI or CGI Restriction ウィンドウを閉じます。
JBoss ネイティブ仮想ディレクトリーを開く
- Default Web Site を右クリックし、Add Virtual Directory をクリックします。Add Virtual Directory ウィンドウが開きます。
- 以下の値を指定して仮想ディレクトリーを追加します。
- Alias:
jboss
- Physical Path:
C:\connectors\jboss-ep-6.0\native\sbin\
- OK をクリックして値を保存し、Add Virtual Directory ウィンドウを閉じます。
JBoss ネイティブ ISAPI リダイレクトフィルター
- ツリービューペインで、Sites → Default Web Site を展開します。
- ISAPI Filters ダブルクリックします。ISAPI Filters Features ビューが表示されます。
- Actions ペインで、Add をクリックします。Add ISAPI Filter ウィンドウが表示されます。
- Add ISAPI Filter ウィンドウで以下の値を指定します。
- Filter name:
jboss
- Executable:
C:\connectors\jboss-ep-6.0\native\sbin\isapi_redirect.dll
- OK をクリックして値を保存し、Add ISAPI Filters ウィンドウを閉じます。
ISAPI-dll ハンドラーを有効にする
- ツリービューペインで、IIS 7 アイテムをダブルクリックします。IIS 7 Home Features View が開きます。
- Handler Mappings をダブルクリックします。Handler Mappings Features View が表示されます。
- Group by コンボボックスで、State を選択します。Handler Mappings が Enabled and Disabled Groups に表示されます。
- ISAPI-dll を見つけます。Disabled グループにある場合は、右クリックし、Edit Feature Permissions を選択します。
- 以下のパーミッションを有効にします。
- 読み取り
- スクリプト
- 実行
- OK をクリックして値を保存し、Edit Feature Permissions ウィンドウを閉じます。
IIS 6
- Start → Run をクリックし、
inetmgr
と入力して、IIS マネージャーを開きます。 - 左側のツリービューで、Websites を展開し、設定する Web サイトを右クリックします。このタスクの残りでは、
Default
Web サイトを設定することを前提とします。Properties をクリックします。 - ISAPI Filters タブをクリックします。
- Add ボタンをクリックします。フィルターの名前を
jboss
と指定し、C:\connectors\jboss-ep-6.0\native\sbin\isapi_redirect.dll
を実行可能ファイルとして指定します。 - OK をクリックしてすべてのダイアログを閉じます。IIS マネージャーを開いたままにします。
ISAPI 仮想ディレクトリーを定義します。
- デフォルトの Web サイトを再び右クリックします。NewAdd Virtual Directory を選択します。
- エイリアスとして
jboss
を指定し、物理パスとしてC:\connectors\jboss-ep-6.0\native\sbin\
を指定します。 - OK をクリックして値を保存し、Add Virtual Directory ウィンドウを閉じます。
- ツリービューで、Web Sites/Default Web Site を展開します。
jboss
仮想ディレクトリーを右クリックし、Properties をクリックします。- Virtual Directory タブをクリックし、以下の変更を行います。
実行パーミッション
- スクリプトおよび実行可能ファイル
読み取りアクセス
- ボックをチェックし読み取りアクセスを有効化します。
- OK をクリックして変更を保存し、JBoss Properties ウィンドウを閉じます。
ISAPI Web サービス拡張機能を定義する
- Web Service Extensions をクリックします。Tasks グループで、Add a new Web service extension を選択します。New Web Service Extension ウィンドウが表示されます。
- 以下の値を追加します。
- 拡張名:
jboss
- 必須ファイル:
C:\connectors\jboss-ep-6.0\native\sbin\isapi_redirect.dll
- 拡張ステータス:
allowed
- OK をクリックして変更を保存し、New Web Service Extension ウィンドウを閉じます。
- jboss Web Service Extension がリストに表示されることを確認します。
Microsoft IIS が ISAPI リダイレクターを使用するよう設定されます。次に、「Enterprise Application Platformが外部 HTTPD から要求を受け入れるように設定」、「ISAPI リダイレクターがクライアント要求を Enterprise Application Platform に送信するよう設定する」、または 「ISAPI がクライアント要求を複数の Enterprise Application Platform サーバーで分散するよう設定する」 に進んでください。
13.6.3. ISAPI リダイレクターがクライアント要求を Enterprise Application Platform に送信するよう設定する
このタスクでは、Enterprise Application Platform サーバーのグループが ISAPI リダイレクターから要求を受け入れるよう設定します。負荷分散または高可用性フェールオーバーの設定は含まれません。これらの機能が必要な場合は、「ISAPI がクライアント要求を複数の Enterprise Application Platform サーバーで分散するよう設定する」を参照してください。
前提条件
- IIS サーバーへの完全な管理者アクセスが必要です。
手順13.13 タスク
ログ、プロパティーファイル、およびロックファイルを格納するディレクトリーを作成します。
この手順の残りでは、この目的のためにディレクトリーC:\connectors\
を使用していることを前提とします。異なるディレクトリーを使用する場合は、適切に手順を変更してください。isapi_redirect.properties
ファイルを作成します。C:\connectors\isapi_redirect.properties
という名前の新しいファイルを作成します。以下の内容をファイルにコピーします。値JBOSS_NATIVE_HOME
を、タスク 「Microsoft IIS が ISAPI リダイレクターを使用するよう設定する」 の実行時に JBoss ネイティブコンポーネントをインストールした実際の場所に置き換えます。# Configuration file for the ISAPI Redirector # Extension uri definition extension_uri=JBOSS_NATIVE_HOME/sbin/isapi_redirect.dll # Full path to the log file for the ISAPI Redirector log_file=c:\connectors\isapi_redirect.log # Log level (debug, info, warn, error or trace) # Use debug only testing phase, for production switch to info log_level=debug # Full path to the workers.properties file worker_file=c:\connectors\workers.properties # Full path to the uriworkermap.properties file worker_mount_file=c:\connectors\uriworkermap.properties #Full path to the rewrite.properties file rewrite_rule_file=c:\connectors\rewrite.properties
uriworkermap.properties
フィルを作成するuriworkermap.properties
ファイルには、デプロイされたアプリケーション URL と、それらへの要求を処理するワーカー間のマッピングが含まれます。以下のサンプルファイルはファイルの構文を示しています。uriworkermap.properties
ファイルをC:\connectors\
に格納してください。# images and css files for path /status are provided by worker01 /status=worker01 /images/*=worker01 /css/*=worker01 # Path /web-console is provided by worker02 # IIS (customized) error page is used for http errors with number greater or equal to 400 # css files are provided by worker01 /web-console/*=worker02;use_server_errors=400 /web-console/css/*=worker01 # Example of exclusion from mapping, logo.gif won't be displayed # !/web-console/images/logo.gif=* # Requests to /app-01 or /app-01/something will be routed to worker01 /app-01|/*=worker01 # Requests to /app-02 or /app-02/something will be routed to worker02 /app-02|/*=worker02
workers.properties
ファイルを作成します。workers.properties
ファイルには、ワーカーラベルとサーバーインスタンス間のマッピング定義が含まれます。以下のサンプルファイルはファイルの構文を示しています。このファイルをC:\connectors\
ディレクトリーに格納してください。# An entry that lists all the workers defined worker.list=worker01, worker02 # Entries that define the host and port associated with these workers # First Enterprise Application Platform server definition, port 8009 is standard port for AJP in EAP worker.worker01.host=127.0.0.1 worker.worker01.port=8009 worker.worker01.type=ajp13 # Second Enterprise Application Platform server definition worker.worker02.host= 127.0.0.100 worker.worker02.port=8009 worker.worker02.type=ajp13
rewrite.properties
ファイルを作成します。rewrite.properties
ファイルには、特定のアプリケーションの単純な URL 書き換えルールが含まれます。以下の例で示されているように、書き換えられたパスは名前と値のペアを使用して指定されます。このファイルをC:\connectors\
ディレクトリーに格納してください。#Simple example # Images are accessible under abc path /app-01/abc/=/app-01/images/
IIS サーバーを再起動します。
バージョンに応じて、IIS サーバーを再起動する適切な手順を実行します。IIS 6
C:\> net stop iisadmin /Y C:\> net start w3svc
IIS 7
C:\> net stop was /Y C:\> net start w3svc
IIS サーバーが、アプリケーションごとに、設定した特定の Enterprise Application Platform サーバーにクライアント要求を送信するよう設定されます。
13.6.4. ISAPI がクライアント要求を複数の Enterprise Application Platform サーバーで分散するよう設定する
この設定により、クライアント要求は指定した Enterprise Application Platform サーバーで分散されます。クライアント要求を、デプロイメントごとに、特定の Enterprise Application Platform サーバーに送信する場合は、「ISAPI リダイレクターがクライアント要求を Enterprise Application Platform に送信するよう設定する」を参照してください。
前提条件
- IIS サーバーへの完全な管理者アクセス。
手順13.14 タスク
ログ、プロパティーファイル、およびロックファイルを格納するディレクトリーを作成します。
この手順の残りでは、この目的のためにディレクトリーC:\connectors\
を使用していることを前提とします。異なるディレクトリーを使用する場合は、適切に手順を変更してください。isapi_redirect.properties
ファイルを作成します。C:\connectors\isapi_redirect.properties
という名前の新しいファイルを作成します。以下の内容をファイルにコピーします。値JBOSS_NATIVE_HOME
を、タスク 「Microsoft IIS が ISAPI リダイレクターを使用するよう設定する」 の実行時に JBoss ネイティブコンポーネントをインストールした実際の場所に置き換えます。# Configuration file for the ISAPI Redirector # Extension uri definition extension_uri=JBOSS_NATIVE_HOME/sbin/isapi_redirect.dll # Full path to the log file for the ISAPI Redirector log_file=c:\connectors\isapi_redirect.log # Log level (debug, info, warn, error or trace) # Use debug only testing phase, for production switch to info log_level=debug # Full path to the workers.properties file worker_file=c:\connectors\workers.properties # Full path to the uriworkermap.properties file worker_mount_file=c:\connectors\uriworkermap.properties #OPTIONAL: Full path to the rewrite.properties file rewrite_rule_file=c:\connectors\rewrite.properties
uriworkermap.properties
フィルを作成します。uriworkermap.properties
ファイルには、デプロイされたアプリケーション URL と、それらへの要求を処理するワーカー間のマッピングが含まれます。以下のサンプルファイルは負荷分散が設定されたファイルの構文を示しています。ワイルドカード (*
) 文字はさまざまな URL サブディレクトリーのすべての要求をrouter
という名前のロードバランサーに送信します。ロードバランサーの設定については、ステップ 4 を参照してください。uriworkermap.properties
ファイルをC:\connectors\
に格納してください。# images, css files, path /status and /web-console will be # provided by nodes defined in the load-balancer called "router" /css/*=router /images/*=router /status=router /web-console|/*=router # Example of exclusion from mapping, logo.gif won't be displayed !/web-console/images/logo.gif=* # Requests to /app-01 and /app-02 will be routed to nodes defined # in the load-balancer called "router" /app-01|/*=router /app-02|/*=router # mapping for management console, nodes in cluster can be enabled or disabled here /jkmanager|/*=status
workers.properties
ファイルを作成します。workers.properties
ファイルには、ワーカーラベルとサーバーインスタンス間のマッピング定義が含まれます。以下のサンプルファイルはファイルの構文を示しています。ロードバランサーは、ファイルの最後で設定され、ワーカーworker01
およびworker02
から構成されます。workers.properties
ファイルは Apache mod_jk 設定に使用されるのと同じファイルの構文に従います。workers.propertie
ファイルの構文の詳細については、「Apache Mod_jk ワーカーの設定リファレンス」を参照してください。このファイルをC:\connectors\
ディレクトリーに格納してください。# The advanced router LB worker worker.list=router,status # First EAP server definition, port 8009 is standard port for AJP in EAP # # lbfactor defines how much the worker will be used. # The higher the number, the more requests are served # lbfactor is useful when one machine is more powerful # ping_mode=A – all possible probes will be used to determine that # connections are still working worker.worker01.port=8009 worker.worker01.host=127.0.0.1 worker.worker01.type=ajp13 worker.worker01.ping_mode=A worker.worker01.socket_timeout=10 worker.worker01.lbfactor=3 # Second EAP server definition worker.worker02.port=8009 worker.worker02.host= 127.0.0.100 worker.worker02.type=ajp13 worker.worker02.ping_mode=A worker.worker02.socket_timeout=10 worker.worker02.lbfactor=1 # Define the LB worker worker.router.type=lb worker.router.balance_workers=worker01,worker02 # Define the status worker for jkmanager worker.status.type=status
rewrite.properties
ファイルを作成します。rewrite.properties
ファイルには、特定のアプリケーションの単純な URL 書き換えルールが含まれます。以下の例で示されているように、書き換えられたパスは名前と値のペアを使用して指定されます。このファイルをC:\connectors\
ディレクトリーに格納してください。#Simple example # Images are accessible under abc path /app-01/abc/=/app-01/images/
IIS サーバーを再起動します。
バージョンに応じて、IIS サーバーを再起動する適切な手順を実行します。IIS 6
C:\> net stop iisadmin /Y C:\> net start w3svc
IIS 7
C:\> net stop was /Y C:\> net start w3svc
IIS サーバーが、workers.properties
ファイルに記述された Enterprise Application Platform サーバーにクライアント要求を送信し、サーバー間で負荷を均等に分散するよう設定されます。
13.7. Oracle NSAPI
13.7.1. Netscape Server API (NSAPI) HTTP コネクターについて
13.7.2. Oracle Solaris で NSAPI コネクターを設定する
NSAPI コネクターは、Oracle iPlanet Web Server 内で実行されるモジュールです。
前提条件
- サーバーが、32 ビットまたは 64 ビットアーキテクチャーで Oracle Solaris 9 以上を実行しています。
- NSAPI コネクターを除き、Oracle iPlanet Web Server 6.1 SP 12 または 7.0 U8 がインストールおよび設定されています。
- Enterprise Application Platform が、ワーカーノードとして動作する各サーバーでインストールおよび設定されています。「Enterprise Application Platformが外部 HTTPD から要求を受け入れるように設定」を参照してください。
- JBoss ネイティブコンポーネント ZIP パッケージがカスタマーサービスポータル (http://access.redhat.com) からダウンロードされました。
手順13.15 タスク
JBoss ネイティブコンポーネントパッケージを抽出します。
この手順の残りでは、ネイティブコンポーネントパッケージが/opt/oracle/webserver7/config/
のconnectors/
という名前のディレクトリーに抽出されます。この手順の残りでは、このディレクトリーは IPLANET_CONFIG と呼ばれます。Oracle iPlanet 設定ディレクトリーが異なる場合、またはOracle iPlanet Web Server 6 を実行している場合は、適切に手順を実行します。サーブレットマッピングを無効にします。
IPLANET_CONFIG/default.web.xml
ファイルを開き、Built In Server Mappings
という見出しのセクションを見つけます。次の 3 つのサーブレットを XML コメント文字 (<!--
および-->
) で囲み、これらのサーブレットへのマッピングを無効にします。- デフォルト
- 呼び出し元
- jsp
以下の設定例は、無効にされたマッピングを示しています。<!-- ============== Built In Servlet Mappings =============== --> <!-- The servlet mappings for the built in servlets defined above. --> <!-- The mapping for the default servlet --> <!--servlet-mapping> <servlet-name>default</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping--> <!-- The mapping for the invoker servlet --> <!--servlet-mapping> <servlet-name>invoker</servlet-name> <url-pattern>/servlet/*</url-pattern> </servlet-mapping--> <!-- The mapping for the JSP servlet --> <!--servlet-mapping> <servlet-name>jsp</servlet-name> <url-pattern>*.jsp</url-pattern> </servlet-mapping-->
ファイルを保存し、終了します。iPlanet Web Server が NSAPI コネクターモジュールをロードするよう設定します。
IPLANET_CONFIG/magnus.conf
ファイルの最後に次の行を追加し、お使いの設定に合うようファイルパスを変更します。これらの行は、nsapi_redirector.so
モジュールと、ワーカーノードとプロパティーがリストされたworkers.properties
ファイルの場所を定義します。Init fn="load-modules" funcs="jk_init,jk_service" shlib="IPLANET_CONFIG/connectors/lib/nsapi_redirector.so" shlib_flags="(global|now)" Init fn="jk_init" worker_file="IPLANET_CONFIG/connectors/workers.properties" log_level="debug" log_file="IPLANET_CONFIG/config/connectors/nsapi.log" shm_file="IPLANET_CONFIG/conf/connectors/jk_shm"
上記の設定は 32 ビットアーキテクチャー向けです。64 ビット Solaris を使用している場合は、文字列lib/nsapi_redirector.so
をlib64/nsapi_redirector.so
に変更します。ファイルを保存し、終了します。NSAPI コネクターを設定します。
NSAPI コネクターに対して、基本的な設定 (負荷分散なし) を行えます。以下のいずれかのオプションを選択します。その後で設定は完了します。
13.7.3. NSAPI を基本的な HTTP コネクターとして設定する
このタスクでは、NSAPI コネクターが負荷分散またはフェールオーバーなしでクライアント要求を Enterprise Application Platform サーバーにリダイレクトするよう設定します。リダイレクトは、デプロイメントごとに (つまり、URL ごとに) 行われます。負荷分散設定については、「NSAPI を負荷分散クラスターとして設定する」を参照してください。
前提条件
- 現在のタスクを続行する前に、「Oracle Solaris で NSAPI コネクターを設定する」を完了する必要があります。
手順13.16 タスク
Enterprise Application Platform サーバーにリダイレクトする URL パスを定義します。
IPLANET_CONFIG/obj.conf
ファイルを編集します。<Object name="default">
で始まるセクションを見つけ、一致する各 URL パターンを次のサンプルファイルで示された形式で追加します。文字列jknsapi
は、次の手順で定義される HTTP コネクターを示します。例は、ワイルドカードを使用したパターン一致を示しています。<Object name="default"> [...] NameTrans fn="assign-name" from="/status" name="jknsapi" NameTrans fn="assign-name" from="/images(|/*)" name="jknsapi" NameTrans fn="assign-name" from="/css(|/*)" name="jknsapi" NameTrans fn="assign-name" from="/nc(|/*)" name="jknsapi" NameTrans fn="assign-name" from="/jmx-console(|/*)" name="jknsapi" </Object>
各パスを提供するワーカーを定義します。
IPLANET_CONFIG/obj.conf
ファイルの編集を続行します。編集したセクションの終了タグのすぐ後に次を追加します:</Object>
。<Object name="jknsapi"> ObjectType fn=force-type type=text/plain Service fn="jk_service" worker="worker01" path="/status" Service fn="jk_service" worker="worker02" path="/nc(/*)" Service fn="jk_service" worker="worker01" </Object>
上記の例は、URL パス/status
を、worker01
という名前のワーカーにリダイレクトし、/nc/
以下のすべての URL パスを、worker02
という名前のワーカーにリダイレクトします。3 番目の行は、前の行で一致しないjknsapi
オブジェクトに割り当てられたすべての URL がworker01
に提供されることを示しています。ファイルを保存し、終了します。ワーカーとその属性を定義します。
ディレクトリーに、IPLANET_CONFIG
/connectors/workers.properties
という名前のファイルを作成します。以下の内容をそのファイルにペーストし、お使いの環境に合わせて変更します。# An entry that lists all the workers defined worker.list=worker01, worker02 # Entries that define the host and port associated with these workers worker.worker01.host=127.0.0.1 worker.worker01.port=8009 worker.worker01.type=ajp13 worker.worker02.host=127.0.0.100 worker.worker02.port=8009 worker.worker02.type=ajp13
workers.properties
ファイルは Apache mod_jk と同じ構文を使用します。利用可能なオプションについては、「Apache Mod_jk ワーカーの設定リファレンス」を参照してください。ファイルを保存し、終了します。iPlanet Web Server を再起動します。
iPlanet Web Server 6.1 を実行するか、7.0 を実行するかに応じて、以下のいずれかの手順を選択します。iPlanet Web Server 6.1
IPLANET_CONFIG/../stop IPLANET_CONFIG/../start
iPlanet Web Server 7.0
IPLANET_CONFIG/../bin/stopserv IPLANET_CONFIG/../bin/startserv
iPlanet Web Server が、設定した URL へのクライアント要求を Enterprise Application Platform のデプロイメントに送信します。
13.7.4. NSAPI を負荷分散クラスターとして設定する
このタスクでは、NSAPI コネクターが負荷分散設定でクライアント要求を Enterprise Application Platform サーバーにリダイレクトするよう設定します。NSAPI を負荷分散なしの単純な HTTP コネクターとして使用するには、「NSAPI を基本的な HTTP コネクターとして設定する」参照してください。
前提条件
- 現在のタスクを続行する前に、「Oracle Solaris で NSAPI コネクターを設定する」を完了する必要があります。
手順13.17 タスク
Enterprise Application Platform サーバーにリダイレクトする URL パスを定義します。
IPLANET_CONFIG/obj.conf
ファイルを編集します。<Object name="default">
で始まるセクションを見つけ、一致する各 URL パターンを次のサンプルファイルで示された形式で追加します。文字列jknsapi
は、次の手順で定義される HTTP コネクターを示します。例は、ワイルドカードを使用したパターン一致を示しています。<Object name="default"> [...] NameTrans fn="assign-name" from="/status" name="jknsapi" NameTrans fn="assign-name" from="/images(|/*)" name="jknsapi" NameTrans fn="assign-name" from="/css(|/*)" name="jknsapi" NameTrans fn="assign-name" from="/nc(|/*)" name="jknsapi" NameTrans fn="assign-name" from="/jmx-console(|/*)" name="jknsapi" NameTrans fn="assign-name" from="/jkmanager/*" name="jknsapi" </Object>
各パスを提供するワーカーを定義します。
IPLANET_CONFIG/obj.conf
ファイルの編集を続行します。前の手順で変更したセクションの終了タグ (</Object>
) のすぐ後に、以下の新しいセクションを追加し、ニーズに合わせて変更します。<Object name="jknsapi"> ObjectType fn=force-type type=text/plain Service fn="jk_service" worker="status" path="/jkmanager(/*)" Service fn="jk_service" worker="router" </Object>
このjksnapi
オブジェクトは、default
オブジェクトのname="jksnapi"
マッピングにマッピングされた各パスを提供するために使用されるワーカーノードを定義します。/jkmanager/*
に一致する URL 以外のすべてが、router
という名前のワーカーにリダイレクトされます。ワーカーとその属性を定義します。
workers.properties
という名前のファイルを
で作成します。以下の内容をファイルに貼り付け、お使いの環境に合わせて変更します。IPLANET_CONFIG
/conf/connector/# The advanced router LB worker # A list of each worker worker.list=router,status # First Enterprise Application Platform server # (worker node) definition. # Port 8009 is the standard port for AJP # worker.worker01.port=8009 worker.worker01.host=127.0.0.1 worker.worker01.type=ajp13 worker.worker01.ping_mode=A worker.worker01.socket_timeout=10 worker.worker01.lbfactor=3 # Second Enterprise Application Platform server worker.worker02.port=8009 worker.worker02.host=127.0.0.100 worker.worker02.type=ajp13 worker.worker02.ping_mode=A worker.worker02.socket_timeout=10 worker.worker02.lbfactor=1 # Define the load-balancer called "router" worker.router.type=lb worker.router.balance_workers=worker01,worker02 # Define the status worker worker.status.type=status
workers.properties
ファイルは、Apache mod_jk と同じ構文を使用します。利用可能なオプションについては、「Apache Mod_jk ワーカーの設定リファレンス」を参照してください。ファイルを保存し、終了します。iPlanet Web Server を再起動します。
iPlanet Web Server 6.1 または 7.0 のいずれかを実行するかに応じて、次のいずれかの手順を選択します。iPlanet Web Server 6.1
IPLANET_CONFIG/../stop IPLANET_CONFIG/../start
iPlanet Web Server 7.0
IPLANET_CONFIG/../bin/stopserv IPLANET_CONFIG/../bin/startserv
iPlanet Web Server は、負荷分散構成で Enterprise Application Platform サーバーに設定した URL パターンリダイレクトします。
第14章 メッセージング
14.1. HornetQ
14.1.1. HornetQ
14.1.2. メッセージングの概念
14.1.3. サポートされているメッセージ形式
- Message Queue パターン
- Message Queue パターンでは、メッセージをキューに送信する必要があります。メッセージがキューに入ると、通常は永続化されて、配信が保証されます。キューを通過したメッセージは、メッセージングシステムによりメッセージコンシューマーに配信されます。 メッセージが処理されると、メッセージコンシューマーはメッセージが配信されたことを確認応答します。Message Queue パターンでは、ポイントツーポイントメッセージングと併用すると、複数のコンシューマーをキューに入れることが可能ですが、各メッセージは単一のコンシューマーのみが受信可能となります。
- Publish-Subscribe パターン
- Publish-Subscribe パターンでは、サーバー上の単一のエンティティに対して複数の送信者がメッセージを送信することが可能です。このエンティティは、「トピック」として広く知られています。各トピックには、複数のコンシューマーが参加することが可能です。これは、「サブスクリプション」として知られています。各サブスクリプションは、トピックによって送信された全メッセージのコピーを受信します。これは、各メッセージを消費するのが単一のコンシューマーのみである Message Queue パターンとは異なります。永続的なサブスクリプションは、トピックに送信された各メッセージをサブスクライバーが消費するまで、そのコピーを保持します。このようなコピーは、サーバーの再起動時にも維持されます。非永続的なサブスクリプションは、そのサブスクリプションを作成した接続が有効な間のみ継続します。
14.1.4. アクセプターおよびコネクターについて
アクセプターおよびコネクター
Acceptor
- アクセプターは、HornetQ サーバーが受け入れる接続タイプを定義します。
Connector
- コネクターは、HornetQ サーバーに接続する方法を定義し、HornetQ クライアントによって使用されます。
Invm および Netty
Invm
- Invm は、Intra Virtual Machine の略語であり、クライアントとサーバーが同じ JVM で実行されているときに使用できます。
Netty
- JBoss プロジェクトの名前。クライアントとサーバーが異なる JVM で実行されている場合に使用する必要があります。
standalone.xml
と domain.xml
で設定されます。これらは、管理コンソールまたは管理 CLI のいずれかを使用して定義できます。
例14.1 デフォルトのアクセプターおよびコネクター設定の例
<connectors> <netty-connector name="netty" socket-binding="messaging"/> <netty-connector name="netty-throughput" socket-binding="messaging-throughput"> <param key="batch-delay" value="50"/> </netty-connector> <in-vm-connector name="in-vm" server-id="0"/> </connectors> <acceptors> <netty-acceptor name="netty" socket-binding="messaging"/> <netty-acceptor name="netty-throughput" socket-binding="messaging-throughput"> <param key="batch-delay" value="50"/> <param key="direct-deliver" value="false"/> </netty-acceptor> <in-vm-acceptor name="in-vm" server-id="0"/> </acceptors>
14.1.5. ブリッジについて
14.1.6. 大規模なメッセージの処理
14.1.8. HornetQ のアプリケーションへの埋め込み
設定オブジェクトのインスタンス化
設定ファイルから、もしくはプログラムを使用して設定パラメーターを指定することにより設定オブジェクトをインスタンス化します。ファイルから設定オブジェクトを作成します。
FileConfigurationImpl
クラスを使用して、ファイルをベースとした設定オブジェクトを設定します。import org.hornetq.core.config.Configuration; import org.hornetq.core.config.impl.FileConfiguration; ... Configuration config = new FileConfiguration(); config.setConfigurationUrl(<replaceable>file-url</replaceable>); config.start();
プログラムを使用して設定オブジェクトを作成します。
ConfigurationImpl
クラスを使用して設定オブジェクトを作成します。import org.hornetq.core.config.Configuration; import org.hornetq.core.config.impl.FileConfiguration; ... Configuration config = new ConfigurationImpl();
- acceptors などの任意の設定パラメーターを指定します。例:
HashSet<TransportConfiguration> transports = new HashSet<TransportConfiguration>(); transports.add(new TransportConfiguration(NettyAcceptorFactory.class.getName())); transports.add(new TransportConfiguration(InVMAcceptorFactory.class.getName())); config.setAcceptorConfigurations(transports);
サーバーをインスタンス化して起動します。
org.hornetq.api.core.server.HornetQ
静的メソッドを使用して、設定オブジェクトをベースとするサーバーを作成して起動します。import org.hornetq.api.core.server.HornetQ; import org.hornetq.core.server.HornetQServer; ... HornetQServer server = HornetQ.newHornetQServer(config); server.start();
埋め込み HornetQ インスタンスは内部メッセージング用にインスタンス化されます。埋め込み HornetQ に接続するには、通常どおりにファクトリを作成します。
14.1.9. JMS サーバーの設定
EAP_HOME/domain/configuration/domain.xml
ファイル、スタンドアローンは EAP_HOME/standalone/configuration/standalone.xml
にあります。
<subsystem xmlns="urn:jboss:domain:messaging:1.0">
要素には、JMS 設定すべてが含まれています。JNDI で必要な JMS のConnectionFactory
、Queue
、あるいはTopic
インスタンスを追加します。
Enterprise Application Platform で JMS サブシステムを有効化
<extensions>
要素にて、以下の行が存在しておりコメントアウトされていないか確認してください。<extension module="org.jboss.as.messaging"/>
基本的な JMS サブシステムの追加
メッセージングサブシステムが設定ファイルに存在しない場合は、追加します。- お使いのプロファイルに該当する
<profile>
を検索し<subsystems>
タグの場所を探します。 <subsystems>
タグのすぐ下に新しい行を追加します。以下をそこに貼り付けます。<subsystem xmlns="urn:jboss:domain:messaging:1.0"> </subsystem>
その他の設定はすべて、その上の空いている行に追加します。
JMS の基本設定を追加
<journal-file-size>102400</journal-file-size> <journal-min-files>2</journal-min-files> <journal-type>NIO</journal-type> <!-- disable messaging persistence --> <persistence-enabled>false</persistence-enabled>
要件にあわせ上記の値をカスタマイズHornetQ に接続ファクトリインスタンスを追加
クライアントは、JMSConnectionFactory
オブジェクトを使い、サーバーへの接続を確立します。JMS 接続ファクトリオブジェクトを HornetQ に追加するには、<jms-connection-factories>
タグを1つ、接続ファクトリごとに<connection-factory>
要素を以下のように追加します。<subsystem xmlns="urn:jboss:domain:messaging:1.0"> ... <jms-connection-factories> <connection-factory name="myConnectionFactory"> <connectors> <connector-ref connector-name="netty"/> </connectors> <entries> <entry name="/ConnectionFactory"/> </entries> </connection-factory> </jms-connection-factories> ... </subsystem>
netty
コネクターの設定この JMS 接続ファクトリは、netty
コネクターを利用します。これは、サーバー設定ファイルにデプロイされたコネクターオブジェクトへの参照です。コネクターオブジェクトは、実際にサーバーへ接続する際に利用するトランスポートとパラメーターを定義します。netty
コネクターを設定するには、以下の設定を含めます。<subsystem xmlns="urn:jboss:domain:messaging:1.0"> ... <connectors> <netty-connector name="netty" socket-binding="messaging"/> <netty-connector name="netty-throughput" socket-binding="messaging-throughput"> <param key="batch-delay" value="50"/> </netty-connector> <in-vm-connector name="in-vm" server-id="0"/> </connectors> ... </subsystem>
コネクターは、messaging
およびmessaging-throughput
ソケットバインディングを参照します。messaging
ソケットバインディングは、ポート 5445 を使い、messaging-throughput
ソケットバインディングはポート 5455 を使います。 以下のソケットバインディングが<socket-binding-groups>
要素に含まれているよう確認してください。<socket-binding-groups> ... <socket-binding-group ... > <socket-binding name="messaging" port="5445"/> <socket-binding name="messaging-throughput" port="5455"/> ... </socket-binding-group> ... </socket-binding-groups>
キューインスタンスを HornetQ に追加
クライアントは JMSQueue
オブジェクトを使いサーバーへ配信する送信メッセージを段階分けします。JMS キューオブジェクトを HornetQ に追加するには、以下のように<jms-queue>
要素を含めます。<subsystem xmlns="urn:jboss:domain:messaging:1.0"> ... <jms-destinations> <jms-queue name="myQueue"> <entry name="/queue/myQueue"/> </jms-queue> </jms-destinations> ...
オプション:トピックインスタンスを HornetQ に追加
クライアントは JMSTopic
オブジェクトを使い、複数のサブスクライバー向けにメッセージを管理します。JMS トピックオブジェクトを追加するには、<topic>
要素を以下のように主組めます。<subsystem xmlns="urn:jboss:domain:messaging:1.0"> ... <topic name="myTopic"> <entry name="/topic/myTopic"/> </topic> ...
追加設定
追加設定が必要な場合、EAP_HOME/docs/schema/jboss-messaging.xsd
の DTD を確認してください。
14.1.10. Java Naming and Directory Interface (JNDI) について
14.1.11. HornetQ 向けに JNDI を設定
手順14.1 タスク
JNDIServer
bean を設定します。
クライアント側で JNDI プロパティを設定
JNDI プロパティにより JNDI クライアントに JNDI サーバーがどこにあるか伝えます。このプロパティをクライアントのクラスパスにあるjndi.properties
のという名前のファイルで指定するか、あるいは最初の JNDI コンテキストの作成時に直接宣言することができます。JNDI プロパティを以下の構成に設定java.naming.factory.initial=org.jnp.interfaces.NamingContextFactory java.naming.provider.url=jnp://hostname:1099 java.naming.factory.url.pkgs=org.jboss.naming:org.jnp.interfaces
- hostname は JNDI サーバーのホスト名あるいは IP アドレスです。
JNDI サーバーポートの設定
管理コンソールの Socket Binding Groups パネルに移動します。
コンソールの左側のメニューから General Configuration → Socket Binding Groups オプションを選択します。選択したサーバーの Socket Binding Groups パネルが表示されます。図14.1 サーバー設定
JNDI ソケットバインディングの編集
Socket Binding Declarations の表から jndi を選択し、下にある ソケットバインディング の Edit ボタンを選択してください。以下の設定と Multicast Port の設定を行い、設定後、Save ボタンを押します。- Port:
1099
- Multicast Port:
1098
JNDI サーバーは HornetQ 用に設定されました。
14.1.12. JMS アドレス の設定
<address-settings>
設定要素内に存在します。
アドレスワイルドカードを使用すると単一のステートメントで複数の似たアドレスを一致させることができます。これは、システムがアスタリスク ( * ) 文字を使用して 1 回の検索で複数のファイルや文字列を一致させることと似ています。以下の文字はワイルドカードステートメントでは特別な意味を持っています。
表14.1 JMX のワイルドカード構文
文字 | 詳細 |
---|---|
. (ピリオド 1 つ) | ワイルドカード表現で単語の間のスペースを意味します。 |
# (シャープまたはハッシュマーク) | ゼロ以上の単語シーケンスと一致します。 |
* (アスタリスク) | 1 つの単語と一致します。 |
表14.2 JMS ワイルドカードの例
例 | 詳細 |
---|---|
news.europe.# | news.europe 、 news.europe.sport 、 news.europe.politic と一致しますが、 news.usa や europe とは一致しません。
|
news. | news.europe と一致しますが、 news.europe.sport とは一致しません。
|
news.*.sport | news.europe.sport と news.usa.sport とは一致しますが、news.europe.politics とは一致しません。
|
例14.2 デフォルトアドレス設定
<address-settings> <!--default for catch all--> <address-setting match="#"> <dead-letter-address>jms.queue.DLQ</dead-letter-address> <expiry-address>jms.queue.ExpiryQueue</expiry-address> <redelivery-delay>0</redelivery-delay> <max-size-bytes>10485760</max-size-bytes> <address-full-policy>BLOCK</address-full-policy> <message-counter-history-day-limit>10</message-counter-history-day-limit> </address-setting> </address-settings>
表14.3 JMS アドレス設定の説明
要素 | 詳細 | デフォルト値 | タイプ |
---|---|---|---|
address-full-policy
|
max-size-bytes が指定されたアドレスがいっぱいの場合に起こることを決定します。
|
PAGE
|
STRING
|
dead-letter-address
|
無効なレターアドレスが指定された場合、
max-delivery-attempts 配信試行が失敗すると、メッセージが無効なレターアドレスに移動されます。それ以外の場合、これらに未配信メッセージは破棄されます。ワイルドカードは許可されます。
|
jms.queue.DLQ
|
STRING
|
expiry-address
|
有効期限が切れたアドレスが存在する場合、有効期限が切れたメッセージは破棄されるのではなく、一致するアドレスに送信されます。ワイルドカードは許可されます。
|
jms.queue.ExpiryQueue
|
STRING
|
last-value-queue
|
キューで最後の値のみを使用するかどうかを定義します。
|
false
|
BOOLEAN
|
max-delivery-attempts
| dead-letter-address に送信する前、または破棄する前にメッセージを再配信する最大試行回数。
|
10
|
INT
|
max-delivery-bytes
|
最大バイトサイズ。
|
10485760L
|
LONG
|
message-counter-history-day-limit
|
メッセージカウンター履歴の日数制限。
|
10
|
INT
|
page-max-cache-size
|
ページングナビゲーション中に IO を最適化するためにメモリー内に保持するページファイルの数。
|
5
|
INT
|
page-size-bytes
|
ページングサイズ。
|
5
|
INT
|
redelivery-delay
|
メッセージの再配信試行間の遅延時間 (ミリ秒単位)。
0 に設定された場合は、再配信が無限に試行されます。
|
0L
|
LONG
|
redistribution-delay
|
メッセージを再配信する前に最後のコンシューマーがキューで閉じられたときの待機時間を定義します。
|
-1L
|
LONG
|
send-to-dla-on-no-route
|
キューにルーティングされず、そのアドレスに指定された無効なレターアドレス (DLA) に送信されたメッセージの条件を設定するアドレスのパラメーター。
|
false
|
BOOLEAN
|
アドレス設定とパターン属性の設定
管理 CLI または管理コンソールを選択して、必要に応じてパターン属性を設定します。管理 CLI を使用したアドレス設定
管理 CLI を使用してアドレスを設定します。新しいパターンの追加
add
操作を使用して、新しいアドレス設定を作成します (必要な場合)。このコマンドは、管理 CLI セッションのルートから実行できます。この場合、以下の例では、 patternname というタイトルの新しいパターンが作成され、max-delivery-attempts
属性が 5 として宣言されます。full
プロファイルのスタンドアロンと監理対象ドメインの編集の例が示されます。[domain@localhost:9999 /] /profile=full/subsystem=messaging/hornetq-server=default/address-setting=patternname/:add(max-delivery-attempts=5)
[standalone@localhost:9999 /] /subsystem=messaging/hornetq-server=default/address-setting=patternname/:add(max-delivery-attempts=5)
パターン属性の編集
write
操作を使用して新しい値を属性に書き込みます。タブ補完を使用して、入力するコマンド文字列を補完したり、利用可能な属性を公開したりできます。以下の例は、max-delivery-attempts
値を 10 に更新します。[domain@localhost:9999 /] /profile=full/subsystem=messaging/hornetq-server=default/address-setting=patternname/:write-attribute(name=max-delivery-attempts,value=10)
[standalone@localhost:9999 /] /subsystem=messaging/hornetq-server=default/address-setting=patternname/:write-attribute(name=max-delivery-attempts,value=10)
パターン属性の確認
read-resource
操作でinclude-runtime=true
パラメーターを実行して値を変更し、サーバーモデルでアクティブな現在のすべての値を公開します。[domain@localhost:9999 /] /profile=full/subsystem=messaging/hornetq-server=default/address-setting=patternname/:read-resource
[standalone@localhost:9999 /] /subsystem=messaging/hornetq-server=default/address-setting=patternname/:read-resource
管理コンソールを使用したアドレスの設定
管理コンソールを使用してアドレスを設定します。管理コンソールにログインします。
管理対象ドメインまたはスタンドアロンサーバーの管理コンソールにログインします。監理対象ドメインを使用する場合は、適切なプロファイルを選択します。
右上にある Profiles タブを選択し、次の画面の左上にある Profile メニューから適切なプロファイルを選択します。full
プロファイルとfull-ha
プロファイルのみでmessaging
サブシステムが有効になります。ナビゲーションメニューから Messaging 項目を選択します。
ナビゲーションメニューから Messaging メニュー項目を展開し、Destinations をクリックします。JMS プロバイダーを表示します。
JMS プロバイダーのリストが表示されます。デフォルトの設定では、default
という名前の 1 つのプロバイダーだけが表示されます。View リンクをクリックして、このプロバイダーの詳細な設定を表示します。アドレス設定を表示します。
Addressing タブをクリックします。Add ボタンをクリックして新しいパターンを追加するか、名前をクリックし、次に Edit ボタンをクリックすることにより、既存のパターンを編集します。オプションを設定します。
新しいパターンを追加する場合、Pattern フィールドはaddress-setting
要素のmatch
パラメーターを参照します。また、Dead Letter Address、Expiry Address、Redelivery Delay、および Max Delivery Attempts を編集することもできます。他のオプションは、管理 CLI を使用して設定する必要があります。
14.1.13. HornetQ 設定属性のリファレンス
read-resource
操作で設定可能または表示可能な属性を公開できます。
例14.3 例
[standalone@localhost:9999 /] /subsystem=messaging/hornetq-server=default:read-resource
表14.4 TableTitle
属性 | サンプル値 | タイプ |
---|---|---|
allow-failback | true | BOOLEAN |
async-connection-execution-enabled | true | BOOLEAN |
backup | false | BOOLEAN |
cluster-password | somethingsecure | STRING |
cluster-user | HORNETQ.CLUSTER.ADMIN.USER | STRING |
clustered | false | BOOLEAN |
connection-ttl-override | -1 | LONG |
create-bindings-dir | true | BOOLEAN |
create-journal-dir | true | BOOLEAN |
failback-delay | 5000 | LONG |
failover-on-shutdown | false | BOOLEAN |
id-cache-size | 2000 | INT |
jmx-domain | org.hornetq | STRING |
jmx-management-enabled | false | BOOLEAN |
journal-buffer-size | 100 | LONG |
journal-buffer-timeout | 100 | LONG |
journal-compact-min-files | 10 | INT |
journal-compact-percentage | 30 | INT |
journal-file-size | 102400 | LONG |
journal-max-io | 1 | INT |
journal-min-files | 2 | INT |
journal-sync-non-transactional | true | BOOLEAN |
journal-sync-transactional | true | BOOLEAN |
journal-type | ASYNCIO | STRING |
live-connector-ref | reference | STRING |
log-journal-write-rate | false | BOOLEAN |
management-address | jms.queue.hornetq.management | STRING |
management-notification-address | hornetq.notifications | STRING |
memory-measure-interval | -1 | LONG |
memory-warning-threshold | 25 | INT |
message-counter-enabled | false | BOOLEAN |
message-counter-max-day-history | 10 | INT |
message-counter-sample-period | 10000 | LONG |
message-expiry-scan-period | 30000 | LONG |
message-expiry-thread-priority | 3 | INT |
page-max-concurrent-io | 5 | INT |
perf-blast-pages | -1 | INT |
persist-delivery-count-before-delivery | false | BOOLEAN |
persist-id-cache | true | BOOLEAN |
persistence-enabled | true | BOOLEAN |
remoting-interceptors | 未定義 | LIST |
run-sync-speed-test | false | BOOLEAN |
scheduled-thread-pool-max-size | 5 | INT |
security-domain | その他 | STRING |
security-enabled | true | BOOLEAN |
security-invalidation-interval | 10000 | LONG |
server-dump-interval | -1 | LONG |
shared-store | true | BOOLEAN |
started | true | BOOLEAN |
thread-pool-max-size | 30 | INT |
transaction-timeout | 300000 | LONG |
transaction-timeout-scan-period | 1000 | LONG |
version | 2.2.16.Final (HQ_2_2_16_FINAL, 122) | STRING |
wild-card-routing-enabled | true | BOOLEAN |
14.1.14. HornetQ でのメッセージングの設定
standalone.xml
や domain.xml
設定ファイルを手作業で編集せずに永続的な変更を行うことができますが、デフォルト設定ファイルのメッセージングコンポーネントについて理解できると便利です。デフォルトの設定ファイルでは、管理ツールを使用するドキュメントサンプルにより参考用の設定ファイル断片が提供されます。
14.1.15. 遅延再配信の設定
遅延再配信は、Java Messaging Service (JMS) のサブシステム設定の <address-setting>
設定要素の子要素である <redelivery-delay>
要素に定義されます。
<!-- delay redelivery of messages for 5s --> <address-setting match="jms.queue.exampleQueue"> <redelivery-delay>5000</redelivery-delay> </address-setting>
<redelivery-delay>
を 0
に設定すると、再配信の遅延はありません。<address-setting-match>
要素にアドレスワイルドカードを使用すると、ワイルドカードに一致するアドレスに対して再配信の遅延を設定することができます。
14.1.16. デッドレターアドレスの設定
デッドレターアドレスは Java Messaging Service (JMS) の サブシステム設定の <address-setting>
要素で定義されます。
<!-- undelivered messages in exampleQueue will be sent to the dead letter address deadLetterQueue after 3 unsuccessful delivery attempts --> <address-setting match="jms.queue.exampleQueue"> <dead-letter-address>jms.queue.deadLetterQueue</dead-letter-address> <max-delivery-attempts>3</max-delivery-attempts> </address-setting>
<dead-letter-address>
が指定されていないと、 <max-delivery-attempts>
で指定される回数配信を試みた後、メッセージが削除されます。 デフォルトでは 10回 メッセージの配信を試みます。<max-delivery-attempts>
を -1
に設定すると、再配信が無限に試行されます。例えば、一致するアドレスのセットに対してグローバルにデッドレターを設定することができ、特定アドレスの <max-delivery-attempts>
を -1
に設定し、このアドレスのみ再配信が無限に行われるようにすることが可能です。アドレスワイルドカードを使用してアドレスのセットにデッドレターを設定することも可能です。
14.1.17. メッセージ期限切れアドレス
メッセージ有効期限アドレスは Java Messaging Service (JMS) の address-setting 設定に定義されています。例は次の通りです。
<!-- expired messages in exampleQueue will be sent to the expiry address expiryQueue --> <address-setting match="jms.queue.exampleQueue"> <expiry-address>jms.queue.expiryQueue</expiry-address> </address-setting>
アドレスワイルドカードを使用すると単一のステートメントで複数の似たアドレスを一致させることができます。これは、システムがアスタリスク ( * ) 文字を使用して 1 回の検索で複数のファイルや文字列を一致させることと似ています。以下の文字はワイルドカードステートメントでは特別な意味を持っています。
表14.5 JMX のワイルドカード構文
文字 | 説明 |
---|---|
. (ピリオド 1 つ) | ワイルドカード表現で言葉の間のスペースを意味します。 |
# (シャープまたはハッシュマーク) | ゼロ以上の言葉の配列と一致します。 |
* (アスタリスク) | 1 つの言葉と一致します。 |
表14.6 JMS ワイルドカードの例
例 | 説明 |
---|---|
news.europe.# | news.europe 、 news.europe.sport 、 news.europe.politic と一致しますが、 news.usa や europe とは一致しません。
|
news. | news.europe と一致しますが、 news.europe.sport とは一致しません。
|
news.*.sport | news.europe.sport と news.usa.sport とは一致しますが、news.europe.politics とは一致しません。
|
14.1.18. メッセージの有効期限の設定
HornetQ Core API を使用すると失効時間を直接メッセージに設定できます。例は次の通りです。
// message will expire in 5000ms from now message.setExpiration(System.currentTimeMillis() + 5000);
MessageProducer
JMS MessageProducer
には送信するメッセージの有効期限を制御する TimeToLive
パラメーターが含まれています。
// messages sent by this producer will be retained for 5s (5000ms) before expiration producer.setTimeToLive(5000);
- _HQ_ORIG_ADDRESS
- _HQ_ACTUAL_EXPIRY
第15章 トランザクションサブシステム
15.1. トランザクションサブシステムの設定
15.1.1. トランザクション設定の概要
次の手順は、JBoss Enterprise Application Platform のトランザクションサブシステムを設定する方法を示しています。
15.1.2. トランザクションマネージャーの設定
default
以外の異なるプロファイルを修正したい場合は、以下の方法で手順とコマンドを修正しなければならない場合があります。
例のコマンドに関する注意点
- 管理コンソールの場合、
default
プロファイルは最初のコンソールログイン時に選択されるものです。異なるプロファイルでトランザクションマネージャーの設定を修正する必要がある場合は、default
の代わりに使用しているプロファイルを選択してください。同様に、例の CLI コマンドのdefault
プロファイルを使用しているプロファイルに置き換えてください。 - スタンドアローンサーバーを使用する場合、存在するプロファイルは 1 つのみです。特定のプロファイルを選択する手順は無視してください。CLI コマンドでは、例のコマンドの
/profile=default
部分を削除してください。
注記
transactions
サブシステムが有効でなくてはなりません。これは、デフォルトで有効になっており、他の多くのサブシステムが適切に機能するために必要なため、無効にする可能性は大変低くなります。
Web ベースの管理コンソールを使用して TM を設定するには、管理コンソール画面の左上にある一覧から Runtime タブを選択します。管理ドメインを使用する場合、選択できるプロファイルがいくつかあります。プロファイル画面の右上にある Profile 選択ボックスから適切なプロファイルを選択してください。Container メニューを展開して、Transactions を選択します。
管理 CLI では、一連のコマンドを使用して TM を設定できます。プロファイル default
の管理ドメインの場合、コマンドはすべて /profile=default/subsystem=transactions/
で始まり、スタンドアローンサーバーの場合は /subsystem=transactions
で始まります。
表15.1 TM 設定オプション
オプション | 詳細 | CLI コマンド |
---|---|---|
Enable Statistics
|
トランザクションの統計を有効にするかどうか指定します。統計は Runtime タブの Subsystem Metrics セクションにある管理コンソールで閲覧できます。
| /profile=default/subsystem=transactions/:write-attribute(name=enable-statistics,value=true)
|
Enable TSM Status
|
トランザクションステータスマネージャー (TSM) のサービスを有効にするかどうか指定します。これは、アウトオブプロセスのリカバリに使用されます。
| /profile=default/subsystem=transactions/:write-attribute(name=enable-tsm-status,value=false)
|
Default Timeout
|
デフォルトのトランザクションタイムアウトです。デフォルトでは
300 秒に設定されています。トランザクションごとにプログラムで上書きできます。
| /profile=default/subsystem=transactions/:write-attribute(name=default-timeout,value=300)
|
Path
|
トランザクションマネージャーコアがデータを格納するファイルシステムの相対または絶対パスです。デフォルトの値は
relative-to 属性の値と相対的なパスです。
| /profile=default/subsystem=transactions/:write-attribute(name=path,value=var)
|
Relative To
|
ドメインモデルのグローバルなパス設定を参照します。デフォルト値は、JBoss Enterprise Application Platform 用のデータディレクトリで、
jboss.server.data.dir プロパティの値です。デフォルトでは、管理ドメインの場合は EAP_HOME/domain/data/ に、スタンドアローンサーバーの場合は EAP_HOME/standalone/data/ に設定されています。path TM 属性の値は、このパスに相対的です。空の文字列を使用して、デフォルト動作を無効にし、path 属性の値が絶対パスとして強制的に扱われるようにします。
| /profile=default/subsystem=transactions/:write-attribute(name=relative-to,value=jboss.server.data.dir)
|
Object Store Path
|
TM オブジェクトストアがデータを格納するファイルシステムの相対または絶対パスです。デフォルトでは、
object-store-relative-to パラメーターの値に相対的です。
| /profile=default/subsystem=transactions/:write-attribute(name=object-store-path,value=tx-object-store)
|
Object Store Path Relative To
|
ドメインモデルのグローバルなパス設定を参照します。デフォルト値は、JBoss Enterprise Application Platform 用のデータディレクトリで、
jboss.server.data.dir プロパティの値です。デフォルトでは、管理ドメインの場合は EAP_HOME/domain/data/ に、スタンドアローンサーバーの場合は EAP_HOME/standalone/data/ に設定されています。path TM 属性の値は、このパスに相対的です。空の文字列を使用して、デフォルト動作を無効にし、path 属性の値が絶対パスとして強制的に扱われるようにします。
| /profile=default/subsystem=transactions/:write-attribute(name=object-store-relative-to,value=jboss.server.data.dir)
|
Socket Binding
|
ソケットベースのメカニズムを使用する場合に、トランザクションマネージャーの回復およびトランザクション識別子の生成に使用するソケットバインディングの名前を指定します。一意の識別子を生成する詳しい情報は、
process-id-socket-max-ports を参照してください。ソケットバインディングは、管理コンソールの Server タブでサーバーグループごとに指定されます。
| /profile=default/subsystem=transactions/:write-attribute(name=socket-binding,value=txn-recovery-environment)
|
Status Socket Binding
|
トランザクションステータスマネージャーで使用するソケットバインディングを指定します。
| /profile=default/subsystem=transactions/:write-attribute(name=status-socket-binding,value=txn-status-manager)
|
Recovery Listener
|
トランザクション回復のプロセスがネットワークソケットをリッスンするかどうか指定します。デフォルトは
false です。
| /profile=default/subsystem=transactions/:write-attribute(name=recovery-listener,value=false)
|
表15.2 高度な TM 設定オプション
オプション | 詳細 | CLI コマンド |
---|---|---|
jts
|
Java Transaction Service (JTS) トランザクションを使用するかどうか指定します。デフォルトは
false で、JTA トランザクションのみ使用します。
| /profile=default/subsystem=transactions/:write-attribute(name=jts,value=false)
|
node-identifier
|
JTS サービスのノード識別子です。トランザクションマネージャーが回復時にこれを使用するため、JTS サービスごとに一意でなければなりません。
| /profile=default/subsystem=transactions/:write-attribute(name=node-identifier,value=1)
|
process-id-socket-max-ports
|
トランザクションマネージャーは、各トランザクションログに対し一意の識別子を作成します。一意の識別子を生成するメカニズムは 2 種類あります。ソケットベースのメカニズムとプロセスのプロセス識別子をベースにしたメカニズムです。
ソケットベースの識別子の場合、あるソケットを開くと、そのポート番号が識別子用に使用されます。ポートがすでに使用されている場合は、空きのポートが見つかるまで次のポートがプローブされます。
process-id-socket-max-ports は、TM が失敗するまでに試行するソケットの最大値を意味します。デフォルト値は 10 です。
| /profile=default/subsystem=transactions/:write-attribute(name=process-id-socket-max-ports,value=10)
|
process-id-uuid
| true に設定すると、プロセス識別子を使用して各トランザクションに一意の識別子を作成します。そうでない場合は、ソケットベースのメカニズムが使用されます。デフォルトは true です。詳細は process-id-socket-max-ports を参照してください。
| /profile=default/subsystem=transactions/:write-attribute(name=process-id-uuid,value=true)
|
use-hornetq-store
|
トランザクションログ用に、ファイルベースのストレージの代わりに HornetQ のジャーナルストレージメカニズムを使用します。デフォルトでは無効になっていますが、I/O パフォーマンスが向上します。別々のトランザクションマネージャーで JTS トランザクションを使用することは推奨されません。これを有効にした場合は、
log-store 値も hornetq に変更してください。
| /profile=default/subsystem=transactions/:write-attribute(name=use-hornetq-store,value=false)
|
log-store
|
ファイルシステムベースのオブジェクトストアを使用する場合は
default に、HornetQ のジャーナリングストレージメカニズムを使用する場合は hornetq に設定します。これを hornetq に設定した場合は、use-hornetq-store も true に変更してください。
| /profile=default/subsystem=transactions/log-store=log-store/:write-attribute(name=type,value=default)
|
15.1.3. JTA トランザクションを使用するようにデータソースを設定する
このタスクでは、Java Transaction API (JTA) をお使いのデータソースで有効化する方法を説明します。ここでの説明はアーリーアクセスプログラム用で、Enterprise Application Platform 6 では変更される予定です。
このタスクを行う前に、 次の条件を満たす必要があります。
- お使いのデータベースまたはその他のリソースが JTA をサポートしている必要があります。不明な場合は、データソースまたはリソースの文書を参照してください。
- データベースを作成する必要があります。「管理インターフェースによる非 XA データソースの作成」 を参照してください。
- JBoss Enterprise Application Platform を停止します。
- テキストエディターで設定ファイルを直接編集できる権限を持たなければなりません。
手順15.1 タスク
テキストエディターで設定ファイルを開きます。
Enterprise Application Platform を管理ドメインまたはスタンドアローンサーバーで実行するかどうかに応じて、設定ファイルの場所が異なります。管理対象ドメイン
管理ドメインのデフォルトの設定ファイルは、Red Hat Enterprise Linux の場合はEAP_HOME/domain/configuration/domain.xml
にあります。Microsoft Windows サーバーの場合はEAP_HOME\domain\configuration\domain.xml
にあります。スタンドアロンサーバー
スタンドアロンサーバーのデフォルトの設定ファイルは、Red Hat Enterprise Linux の場合はEAP_HOME/standalone/configuration/standalone.xml
にあります。Microsoft Windows サーバーの場合はEAP_HOME\standalone\configuration\standalone.xml
にあります。
お使いのデータソースに対応する
<datasource>
タグを探します。データソースのjndi-name
属性には作成時に指定した属性が設定されます。例えば、 ExampleDS データソースは次のようになります。<datasource jndi-name="java:jboss/datasources/ExampleDS" pool-name="H2DS" enabled="true" jta="true" use-java-context="true" use-ccm="true">
jta
属性をtrue
に設定します。上記のように、jta="true"
を<datasource>
タグの内容に追加します。設定ファイルを保存します。
設定ファイルを保存しテキストエディターを終了します。JBoss Enterprise Application Platform を起動します。
JBoss Enterprise Application Platform 6 サーバーを再起動します。
JBoss Enterprise Application Platform が起動し、データソースが JTA トランザクションを使用するように設定されます。
15.1.4. XA Datasource の設定
XA Datasource を追加するには、管理コンソールにログインする必要があります。詳細は 「管理コンソールへログイン」 を参照してください。
新規データソースの追加
新規データソースを Enterprise Application Platform に追加します。「管理インターフェースによる非 XA データソースの作成」 の手順に従いますが、上部の XA Datasource タブをクリックしてください。必要に応じて他のプロパティーを設定します。
データソースパラメーターの一覧は 「データソースのパラメーター」 にあります。
XA Datasource が設定され、使用する準備ができました。
15.1.5. トランザクションログメッセージについて
DEBUG
ログレベルを使用します。詳細なデバッグでは TRACE
ログレベルを使用します。トランザクションロガーの設定に関する詳細は 「トランザクションサブシステムのログ設定」 を参照してください。
TRACE
ログレベルに設定すると、トランザクションマネージャーは多くのロギング情報を生成できます。一般的に表示されるメッセージの一部は次の通りです。他のメッセージが表示されることもあります。
表15.3 トランザクションステートの変更
トランザクションの開始 |
トランザクションが開始されると、次のコードが実行されます。
com.arjuna.ats.arjuna.coordinator.BasicAction::Begin:1342 tsLogger.logger.trace("BasicAction::Begin() for action-id "+ get_uid()); |
トランザクションのコミット |
トランザクションがコミットすると次のコードが実行されます。
com.arjuna.ats.arjuna.coordinator.BasicAction::End:1342 tsLogger.logger.trace("BasicAction::End() for action-id "+ get_uid()); |
トランザクションのロールバック |
トランザクションがロールバックされると次のコードが実行されます。
com.arjuna.ats.arjuna.coordinator.BasicAction::Abort:1575 tsLogger.logger.trace("BasicAction::Abort() for action-id "+ get_uid()); |
トランザクションのタイムアウト |
トランザクションがタイムアウトすると次のコードが実行されます。
com.arjuna.ats.arjuna.coordinator.TransactionReaper::doCancellations:349 tsLogger.logger.trace("Reaper Worker " + Thread.currentThread() + " attempting to cancel " + e._control.get_uid()); You will then see the same thread rolling back the transaction as shown above |
15.1.6. トランザクションサブシステムのログ設定
Enterprise Application Platform の他のログ設定に依存せずにトランザクションログの情報量を制御する手順を説明します。主に Web ベースの管理コンソールを用いた手順を説明し、管理 CLI のコマンドはその説明の後で取り上げます。
手順15.2 管理コンソールを使用したトランザクションロガーの設定
ログ設定エリアへの移動
管理コンソールにて画面の左上にある Profiles タブをクリックします。管理ドメインを使用する場合は、右上の Profile 選択ボックスから設定したいサーバープロファイルを選択します。Core メニューを展開して、Logging ラベルをクリックします。com.arjuna
属性を編集します。ページの下の方にある Details セクションの Edit ボタンをクリックします。ここにクラス固有のログ情報を追加できます。com.arjuna
クラスはすでに存在しています。ログレベルと親ハンドラーを使用するかどうか変更できます。- ログレベル
- デフォルトのログレベルは
WARN
です。トランザクションはログを大量に出力できるため、標準的なログレベルの意味は、トランザクションロガーでは若干異なります。通常、選択したレベルより重要度が低いレベルでタグ付けされたメッセージは破棄されます。トランザクションログのレベル (詳細度が最高レベルから最低レベルまで)
- DEBUG
- INFO
- WARN
- ERROR
- FAILURE
- 親ハンドラーの使用
- ロガーがログ出力を親ロガーに送信するかどうか指定します。デフォルトの動作は
true
です。
- 変更は直ちに反映されます。
15.2. トランザクション管理
15.2.1. トランザクションの参照と管理
log-store
と呼ばれるリソースとして公開します。probe
と呼ばれる API 操作はトランザクションログを読み取り、各ログに対してノードを作成します。probe
コマンドは、log-store
を更新する必要があるときに、いつでも手動で呼び出すことができます。トランザクションログが現れて、すぐに消失されるのは通常のことです。
例15.1 ログストアの更新
default
を使用するサーバーグループに対してログストアを更新します。スタンドアローンサーバーの場合は、コマンドから profile=default
を削除します。
/profile=default/subsystem=transactions/log-store=log-store/:probe
例15.2 準備されたすべてのトランザクションの表示
ls
コマンドに類似した機能を持つ次のコマンドを実行します。
ls /profile=default/subsystem=transactions/log-store=log-store/transactions
トランザクションの管理
- トランザクションの属性を表示します。
- JNDI 名、EIS 製品名およびバージョン、ステータスなどのトランザクションに関する情報を表示するには、
:read-resource
CLIコマンドを使用します。/profile=default/subsystem=transactions/log-store=log-store/transactions=0\:ffff7f000001\:-b66efc2\:4f9e6f8f\:9:read-resource
- トランザクションの参加者を表示します。
- 各トランザクションログには、
参加者
と呼ばれる子要素が含まれます。トランザクションの参加者を確認するには、この要素に対してread-resource
CLI コマンドを使用します。参加者は、JNDI 名によって識別されます。/profile=default/subsystem=transactions/log-store=log-store/transactions=0\:ffff7f000001\:-b66efc2\:4f9e6f8f\:9/participants=java\:\/JmsXA:read-resource
結果は以下のようになります。{ "outcome" => "success", "result" => { "eis-product-name" => "HornetQ", "eis-product-version" => "2.0", "jndi-name" => "java:/JmsXA", "status" => "HEURISTIC", "type" => "/StateManager/AbstractRecord/XAResourceRecord" } }
ここで示された結果ステータスはHEURISTIC
であり、復元可能です。詳細については、トランザクションを復元します。 を参照してください。 - トランザクションを削除します。
- 各トランザクションログは、トランザクションを表すトランザクションログを削除するために、
:delete
操作をサポートします。/profile=default/subsystem=transactions/log-store=log-store/transactions=0\:ffff7f000001\:-b66efc2\:4f9e6f8f\:9:delete
- トランザクションを復元します。
- 各トランザクションログは、
:recover
CLI コマンドを使用した復元をサポートします。ヒューリスティックなトランザクションと参加者の復元
- トランザクションのステータスが
HEURISTIC
である場合は、復元操作によって、ステータスがPREPARE
に変わり、復元がトリガーされます。 - トランザクションの参加者の 1 つがヒューリスティックな場合、復元操作により、
commit
操作の応答が試行されます。成功した場合、トランザクションログから参加者が削除されます。これを確認するには、log-store
上で:probe
操作を再実行し、参加者がリストされていないことを確認します。これが最後の参加者の場合は、トランザクションも削除されます。
- 復元が必要なトランザクションのステータスを更新します。
- トランザクションを復元する必要がある場合は、復元を試行する前に、
:refresh
CLI コマンドを使用して、トランザクションで復元が必要であることを確認できます。/profile=default/subsystem=transactions/log-store=log-store/transactions=0\:ffff7f000001\:-b66efc2\:4f9e6f8f\:9:refresh
注記
use-hornetq-store
オプションの値を true
に設定します。トランザクションマネージャーの設定については、「JTA トランザクションを使用するようにデータソースを設定する」 を参照してください。
Web ベースの管理コンソールまたはコマンドライン管理 CLI のいずれかを使用して、トランザクションマネージャーとトランザクションサブシステムに関する統計情報を評できます。
表15.4 トランザクションサブシステム統計情報
統計 | 説明 | CLI コマンド |
---|---|---|
Total (合計) |
このサーバー上でトランザクションマネージャーにより処理されるトランザクションの合計数。
|
/host=master/server=server-one/subsystem=transactions/:read-attribute(name=number-of-transactions,include-defaults=true) |
Committed (コミット済み) |
このサーバー上でトランザクションマネージャーにより処理されるコミット済みトランザクションの数。
|
/host=master/server=server-one/subsystem=transactions/:read-attribute(name=number-of-committed-transactions,include-defaults=true) |
Aborted (異常終了) |
このサーバー上でトランザクションマネージャーにより処理される異常終了したトランザクションの数。
|
/host=master/server=server-one/subsystem=transactions/:read-attribute(name=number-of-aborted-transactions,include-defaults=true) |
Timed Out (タイムアウト) |
このサーバー上でトランザクションマネージャーにより処理されるタイムアウトのトランザクションの数。
|
/host=master/server=server-one/subsystem=transactions/:read-attribute(name=number-of-timed-out-transactions,include-defaults=true) |
Heuristics (ヒューリスティック) |
管理コンソールで利用不可です。ヒューリスティック状態のトランザクションの数。
|
/host=master/server=server-one/subsystem=transactions/:read-attribute(name=number-of-heuristics,include-defaults=true) |
In-Flight Transactions (フライト状態のトランザクション) |
管理コンソールでは使用できません。開始した未終了のトランザクションの数。
|
/host=master/server=server-one/subsystem=transactions/:read-attribute(name=number-of-inflight-transactions,include-defaults=true) |
Failure Origin - Applications (障害の原因 - アプリケーション) |
障害の原因がアプリケーションであった失敗トランザクションの数。
|
/host=master/server=server-one/subsystem=transactions/:read-attribute(name=number-of-application-rollbacks,include-defaults=true) |
Failure Origin - Resources (障害の原因 - リソース) |
障害の原因がリソースであった失敗トランザクションの数。
|
/host=master/server=server-one/subsystem=transactions/:read-attribute(name=number-of-resource-rollbacks,include-defaults=true) |
15.3. トランザクションに関する参考資料
15.3.1. JBoss Transactions エラーと例外
UserTransaction
クラスのメソッドがスローする例外に関する詳細は、http://download.oracle.com/javaee/1.3/api/javax/transaction/UserTransaction.html の 『UserTransaction API』 の仕様を参照してください。
15.3.2. JTA クラスタリングの制限事項
15.4. ORB 設定
15.4.1. Common Object Request Broker Architecture (CORBA) について
15.4.2. JTS トランザクション用 ORB の設定
注記
full
および full-ha
プロファイルでのみ利用可能です。スタンドアロンサーバーでは、standalone-full.xml
または standalone-full-ha.xml
設定で利用可能です。
手順15.3 管理コンソールを使用した ORB の設定
プロファイル設定を表示します。
管理コンソールの右上から Profiles (管理対象ドメイン) または Profile (スタンドアロンサーバー) を選択します。管理対象ドメインを使用する場合は、左上にある選択ボックスから full または full-ha プロファイルを選択します。Initializers 設定の変更
必要な場合は、左側にある Subsystems メニューを展開します。Container サブメニューを展開し、JacORB をクリックします。メイン画面に表示されるフォームで、Initializers タブを選択し、Edit ボタンをクリックします。Security の値をon
に設定して、セキュリティーインターセプターを有効にします。JTS 用 ORB を有効にするには、Transaction Interceptors 値をデフォルトのspec
ではなくon
に設定します。これらの値に関する詳細な説明については、フォームの Need Help? リンクを参照してください。値の編集が完了したら、Save をクリックします。高度な ORB 設定
高度な設定オプションについては、フォームの他のセクションを参照してください。各セクションには、パラメーターに関する詳細な情報とともに Need Help? リンクが含まれます。
管理 CLI を使用して ORB の各側面を設定できます。以下のコマンドは、管理コンソールに対するイニシャライザーに上記の手順と同じ値を設定します。これは、JTS と使用する ORB の最小設定です。
/profile=full
部分を省略します。
例15.3 セキュリティーインターセプターの有効化
/profile=full/subsystem=jacorb/:write-attribute(name=security,value=on)
例15.4 JTS 用 ORB の有効化
/profile=full/subsystem=jacorb/:write-attribute(name=transactions,value=on)
第16章 Enterprise JavaBeans
16.1. はじめに
16.1.1. Enterprise JavaBeans の概要
16.1.2. 管理者向け Enterprise JavaBeans の概要
- 右上の Profile リンクをクリックして Profile ビューに切り替えます。
- Profile メニューが左側で展開されることを確認します。展開されたときに、Profile ラベルの横にある矢印が下向きになります。
- Container をクリックして展開し、EJB 3をクリックします。
- 上部の Profile リンクをクリックして、Profile ビューに切り替えます。
- 左側で Subsystems メニューが展開されていることを確認します。展開されたときに、Subsystems ラベルの横にある矢印が下向きになります。
- Profile メニューから、変更するプロファイルを選択します。
- Container をクリックして展開し、EJB 3をクリックします。
図16.1 管理コンソールの EJB 設定オプション (スタンドアロンサーバー)
16.1.3. エンタープライズ Bean
重要
16.1.4. セッション Bean
16.1.5. メッセージ駆動型 Bean
16.2. Bean プールの設定
16.2.1. Bean プール
16.2.2. Bean プールの作成
手順16.1 管理コンソールを使用した Bean プールの作成
- 管理コンソールへログインします。「管理コンソールへログイン」 を参照してください。
- EJB3 Bean Pools パネルへ移動します。
図16.2 EJB3 Bean プールパネル
- Add ボタンをクリックすると、Add EJB3 Bean Pools ダイアログが表示されます。
- 必要な詳細、Name、Max Pool Size、Timeout の値と、Timeout の単位を指定します。
- Save ボタンをクリックして新しい Bean プールを追加するか、 Cancel リンクをクリックして取り消します。
- Save ボタンをクリックすると、ダイアログが閉じられ、新しい Bean プールが一覧に表示されます。
- Cancel をクリックするとダイアログが閉じられ、新しい Bean プールは作成されません。
手順16.2 CLI を使用した Bean プールの作成
- CLI ツールを起動し、サーバーに接続します。「管理 CLI を使用した管理対象サーバーインスタンスへの接続」を参照してください。
- 次の構文で
add
操作を使用します。/subsystem=ejb3/strict-max-bean-instance-pool=BEANPOOLNAME:add(max-pool-size=MAXSIZE, timeout=TIMEOUT, timeout-unit="UNIT")
- BEANPOOLNAME を Bean プールの必要な名前に置き換えます。
- MAXSIZE を Bean プールの最大サイズに置き換えます。
- TIMEOUT の置き換え
- UNIT を必要な時間単位に置き換えます。使用可能な値は
NANOSECONDS
、MICROSECONDS
、MILLISECONDS
、SECONDS
、MINUTES
,HOURS
、DAYS
です。
read-resource
操作を使用して Bean プールの作成を確認します。/subsystem=ejb3/strict-max-bean-instance-pool=BEANPOOLNAME:read-resource
例16.1 CLI を使用した Bean プールの作成
[standalone@localhost:9999 /] /subsystem=ejb3/strict-max-bean-instance-pool=ACCTS_BEAN_POOL:add(max-pool-size=500, timeout=5000, timeout-unit="SECONDS") {"outcome" => "success"} [standalone@localhost:9999 /]
例16.2 XML 設定の例
<subsystem xmlns="urn:jboss:domain:ejb3:1.2"> <pools> <bean-instance-pools> <strict-max-pool name="slsb-strict-max-pool" max-pool-size="20" instance-acquisition-timeout="5" instance-acquisition-timeout-unit="MINUTES" /> <strict-max-pool name="mdb-strict-max-pool" max-pool-size="20" instance-acquisition-timeout="5" instance-acquisition-timeout-unit="MINUTES" /> </bean-instance-pools> </pools> </subsystem>
16.2.3. Bean プールの削除
前提条件
- 使用されている Bean プールは削除できません。「セッションおよびメッセージ駆動型 Bean に対する Bean プールの割り当て」 を参照して、Bean プールが使用されていないことを確認してください。
手順16.3 管理コンソールを使用した Bean プールの削除
- 管理コンソールへログインします。「管理コンソールへログイン」 を参照してください。
- 右上の Profile をクリックし、左側の Profile パネルの Container 項目を展開して、EJB 3 を選択します。次に、メインパネルから Bean Pools タブを選択します。
図16.3 EJB3 Bean プールパネル
- 一覧より削除する Bean プールを選択します。
- Remove ボタンをクリックします。Remove Item ダイアログが表示されます。
- OK ボタンをクリックして削除を実行するか、Cancel リンクをクリックして処理を取り消します。Ok ボタンをクリックすると、ダイアログが閉じられます。Bean プールが削除され、一覧からも削除されます。Cancel をクリックするとダイアログが閉じられ、何も変更されません。
手順16.4 CLI を使用した Bean プールの削除
- CLI ツールを起動し、サーバーに接続します。「管理 CLI を使用した管理対象サーバーインスタンスへの接続」を参照してください。
- 次の構文で
remove
操作を使用します。/subsystem=ejb3/strict-max-bean-instance-pool=BEANPOOLNAME:remove
- BEANPOOLNAME を Bean プールの必要な名前に置き換えます。
例16.3 CLI を使用した Bean プールの削除
[standalone@localhost:9999 /] /subsystem=ejb3/strict-max-bean-instance-pool=ACCTS_BEAN_POOL:remove {"outcome" => "success"} [standalone@localhost:9999 /]
16.2.4. Bean プールの編集
手順16.5 管理コンソールを使用した Bean プールの編集
- 管理コンソールへログインします。「管理コンソールへログイン」 を参照してください。
- 右上の Profile をクリックし、左側の Profile パネルの Container 項目を展開して、EJB 3 を選択します。次に、メインパネルから Bean Pools タブを選択します。
図16.4 EJB3 Bean プールパネル
- 一覧より編集する Bean プールを選択します。
- Edit ボタンをクリックします。Details 領域のフィールドが編集可能になります。
- 変更したい詳細を編集します。Max Pool Size と Timeout の値と、Timeout の単位のみが変更可能です。
- 変更を保存するには Save ボタンをクリックします。変更を破棄するには Cancel リンクをクリックします。Ok ボタンをクリックすると、Details エリアが編集不可能になり、Bean プールが新しい詳細に更新されます。Cancel リンクをクリックすると、 Details エリアが編集不可能になり、何も変更されません。
手順16.6 CLI を使用した Bean プールの編集
- CLI ツールを起動し、サーバーに接続します。「管理 CLI を使用した管理対象サーバーインスタンスへの接続」を参照してください。
- Bean プールの各属性を変更するために、次の構文で
write-attribute
操作を使用します。/subsystem=ejb3/strict-max-bean-instance-pool=BEANPOOLNAME:write-attribute(name="ATTRIBUTE", value="VALUE")
- BEANPOOLNAME を Bean プールの必要な名前に置き換えます。
- ATTRIBUTE を、編集する属性の名前に置き換えます。このように編集できる属性は、
max-pool-size
、timeout
、およびtimeout-unit
です。 - VALUE を属性の必要な値に置き換えます。
read-resource
操作を使用して Bean プールの変更を確認します。/subsystem=ejb3/strict-max-bean-instance-pool=BEANPOOLNAME:read-resource
例16.4 CLI を使用した Bean プールのタイムアウト値の設定
[standalone@localhost:9999 /] /subsystem=ejb3/strict-max-bean-instance-pool=HSBeanPool:write-attribute(name="timeout", value="1500") {"outcome" => "success"} [standalone@localhost:9999 /]
16.2.5. セッションおよびメッセージ駆動型 Bean に対する Bean プールの割り当て
slsb-strict-max-pool
とメッセージ駆動型 Bean に対する mdb-strict-max-pool
の 2 つの Bean プールが提供されます。
手順16.7 管理コンソールを使用したセッションおよびメッセージ駆動型 Bean に対する Bean プールの割り当て
- 管理コンソールへログインします。「管理コンソールへログイン」 を参照してください。
- EJB3 コンテナー設定パネルへ移動します。
図16.5 管理コンソールの EJB3 コンテナー設定パネル (スタンドアロンサーバー)
- Edit ボタンをクリックします。Details 領域のフィールドが編集可能になります。
- 適切なコンボボックスから、Bean の各タイプに使用する Bean プールを選択します。
- Save ボタンをクリックして変更を維持するか、 Cancel リンクをクリックして変更を破棄します。
- Details 領域が編集可能になり、正しい Bean プール選択が表示されます。
手順16.8 CLI を使用したセッションおよびメッセージ駆動型 Bean に対する Bean プールの割り当て
- CLI ツールを起動し、サーバーに接続します。「管理 CLI を使用した管理対象サーバーインスタンスへの接続」を参照してください。
- 次の構文で
write-attribute
操作を使用します。/subsystem=ejb3:write-attribute(name="BEANTYPE", value="BEANPOOL")
- BEANTYPE は、メッセージ駆動型 Bean の
default-mdb-instance-pool
またはステートレスセッション Bean のdefault-slsb-instance-pool
に置き換えます。 - BEANPOOL を割り当てる Bean プールの名前に置き換えます。
read-resource
操作を使用して変更を確認します。/subsystem=ejb3:read-resource
例16.5 CLI を使用したセッション Bean に対する Bean プールの割り当て
[standalone@localhost:9999 /] /subsystem=ejb3:write-attribute(name="default-slsb-instance-pool", value="LV_SLSB_POOL") {"outcome" => "success"} [standalone@localhost:9999 /]
例16.6 XML 設定の例
<subsystem xmlns="urn:jboss:domain:ejb3:1.2"> <session-bean> <stateless> <bean-instance-pool-ref pool-name="slsb-strict-max-pool"/> </stateless> <stateful default-access-timeout="5000" cache-ref="simple"/> <singleton default-access-timeout="5000"/> </session-bean> <mdb> <resource-adapter-ref resource-adapter-name="hornetq-ra"/> <bean-instance-pool-ref pool-name="mdb-strict-max-pool"/> </mdb> </subsystem>
16.3. EJB スレッドプールの設定
16.3.1. エンタープライズ Bean スレッドプール
16.3.2. スレッドプールの作成
手順16.9 管理コンソールを使用した EJB スレッドプールの作成
- 管理コンソールへログインします。「管理コンソールへログイン」 を参照してください。
- 右上の Profile をクリックし、左側の Profile パネルの Container 項目を展開して、EJB 3 を選択します。次に、メインパネルから Thread Pools タブを選択します。
図16.6 EJB3 スレッドプールパネル
- Add ボタンをクリックすると、Add EJB3 Thread Pools ダイアログが表示されます。
- 必要な詳細、Name、Max. Threads、Keep-Alive Timeout の値を指定します。
- Save ボタンをクリックして新しいスレッドプールを追加するか、 Cancel リンクをクリックして取り消しします。
- Save ボタンをクリックすると、ダイアログが閉じられ、新しいスレッドプールが一覧に表示されます。
- Cancel をクリックするとダイアログが閉じられ、新しいスレッドプールは作成されません。
手順16.10 CLI を使用したスレッドプールの作成
- CLI ツールを起動し、サーバーに接続します。「管理 CLI を使用した管理対象サーバーインスタンスへの接続」を参照してください。
- 次の構文で
add
操作を使用します。/subsystem=ejb3/thread-pool=THREADPOOLNAME:add(max-threads=MAXSIZE, keepalive-time={"time"=>"TIME", "unit"=>UNIT"})
- THREADPOOLNAME をスレッドプールの必要な名前に置き換えます。
- MAXSIZE を スレッドプールの最大サイズに置き換えます。
- UNIT を必要な keep-alive 時間に使用される時間単位に置き換えます。使用可能な値は
NANOSECONDS
、MICROSECONDS
、MILLISECONDS
、SECONDS
、MINUTES
,HOURS
、DAYS
です。 - TIME を必要な keep-alive 時間の整数値に置き換えます。この値は UNIT の数になります。
read-resource
操作を使用して Bean プールの作成を確認します。/subsystem=ejb3/strict-max-bean-instance-pool=THREADPOOLNAME:read-resource
例16.7 CLI を使用したスレッドプールの作成
[standalone@localhost:9999 /] /subsystem=ejb3/thread-pool=testmepool:add(max-threads=50, keepalive-time={"time"=>"150", "unit"=>"SECONDS"}) {"outcome" => "success"} [standalone@localhost:9999 /]
例16.8 XML 設定の例
<subsystem xmlns="urn:jboss:domain:ejb3:1.2"> <thread-pools> <thread-pool name="default" max-threads="20" keepalive-time="150"/> </thread-pools> </subsystem>
16.3.3. スレッドプールの削除
要件
- 使用されているスレッドプールは削除できません。次のタスクを参照して、スレッドプールが使用されていないことを確認してください。
手順16.11 管理コンソールを使用した EJB スレッドプールの削除
- 管理コンソールへログインします。「管理コンソールへログイン」 を参照してください。
- 右上の Profile をクリックし、左側の Profile パネルの Container 項目を展開して、EJB 3 を選択します。次に、メインパネルから Thread Pools タブを選択します。
図16.7 EJB3 スレッドプールパネル
- 一覧より削除するスレッドプールを選択します。
- Remove ボタンをクリックします。Remove Item ダイアログが表示されます。
- OK ボタンをクリックして削除を実行するか、Cancel リンクをクリックして処理を取り消します。Ok ボタンをクリックすると、ダイアログが閉じられます。スレッドプールが削除され、一覧からも削除されます。Cancel をクリックするとダイアログが閉じられ、何も変更されません。
手順16.12 CLI を使用したスレッドプールの削除
- CLI ツールを起動し、サーバーに接続します。「管理 CLI を使用した管理対象サーバーインスタンスへの接続」を参照してください。
- 次の構文で
remove
操作を使用します。/subsystem=ejb3/thread-pool=THREADPOOLNAME:remove
- THREADPOOLNAME をスレッドプールの名前に置き換えます。
例16.9 CLI を使用したスレッドプールの削除
[standalone@localhost:9999 /] /subsystem=ejb3/thread-pool=ACCTS_THREADS:remove {"outcome" => "success"} [standalone@localhost:9999 /]
16.3.4. スレッドプールの編集
手順16.13 管理コンソールを使用したスレッドプールの編集
ログイン
管理コンソールへログインします。EJB3 スレッドプールタブへの移動
右上の Profile をクリックし、左側の Profile パネルの Container 項目を展開して、EJB 3 を選択します。次に、メインパネルから Thread Pools タブを選択します。図16.8 EJB3 スレッドプールタブ
編集するスレッドプールの選択
一覧より編集するスレッドプールを選択します。Edit ボタンのクリック
Details エリアのフィールドが編集可能になります。詳細の編集
変更したい詳細を編集します。Thread Factory
、Max Threads
、Keepalive Timeout
、Keepalive Timeout Unit
の値のみが編集可能です。保存またはキャンセル
変更を保存するには Save ボタンをクリックします。変更を破棄するには Cancel リンクをクリックします。
手順16.14 CLI を使用したスレッドプールの編集
- CLI ツールを起動し、サーバーに接続します。「管理 CLI を使用した管理対象サーバーインスタンスへの接続」を参照してください。
- スレッドプールの各属性を変更するために、次の構文で
write-attribute
操作を使用します。/subsystem=ejb3/thread-pool=THREADPOOLNAME:write-attribute(name="ATTRIBUTE", value="VALUE")
- THREADPOOLNAME をスレッドプールの名前に置き換えます。
- ATTRIBUTE を、編集する属性の名前に置き換えます。このように編集できる属性は、
keepalive-time
、max-threads
、およびthread-factory
です。 - VALUE を属性の必要な値に置き換えます。
read-resource
操作を使用して、スレッドプールへの変更を確認します。/subsystem=ejb3/thread-pool=THREADPOOLNAME:read-resource
重要
keepalive-time
属性の値を CLI で変更する場合、必要な値はオブジェクト表現です。構文は次のとおりです。
/subsystem=ejb3/thread-pool=THREADPOOLNAME:write-attribute(name="keepalive-time", value={"time" => "VALUE","unit" => "UNIT"}
例16.10 CLI を使用したスレッドプールの最大値の設定
[standalone@localhost:9999 /] /subsystem=ejb3/thread-pool=HSThreads:write-attribute(name="max-threads", value="50") {"outcome" => "success"} [standalone@localhost:9999 /]
例16.11 CLI を使用したスレッドプールの keepalive-time
時間値の設定
[standalone@localhost:9999 /] /subsystem=ejb3/thread-pool=HSThreads:write-attribute(name="keepalive-time", value={"time"=>"150"}) {"outcome" => "success"} [standalone@localhost:9999 /]
16.4. セッション Bean の設定
16.4.1. セッション Bean のアクセスタイムアウト
@javax.ejb.AccessTimeout
アノテーションを用いて、使用するタイムアウトの値と時間の単位を指定することができます。セッション Bean (すべての Bean のメソッドに適用)や特定のメソッドに指定し、Bean の設定を上書きすることができます。
16.4.2. デフォルトセッション Bean アクセスタイムアウト値の設定
手順16.15 管理コンソールを使用してデフォルトのセッション Bean アクセスタイムアウト値を設定
- 管理コンソールへログインします。「管理コンソールへログイン」 を参照してください。
- 右上の Profile をクリックし、左側の Profile パネルの Container 項目を展開して、EJB 3 を選択します。次に、メインパネルから Container タブを選択します。
図16.9 管理コンソールの EJB3 コンテナー設定パネル (スタンドアロンサーバー)
- Edit ボタンをクリックします。Details 領域のフィールドが編集可能になります。
- Stateful Access Timeout または Singleton Access Timeout テキストボックスに必要な値を入力します。
- Save ボタンをクリックして変更を維持するか、 Cancel リンクをクリックして変更を破棄します。
- Details 領域が編集不可になり、正しいタイムアウト値が表示されます。
手順16.16 CLI を使用したセッション Bean のアクセスタイムアウト値の設定
- CLI ツールを起動し、サーバーに接続します。「管理 CLI を使用した管理対象サーバーインスタンスへの接続」を参照してください。
- 次の構文で
write-attribute
操作を使用します。/subsystem=ejb3:write-attribute(name="BEANTYPE", value=TIME)
- BEANTYPE は、ステートフルセッション Bean の
default-stateful-bean-access-timeout
またはシングルトンセッション Bean のdefault-singleton-bean-access-timeout
に置き換えます。 - TIME を必要なタイムアウト値に置き換えます。
read-resource
操作を使用して変更を確認します。/subsystem=ejb3:read-resource
例16.12 CLI を使用してデフォルトのステートフル Bean のアクセスタイムアウト値を 9000 に設定する
[standalone@localhost:9999 /] /subsystem=ejb3:write-attribute(name="default-stateful-bean-access-timeout", value=9000) {"outcome" => "success"} [standalone@localhost:9999 /]
例16.13 XML 設定の例
<subsystem xmlns="urn:jboss:domain:ejb3:1.2"> <session-bean> <stateless> <bean-instance-pool-ref pool-name="slsb-strict-max-pool"/> </stateless> <stateful default-access-timeout="5000" cache-ref="simple"/> <singleton default-access-timeout="5000"/> </session-bean> </subsystem>
16.5. メッセージ駆動型 Bean の設定
16.5.1. メッセージ駆動型 Bean のデフォルトリソースアダプターの設定
hornetq-ra
です。
手順16.17 管理コンソールを使用したメッセージ駆動型 Bean のデフォルトリソースアダプターの設定
- 管理コンソールへログインします。「管理コンソールへログイン」 を参照してください。
- 右上の Profile をクリックし、左側の Profile パネルの Container 項目を展開して、EJB 3 を選択します。次に、メインパネルから Container タブを選択します。
図16.10 管理コンソールの EJB3 コンテナー設定パネル (スタンドアロンサーバー)
- Edit ボタンをクリックします。Details 領域のフィールドが編集可能になります。
- Default Resource Adapter テキストボックスに使用するリソースアダプターの名前を入力します。
- Save ボタンをクリックして変更を維持するか、 Cancel リンクをクリックして変更を破棄します。
- Details エリアが編集不可能になり、正しいリソースアダプター名が表示されます。
手順16.18 CLI を使用したメッセージ駆動型 Bean のデフォルトリソースアダプターの設定
- CLI ツールを起動し、サーバーに接続します。「管理 CLI を使用した管理対象サーバーインスタンスへの接続」を参照してください。
- 次の構文で
write-attribute
操作を使用します。/subsystem=ejb3:write-attribute(name="default-resource-adapter-name", value="RESOURCE-ADAPTER")
RESOURCE-ADAPTER を使用されるリソースアダプターの名前に置き換えます。 read-resource
操作を使用して変更を確認します。/subsystem=ejb3:read-resource
例16.14 CLI を使用したメッセージ駆動型 Bean のデフォルトリソースアダプターの設定
[standalone@localhost:9999 subsystem=ejb3] /subsystem=ejb3:write-attribute(name="default-resource-adapter-name", value="EDIS-RA") {"outcome" => "success"} [standalone@localhost:9999 subsystem=ejb3]
例16.15 XML 設定の例
<subsystem xmlns="urn:jboss:domain:ejb3:1.2"> <mdb> <resource-adapter-ref resource-adapter-name="hornetq-ra"/> <bean-instance-pool-ref pool-name="mdb-strict-max-pool"/> </mdb> </subsystem>
16.6. EJB3 タイマーサービスの設定
16.6.1. EJB3 タイマーサービス
16.6.2. EJB3 タイマーサービスの設定
手順16.19 EJB3 タイマーサービスの設定
ログイン
管理コンソールへログインします。Timer Service タブを開く
右上の Profile をクリックし、左側の Profile パネルの Container 項目を展開して、EJB 3 を選択します。メインパネルから Services タブを選択した後、Timer Service タブを選択します。図16.11 EJB3 Services パネルの Timer Service タブ
編集モードの入力
Edit ボタンをクリックします。フィールドが編集可能になります。必要な変更を追加します。
追加のスレッドプールが設定されている場合はタイマーサービスに使用される別の EJB3 スレッドプールを選択し、タイマーサービスデータの保存に使用されるディレクトリを変更することができます。タイマーサービスデータディレクトリの設定は、データが保存されるディレクトリであるPath
と、Path
が含まれるディレクトリであるRelative To
の 2 つの値で構成されます。デフォルトではRelative To
はファイルシステムの Path 変数に設定されています。保存またはキャンセル
Save ボタンをクリックして変更を維持するか、 Cancel リンクをクリックして変更を破棄します。
16.7. EJB3 非同期呼び出しサービスの設定
16.7.1. EJB3 非同期呼び出しサービス
16.7.2. EJB3 非同期呼び出しサービスのスレッドプールの設定
手順16.20 EJB3 非同期呼び出しサービスのスレッドプールの設定
ログイン
管理コンソールへログインします。Async Service タブを開く
右上の Profile をクリックし、左側の Profile パネルの Container 項目を展開して、EJB 3 を選択します。メインパネルから Services タブを選択した後、Async Service タブを選択します。図16.12 EJB3 Services パネルの Async Service タブ
編集モードの入力
Edit ボタンをクリックします。フィールドが編集可能になります。スレッドプールの選択
使用する EJB3 スレッドプールを一覧より選択します。スレッドプールが既に作成されていなければなりません。保存またはキャンセル
Save ボタンをクリックして変更を維持するか、 Cancel リンクをクリックして変更を破棄します。
16.8. EJB3 リモート呼び出しサービスの設定
16.8.2. EJB3 リモートサービスの設定
手順16.21 EJB3 リモートサービスの設定
ログイン
管理コンソールへログインします。Remote Service タブを開く
右上の Profile をクリックし、左側の Profile パネルの Container 項目を展開して、EJB 3 を選択します。メインパネルから Services タブを選択した後、Remote Service タブを選択します。図16.13 EJB3 Services パネルの Remote Service タブ
編集モードの入力
Edit ボタンをクリックします。フィールドが編集可能になります。必要な変更の追加
追加のスレッドプールが設定されている場合はリモートサービスに使用される別の EJB3 スレッドプールを選択することができます。EJB リモーティングチャネルの登録に使用されるコネクターを変更できます。保存またはキャンセル
Save ボタンをクリックして変更を維持するか、 Cancel リンクをクリックして変更を破棄します。
16.9. EJB 2.x エンティティー Bean の設定
16.9.1. EJB セッション Bean
16.9.2. Container-Managed Persistence
16.9.3. EJB 2.x のコンテナ管理による永続性の有効化
org.jboss.as.cmp
拡張子によって処理されます。CMP は管理ドメインや standalone-full.xml
などのスタンドアロンサーバーの完全設定ではデフォルトで有効になっています。
org.jboss.as.cmp
モジュールをサーバー設定ファイルの有効な拡張子の一覧に追加します。
<extensions> <extension module="org.jboss.as.cmp"/> </extensions>
org.jboss.as.cmp
モジュールの拡張子エントリーを削除します。
16.9.4. EJB 2.x Container-Managed Persistence の設定
- UUID ベースのキージェネレーター
- UUID ベースのキージェネレーターは、Universally Unique Identifiers を使用してキーを生成します。UUID キージェネレーターは、一意の名前のみを持つ必要があり、他の設定は持ちません。UUID ベースのキージェネレーターは、以下のコマンド構文を使用して CLI で追加できます。
/subsystem=cmp/uuid-keygenerator=UNIQUE_NAME:add
例16.16 UUID キージェネレーターの追加
名前がuuid_identities
の UUID ベースのキージェネレーターを追加するには、以下の CLI コマンドを使用します。/subsystem=cmp/uuid-keygenerator=uuid_identities:add
このコマンドで作成される XML 設定は以下のとおりです。<subsystem xmlns="urn:jboss:domain:cmp:1.0"> <key-generators> <uuid name="uuid_identities" /> </key-generators> </subsystem>
- HiLo キージェネレーター
- HiLo キージェネレーターは、データベースを使用してエンティティー ID キーを作成および格納します。HiLo キージェネレーターは、一意の名前を持つ必要があり、データと、キーを格納するテーブルおよび列の名前を格納するために使用されるデータソースを指定するプロパティーで設定されます。HiLo キージェネレーターは、以下のコマンド構文を使用して CLI で追加できます。
/subsystem=cmp/hilo-keygenerator=UNIQUE_NAME/:add(property=value, property=value, ...)
例16.17 HiLo キージェネレーターの追加
/subsystem=cmp/hilo-keygenerator=DB_KEYS/:add(create-table=false,data-source=java:jboss/datasources/ExampleDS,drop-table=false,id-column=cmp_key_ids,select-hi-ddl=select max(cmp_key_ids) from cmp_key_seq,sequence-column=cmp_key_seq,table-name=cmp-keys))
このコマンドで作成される XML 設定は以下のとおりです。<subsystem xmlns="urn:jboss:domain:cmp:1.0"> <key-generators> <hilo name="DB_KEYS"> <create-table>false</create-table> <data-source>java:jboss/datasources/ExampleDS</data-source> <drop-table>false</drop-table> <id-column>cmp_key_ids</id-column> <select-hi-ddl>select max(cmp_key_ids) from cmp_key_seq</select-hi-ddl> <sequence-column>cmp_key_seq</sequence-column> <table-name>cmp-keys</table-name> </hilo> </key-generators> </subsystem>
16.9.5. HiLo キージェネレーター用の CMP サブシステムプロパティ
表16.1 HiLo キージェネレーター用の CMP サブシステムプロパティ
プロパティ | データ型 | 説明 |
---|---|---|
block-size | long |
-
|
create-table | ブール値 | TRUE に設定すると、table-name で指定した名前のテーブルがみつからない場合には、create-table-ddl のコンテンツを使用してそのテーブルが作成されます。
|
create-table-ddl | 文字列 | table-name で指定されたテーブルがみつからず、かつ create-table が TRUE に設定されている場合にそのテーブルを作成するのに使用する DDL コマンド。
|
data-source | トークン |
データベースへの接続に使用するデータソース
|
drop-table | ブール値 |
-
|
id-column | トークン |
-
|
select-hi-ddl | 文字列 | 現在保管されている中で最も大きなキーを返す SQL コマンド。 |
sequence-column | トークン |
-
|
sequence-name | トークン |
-
|
table-name | トークン |
キー情報の保管に使用するテーブルの名前
|
第17章 Java Connector Architecture (JCA)
17.1. はじめに
17.1.1. Java EE Connector API (JCA) について
17.1.2. Java Connector Architecture (JCA)
- 接続
- トランザクション
- セキュリティ
- ライフサイクル
- 作業インスタンス
- トランザクションインフロー
- メッセージインフロー
17.1.3. リソースアダプター
17.2. Java Connector Architecture (JCA) サブシステムの設定の概要
- 右上の Profile リンクをクリックし、Profile ビューに切り替えます。
- 左側のナビゲーションパネルの Profile セクションが展開されていることを確認します。
- Connector をクリックして展開し、JCA をクリックします。
- 右上の Profile リンクをクリックし、Profile ビューに切り替えます。
- 左側のナビゲートパネル最上部の Profile メニューから変更するプロファイルを選択します。
- Connector をクリックして展開し、JCA をクリックします。
- 共通設定
- Common Config タブには、接続マネージャー、アーカイブ検証、および Bean 検証 (JSR-303) の設定が含まれます。また、これらの各設定は独自のタブに含まれます。これらの設定を変更するには、適切なタブを開き、編集ボタンをクリックし、必要な変更を行い、保存ボタンをクリックします。
図17.1 JCA 共通設定
それぞれに対して編集できる設定は次のとおりです。- 接続マネージャー:
- エラーログが有効であるかどうか
- デバッグログが有効であるかどうか
- アーカイブ検証:
- 有効であるかどうか
- 失敗してエラーが発生するかどうか
- 失敗して警告が発生するかどうか
- Bean 検証:
- 有効であるかどうか
- ブートストラップコンテキスト
- Bootstrap Contexts タブには、設定されたブートストラップコンテキストのリストが含まれます。新しいブートストラップコンテキストオブジェクトを追加、削除、および設定できます。各ブートストラップコンテキストにはワークマネージャーを割り当てることができます。
図17.2 ブートストラップコンテキスト
- ワークマネージャー
- Work Manager タブには、設定されたワークマネージャーのリストが含まれます。新しいワークマネージャーを追加および削除でき、スレッドプールをここで設定できます。各ワークマネージャーは、1 つの短い実行スレッドプールと最大 1 つの長い実行スレッドプールを持つことができます。
図17.3 ワークマネージャー
次のスレッドプール属性をここで設定できます。- キープアライブタイムアウト
- キープアライブタイムアウトユニット
- コアタイムアウトを許可するかどうか
- スレッドファクトリー
- 最大スレッド数
- コアスレッド数
- キューの長さ
図17.4 ワークマネージャースレッドプール
17.3. リソースアダプターのデプロイ
手順17.1 管理 CLI を使用したリソースアダプターのデプロイ
- 使用しているオペレーティングシステムのコマンドプロンプトを開きます。
- 管理 CLI へ接続します。
- Linux の場合は、コマンドラインで以下を入力します。
$ EAP_HOME/bin/jboss-cli.sh --connect $ Connected to standalone controller at localhost:9999
- Windows の場合は、コマンドラインで以下を入力します。
C:\>EAP_HOME\bin\jboss-cli.bat --connect C:\> Connected to standalone controller at localhost:9999
- リソースアダプターをデプロイします。
- リソースアダプターをスタンドアロンサーバーへデプロイするには、次のコマンドラインを入力します。
$ deploy path/to/resource-adapter-name.rar
- リソースアダプターを管理対象ドメインのすべてのサーバーグループにデプロイするには、次のコマンドラインを入力します。
$ deploy path/to/resource-adapter-name.rar --all-server-groups
手順17.2 Web ベースの管理コンソールを使用したリソースアダプターのデプロイ
- JBoss Enterprise Application Platform 6 サーバーを起動します。
- 管理ユーザーを追加していない場合は、ここで追加します。詳細は、JBoss Enterprise Application Platform 6 インストールガイドの「JBoss Enterprise Application Platform 6 を初めて使用」の章を参照してください。
- Web ブラウザーを開き、管理コンソールへ移動します。デフォルトの場所は http://localhost:9990/console/ です。管理コンソールについての詳細は 「管理コンソールへログイン」 を参照してください。
- 右上にある Runtime リンクをクリックして Runtime ビューに切り替えた後、左のナビゲーションパネルにある Manage Deployments を選択して右上にある Add Content をクリックします。
図17.5 デプロイメントの管理 - コンテンツの追加
- リソースアダプターアーカイブを閲覧して選択した後、Next をクリックします。
図17.6 デプロイメントの選択
- デプロイ名を検証した後、Save をクリックします。
図17.7 デプロイメント名の検証
- この時点で、リソースアダプターアーカイブが無効の状態でリストに表示されるはずです。Enable リンクをクリックして有効にします。
図17.8 デプロイメントの有効化
- 「Are you sure?」 (本当にリストされた RAR を有効にしたいですか) という内容のダイアログが表示されます。Confirm をクリックするとリソースアダプターアーカイブの状態が
Enabled
と表示されます。図17.9 デプロイメント
手順17.3 手作業によるリソースアダプターのデプロイ
- リソースアダプターアーカイブをサーバーデプロイメントディレクトリへコピーします。
- スタンドアロンサーバーの場合、リソースアダプターアーカイブを
EAP_HOME/standalone/deployments/
ディレクトリへコピーします。 - 管理対象ドメインの場合、リソースアダプターアーカイブをドメインコントローラーの
EAP_HOME/domain/deployments/
ディレクトリへコピーします。
17.4. デプロイされたリソースアダプターの設定
前提条件:
- 管理コンソールにログインできる必要があります。
- リソースアダプターがすでにデプロイされている必要があります
ログイン
管理コンソールへログインします。JCA Resource Adapters 画面を開きます。
サーバーがスタンドアロンサーバーとして実行されている場合は、次の手順を実行します。- 右上の Profile リンクをクリックし、Profile ビューに切り替えます。
- 左側のナビゲーションパネルの Profile セクションが展開されていることを確認します。
- Connector をクリックして展開し、Resource Adapters をクリックします。
サーバーが管理ドメインの一部として実行されている場合は、次の手順を実行します。- 右上の Profile リンクをクリックし、Profile ビューに切り替えます。
- 左側のナビゲートパネル最上部の Profile メニューから変更するプロファイルを選択します。
- Connector をクリックして展開し、Resource Adapters をクリックします。
新しいリソースアダプターの追加
Add ボタンをクリックします。Create Resource Adapter パネルが表示されます。デプロイされたアーカイブの名前を入力し、トランザクションタイプを選択し、Save をクリックします。新しいアーカイブが、利用可能なリソースアダプターのリストに表示されます。プロパティーの追加
プロパティーを追加するには、利用可能なリソースアダプターのリストからリソースアダプターを選択し、プロパティータブをクリックします。add をクリックすると、Create Config Property パネルが表示されます。プロパティーの名前と必要な値を追加します。save をクリックします。プロパティーのリストに新しいプロパティーと値が表示されます。接続定義の編集
リソースアダプターの接続定義を編集するには、利用可能なリソースアダプターリストのリソースアダプターに対する View リンクをクリックします。ビューが Connection Definitions 画面に変更され、新しい接続定義を追加し、プロパティーを設定できます。この画面の左上の Back リンクをクリックして、Resource Adapters 画面に戻ります。管理オブジェクトの編集
リソースアダプターの管理オブジェクトを編集するには、利用可能なリソースアダプターリストのリソースアダプターの View リンクをクリックします。ビューが Connection Definitions 画面に変わったら、最上部の Admin Objects リンクをクリックします。ビューは Admin Objects 画面に変わり、新しい管理オブジェクトを追加し、プロパティーを設定できます。この画面の左上の Back リンクをクリックして、Resource Adapters 画面に戻ります。
17.5. リソースアダプター記述子リファレンス
表17.1 主要な要素
要素 | 説明 |
---|---|
bean-validation-groups | 使用する必要がある Bean 検証グループを指定します。 |
bootstrap-context | 使用する必要があるブートストラップコンテキストの一意な名前を指定します。 |
config-property | config-property は、リソースアダプター設定プロパティーを指定します。 |
transaction-support | このリソースアダプターによりサポートされたトランザクションのタイプを定義します。有効値は NoTransaction、LocalTransaction、XATransaction です。 |
connection-definitions | 接続定義を指定します。 |
admin-objects | 管理オブジェクトを指定します。 |
表17.2 Bean 有効グループ要素
要素 | 説明 |
---|---|
bean-validation-group | 検証に使用する Bean 検証グループの完全修飾クラス名を指定します。 |
表17.3 接続定義/管理オブジェクト属性
属性 | 説明 |
---|---|
class-name | 管理対象接続ファクトリーまたは管理オブジェクトの完全修飾クラス名を指定します。 |
jndi-name | JNDI 名を指定します。 |
enabled | 該当するオブジェクトをアクティブにします。 |
use-java-context | java:/ JNDI コンテキストを使用するかどうかを指定します。 |
pool-name | オブジェクトのプール名を指定します。 |
use-ccm | キャッシュ接続マネージャーを有効にします。 |
表17.4 接続定義要素
要素 | 説明 |
---|---|
config-property | config-property は、管理対象接続ファクトリー設定プロパティーを指定します。 |
pool | プール設定を指定します。 |
xa-pool | XA プール設定を指定します。 |
security | セキュリティー設定を指定します。 |
timeout | タイムアウト設定を指定します。 |
validation | 検証設定を指定します。 |
recovery | XA リカバリー設定を指定します。 |
表17.5 プール要素
要素 | 説明 |
---|---|
min-pool-size | min-pool-size 要素は、プールが保持する最小接続数を指定します。これらは、接続の要求からサブジェクトが既知になるまで作成されません。このデフォルト値は 0 です。 |
max-pool-size | max-pool-size 要素は、プールの最大接続数を指定します。各サブプールで作成できる最大接続数は、max-pool-size の接続数です。このデフォルト値は 20 です。 |
prefill | 接続プールを事前に満たすかどうかを指定します。デフォルトでは false です。 |
use-strict-min | min-pool-size を厳密と見なすかどうかを指定します。デフォルトは false です。 |
flush-strategy | エラー発生時にプールをどのようにフラッシュするかを指定します。有効値は FailingConnectionOnly (デフォルト値)、IdleConnections、EntirePool です。 |
表17.6 XA プール要素
要素 | 説明 |
---|---|
min-pool-size | min-pool-size 要素は、プールが保持する最小接続数を指定します。これらは、接続の要求からサブジェクトが既知になるまで作成されません。このデフォルト値は 0 です。 |
max-pool-size | max-pool-size 要素は、プールの最大接続数を指定します。各サブプールで作成できる最大接続数は、max-pool-size の接続数です。このデフォルト値は 20 です。 |
prefill | 接続プールを事前に満たすかどうかを指定します。デフォルトでは false です。 |
use-strict-min | min-pool-size を厳密と見なすかどうかを指定します。デフォルトは false です。 |
flush-strategy | エラー発生時にプールをどのようにフラッシュするかを指定します。有効値は FailingConnectionOnly (デフォルト値)、IdleConnections、EntirePool です。 |
is-same-rm-override | is-same-rm-override 要素を使用すると、javax.transaction.xa.XAResource.isSameRM(XAResource) が true を返すか、false を返すかを無条件に設定できます。 |
interleaving | XA 接続ファクトリのインターリービングを有効にする要素 |
no-tx-separate-pools | Oracle では、XA 接続を JTA トランザクションの内部と外部の両方で使用することが推奨されません。この問題を回避するには、さまざまなコンテキストに個別のサブプールを作成します。 |
pad-xid | Xid をパディングするかどうか |
wrap-xa-resource | XAResource インスタンスを org.jboss.tm.XAResourceWrapper インスタンスにラップするかどうか |
表17.7 セキュリティー要素
要素 | 説明 |
---|---|
application | プール内の接続を区別するために、アプリケーションにより提供されたパラメーター (getConnection(user, pw) など) を使用することを指定します。 |
security-domain | プール内の接続を区別するために (セキュリティードメインからの) サブジェクトを使用することを指定します。security-domain の内容は認証を処理する JAAS セキュリティーマネージャーの名前です。この名前は、JAAS login-config.xml 記述子の application-policy/name 属性に相関します。 |
security-domain-and-application | プール内の接続を区別するために、アプリケーションにより提供されたパラメーター (getConnection(user, pw) など) または (セキュリティードメインからの) サブジェクトを使用することを指定します。security-domain の内容は認証を処理する JAAS セキュリティーマネージャーの名前です。この名前は、JAAS login-config.xml 記述子の application-policy/name 属性に相関します。 |
表17.8 タイムアウト要素
要素 | 説明 |
---|---|
blocking-timeout-millis | blocking-timeout-millis 要素は、接続待機中にブロックする最大時間数 (ミリ秒単位) を指定します。この時間を超過すると、例外が送出されます。これは、接続許可の待機中にブロックするだけで、新規接続の作成に長時間要している場合は例外を送出しません。デフォルト値は 30000 (30 秒) です。 |
idle-timeout-minutes | idle-timeout-minutes 要素は、接続が閉じられるまでのアイドル最大時間 (分単位) を指定します。実際の最大時間は、IdleRemover スキャン時間 (プールの最小 idle-timeout-minutes の 1/2) に基づきます。 |
allocation-retry | allocation-retry 要素は、接続の割り当てを再試行する回数を指定します。その回数を超えると、例外が発生します。デフォルト値は 0 です。 |
allocation-retry-wait-millis | allocation-retry-wait-millis 要素は、接続割り当ての再試行間の時間 (ミリ秒単位) を指定します。デフォルト値は 5000 (5 秒) です。 |
xa-resource-timeout | XAResource.setTransactionTimeout() に渡されます。デフォルト値はゼロであり、セッターは呼び出されません。秒単位で指定されます。 |
表17.9 検証要素
要素 | 説明 |
---|---|
background-validation | 接続をバックグラウンドで検証するか、使用する前に検証するかを指定する要素 |
background-validation-minutes | background-validation-minutes 要素は、バックグラウンド検証が実行される時間を分単位で指定します。 |
use-fast-fail | 無効な場合に最初の接続で接続割り当てを失敗させるか (true)、プールですべての接続が使用されるまで試行を続けるか (false) を指定します。デフォルト値は false です。 |
表17.10 管理オブジェクト要素
要素 | 説明 |
---|---|
config-property | 管理オブジェクト設定プロパティーを指定します。 |
表17.11 復元要素
要素 | 説明 |
---|---|
recover-credential | 復元に使用する名前とパスワードのペアまたはセキュリティードメインを指定します。 |
recover-plugin | org.jboss.jca.core.spi.recovery.RecoveryPlugin クラスの実装を指定します。 |
jboss-as-resource-adapters_1_0.xsd
と http://docs.jboss.org/ironjacamar/schema/ironjacamar_1_0.xsd (自動アクティブ化用) で定義されます。
17.6. WebSphere MQ リソースアダプターのデプロイ
WebSphere MQ は、分散型システム上のアプリケーションの相互通信を可能にする、IBM の Messaging Oriented Middleware (MOM) ソフトウェアです。この機能は、メッセージとメッセージキューを使用することによって実現します。WebSphere MQ はメッセージキューへのメッセージ配信と、メッセージチャネルを使用したその他のキューマネージャーへのデータ転送を行います。WebSphere MQ に関する詳しい情報は、WebSphere MQ を参照してください。
本トピックでは、JBoss Enterprise Application Platform 6 における WebSphere MQ Resource Adapter のデプロイと設定の手順について説明します。この作業は、設定ファイルを手動で編集する方法もしくは Management CLI ツールや Web ベースの管理コンソールを使用する方法で行うことができます。
作業を開始する前に、WebSphere MQ リソースアダプターのバージョンを確認して、一部の WebSphere MQ 設定プロパティについて理解しておく必要があります。
- WebSphere MQ リソースアダプターは、
wmq.jmsra-VERSION.rar
と呼ばれる Resource Archive (RAR) ファイルとして提供されます。7.0.1.7
以降のバージョンを使用する必要があります。 - 以下の WebSphere MQ 設定プロパティの値を知っておく必要があります。これらのプロパティに関する詳細は、WebSphere MQ 製品ドキュメントを参照してください。
- MQ.QUEUE.MANAGER: WebSphere MQ キューマネージャーの名前
- MQ.HOST.NAME: WebSphere MQ キューマネージャーへの接続に使用するホストの名前
- MQ.CHANNEL.NAME: WebSphere MQ キューマネージャーへの接続に使用するサーバーチャネル
- MQ.QUEUE.NAME: デスティネーションキューの名前
- MQ.PORT: WebSphere MQ キューマネージャーへの接続に使用するポート
- MQ.CLIENT: トランスポートタイプ
- 送信接続には、以下の設定プロパティに精通している必要があります:
- MQ.CONNECTIONFACTORY.NAME: リモートシステムへの接続を提供する接続ファクトリの名前
手順17.4 リソースアダプターの手動でのデプロイ
wmq.jmsra-VERSION.rar
ファイルをEAP_HOME/standalone/deployments/
ディレクトリにコピーします。- サーバー設定ファイルにリソースアダプターを追加します。
- エディターで
EAP_HOME/standalone/configuration/standalone-full.xml
ファイルを開きます。 - 設定ファイルで
urn:jboss:domain:resource-adapters
サブシステムを探します。 - このサブシステムに対してリソースアダプターが定義されていない場合には、最初に
<subsystem xmlns="urn:jboss:domain:resource-adapters:1.0"/>
の箇所を次のように置き換えます:<subsystem xmlns="urn:jboss:domain:resource-adapters:1.0"> <resource-adapters> <!-- <resource-adapter> configuration listed below --> </resource-adapters> </subsystem>
<!-- <resource-adapter> configuration listed below -->
を次のように置き換えてください:<subsystem xmlns="urn:jboss:domain:resource-adapters:1.0"> <resource-adapters> <resource-adapter> <archive> wmq.jmsra-VERSION.rar </archive> <transaction-support>XATransaction</transaction-support> <connection-definitions> <connection-definition class-name="com.ibm.mq.connector.outbound.ManagedConnectionFactoryImpl" jndi-name="java:jboss/MQ.CONNECTIONFACTORY.NAME" enabled="true" pool-name="MQ.CONNECTIONFACTORY.NAME"> <config-property name="channel"> MQ.CHANNEL.NAME </config-property> <config-property name="transportType"> MQ.CLIENT </config-property> <config-property name="queueManager"> MQ.QUEUE.MANAGER </config-property> </connection-definition> </connection-definitions> <admin-objects> <admin-object class-name="com.ibm.mq.connector.outbound.MQQueueProxy" jndi-name="java:jboss/MQ.QUEUE.NAME" pool-name="MQ.QUEUE.NAME"> <config-property name="baseQueueName"> MQ.QUEUE.NAME </config-property> </admin-object> </admin-objects> </resource-adapter> </resource-adapters> </subsystem>
VERSION は必ず、RAR の名前に付いている実際のバージョンに置き換えてください。- JBoss Enterprise Application Platform 6 で EJB3 メッセージングシステムのデフォルトプロバイダーを HornetQ から WebSphere MQ に変更するには、
urn:jboss:domain:ejb3:1.2
サブシステムを以下のように変更します:<mdb> <resource-adapter-ref resource-adapter-name="hornetq-ra"/> <bean-instance-pool-ref pool-name="mdb-strict-max-pool"/> </mdb>
の箇所を次のように置き換えます:<mdb> <resource-adapter-ref resource-adapter-name="wmq.jmsra-VERSION.rar"/> <bean-instance-pool-ref pool-name="mdb-strict-max-pool"/> </mdb>
VERSION は必ず、RAR の名前に付いている実際のバージョンに置き換えてください。
手順17.5 リソースアダプターを使用するように MDB コードを変更します。
- MDB コードで ActivationConfigProperty および ResourceAdapter を次のように設定します:
@MessageDriven( name="WebSphereMQMDB". activationConfig = { @ActivationConfigProperty(propertyName = "destinationType",propertyValue = "javax.jms.Queue"), @ActivationConfigProperty(propertyName = "useJNDI", propertyValue = "false"), @ActivationConfigProperty(propertyName = "hostName", propertyValue = "MQ.HOST.NAME"), @ActivationConfigProperty(propertyName = "port", propertyValue = "MQ.PORT"), @ActivationConfigProperty(propertyName = "channel", propertyValue = "MQ.CHANNEL.NAME"), @ActivationConfigProperty(propertyName = "queueManager", propertyValue = "MQ.QUEUE.MANAGER"), @ActivationConfigProperty(propertyName = "destination", propertyValue = "MQ.QUEUE.NAME"), @ActivationConfigProperty(propertyName = "transportType", propertyValue = "MQ.CLIENT") }) @ResourceAdapter(value = "wmq.jmsra-VERSION.rar") @TransactionAttribute(TransactionAttributeType.NOT_SUPPORTED) public class WebSphereMQMDB implements MessageListener { }
VERSION は必ず、RAR の名前に付いている実際のバージョンに置き換えてください。
第18章 Amazon EC2 での JBoss Enterprise Application Platform 6 のデプロイ
18.1. はじめに
18.1.1. Amazon EC2 について
18.1.2. Amazon Machine Instance (AMI) について
18.1.3. JBoss Cloud Access について
18.1.4. JBoss Cloud Access 機能
- Red Hat Enterprise Linux 6
- JBoss Enterprise Application Platform 6
- JBoss Operations Network (JON) 3 エージェント
- Red Hat Update Infrastructure を使用した RPM による製品アップデート
重要
18.1.5. サポートされる Amazon EC2 インスタンスタイプ
表18.1 サポートされる Amazon EC2 インスタンスタイプ
インスタンスタイプ | 説明 |
---|---|
標準インスタンス |
標準インスタンスは、memory-to-CPU 比率が調整された汎用的な環境です。
|
高メモリーインスタンス |
高メモリーインスタンスでは、標準インスタンスよりも多いメモリーが割り当てられます。高メモリーインスタンスは、データベースやメモリーキャッシングアプリケーションなどの高スループットアプリケーションに適しています。
|
高 CPU インスタンス |
高 CPU インスタンスでは、メモリーよりも多い CPU リソースが割り当てられるため、これはスループットが比較的低く、CPU リソースを大量に消費するアプリケーションに適しています。
|
重要
Micro (t1.micro)
は、JBoss Enterprise Application Platform のデプロイメントに適していません。
18.1.6. サポート対象 Red Hat AMI
RHEL-osversion-JBEAP-6.0.0-arch-creationdate
6.2
など)。
x86_64
または i386
です。
20120501
など)。
RHEL-6.2-JBEAP-6.0.0-x86_64-20120501
。
18.2. Amazon EC2 での JBoss Enterprise Application Platform 6 のデプロイ
18.2.1. Amazon EC2 での JBoss Enterprise Application Platform 6 のデプロイの概要
- JBoss Enterprise Application Platform 6 (https://access.redhat.com/knowledge/docs/JBoss_Enterprise_Application_Platform/)
- Red Hat Enterprise Linux 6 (https://access.redhat.com/knowledge/docs/Red_Hat_Enterprise_Linux/)
- Amazon Web Services (http://aws.amazon.com/documentation/)
18.2.2. 非クラスター化の JBoss Enterprise Application Platform 6
18.2.2.1. 非クラスターインスタンスについて
18.2.2.2. 非クラスターインスタンス
18.2.2.2.1. 非クラスター JBoss Enterprise Application Platform 6 インスタンスの起動
このトピックでは、Red Hat AMI (Amazon Machine Image) 上の JBoss Enterprise Application Platform 6 の非クラスターインスタンスを起動するために必要な手順について説明します。
前提条件
- 適切な Red Hat AMI。「サポート対象 Red Hat AMI」を参照してください。
- 少なくともポート 22、8080、および 9990 で受信要求を許可する事前設定済みセキュリティーグループ。
手順18.1 タスク
例18.1 User Data フィールドの例
この例は、非クラスター JBoss Enterprise Application Platform 6 インスタンス用の User Data フィールドを示します。ユーザーadmin
のパスワードはadmin
に設定されます。JBOSSAS_ADMIN_PASSWORD=admin JBOSS_IP=0.0.0.0 #listen on all IPs and interfaces # In production, access to these ports needs to be restricted for security reasons PORTS_ALLOWED="9990 9443" cat> $USER_SCRIPT << "EOF" # Get the application to be deployed from an Internet URL # mkdir -p /usr/share/java/jboss-ec2-eap-applications # wget https://<your secure storage hostname>/<path>/<app name>.war -O /usr/share/java/jboss-ec2-eap-applications/<app name>.war # Create a file of CLI commands to be executed after starting the server cat> $USER_CLI_COMMANDS << "EOC" # deploy /usr/share/java/jboss-ec2-eap-applications/<app name>.war EOC EOF
本番稼働インスタンスの場合
本番環境インスタンスの場合は、次の行をUser Data
フィールドのUSER_SCRIPT
行の下に追加してセキュリティーアップデートが起動時に適用されるようにします。yum -y update
注記
yum -y update
を定期的に実行して、セキュリティー修正と拡張を適用する必要があります。- Red Hat AMI インスタンスを起動します。
JBoss Enterprise Application Platform 6 の非クラスターインスタンスが設定され、Red Hat AMI で起動されます。
18.2.2.2.2. 非クラスター JBoss Enterprise Application Platform インスタンスでのアプリケーションのデプロイ
このトピックでは、Red Hat AMI 上の非クラスター JBoss Enterprise Application Platform 6 インスタンスへのアプリケーションのデプロイについて説明します。
サンプルアプリケーションのデプロイ
次の行をUser Data
フィールドに追加します。# Deploy the sample application from the local filesystem deploy --force /usr/share/java/jboss-ec2-eap-samples/hello.war
例18.2 サンプルアプリケーションの User Data フィールドの例
この例では、Red Hat AMI で提供されたサンプルアプリケーションを使用します。また、非クラスター JBoss Enterprise Application Platform 6 インスタンスの基本的な設定も含まれます。ユーザーadmin
のパスワードがadmin
に設定されています。JBOSSAS_ADMIN_PASSWORD=admin JBOSS_IP=0.0.0.0 #listen on all IPs and interfaces # In production, access to these ports needs to be restricted for security reasons PORTS_ALLOWED="9990 9443" cat> $USER_SCRIPT << "EOF" # Create a file of CLI commands to be executed after starting the server cat> $USER_CLI_COMMANDS << "EOC" # Deploy the sample application from the local filesystem deploy --force /usr/share/java/jboss-ec2-eap-samples/hello.war EOC EOF
カスタムアプリケーションのデプロイ
次の行をUser Data
フィールドに追加し、アプリケーションメイト URL を設定します。# Get the application to be deployed from an Internet URL mkdir -p /usr/share/java/jboss-ec2-eap-applications wget https://<your secure storage hostname>/<path>/<app name>.war -O /usr/share/java/jboss-ec2-eap-applications/<app name>.war
例18.3 カスタムアプリケーションの User Data フィールドの例
この例では、MyApp
と呼ばれるアプリケーションが使用され、非クラスター JBoss Enterprise Application Platform 6 インスタンスの基本的な設定が含まれます。ユーザーadmin
のパスワードがadmin
に設定されます。JBOSSAS_ADMIN_PASSWORD=admin JBOSS_IP=0.0.0.0 #listen on all IPs and interfaces # In production, access to these ports needs to be restricted for security reasons PORTS_ALLOWED="9990 9443" cat> $USER_SCRIPT << "EOF" # Get the application to be deployed from an Internet URL mkdir -p /usr/share/java/jboss-ec2-eap-applications wget https://PATH_TO_MYAPP/MyApp.war -O /usr/share/java/jboss-ec2-eap-applications/MyApp.war # Create a file of CLI commands to be executed after starting the server cat> $USER_CLI_COMMANDS << "EOC" deploy /usr/share/java/jboss-ec2-eap-applications/MyApp.war EOC EOF
- Red Hat AMI インスタンスを起動します。
アプリケーションが JBoss Enterprise Application Platform 6 に正常にデプロイされます。
18.2.2.2.3. 非クラスター JBoss Enterprise Application Platform 6 インスタンスのテスト
このトピックでは、非クラスター JBoss Enterprise Application Platform 6 が正常に実行されていることをテストするために必要な手順について説明します。
手順18.2 タスク
- インスタンスの詳細ペインにあるインスタンスの
Public DNS
を調べます。 http://<public-DNS>:8080
に移動します。- 管理コンソールへのリンクを含む JBoss Enterprise Application Platform ホームページが表示されることを確認します。ホームページが表示されない場合は、「Amazon EC2 のトラブルシューティングについて」を参照してください。
- Admin Console ハイパーリンクをクリックします。
- ログイン:
- ユーザー名:
admin
- パスワード:
User Data
フィールドで指定されます: 「非クラスター JBoss Enterprise Application Platform 6 インスタンスの起動」.
サンプルアプリケーションのテスト
http://<public-DNS>:8080/hello
に移動して、サンプルアプリケーションが正常に実行されていることをテストします。テキストHello World!
がブラウザーで表示されます。このテキストが表示されない場合は、「Amazon EC2 のトラブルシューティングについて」を参照してください。- JBoss Enterprise Application Platform 管理コンソールからログアウトします。
JBoss Enterprise Application Platform 6 インスタンスが正常に実行されます。
18.2.2.3. 非クラスター化管理対象ドメイン
18.2.2.3.1. [en-US] Launch an Instance to Serve as a Domain Controller
This topic covers the steps required to launch a non-clustered JBoss Enterprise Application Platform 6 managed domain on a Red Hat AMI (Amazon Machine Image).
Prerequisites
- A suitable Red Hat AMI. Refer to 「サポート対象 Red Hat AMI」.
手順18.3 Task
- In the Security Group tab, ensure all traffic is allowed. Red Hat Enterprise Linux's built-in firewall capabilities can be used to restrict access if desired.
- Set the public subnet of the VPC to running.
- Select a static IP.
- Configure the
User Data
field. The configurable parameters are available here: 「永続的な設定パラメーター」, 「カスタムスクリプトパラメーター」.例18.4 Example User Data Field
The example shows the User Data field for a non-clustered JBoss Enterprise Application Platform 6 managed domain. The password for the useradmin
has been set toadmin
.## password that will be used by slave host controllers to connect to the domain controller JBOSSAS_ADMIN_PASSWORD=admin ## subnet prefix this machine is connected to SUBNET=10.0.0. #### to run the example no modifications below should be needed #### JBOSS_DOMAIN_CONTROLLER=true PORTS_ALLOWED="9999 9990 9443" JBOSS_IP=`hostname | sed -e 's/ip-//' -e 'y/-/./'` #listen on public/private EC2 IP address cat > $USER_SCRIPT << "EOF" ## Get the application to be deployed from an Internet URL # mkdir -p /usr/share/java/jboss-ec2-eap-applications # wget https://<your secure storage hostname>/<path>/<app name>.war -O /usr/share/java/jboss-ec2-eap-applications/<app name>.war ## Create a file of CLI commands to be executed after starting the server cat> $USER_CLI_COMMANDS << "EOC" # Add the modcluster subsystem to the default profile to set up a proxy /profile=default/subsystem=web/connector=ajp:add(name=ajp,protocol=AJP/1.3,scheme=http,socket-binding=ajp) /:composite(steps=[ {"operation" => "add", "address" => [ ("profile" => "default"), ("subsystem" => "modcluster") ] },{ "operation" => "add", "address" => [ ("profile" => "default"), ("subsystem" => "modcluster"), ("mod-cluster-config" => "configuration") ], "advertise" => "false", "proxy-list" => "${jboss.modcluster.proxyList}", "connector" => "ajp"}, { "operation" => "add", "address" => [ ("profile" => "default"), ("subsystem" => "modcluster"), ("mod-cluster-config" => "configuration"), ("dynamic-load-provider" => "configuration") ]}, { "operation" => "add", "address" => [ ("profile" => "default"), ("subsystem" => "modcluster"), ("mod-cluster-config" => "configuration"), ("dynamic-load-provider" => "configuration"), ("load-metric" => "busyness")], "type" => "busyness"} ]) # Deploy the sample application from the local filesystem deploy /usr/share/java/jboss-ec2-eap-samples/hello.war --server-groups=main-server-group EOC ## this will workaround the problem that in a VPC, instance hostnames are not resolvable echo -e "127.0.0.1\tlocalhost.localdomain localhost" > /etc/hosts echo -e "::1\tlocalhost6.localdomain6 localhost6" >> /etc/hosts for (( i=1 ; i<255 ; i++ )); do echo -e "$SUBNET$i\tip-${SUBNET//./-}$i" ; done >> /etc/hosts EOF
For Production Instances
For a production instance, add the following line beneath theUSER_SCRIPT
line of theUser Data
field, to ensure security updates are applied on boot.yum -y update
注記
yum -y update
should be run regularly, to apply security fixes and enhancements.- Launch the Red Hat AMI instance.
A non-clustered JBoss Enterprise Application Platform 6 managed domain has been configured, and launched on a Red Hat AMI.
18.2.2.3.2. [en-US] Launch One or More Instances to Serve as Host Controllers
This topic covers the steps required to launch one or more instances of JBoss Enterprise Application Platform 6 to serve as non-clustered host controllers on a Red Hat AMI (Amazon Machine Image).
Prerequisites
- Configure and launch the non-clustered domain controller. Refer to 「[en-US] Launch an Instance to Serve as a Domain Controller」 .
手順18.4 Launch Host Controllers
- Select an AMI.
- Define the desired number of instances (the number of slave host controllers).
- Select the VPC and instance type.
- Click on Security Group.
- Ensure that all traffic from the JBoss Enterprise Application Platform subnet is allowed.
- Define other restrictions as desired.
- Add the following into the User Data field:
## mod cluster proxy addresses MOD_CLUSTER_PROXY_LIST=10.0.0.4:7654 ## host controller setup JBOSS_DOMAIN_MASTER_ADDRESS=10.0.0.5 JBOSS_HOST_PASSWORD=<password for slave host controllers> ## subnet prefix this machine is connected to SUBNET=10.0.1. #### to run the example no modifications below should be needed #### JBOSS_HOST_USERNAME=admin PORTS_ALLOWED="1024:65535" JBOSS_IP=`hostname | sed -e 's/ip-//' -e 'y/-/./'` #listen on public/private EC2 IP address cat > $USER_SCRIPT << "EOF" ## Server instance configuration sed -i "s/other-server-group/main-server-group/" $JBOSS_CONFIG_DIR/$JBOSS_HOST_CONFIG ## this will workaround the problem that in a VPC, instance hostnames are not resolvable echo -e "127.0.0.1\tlocalhost.localdomain localhost" > /etc/hosts echo -e "::1\tlocalhost6.localdomain6 localhost6" >> /etc/hosts for (( i=1 ; i<255 ; i++ )); do echo -e "$SUBNET$i\tip-${SUBNET//./-}$i" ; done >> /etc/hosts EOF
For Production Instances
For a production instance, add the following line beneath theUSER_SCRIPT
line of theUser Data
field, to ensure security updates are applied on boot.yum -y update
注記
yum -y update
should be run regularly, to apply security fixes and enhancements.- Launch the Red Hat AMI instance.
The JBoss Enterprise Application Platform 6 non-clustered host controllers are configured and launched on a Red Hat AMI.
18.2.2.3.3. [en-US] Test the Non-Clustered JBoss Enterprise Application Platform 6 Managed Domain
This topic covers the steps required to test the non-clustered JBoss Enterprise Application Platform managed domain on a Red Hat AMI (Amazon Machine Image).
Prerequisites
- Configure and launch the domain controller. Refer to 「[en-US] Launch an Instance to Serve as a Domain Controller」 .
- Configure and launch the host controllers. Refer to 「[en-US] Launch One or More Instances to Serve as Host Controllers」 .
手順18.5 Test the Web Server
- Navigate to
http://ELASTIC_IP_OF_APACHE_HTTPD
in a browser to confirm the web server is running successfully.
手順18.6 Test the Domain Controller
- Navigate to
http://ELASTIC_IP_OF_DOMAIN_CONTROLLER:9990/console
- Log in using the username of
admin
and the password specified in the User Data field for the domain controller and the admin console landing page for a managed domain should appear (http://ELASTIC_IP_OF_DOMAIN_CONTROLLER:9990/console/App.html#server-instances
). - Click the Server label at the top right side of the screen, and select any of the host controllers in the Host dropdown menu at the top left side of the screen.
- Verify that each host controller has two server configurations called
server-one
andserver-two
and that they both belong to themain-server-group
. - Log out of the JBoss Enterprise Application Platform Admin Console.
手順18.7 Test the Host Controllers
- Navigate to
http://ELASTIC_IP_OF_APACHE_HTTPD/hello
to test that the sample application is running successfully. The textHello World!
should appear in the browser.If the text is not visible, refer here: Section 18.5.1, “About Troubleshooting Amazon EC2”. - Connect to the Apache HTTPD instance:
$ ssh -L7654:localhost:7654 ELASTIC_IP_OF_APACHE_HTTPD
- Navigate to
http://localhost:7654/mod_cluster-manager
to confirm all instances are running correctly.
The JBoss Enterprise Application Platform 6 web server, domain controller, and host controllers are running correctly on a Red Hat AMI.
18.2.3. クラスター化の JBoss Enterprise Application Platform 6
18.2.3.1. クラスターインスタンスについて
standalone-ec2-ha.xml
と standalone-mod_cluster-ec2-ha.xml
) が含まれます。Amazon EC2 はマルチキャストをサポートしないため、これらの各設定ファイルは、マルチキャストを使用せずにクラスタリングを提供します。これは、クラスター通信用 TCP ユニキャストと S3_PING を検出プロトコルとして使用して行われます。また、standalone-mod_cluster-ec2-ha.xml
設定は、mod_cluster プロキシを使用して簡単な登録を提供します。
domain-ec2.xml
設定ファイルはクラスター化された管理対象ドメインで使用される ec2-ha と mod_cluster-ec2-ha の 2 つのプロファイルを提供します。
18.2.3.2. リレーショナルデータベースサービスデータベースインスタンスの作成
このトピックでは、MySQL を例として使用して、リレーショナルデータベースサービスデータベースインスタンスを作成する手順について説明します。
警告
重要
手順18.8 タスク
- AWS コンソールの RDS をクリックします。
- 必要な場合は、サービスをサブスクライブします。
- Launch DB instance をクリックします。
- MySQL をクリックします。
- バージョンを選択します (
5.5.12
など)。 - small instance を選択します。
- Multi-AZ Deployment と Auto upgrade が
off
であることを確認します。 - Storage を
5GB
に設定します。 - データベース管理者のユーザー名とパスワードを定義し、Next をクリックします。
- インスタンスで作成するデータベース名を選択し、Next をクリックします。
- 必要な場合は、バックアップおよび保守を無効にします。
- 設定を確認します。
データベースが作成されます。数分後に、データベースは初期化され、使用できるようになります。
18.2.3.3. Virtual Private Cloud について
18.2.3.4. Virtual Private Cloud (VPC) の作成
このトピックでは、VPC に対して外部のデータベースを例として使用して Virtual Private Cloud を作成するのに必要な手順について説明します。セキュリティーポリシーでは、データベースに対する接続を暗号化する必要がある場合があります。データベース接続の暗号化の詳細については、Amazon の 『RDS FAQ』 を参照してください。
重要
- AWS コンソールの VPC タブに移動します。
- 必要な場合は、サービスをサブスクライブします。
- "Create new VPC" をクリックします。
- 1 つのパブリックサブネットと 1 つのプライベートサブネットがある VPC を選択します。
- パブリックサブネットを
10.0.0.0/24
に設定します。 - プライベートサブネットを
10.0.1.0/24
に設定します。
- Elastic IPs に移動します。
- mod_cluster プロキシ/NAT インスタンスが使用する弾力的な IP を作成します。
- Security groups に移動し、すべての送受信トラフィックを許可するセキュリティーグループを作成します。
- ネットワーク ACL に移動します。
- すべての送受信トラフィックを許可する ACL を作成します。
- TCP ポート
22
、8009
、8080
、8443
、9443
、9990
、および16163
でのみすべての送受信トラフィックを許可する ACL を作成します。
Virtual Private Cloud が正常に作成されます。
18.2.3.5. mod_cluster プロキシとして使用する Apache HTTPD インスタンスと VPC 用 NAT インスタンスを起動する
このトピックでは、mod_cluster プロキシとして使用する Apache HTTPD インスタンスと Virtual Private Cloud 用 NAT インスタンスを起動するために必要な手順について説明します。
手順18.9 mod_cluster プロキシとして使用する Apache HTTPD インスタンスと VPC 用 NAT インスタンスを起動する
- このインスタンスに対して弾力的な IP を作成します。
- AMI を選択します。
- Security Group に移動し、すべてのトラフィックを許可します (必要な場合は、アクセスを制限する Red Hat Enterprise Linux の組み込みファイアウォール機能を使用)。
- VPC のパブリックサブネットで "
running
" を選択します。 - 静的な IP (
10.0.0.4
など) を選択します。 - 以下の内容を User Data: フィールドに指定します。
JBOSSCONF=disabled cat > $USER_SCRIPT << "EOS" echo 1 > /proc/sys/net/ipv4/ip_forward echo 0 > /proc/sys/net/ipv4/conf/all/rp_filter echo 0 > /proc/sys/net/ipv4/conf/eth0/rp_filter iptables -I INPUT 4 -s 10.0.1.0/24 -p tcp --dport 7654 -j ACCEPT iptables -I INPUT 4 -p tcp --dport 80 -j ACCEPT iptables -I FORWARD -m state --state RELATED,ESTABLISHED -j ACCEPT iptables -I FORWARD -s 10.0.1.0/24 -j ACCEPT iptables -t nat -A POSTROUTING -o eth0 ! -s 10.0.0.4 -j MASQUERADE # balancer module incompatible with mod_cluster sed -i -e 's/LoadModule proxy_balancer_module/#\0/' /etc/httpd/conf/httpd.conf cat > /etc/httpd/conf.d/mod_cluster.conf << "EOF" #LoadModule proxy_module modules/mod_proxy.so #LoadModule proxy_ajp_module modules/mod_proxy_ajp.so LoadModule slotmem_module modules/mod_slotmem.so LoadModule manager_module modules/mod_manager.so LoadModule proxy_cluster_module modules/mod_proxy_cluster.so LoadModule advertise_module modules/mod_advertise.so Listen 7654 # workaround JBPAPP-4557 MemManagerFile /var/cache/mod_proxy/manager <VirtualHost *:7654> <Location /mod_cluster-manager> SetHandler mod_cluster-manager Order deny,allow Deny from all Allow from 127.0.0.1 </Location> <Location /> Order deny,allow Deny from all Allow from 10. Allow from 127.0.0.1 </Location> KeepAliveTimeout 60 MaxKeepAliveRequests 0 ManagerBalancerName mycluster ServerAdvertise Off EnableMCPMReceive On </VirtualHost> EOF echo "`hostname | sed -e 's/ip-//' -e 'y/-/./'` `hostname`" >> /etc/hosts semanage port -a -t http_port_t -p tcp 7654 #add port in the apache port list for the below to work setsebool -P httpd_can_network_relay 1 #for mod_proxy_cluster to work chcon -t httpd_config_t -u system_u /etc/httpd/conf.d/mod_cluster.conf #### Uncomment the following line when launching a managed domain #### # setsebool -P httpd_can_network_connect 1 service httpd start EOS
- このインスタンスに対する Amazon EC2 クラウド送信元/送信先チェックを無効にして、ルーターとして動作できるようにします。
- 稼働している Apache HTTPD インスタンスを右クリックし、"Change Source/Dest check" を選択します。
- Yes, Disable をクリックします。
- このインスタンスに弾力的な IP を割り当てます。
Apache HTTPD インスタンスが正常に起動されます。
18.2.3.6. VPC プライベートサブネットデフォルトルートの設定
このトピックでは、VPC プライベートサブネットデフォルトルートを設定するために必要な手順について説明します。JBoss Enterprise Application Platform クラスターノードは VPC のプライベートサブネットで実行されますが、クラスターノードでは S3 接続のインターネットアクセスが必要です。NAT インスタンスを通過するためにデフォルトルートを設定する必要があります。
手順18.10 VPC プライベートサブネットデフォルトルートの設定
- Amazon AWS コンソールで Apache HTTPD インスタンスに移動します。
- VPC → route tables に移動します。
- プライベートサブネットで使用されたルーティングテーブルをクリックします。
- 新しいルートのフィールドに、
0.0.0.0/0
を入力します。 - "Select a target" をクリックします。
- "
Enter Instance ID
" を選択します。 - 稼働している Apache HTTPD インスタンスの ID を選択します。
デフォルトルートが、VPC サブネットに対して正常に設定されます。
18.2.3.7. Identity and Access Management (IAM) について
18.2.3.8. IAM セットアップの設定
このトピックでは、クラスター JBoss Enterprise Application Platform インスタンス用の IAM をセットアップするのに必要な設定手順について説明します。S3_PING
プロトコルは S3 バケットを使用して他のクラスターメンバーを検出します。JGroups バージョン 3.0.x では、S3 サービスに対して認証するために Amazon AWS アカウントアクセスとシークレットキーが必要です。
手順18.11 IAM セットアップの設定
- AWS コンソールの IAM タブに移動します。
- users をクリックします。
- Create New Users を選択します。
- 名前を選択し、Generate an access key for each User オプションがチェックされていることを確認します。
- Download credentials を選択し、セキュアな場所に保存します。
- ウィンドウを閉じます。
- 新しく作成されたユーザーをクリックします。
User ARM
値を書き留めます。この値は、S3 バケットをセットアップするために必要です (「S3 バケットセットアップの設定」 を参照)。
IAM ユーザーアカウントが正常に作成されます。
18.2.3.9. S3 バケットについて
18.2.3.10. S3 バケットセットアップの設定
このトピックでは、新しい S3 バケットを設定するのに必要な手順について説明します。
前提条件
手順18.12 S3 バケットセットアップの設定
- AWS コンソールで S3 タブを開きます。
- Create Bucket をクリックします。
- バケットの名前を選択し、Create をクリックします。
注記
バケット名は S3 全体で一意です。名前は再使用できません。 - 新しいバケットを右クリックし、Properties を選択します。
- パーミッションタブの Add bucket policy をクリックします。
- New policy をクリックして、ポリシー作成ウィザードを開きます。
- 以下の内容を新しいポリシーにコピーし、
arn:aws:iam::05555555555:user/jbosscluster*
を 「IAM セットアップの設定」で定義された値に置き換えます。clusterbucket123
の両方のインスタンスをこの手順 3 で定義されたバケットの名前に変更します。{ "Version": "2008-10-17", "Id": "Policy1312228794320", "Statement": [ { "Sid": "Stmt1312228781799", "Effect": "Allow", "Principal": { "AWS": [ "arn:aws:iam::055555555555:user/jbosscluster" ] }, "Action": [ "s3:ListBucketVersions", "s3:GetObjectVersion", "s3:ListBucket", "s3:PutBucketVersioning", "s3:DeleteObject", "s3:DeleteObjectVersion", "s3:GetObject", "s3:ListBucketMultipartUploads", "s3:ListMultipartUploadParts", "s3:PutObject", "s3:GetBucketVersioning" ], "Resource": [ "arn:aws:s3:::clusterbucket123/*", "arn:aws:s3:::clusterbucket123" ] } ] }
新しい S3 バケットが正常に作成および設定されます。
18.2.3.11. クラスターインスタンス
18.2.3.11.1. クラスター JBoss Enterprise Application Platform 6 AMI の起動
このトピックでは、クラスター JBoss Enterprise Application Platform 6 AMI を起動するのに必要な手順について説明します。
前提条件
警告
JBOSS_CLUSTER_ID
変数を参照してください (「永続的な設定パラメーター」)。
重要
警告
手順18.13 クラスター JBoss Enterprise Application Platform 6 AMI の起動
- AMI を選択します。
- 必要な数のインスタンス (クラスターサイズ) を定義します。
- VPC およびインスタンスタイプを選択します。
- Security Group をクリックします。
- JBoss Enterprise Application Platform クラスターサブネットからのすべてのトラフィックが許可されることを確認します。
- 必要に応じて他の制限を定義します。
- 以下の内容を User Data フィールドに追加します。
例18.5 User Data フィールドの例
## mod cluster proxy addresses MOD_CLUSTER_PROXY_LIST=10.0.0.4:7654 ## clustering setup JBOSS_JGROUPS_S3_PING_SECRET_ACCESS_KEY=<your secret key> JBOSS_JGROUPS_S3_PING_ACCESS_KEY=<your access key> JBOSS_JGROUPS_S3_PING_BUCKET=<your bucket name> ## password to access admin console JBOSSAS_ADMIN_PASSWORD=<your password for opening admin console> ## database credentials configuration JAVA_OPTS="$JAVA_OPTS -Ddb.host=instancename.something.rds.amazonaws.com -Ddb.database=mydatabase -Ddb.user=<user> -Ddb.passwd=<pass>" ## subnet prefix this machine is connected to SUBNET=10.0.1. #### to run the example no modifications below should be needed #### PORTS_ALLOWED="1024:65535" JBOSS_IP=`hostname | sed -e 's/ip-//' -e 'y/-/./'` #listen on public/private EC2 IP address cat > $USER_SCRIPT << "EOF" ## Get the application to be deployed from an Internet URL # mkdir -p /usr/share/java/jboss-ec2-eap-applications # wget https://<your secure storage hostname>/<path>/<app name>.war -O /usr/share/java/jboss-ec2-eap-applications/<app name>.war ## install the JDBC driver as a core module yum -y install mysql-connector-java mkdir -p /usr/share/jbossas/modules/com/mysql/main cp -v /usr/share/java/mysql-connector-java-*.jar /usr/share/jbossas/modules/com/mysql/main/mysql-connector-java.jar cat > /usr/share/jbossas/modules/com/mysql/main/module.xml <<"EOM" <module xmlns="urn:jboss:module:1.0" name="com.mysql"> <resources> <resource-root path="mysql-connector-java.jar"/> </resources> <dependencies> <module name="javax.api"/> </dependencies> </module> EOM cat > $USER_CLI_COMMANDS << "EOC" ## Deploy sample application from local filesystem deploy --force /usr/share/java/jboss-ec2-eap-samples/cluster-demo.war ## ExampleDS configuration for MySQL database data-source remove --name=ExampleDS /subsystem=datasources/jdbc-driver=mysql:add(driver-name="mysql",driver-module-name="com.mysql") data-source add --name=ExampleDS --connection-url="jdbc:mysql://${db.host}:3306/${db.database}" --jndi-name=java:jboss/datasources/ExampleDS --driver-name=mysql --user-name="${db.user}" --password="${db.passwd}" /subsystem=datasources/data-source=ExampleDS:enable /subsystem=datasources/data-source=ExampleDS:test-connection-in-pool EOC ## this will workaround the problem that in a VPC, instance hostnames are not resolvable echo -e "127.0.0.1\tlocalhost.localdomain localhost" > /etc/hosts echo -e "::1\tlocalhost6.localdomain6 localhost6" >> /etc/hosts for (( i=1 ; i<255 ; i++ )); do echo -e "$SUBNET$i\tip-${SUBNET//./-}$i" ; done >> /etc/hosts EOF
クラスター JBoss Enterprise Application Platform 6 AMI が正常に設定および起動されます。
18.2.3.11.2. クラスター JBoss Enterprise Application Platform 6 インスタンスのテスト
このトピックでは、クラスター JBoss Enterprise Application Platform 6 インスタンスが正常に実行されていることを確認する手順について説明します。
手順18.14 クラスターインスタンスのテスト
- ブラウザーで http://ELASTIC_IP_OF_APACHE_HTTPD に移動し、Web サーバーが正常に実行されていることを確認します。
クラスターノードのテスト
- ブラウザーで http://ELASTIC_IP_OF_APACHE_HTTPD/cluster-demo/put.jsp に移動します。
- いずれかのクラスターノードが次のメッセージをログに記録することを確認します。
Putting date now
- 前の手順でメッセージをログに記録したクラスターノードを停止します。
- ブラウザーで http://ELASTIC_IP_OF_APACHE_HTTPD/cluster-demo/get.jsp に移動します。
- 示された時間が、手順 2-a で
put.jsp
を使用して示された時間と同じであることを確認します。 - いずれかの稼働クラスターノードが次のメッセージをログに記録することを確認します。
Getting date now
- 停止されたクラスターノードを再起動します。
- Apache HTTPD インスタンスに接続します。
ssh -L7654:localhost:7654 <ELASTIC_IP_OF_APACHE_HTTPD>
- http://localhost:7654/mod_cluster-manager に移動して、すべてのインスタンスが正常に実行されていることを確認します。
クラスター JBoss Enterprise Application Platform 6 インスタンスがテストされ、正常に稼働していることが確認されます。
18.2.3.12. クラスター化管理対象ドメイン
18.2.3.12.1. [en-US] Launch an Instance to Serve as a Cluster Domain Controller
This topic covers the steps required to launch a clustered JBoss Enterprise Application Platform 6 managed domain on a Red Hat AMI (Amazon Machine Image).
Prerequisites
- A suitable Red Hat AMI. Refer to 「サポート対象 Red Hat AMI」 .
手順18.15 Launch a Cluster Domain Contoller
- Create an elastic IP for this instance.
- Select an AMI.
- Go to Security Group and allow all traffic (use Red Hat Enterprise Linux's built-in firewall capabilities to restrict access if desired).
- Choose "running" in the public subnet of the VPC.
- Choose a static IP (e.g. 10.0.0.5).
- Put the following in the User Data: field:
## mod cluster proxy addresses MOD_CLUSTER_PROXY_LIST=10.0.0.4:7654 ## password that will be used by slave host controllers to connect to the domain controller JBOSSAS_ADMIN_PASSWORD=<password for slave host controllers> ## subnet prefix this machine is connected to SUBNET=10.0.0. #### to run the example no modifications below should be needed #### JBOSS_DOMAIN_CONTROLLER=true PORTS_ALLOWED="9999 9990 9443" JBOSS_IP=`hostname | sed -e 's/ip-//' -e 'y/-/./'` #listen on public/private EC2 IP address cat > $USER_SCRIPT << "EOF" ## Get the application to be deployed from an Internet URL # mkdir -p /usr/share/java/jboss-ec2-eap-applications # wget https://<your secure storage hostname>/<path>/<app name>.war -O /usr/share/java/jboss-ec2-eap-applications/<app name>.war ## Install the JDBC driver as a core module yum -y install mysql-connector-java mkdir -p /usr/share/jbossas/modules/com/mysql/main cp -v /usr/share/java/mysql-connector-java-*.jar /usr/share/jbossas/modules/com/mysql/main/mysql-connector-java.jar cat > /usr/share/jbossas/modules/com/mysql/main/module.xml <<"EOM" <module xmlns="urn:jboss:module:1.0" name="com.mysql"> <resources> <resource-root path="mysql-connector-java.jar"/> </resources> <dependencies> <module name="javax.api"/> </dependencies> </module> EOM cat > $USER_CLI_COMMANDS << "EOC" ## Deploy the sample application from the local filesystem deploy /usr/share/java/jboss-ec2-eap-samples/cluster-demo.war --server-groups=other-server-group ## ExampleDS configuration for MySQL database data-source --profile=mod_cluster-ec2-ha remove --name=ExampleDS /profile=mod_cluster-ec2-ha/subsystem=datasources/jdbc-driver=mysql:add(driver-name="mysql",driver-module-name="com.mysql") data-source --profile=mod_cluster-ec2-ha add --name=ExampleDS --connection-url="jdbc:mysql://${db.host}:3306/${db.database}" --jndi-name=java:jboss/datasources/ExampleDS --driver-name=mysql --user-name="${db.user}" --password="${db.passwd}" /profile=mod_cluster-ec2-ha/subsystem=datasources/data-source=ExampleDS:enable EOC ## this will workaround the problem that in a VPC, instance hostnames are not resolvable echo -e "127.0.0.1\tlocalhost.localdomain localhost" > /etc/hosts echo -e "::1\tlocalhost6.localdomain6 localhost6" >> /etc/hosts for (( i=1 ; i<255 ; i++ )); do echo -e "$SUBNET$i\tip-${SUBNET//./-}$i" ; done >> /etc/hosts EOF
For Production Instances
For a production instance, add the following line beneath theUSER_SCRIPT
line of theUser Data
field, to ensure security updates are applied on boot.yum -y update
注記
yum -y update
should be run regularly, to apply security fixes and enhancements.- Launch the Red Hat AMI instance.
A clustered JBoss Enterprise Application Platform 6 managed domain is configured and launched on a Red Hat AMI.
18.2.3.12.2. [en-US] Launch One or More Instances to Serve as Cluster Host Controllers
This topic covers the steps required to launch one or more instances of JBoss Enterprise Application Platform 6 to serve as cluster host controllers on a Red Hat AMI (Amazon Machine Image).
Prerequisites
- Configure and launch the cluster domain controller. Refer to 「[en-US] Launch an Instance to Serve as a Cluster Domain Controller」 .
手順18.16 Launch Host Controllers
- Select an AMI.
- Define the desired number of instances (the number of slave host controllers).
- Select the VPC and instance type.
- Click on Security Group.
- Ensure that all traffic from the JBoss Enterprise Application Platform cluster subnet is allowed.
- Define other restrictions as desired.
- Add the following into the User Data field:
## mod cluster proxy addresses MOD_CLUSTER_PROXY_LIST=10.0.0.4:7654 ## clustering setup JBOSS_JGROUPS_S3_PING_SECRET_ACCESS_KEY=<your secret key> JBOSS_JGROUPS_S3_PING_ACCESS_KEY=<your access key> JBOSS_JGROUPS_S3_PING_BUCKET=<your bucket name> ## host controller setup JBOSS_DOMAIN_MASTER_ADDRESS=10.0.0.5 JBOSS_HOST_PASSWORD=<password for slave host controllers> ## database credentials configuration JAVA_OPTS="$JAVA_OPTS -Ddb.host=instancename.something.rds.amazonaws.com -Ddb.database=mydatabase -Ddb.user=<user> -Ddb.passwd=<pass>" ## subnet prefix this machine is connected to SUBNET=10.0.1. #### to run the example no modifications below should be needed #### JBOSS_HOST_USERNAME=admin PORTS_ALLOWED="1024:65535" JBOSS_IP=`hostname | sed -e 's/ip-//' -e 'y/-/./'` #listen on public/private EC2 IP address cat > $USER_SCRIPT << "EOF" ## Server instance configuration sed -i "s/main-server-group/other-server-group/" $JBOSS_CONFIG_DIR/$JBOSS_HOST_CONFIG ## install the JDBC driver as a core module yum -y install mysql-connector-java mkdir -p /usr/share/jbossas/modules/com/mysql/main cp -v /usr/share/java/mysql-connector-java-*.jar /usr/share/jbossas/modules/com/mysql/main/mysql-connector-java.jar cat > /usr/share/jbossas/modules/com/mysql/main/module.xml <<"EOM" <module xmlns="urn:jboss:module:1.0" name="com.mysql"> <resources> <resource-root path="mysql-connector-java.jar"/> </resources> <dependencies> <module name="javax.api"/> </dependencies> </module> EOM ## this will workaround the problem that in a VPC, instance hostnames are not resolvable echo -e "127.0.0.1\tlocalhost.localdomain localhost" > /etc/hosts echo -e "::1\tlocalhost6.localdomain6 localhost6" >> /etc/hosts for (( i=1 ; i<255 ; i++ )); do echo -e "$SUBNET$i\tip-${SUBNET//./-}$i" ; done >> /etc/hosts EOF
For Production Instances
For a production instance, add the following line beneath theUSER_SCRIPT
line of theUser Data
field, to ensure security updates are applied on boot.yum -y update
注記
yum -y update
should be run regularly, to apply security fixes and enhancements.- Launch the Red Hat AMI instance.
The JBoss Enterprise Application Platform 6 cluster host controllers are configured and launched on a Red Hat AMI.
18.2.3.12.3. [en-US] Test the Clustered JBoss Enterprise Application Platform 6 Managed Domain
This topic covers the steps required to test the clustered JBoss Enterprise Application Platform managed domain on a Red Hat AMI (Amazon Machine Image).
Prerequisites
- Configure and launch the cluster domain controller. Refer to 「[en-US] Launch an Instance to Serve as a Cluster Domain Controller」 .
- Configure and launch the cluster host controllers. Refer to 「[en-US] Launch One or More Instances to Serve as Cluster Host Controllers」 .
手順18.17 Test the Apache HTTPD instance
- Navigate to
http://ELASTIC_IP_OF_APACHE_HTTPD
in a browser to confirm the web server is running successfully.
手順18.18 Test the Domain Controller
- Navigate to
http://ELASTIC_IP_OF_DOMAIN_CONTROLLER:9990/console
- Log in using the username
admin
and the password specified in the User Data field for the domain controller. Once logged in, the admin console landing page for a managed domain should appear (http://ELASTIC_IP_OF_DOMAIN_CONTROLLER:9990/console/App.html#server-instances
). - Click the Server label at the top right side of the screen. Select any of the host controllers in the Host dropdown menu at the top left side of the screen.
- Verify that this host controller has two server configurations called
server-one
andserver-two
and verify that they both belong to theother-server-group
.
手順18.19 Test the Host Controllers
- Navigate to
http://ELASTIC_IP_OF_APACHE_HTTPD/cluster-demo/put.jsp
in a browser. - Verify that one of the host controllers logs the following message:
Putting date now.
- Stop the server instance that logged the message in the previous step (see Section 2.8.3, Stop a Server Using the Management Console).
- Navigate to
http://ELASTIC_IP_OF_APACHE_HTTPD/cluster-demo/get.jsp
in a browser. - Verify that the time shown is the same as the time that was
PUT
usingput.jsp
in Step 2. - Verify that one of the running server instances logs the following message:
Getting date now.
- Restart the stopped server instance (see Section 2.8.3, Start a Server Using the Management Console)
- Connect to the Apache HTTPD instance.
$ ssh -L7654:localhost:7654 ELASTIC_IP_OF_APACHE_HTTPD
- Navigate to
http://localhost:7654/mod_cluster-manager
to confirm all instances are running correctly.
The JBoss Enterprise Application Platform 6 web server, domain controller, and host controllers are running correctly on a Red Hat AMI.
18.3. JBoss Operations Network (JON) での監視の確立
18.3.1. AMI 監視について
18.3.2. 接続要件について
18.3.3. Network Address Translation (NAT) について
agent-configuration.xml
設定ファイルの rhq.communications.connector.*
の説明を参照してください。
18.3.4. Amazon EC2 および DNS について
18.3.5. EC2 でのルーティングについて
source/destination checking
ルーティング機能がアクティベートされます。この機能はマシンの IP アドレスとは異なる送信先を持つサーバーに送信されるすべてのパケットを破棄します。JON サーバーにエージェントを接続するために選択された VPN ソリューションにルーターが含まれる場合は、サーバーをルーターまたは VPN ゲートウェイとして動作するためにこの機能を無効にする必要があります。この設定は、Amazon AWS コンソールを介してアクセスできます。また、source/destination checking
は、Virtual Private Cloud (VPC) でも無効にする必要があります。
- VPC の作成時に、プライベートネットワークですでに使用されているアドレスの割り当てを回避し、接続の問題を回避します。
- インスタンスが利用可能なゾーンのローカルリソースにアクセスする必要がある場合は、Amazon EC2 プライベートアドレスが使用され、トラフィックが VPN を介してルーティングされないことを確認します。
- Amazon EC2 インスタンスが企業プライベートネットワークアドレスの小さいサブネット (JON サーバーのみなど) にアクセスする場合は、これらのアドレスのみを VPN を介してルーティングする必要があります。これにより、セキュリティーが強化され、Amazon EC2 またはプライベートネットワークアドレス空間の競合の可能性が低くなります。
18.3.6. JON での終了と再起動について
/etc/sysconfig/jon-agent-ec2
の JON_AGENT_ADDR
を更新し、エージェントを再起動します。
18.3.7. JBoss Operations Network で登録するインスタンスの設定
- JBoss Enterprise Application Platform の場合は、これを User Data フィールドに追加します。
JON_SERVER_ADDR=jon2.it.example.com ## if instance not already configured to resolve its hostname JON_AGENT_ADDR=`ip addr show dev eth0 primary to 0/0 | sed -n 's#.*inet \([0-9.]\+\)/.*#\1#p'` PORTS_ALLOWED=16163 # insert other JON options when necessary, see Appendix I
18.4. ユーザースクリプト設定
18.4.1. 永続的な設定パラメーター
次のパラメーターを使用して、JBoss Enterprise Application Platform の設定と操作に影響を与えることができます。この内容は、/etc/sysconfig/jbossas
と /etc/sysconfig/jon-agent-ec2
に書き込まれます。
表18.2 設定可能なパラメーター
名前 | 説明 | デフォルト |
---|---|---|
JBOSS_JGROUPS_S3_PING_ACCESS_KEY | S3_PING 検出用 Amazon AWS ユーザーアカウントアクセスキー (クラスタリングが使用される場合)。 | N/A |
JBOSS_JGROUPS_S3_PING_SECRET_ACCESS_KEY | Amazon AWS ユーザーアカウント秘密アクセスキー。 | N/A |
JBOSS_JGROUPS_S3_PING_BUCKET | S3_PING 検出に使用する Amazon S3 バケット。 | N/A |
JBOSS_CLUSTER_ID |
クラスターメンバーノードの ID。クラスタリングの場合のみ使用されます。許可される値は次のとおりです (順番どおり)。
| eth0 の IP アドレスの最後のオクテット |
MOD_CLUSTER_PROXY_LIST | mod_cluster プロキシーの IP/ホスト名のカンマ区切りリスト (mod_cluster を使用する場合)。 | N/A |
PORTS_ALLOWED | デフォルトのもの以外に、ファイアウォールで許可される受信ポートのリスト。 | N/A |
JBOSSAS_ADMIN_PASSWORD | admin ユーザーのパスワード。 | N/A |
JON_SERVER_ADDR | 登録するのに使用する JON サーバーのホスト名または IP。これは登録のためにのみ使用され、登録後、エージェントは JON クラスター内の他のサーバーと通信できます。 | N/A |
JON_SERVER_PORT | サーバーと通信するためにエージェントが使用するポート。 | 7080 |
JON_AGENT_NAME | JON エージェントの名前 (一意である必要があります)。 | インスタンスの ID |
JON_AGENT_PORT | エージェントがリッスンするポート。 | 16163 |
JON_AGENT_ADDR | JON エージェントがバインドされる IP アドレス。これは、サーバーが複数のパブリックアドレス (VPN など) を持つ場合に使用されます。 | JON エージェントは、デフォルトでローカルホスト名の IP を選択します。 |
JON_AGENT_OPTS | SSL、NAT、および他の高度な設定を指定するために使用できる追加の JON エージェントシステムプロパティー。 | N/A |
JBOSS_SERVER_CONFIG |
使用する JBoss EAP サーバー設定ファイルの名前。JBOSS_DOMAIN_CONTROLLER=true の場合は、
domain-ec2.xml が使用されます。それ外の場合は、次のようになります。
| standalone.xml 、standalone-full.xml 、standalone-ec2-ha.xml 、standalone-mod_cluser-ec2-ha.xml 、domain-ec2.xml (他のパラメーターに依存します)。 |
JAVA_OPTS | JBoss Enterprise Application Platform が起動する前に変数に追加するカスタム値。 | JAVA_OPTS は、他のパラメーターの値から構築されます。 |
JBOSS_IP | サーバーがバインドされる IP アドレス。 | 127.0.0.1 |
JBOSSCONF | 起動する JBoss Enterprise Application Platform 6 プロファイルの名前。JBoss Enterprise Application Platform 6 が起動しないようにするには、JBOSSCONF を disabled に設定します。 | standalone |
JBOSS_DOMAIN_CONTROLLER
|
このインスタンスをドメインコントローラーとして実行するかどうかを設定します。
| false
|
JBOSS_DOMAIN_MASTER_ADDRESS
|
リモートドメインコントローラーの IP アドレス。
|
N/A
|
JBOSS_HOST_NAME
|
論理ホスト名 (ドメイン内)。これは一意である必要があります。
|
HOSTNAME 環境変数の値。
|
JBOSS_HOST_USERNAME
|
ドメインコントローラーでの登録時にホストコントローラーが使用する必要があるユーザー名。これが提供されない場合は、JBOSS_HOST_NAME が代わりに使用されます。
|
JBOSS_HOST_NAME
|
JBOSS_HOST_PASSWORD
|
ドメインコントローラーでの登録時にホストコントローラーが使用する必要があるパスワード。
|
N/A
|
JBOSS_HOST_CONFIG
|
JBOSS_DOMAIN_CONTROLLER=true の場合は、
host-master.xml が使用されます。JBOSS_DOMAIN_MASTER_ADDRESS が存在する場合は、host-slave.xml が使用されます。
| host-master.xml または host-slave.xml (他のパラメーターに依存します)。
|
18.4.2. カスタムスクリプトパラメーター
User Data: フィールドのユーザーカスタマイズセクションでは、次のパラメーターを使用できます。
表18.3 設定可能なパラメーター
名前 | 説明 |
---|---|
JBOSS_DEPLOY_DIR
|
アクティブプロファイルのデプロイディレクトリー (
/var/lib/jbossas/standalone/deployments/ など)。このディレクトリーに置かれたデプロイ可能なアーカイブがデプロイされます。Red Hat は、デプロイディレクトリーの代わりに管理コンソールまたは CLI ツールを使用してデプロイメントを管理することをお勧めします。
|
JBOSS_CONFIG_DIR
|
アクティブプロファイルの設定ディレクトリー (
/var/lib/jbossas/standalone/configuration など)。
|
JBOSS_HOST_CONFIG
|
アクティブホスト設定ファイルの名前 (
host-master.xml など)。Red Hat は、設定ファイルを編集する代わりに、管理コンソールまたは CLI ツールを使用してサーバーを設定することをお勧めします。
|
JBOSS_SERVER_CONFIG
|
アクティブサーバー設定ファイルの名前 (
standalone-ec2-ha.xml など)。Red Hat は、設定ファイルを編集する代わりに、管理コンソールまたは CLI ツールを使用してサーバーを設定することをお勧めします。
|
USER_SCRIPT
|
カスタム設定スクリプトへのパス (ソースユーザーデータ設定の前に利用可能)。
|
USER_CLI_COMMANDS
|
CLI コマンドのカスタムファイルへのパス (ソースユーザーデータ設定の前に利用可能)。
|
18.5. トラブルシューティング
18.5.1. Amazon EC2 のトラブルシューティングについて
18.5.2. 診断情報
/var/log/jboss_user-data.out
は、jboss-ec2-eap 初期化スクリプトとユーザーカスタム設定スクリプトの出力です。/var/cache/jboss-ec2-eap/
には、インスタンス起動時に使用される実際のユーザーデータ、カスタムスクリプト、およびカスタム CLI コマンドが含まれます。- また、
/var/log
には、マシンの起動時に収集され、JBoss Enterprise Application Platform、httpd、および他のほとんどサービスから収集されたすべてのログが含まれます。
第19章 補足参考資料
19.1. Red Hat カスタマーポータルからファイルをダウンロード
このタスクをはじめる前に、まずカスタマーポータルのアカウントを作成する必要があります。http://access.redhat.com へ移動し、右上端にある登録 リンクをクリックしアカウントを作成してください。
手順19.1 タスク:
- 結果:
RHN のログインし、http://access.redhat.comのWeb メインページに戻ります。
ダウンロード ページへの移動
以下のオプションのいずれかを使い、ダウンロード ページへ移動します。- 上部のナビゲーションバーのダウンロード リンクをクリックします。
- https://access.redhat.com/downloads/ へ直接移動します。
ダウンロードをする製品とバージョンを選択します。
以下の方法を使い、正しい製品とバージョンを選びダウンロードしてください。- ナビゲーションを使って1つずつ進めていきます。
- 画面の右上端にある検索エリアを使い製品を検索します。
お使いのオペレーティングシステムやインストール方法にあったファイルをダウンロードします。
選択した製品に従い、オペレーティングシステムやアーキテクチャー別に ZIP アーカイブ、RPM、ネーティブインストーラーを選んでいただけます。ファイル名あるいは、ダウンロードしたいファイルの右側にある ダウンロード リンクをクリックします。
お使いのコンピューターにファイルをダウンロードします。
19.2. Red Hat Enterprise Linux でデフォルトの JDK を設定
複数の Java Development Kits (JDK) を Red Hat Enterprise Linux システムにインストール可能です。このタスクでは、現在の環境ではどれを使うか指定する方法を説明します。alternatives
コマンドを使って行います。
注記
このタスクを完了するにはスーパーユーザー権限が必要です。スーパーユーザー権限を取得するには、直接ログインするか、sudo
コマンドを使います。
希望の
java
およびjavac
バイナリのパスを決定します。rpm -ql packagename |grep bin
コマンドを使い、RPM からインストールしたバイナリの場所を検索します。java
とjavac
バイナリのデフォルトの場所は、Red Hat Enterprise Linux 32-bit システムの場合、以下のとおりです。表19.1
java
およびjavac
バイナリのデフォルトの場所JDK パス OpenJDK 1.6 /usr/lib/jvm/jre-1.6.0-openjdk/bin/java
/usr/lib/jvm/java-1.6.0-openjdk/bin/javac
Oracle JDK 1.6 /usr/lib/jvm/jre-1.6.0-sun/bin/java
/usr/lib/jvm/java-1.6.0-sun/bin/javac
それぞれ利用したい別の JDK を設定
以下のコマンドを実行し、特定のjava
およびjavac
を使うようお使いのシステムを設定します。/usr/sbin/alternatives --config java
あるいは/usr/sbin/alternatives --config javac
画面の指示に従います。オプション: 別の選択肢として
java_sdk_1.6.0
を設定します。Oracle JDK を使いたい場合、代わりのJDK にjava_sdk_1.6.0.
も設定してください。以下のコマンドを使います。/usr/sbin/alternatives --config java_sdk_1.6.0
. 正しいパスは通常、/usr/lib/jvm/java-1.6.0-sun
となっています。ファイルを表示させることで確認することができます。
別の JDK が選択され有効になります。
付録A 改訂履歴
改訂履歴 | |||
---|---|---|---|
改訂 2.0.0-1 | Wed Feb 12 2014 | CS Builder Robot | |
|