BEA ホーム | 製品 | dev2dev | support | askBEA |
![]() |
![]() |
|
![]() |
e-docs > WebLogic Server > WebLogic J2EE コネクタ アーキテクチャ > weblogic-ra.xml デプロイメント記述子の要素 |
WebLogic J2EE コネクタ アーキテクチャ
|
以下の節では、WebLogic Server リソース アダプタ アーカイブで使用する WebLogic Server 固有の全 XML 記述子プロパティをリファレンス形式で示し、XML 記述子プロパティを編集する方法について説明します。リソース アダプタ用のデプロイメント記述子を参照する必要がある場合は、これらの節を参考にしてください。
リソース アダプタ アーカイブ (RAR) に weblogic-ra.xml ファイルが含まれない場合、WebLogic Server はこのファイルを自動的に作成します。
WebLogic Server のリソース アダプタ アーカイブで使用される XML デプロイメント記述子を定義または変更する場合は、weblogic-ra.xml ファイルで XML 要素を手動で定義または編集する必要があります。
<max-config-property></max-config-property>
XML デプロイメント ファイルの編集、作成時に、各デプロイメント ファイルに対して正しい DOCTYPE ヘッダを指定することが重要です。特に、DOCTYPE ヘッダ内部に不正な PUBLIC 要素を使用すると、原因究明が困難なパーサ エラーになることがあります。
このヘッダは、デプロイメント記述子の文書型定義 (DTD) ファイルの場所およびバージョンを表します。このヘッダは外部 URL の java.sun.com を参照していますが、WebLogic Server には独自の DTD ファイルが用意されているので、ホスト サーバがインターネットにアクセスする必要はありません。ただし、この要素の DTD のバージョンはデプロイメント記述子のバージョンの識別に使用されるので、<!DOCTYPE...> 要素を ra.xml ファイルに含めて、外部 URL を参照させる必要があります。
ra.xml および weblogic-ra.xml ファイルの DOCTYPE ヘッダ全体は以下のようになります。
<!DOCTYPE connector PUBLIC |
|
<!DOCTYPE weblogic-connection-factory-dd PUBLIC "-//BEA Systems, Inc.//DTD WebLogic 7.0.0 Connector//EN" "http://www.bea.com/servers/wls700/dtd/weblogic700-ra.dtd"> |
XML の解析ユーティリティ (ejbc など) でヘッダ情報が不正な XML ファイルを解析すると、次のようなエラー メッセージが表示されることがあります。
SAXException: This document may not have the identifier 'identifier_name'
identifier_name には通常、PUBLIC 要素内の不正な文字列が表示されます。
検証用 DTD (Document Type Definitions : 文書型定義)
XML ファイルの内容および要素の配置は、使用する各ファイルの文書型定義 (DTD) に従っている必要があります。WebLogic Server ユーティリティでは、XML デプロイメント ファイルの DOCTYPE ヘッダ内に埋め込まれた DTD は無視され、代わりにサーバと共にインストールされた DTD の場所が使用されます。ただし、DOCTYPE ヘッダ情報には、パーサ エラーを避けるために有効な URL 構文を指定する必要があります。
以下のリンクでは、WebLogic Server で使用される XML デプロイメント ファイル用の DTD の場所が示されています。
注意: ほとんどのブラウザでは、.dtd ファイルの内容は表示されません。DTD ファイルの内容をブラウザで見るには、リンクをテキスト ファイルとして保存し、テキスト エディタで開いて表示します。
Administration Console デプロイメント記述子エディタを使用したファイルの編集
この節では、Administration Console のデプロイメント記述子エディタを使用して以下のリソース アダプタのデプロイメント記述子を編集する手順を説明します。
リソース アダプタ デプロイメント記述子の要素の詳細については、『WebLogic J2EE コネクタ アーキテクチャ』を参照してください。
リソース アダプタのデプロイメント記述子を編集するには、次の手順に従います。
WebLogic Builder を使用したデプロイメント記述の編集
WebLogic Builder は、アプリケーションのデプロイメント記述子 XML ファイルを編集するためのビジュアルな環境を提供します。WebLogic Builder では、これらの XML ファイルをビジュアルに編集しながら参照できるので、テキストによる編集は必要ありません。
WebLogic Builder は以下の開発作業に使用します。
WebLogic Builder の使い方については、WebLogic Builder のマニュアルを参照してください。
コード リスト 8-2 weblogic-ra.xml DTD
<!--
WebLogic Server v7.0 固有のリソース アダプタ デプロイメント記述子用の XML DTD
この DTD は J2EE コネクタ アーキテクチャ v1.0 リソース アダプタ デプロイメント記述子 (ra.xml) に使用することが目的です。
weblogic600-ra.dtd 以降の変更の概要
* connection-cleanup-frequency および connection-duration-time の非推奨化。これらの要素を connection-maxidle-time に代えました。
* connection-profiling-enabled の追加
* security-principal-map の非推奨化。この要素に元々格納されていたパスワード資格情報は WebLogic Server の内部ストレージに格納されるようになりました。詳細については、『WebLogic J2EE コネクタ アーキテクチャ』を参照してください。
Copyright (c) 2002 by BEA Systems, Inc. All Rights Reserved.
-->
<!--
この DTD は、デプロイ済みリソース アダプタの接続ファクトリを定義するための WebLogic 固有のデプロイメント情報を定義します。この要素は、接続プール パラメータを始めとしてコンフィグレーション可能なすべての接続ファクトリ パラメータおよびリソース プリンシパル マップ用のセキュリティ パラメータを指定し、 ra.xml デプロイメント記述子のコンフィグレーション パラメータの値を定義する機能を提供します。
-->
<!--
weblogic-connection-factory-dd 要素は WebLogic 固有のデプロイメント記述子のルート要素で、デプロイ済みリソース アダプタ用です。
-->
<!ELEMENT weblogic-connection-factory-dd (connection-factory-name, description?, jndi-name, ra-link-ref?, native-libdir?,pool-params?, (logging-enabled, log-filename)?, map-config-property*, security-principal-map?)>
<!--
connection-factory-name 要素は、特定のリソース アダプタのデプロイメントおよび対応する接続ファクトリに関連付けられる論理名を定義します。
connection-factory-name の値は、ra-link-ref 要素を介して他のデプロイ済みリソース アダプタで使用できます。これにより、複数のデプロイ済み接続ファクトリ間で、指定されているコンフィグレーションを共有するだけでなく、共通のデプロイ済みリソース アダプタを利用することもできます。
この要素は必須です。
-->
<!ELEMENT connection-factory-name (#PCDATA)>
<!--
description 要素は、親要素を示すテキストの指定に使用します。description 要素には、デプロイヤがデプロイ済みファクトリについて説明するための情報を含めます。
この要素は省略できます。
-->
<!ELEMENT description (#PCDATA)>
<!--
jndi-name 要素は、接続ファクトリ オブジェクトを WebLogic JNDI ネームスペースにバインドするための名前を定義します。クライアント EJB およびサーブレットも、WebLogic 固有のデプロイメント記述子で定義されている Reference Descriptor 要素でこの JNDI を使用します。
この要素は必須です。
-->
<!ELEMENT jndi-name (#PCDATA)>
<!--
ra-link-ref では、複数のデプロイ済み接続ファクトリを 1 つのデプロイ済みリソース アダプタに論理的に関連付けることができます。省略可能な ra-link-ref 要素に別のデプロイ済み接続ファクトリを示す値を指定すると、新しくデプロイされる接続ファクトリが、参照先の接続ファクトリと一緒にデプロイされたリソース アダプタを共有します。
また、参照先の接続ファクトリのデプロイメントで定義されているすべての値は、その他の値が指定されていない限り、新しくデプロイされるこの接続ファクトリが継承します。
この要素は省略できます。
-->
<!ELEMENT ra-link-ref (#PCDATA)>
<!--
native-libdir 要素は、このリソース アダプタ デプロイメントのすべてのネイティブ ライブラリ用に使用するディレクトリの場所を示します。デプロイメント処理の一部として、検出されたネイティブ ライブラリはすべて指定された場所にコピーされます。
管理者は、WebLogic Server の実行中にライブラリが見つかるようにプラットフォームのアクションを実行する必要があります。
この要素は、ネイティブ ライブラリが存在する場合には必須です。
-->
<!ELEMENT native-libdir (#PCDATA)>
<!--
pool-params 要素は、この接続ファクトリの接続プール固有のパラメータを指定するための親要素です。
WebLogic は、管理対象の接続が保持するプールの動作を制御する際にこれらの指定を使用します。
この要素は省略できます。この要素またはこの要素に固有の項目を指定しないと、デフォルト値が割り当てられます。指定されているデフォルト値については、それぞれの要素の説明を参照してください。
-->
<!ELEMENT pool-params (initial-capacity?, max-capacity?, capacity-increment?, shrinking-enabled?, shrink-period-minutes?, connection-cleanup-frequency?, connection-duration-time?, connection-maxidle-time?, connection-profiling-enabled?)>
<!--
initial-capacity 要素は、管理対象の接続の初期数を示します。WebLogic Server はデプロイメント中にこの数の接続を取得しようとします。
この要素は省略できます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
デフォルト値 : 1
-->
<!ELEMENT initial-capacity (#PCDATA)>
<!--
max-capacity 要素は、WebLogic Server が許容する管理対象の接続の最大数を示します。この制限を超えて管理対象の接続の割り当てを要求すると、呼び出し側に ResourceAllocationException が返されます。
この要素は省略できます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
デフォルト値 : 10
-->
<!ELEMENT max-capacity (#PCDATA)>
<!--
capacity-increment 要素は、管理対象の接続の追加数を示します。WebLogic Server は、保持している接続プールのサイズを変更する際にこの数の接続を取得しようとします。
この要素は省略できます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
デフォルト値 : 1
-->
<!ELEMENT capacity-increment (#PCDATA)>
<!--
shrinking-enabled 要素は、接続プールがシステム リソースの管理手段として未使用の管理対象接続を再利用するかどうかを示します。
この要素は省略できます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
値の範囲 : true または false
デフォルト値 : true
-->
<!ELEMENT shrinking-enabled (#PCDATA)>
<!--
shrink-period-minutes 要素は、接続プール管理によって未使用の管理対象接続を再利用しようとする間隔を示します。
この要素は省略できます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
デフォルト値 : 15
-->
<!ELEMENT shrink-period-minutes (#PCDATA)>
<!--
connection-cleanup-frequency 要素は、接続プール管理によって設定されている使用時間を超えた接続ハンドルを破棄しようとする間隔 (秒単位) を示します。この要素は connection-duration-time と連携して、アプリケーションが使用後の接続を閉じなかった場合に接続リークを防ぎます。
この要素は非推奨です。この要素は今後 connection-maxidle-time に代えられます。
この要素は省略できます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
デフォルト値 : -1
-->
<!ELEMENT connection-cleanup-frequency (#PCDATA)>
<!--
connection-duration-time 要素は、接続ハンドルがアクティブな状態を続ける時間 (秒単位) を示します。この要素は connection-cleanup-frequency と連携して、アプリケーションが使用後の接続を閉じなかった場合にリークを防ぎます。
この要素は非推奨です。この要素は今後 connection-maxidle-time に代えられます。
この要素は省略できます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
デフォルト値 : -1
-->
<!ELEMENT connection-duration-time (#PCDATA)>
<!--
connection-maxidle-time 要素は、接続ハンドルがアクティブな状態を続ける時間 (秒単位) を示します。この要素はアプリケーションが接続の使用を完了後に接続を閉じなかった時にリークを防ぎます。アイドル接続が打ち切られるのは、接続プールが一杯になり、そのために新しい接続要求が失敗することが確実な場合のみです。
この要素は省略できます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
デフォルト値 : 0
-->
<!ELEMENT connection-maxidle-time (#PCDATA)>
<!--
connection-profiling-enabled 要素は、各接続の割り当て先のコール スタックを接続プールに格納するか否かを示します。有効化すると、この情報をコンソールを通じてアクティブな接続で参照できます。また、これを有効化すると、リークした接続とアイドル接続のスタックが表示され、接続のクローズに失敗するコンポーネントをデバッグする上で役立ちます。
この要素は省略できます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
値の範囲 : true または false
デフォルト値 : false
-->
<!ELEMENT connection-profiling-enabled (#PCDATA)>
<!--
logging-enabled 要素は、ManagedConnectionFactory または ManagedConnection に対してログ ライタが設定されているかどうかを示します。この要素を true に設定すると、ManagedConnectionFactory または ManagedConnection から生成された出力は、log-filename 要素で指定したファイルに送られます。
この要素は省略できます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
値の範囲 : true または false
デフォルト値 : false
-->
<!ELEMENT logging-enabled (#PCDATA)>
<!--
log-filename 要素は、ManagedConnectionFactory または ManagedConnection から生成された出力を送るログ ファイルの名前を指定します。
ファイル名は絶対アドレスで指定する必要があります。
この要素は省略できます。
-->
<!ELEMENT log-filename (#PCDATA)>
<!--
各 map-config-property 要素は、対応する config-property-name 名を持つ ra.xml の config-entry 要素に対応するコンフィグレーション プロパティの名前および値を示します。
デプロイメント時には、map-config-property で指定されたすべての値が ManagedConnectionFactory で設定されます。
map-config-property を介して指定された値は、対応する ra.xml の config-entry 要素で指定されたデフォルト値に優先します。
この要素は省略できます。
-->
<!ELEMENT map-config-property (map-config-property-name, map-config-property-value)> <!ELEMENT map-config-property-name (#PCDATA)> <!ELEMENT map-config-property-value (#PCDATA)>
<!--
各 security-principal-map 要素は、WebLogic 実行時の既知の開始プリンシパルに基づいて、リソース アダプタ/EIS の許可処理用のリソース プリンシパル値を定義するためのメカニズムを提供します。
このマップにより、管理対象の接続と接続ハンドルを割り当てる際に使用される開始プリンシパルと対応するリソース プリンシパルのユーザ名およびパスワードのセットを指定できます。
デフォルトのリソース プリンシパルは、このマップに基づいて接続ファクトリ用に定義できます。initiating-principal 値に「*」を指定し、対応する resource-principal 値を指定した場合、マップ内で現在の ID と一致するものがないときには必ず定義した resource-principal が利用されます。
この要素は非推奨です。詳細については、『WebLogic J2EE コネクタ アーキテクチャ』を参照してください。
この要素は省略できますが、コンテナ管理によるサインオンがリソース アダプタでサポートされており、いずれかのクライアントで使用される場合は指定する必要があります。
また、デプロイ時に管理対象の接続を接続プールに取得する試みは、定義されている「デフォルト」リソース プリンシパル (指定されている場合) を使用して行われます。
-->
<!ELEMENT security-principal-map (map-entry*)>
<!ELEMENT map-entry (initiating-principal+, resource-principal)>
<!ELEMENT initiating-principal (#PCDATA)>
<!ELEMENT resource-principal (resource-username, resource-password)>
<!ELEMENT resource-username (#PCDATA)>
<!ELEMENT resource-password (#PCDATA)>
以下の図は、weblogic-ra.xml デプロイメント記述子の構造を示しています。
weblogic-ra.xml ファイルで定義できる各要素について以下の節で説明します。
weblogic-connection-factory-dd (必須)
WebLogic 固有のデプロイメント記述子のルート要素で、デプロイ済みリソース アダプタ用です。
特定のリソース アダプタのデプロイメントおよび対応する接続ファクトリに関連付けられる論理名を定義します。この要素の値は、ra-link-ref 要素を介して他のデプロイ済みリソース アダプタで使用できます。これにより、複数のデプロイ済み接続ファクトリ間で、指定されているコンフィグレーションを共有するだけでなく、共通のデプロイ済みリソース アダプタを利用することもできます。
親要素について説明するテキストを指定します。この要素には、デプロイヤがデプロイ済みファクトリについて説明するための情報を含めます。
接続ファクトリ オブジェクトを WebLogic JNDI ネームスペースにバインドするための名前を定義します。クライアント EJB およびサーブレットも、WebLogic 固有のデプロイメント記述子で定義されている Reference Descriptor 要素でこの JNDI を使用します。
複数のデプロイ済み接続ファクトリを 1 つのデプロイ済みリソース アダプタに論理的に関連付けることができます。省略可能な ra-link-ref 要素に別のデプロイ済み接続ファクトリを示す値を指定すると、新しくデプロイされる接続ファクトリが、参照先の接続ファクトリと一緒にデプロイされたリソース アダプタを共有します。また、参照先の接続ファクトリのデプロイメントで定義されているすべての値は、その他の値が指定されていない限り、新しくデプロイされるこの接続ファクトリが継承します。
native-libdir (ネイティブ ライブラリが存在する場合は必須)
このリソース アダプタ デプロイメントのすべてのネイティブ ライブラリ用に使用するディレクトリの場所を示します。デプロイメント処理の一部として、検出されたネイティブ ライブラリはすべて指定された場所にコピーされます。管理者は、WebLogic Server の実行中にライブラリが見つかるようにプラットフォームのアクションを実行する必要があります。
この接続ファクトリの接続プール固有のパラメータを指定するための親要素です。WebLogic Server は、管理対象の接続が保持するプールの動作を制御する際にこれらの指定を使用します。
この要素またはこの要素に固有の項目を指定しないと、デフォルト値が割り当てられます。指定されているデフォルト値については、それぞれの要素の説明を参照してください。
管理対象の接続の初期数を示します。WebLogic Server はデプロイメント中にこの数の接続を取得しようとします。
この値を指定しないと、WebLogic Server は定義されているデフォルト値を使用します。
WebLogic Server が許容する管理対象接続の最大数を指定します。この制限を超えて管理対象の接続の割り当てを要求すると、呼び出し側に ResourceAllocationException が返されます。
この値を指定しないと、WebLogic Server は定義されているデフォルト値を使用します。
管理対象の接続の最大追加数を示します。WebLogic Server は、保持している接続プールのサイズを変更する際にこの数の接続を取得しようとします。
この値を指定しないと、WebLogic Server は定義されているデフォルト値を使用します。
接続プールがシステム リソースの管理手段として未使用の管理対象接続を再利用するかどうかを示します。
この値を指定しないと、WebLogic Server は定義されているデフォルト値を使用します。
接続プール マネージャが未使用の管理対象接続を再利用しようとする間隔を示します。
この値を指定しないと、WebLogic Server は定義されているデフォルト値を使用します。
connection-cleanup-frequency (省略可能)
接続プール管理によって設定されている使用時間を超えた接続ハンドルを破棄しようとする間隔を示します。この要素は connection-duration-time と連携して、アプリケーションが使用後の接続を閉じなかった場合に接続リークを防ぎます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
注意: connection-cleanup-frequency 要素は非推奨です。このパラメータを現在コンフィグレーションで使用している場合、デプロイメント機能はまだ使用することができます。しかし、これらの要素はコンフィグレーションに反映されません。
connection-duration-time (省略可能)
この要素は非推奨です。接続がアクティブとなる時間を指定します。この要素は connection-cleanup-frequency と連携して、アプリケーションが使用後の接続を閉じなかった場合にリークを防ぎます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
注意: connection-duration-time 要素は非推奨です。このパラメータを現在コンフィグレーションで使用している場合、デプロイメント機能はまだ使用することができます。しかし、これらの要素はコンフィグレーションに反映されません。
connection-maxidle-time (省略可能)
接続ハンドルがアイドル状態を保つことができる時間 (単位 : 秒) を指定します。この要素はアプリケーションが接続の使用を完了後に接続を閉じなかった時にリークを防ぎます。アイドル接続が打ち切られるのは、接続プールが一杯になり、そのために新しい接続要求が失敗することが確実な場合のみです。
この値を指定しないと、WebLogic Server は定義されているデフォルト値を使用します。
connection-profiling-enabled (省略可能)
接続プールが各接続の割り当て先コールスタックを格納するかどうかを指定します。有効化すると、この情報をコンソールを通じてアクティブな接続で参照できます。また、これを有効化すると、リークした接続とアイドル接続のスタックが表示され、接続のクローズに失敗するコンポーネントをデバッグする上で役立ちます。
この値を指定しないと、WebLogic は定義されているデフォルト値を使用します。
ManagedConnectionFactory または ManagedConnection に対してログ ライタが設定されているかどうかを示します。この要素を true に設定すると、ManagedConnectionFactory または ManagedConnection から生成された出力は、log-filename 要素で指定したファイルに送られます。
この値を指定しないと、WebLogic Server は定義されているデフォルト値を使用します。
ManagedConnectionFactory または ManagedConnection から生成された出力を送るログ ファイルの名前を指定します。
map-config-property (省略可能、ゼロまたは 1 つ以上)
対応する config-property-name 名を持つ ra.xml の config-entry 要素に対応するコンフィグレーション プロパティの名前および値を示します。デプロイメント時には、map-config-property で指定されたすべての値が ManagedConnectionFactory で設定されます。map-config-property を介して指定された値は、対応する ra.xml config-entry 要素で指定されたデフォルト値に優先します。
map-config-property-name (省略可能)
対応する config-property-name を持つ ra.xml config-entry に対応する名前を示します。
map-config-property-value (省略可能)
対応する config-property-name を持つ ra.xml config-entry に対応する値を示します。
(この要素は非推奨です。) WebLogic 実行時の既知の initiating-principal に基づいて、リソース アダプタおよび EIS の許可処理用の resource-principal 値を定義するためのメカニズムを提供します。このマップにより、管理対象の接続と接続ハンドルを割り当てる際に使用される開始プリンシパルと対応するリソース プリンシパルのユーザ名およびパスワードのセットを指定できます。
デフォルトの resource-principal は、このマップに基づいて接続ファクトリ用に定義できます。initiating-principal 値に「*」を指定し、対応する resource-principal 値を指定した場合、マップ内で現在の ID と一致するものがないときには必ず定義した resource-principal が利用されます。
この要素は省略できますが、コンテナ管理によるサインオンがリソース アダプタでサポートされており、いずれかのクライアントで使用される場合は指定する必要があります。
また、定義済みの「デフォルト」リソース プリンシパル (指定されている場合) を使用して、デプロイメント時に管理対象の接続を接続プールに取得するよう試行されます。
security-principal-map 内のエントリを示します。
![]() |
![]() |
![]() |
![]() |
||
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |