Oracle® Fusion Middleware Oracle WebLogic Server リソース アダプタ プログラマーズ ガイド 11g リリース 1 (10.3.1) B55541-01 |
|
戻る |
次へ |
この付録の以下の節では、WebLogic Server 固有のデプロイメント記述子 weblogic-ra.xml
で定義できるデプロイメント記述子要素について説明します。weblogic-ra.xml
のスキーマは http://xmlns.oracle.com/weblogic/weblogic-connector/1.0/weblogic-connector.xsd
です。リソース アダプタ アーカイブ (RAR) に weblogic-ra.xml
デプロイメント記述子が含まれていない場合、WebLogic Server はデプロイメント記述子要素のデフォルト値を自動的に選択します。
weblogic-connector
要素は、デプロイされるリソース アダプタ用の、WebLogic 固有のデプロイメント記述子のルート要素です。weblogic-connector
要素の内部に以下の要素を定義できます。
表 A-1 weblogic-connector の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
native-libdir |
ネイティブ ライブラリがある場合は必須 |
リソース アダプタで必要なすべてのネイティブ ライブラリが存在するディレクトリを指定する。 |
jndi-name |
リソース アダプタ Bean が指定されている場合にのみ必須 |
リソース アダプタの JNDI 名を指定する。リソース アダプタ Bean はこの名前で JNDI ツリーに登録される。リソース アダプタ Bean が指定されていない場合は必須の要素とはならない。リソース アダプタ Bean のないリソース アダプタの JNDI 名を指定すると、要素は機能しなくなる。 |
enable-access-outside-app |
省略可能 |
J2CA 1.5 仕様で規定されているように、リソース アダプタがアプリケーション (つまり EAR) の内部にパッケージ化されている場合、そのアプリケーション内のコンポーネントのみがリソース アダプタにアクセスできる。この要素を使用すると、この機能をオーバーライドできる。 注意 : この要素はスタンドアロンのリソース アダプタには適用されない。 デフォルト値 : 注意 : false に設定した場合、リソース アダプタと同じアプリケーション内のクライアントのみが、リソース アダプタにアクセスできる。 (このリリースでサポートされる) バージョン 1.0 リソース アダプタでは、この要素のデフォルト値は |
enable-global-access-to- classes |
省略可能 |
|
work-manager |
省略可能 |
この複合要素では、リソース アダプタ Bean で使用されるワーク マネージャを作成するための、すべてのコンフィグレーション可能な要素を指定する。 ワーク マネージャは、デッドロックを回避し、同時実行性の制約を受けながら最適なスループットを実現するために、作業スレッドの数を動的に調整する。応答時間の目標値、シェア、優先順位などの目標も達成する。
|
security |
省略可能 |
この複合要素では、リソース アダプタの処理に関するすべてのセキュリティ パラメータを指定する。 コネクタ コンテナが使用するセキュリティのデフォルトについては、「security」を参照。 |
properties |
省略可能 |
この複合要素は、
|
admin-objects |
省略可能 |
この複合要素では、リソース アダプタのすべての管理オブジェクトを定義する。
|
outbound-resource-adapter |
省略可能 |
この複合要素では、リソース アダプタの発信コンポーネントについて記述する。
|
work-manager
要素は、リソース アダプタ Bean で使用されるワーク マネージャを作成するときにコンフィグレーション可能な、すべての要素の指定に使用する複合要素です。work-manager
要素は weblogic-j2ee.xsd
スキーマからインポートされます。work-manager
要素の中に以下の下位要素をコンフィグレーションできます。
表 A-2 work-manager の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
name |
必須 |
ワーク マネージャの名前を指定する。 J2CA 1.5 仕様では、リソース アダプタからアプリケーション サーバに作業スレッドを送信する方法を説明している。この作業スレッドは WebLogic Server ワーク マネージャによって管理される。ワーク マネージャは、デッドロックを回避し、同時実行性の制約を受けながら最適なスループットを実現するために、作業スレッドの数を動的に調整する。応答時間の目標値、シェア、優先順位などの目標も達成する。 |
response-time-request-class fair-share-request-class context-request-class request-class-name |
省略可能 |
|
min-threads-constraint min-threads-constraint-name |
省略可能 |
以下の 2 つの要素から選択できる。
|
max-threads-constraint max-threads-constraint-name |
省略可能 |
以下の 2 つの要素から選択できる。
|
capacity capacity-name |
省略可能 |
以下の 2 つの要素から選択できる。
|
security
複合要素には、コネクタ コンテナに対してコンフィグレーション可能なデフォルトのセキュリティ情報が含まれます。詳細については、「リソース アダプタのセキュリティ ID のコンフィグレーション」を参照してください。
表 A-3 security の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
default-principal-name |
省略可能 |
リソース アダプタへの呼び出しに使用されるデフォルトのセキュア ID を指定する。 この値を指定しない場合、デフォルトは匿名 ID になる。その場合は、セキュリティ ID がないのと同じことになる。 この要素の下位要素については、「default-principal-name」を参照。 |
manage-as-principal-name |
省略可能 |
起動、停止、テスト、縮小、トランザクション管理などの、リソース アダプタのさまざまな管理タスクの実行に使用されるセキュア ID を指定する。 指定しない場合、デフォルトは この要素の下位要素については、「manage-as-principal-name」を参照。 |
run-as-principal-name |
省略可能 |
接続要求時にコネクタ コンテナからリソース アダプタ コードへのすべての呼び出しで使用されるセキュア ID を指定する (この要素は現在、発信機能にのみ適用される)。 指定しない場合、デフォルトは この要素の下位要素については、「run-as-principal-name」を参照。 |
run-work-as-principal-name |
省略可能 |
リソース アダプタによって開始されたすべての Work インスタンスの実行に使用されるセキュア ID を指定する。 指定しない場合、デフォルトは この要素の下位要素については、「run-work-as-principal-name」を参照。 |
default-principal-name
要素には以下の下位要素が含まれます。
manage-as-principal-name
要素には以下の下位要素が含まれます。
run-as-principal-name
要素には以下の下位要素が含まれます。
properties
要素は weblogic-connector
要素の下位要素であり、ra.xml
でリソース アダプタ Bean に対して指定されたプロパティのコンテナです。1 つまたは複数の property
要素を保持します。
properties
要素の内部に property
要素を次のように定義します。
表 A-8 properties の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
property |
必須 |
2 つの下位要素がある。
|
admin-objects
複合要素では、リソース アダプタのすべての管理オブジェクトを定義します。outbound-resource-adapter 複合要素と同様に、admin-objects
複合要素には、指定できる 3 つの階層的なプロパティ レベルがあります。
admin-objects
要素は weblogic-connector
要素の下位要素です。admin-objects
要素の内部に以下の要素を定義できます。
表 A-9 admin-objects の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
default-properties |
省略可能 |
リソース アダプタのすべての管理オブジェクトに適用されるデフォルト プロパティを (グローバル レベルで) 指定する。
|
admin-object-group |
1 つまたは複数 |
|
admin-object-group
要素は管理オブジェクト グループの定義に使用されます。グループ レベルでは、ra.xml
デプロイメント記述子で指定された特定の管理オブジェクト グループに属する、すべての管理オブジェクトに適用されるパラメータを指定します。グループで指定されたプロパティは、グローバル レベルで指定されたパラメータをオーバーライドします。
admin-object-interface
要素 (admin-object-group
要素の下位要素) は、各 admin-object-group
に必須のユニークな要素 (キー) として機能します。weblogic-ra.xml admin-object-interface
要素と ra.xml adminobject-interface
要素間には、1 対 1 の関係が必要です。
admin-object-group
要素は weblogic-connector
要素の下位要素です。admin-object-group
要素の内部に以下の要素を定義できます。
表 A-10 admin-object-group
要素 | 必須/省略可能 | 説明 |
---|---|---|
admin-object-interface |
必須 |
|
default-properties |
省略可能 |
この管理オブジェクト グループ内のすべての管理オブジェクトに適用される、すべてのデフォルト プロパティを指定する。
|
admin-object-instance |
1 つまたは複数 |
管理オブジェクト グループ内の 1 つまたは複数のオブジェクト インスタンス (リソース アダプタの管理オブジェクト インスタンスに相当する) を指定する。インスタンス レベルでプロパティを指定すると、グループ レベルやグローバル レベルで指定された同じプロパティをオーバーライドできる。下位要素については、「admin-object-instance」を参照。 |
admin-object-instance
の下に以下の下位要素を定義できます。
表 A-11 admin-object-instance の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
jndi-name / resource-link |
必須 |
管理オブジェクト インスタンスの参照名を定義する管理オブジェクト グループ。接続インスタンスの JNDI 名となる参照名またはリソース リンクを指定できる。 ( 注意 : これが機能するためには、enable-access-outside-app 要素を リソース アダプタを外部の他のアプリケーションから参照できるようにする必要がない場合は、 |
admin-object-properties |
省略可能 |
管理オブジェクト インスタンスに適用されるすべてのプロパティを定義する。
|
outbound-resource-adapter
要素は weblogic-connector
要素の下位要素です。outbound-resource-adapter
要素の内部に以下の要素を定義できます。
表 A-12 outbound-resource-adapter の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
default-connection-properties |
省略可能 |
この複合要素を使用して、プロパティをグローバル レベルで指定する。このレベルで、ユーザはリソース アダプタのすべての発信接続プールに適用されるパラメータを指定できる。 下位要素については、「default-connection-properties」を参照。 |
connection-definition-group |
1 つまたは複数 |
この要素を使用して、すべての接続定義グループを指定する。 グループで指定されたプロパティは、 下位要素については、「connection-definition-group」を参照。 |
default-connection-properties
要素は outbound-resource-adapter
要素の下位要素です。default-connection-properties
要素の内部に以下の要素を定義できます。
表 A-13 default-connection-properties の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
pool-params |
省略可能 |
この接続ファクトリの接続プール固有のパラメータを指定するための親要素となる。WebLogic Server はここでの指定を使用して、ManagedConnection のプールの動作を制御する。 この要素は省略可能。この要素またはこの要素の特定の項目を指定しない場合は、デフォルト値が割り当てられる。指定されているデフォルト値については、それぞれの要素の説明を参照。 下位要素については、「pool-params」を参照。 |
logging |
省略可能 |
リソース アダプタの 下位要素については、「logging」を参照。 |
transaction-support |
省略可能 |
特定の接続ファクトリのトランザクション サポートのレベルを指定する。 transaction-support の値は以下のいずれか。 NoTransaction LocalTransaction XATransaction 関連情報については、「接続管理」を参照してください。 |
authentication-mechanism |
省略可能 |
|
reauthentication-support |
省略可能 |
特定の接続ファクトリで、既存の |
properties |
省略可能 |
|
res-auth |
省略可能 |
コンテナ管理によるセキュリティまたはアプリケーション管理によるセキュリティのどちらを使用するかを指定する。この要素の値は |
pool-params
要素は default-connection-properties
要素の下位要素です。pool-params
要素の内部に以下の要素を定義できます。
表 A-14 pool-params の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
initial-capacity |
省略可能 |
ManagedConnection の初期数を指定する。WebLogic Server はデプロイメント中にこの数の接続を作成しようとする。 デフォルト値 : 1 |
max-capacity |
省略可能 |
WebLogic Server が許容する ManagedConnection の最大数を指定する。この制限を超えて ManagedConnection の割り当てを要求すると、呼び出し側に デフォルト値 : 10 |
capacity-increment |
省略可能 |
追加の ManagedConnection の最大数を指定する。WebLogic Server は、保持している接続プールのサイズを変更する際にこの数の接続を作成しようとする。 デフォルト値 : 1 |
shrinking-enabled |
省略可能 |
システム リソースを制御する手段として、未使用の ManagedConnection を破棄して接続プールから削除するかどうかを指定する。 デフォルト値 : true |
shrink-frequency-seconds |
省略可能 |
接続プール マネージャが未使用の ManagedConnection を破棄しようとする間隔 (秒単位) を指定する。 デフォルト値 : 900 秒 |
highest-num-waiters |
省略可能 |
接続プールの接続を予約するのを待ちながら、同時にブロックできるスレッドの最大数を指定する。 デフォルト値 : 0 |
highest-num-unavailable |
省略可能 |
接続の更新などの目的でアプリケーションから使用できなくなる、プール内の ManagedConnection の最大数を指定する。 バックエンド システムが使用できなくなった場合などに、接続プールの制御以外の要因で、指定値を超えることもある。 デフォルト値 : 0 |
connection-creation-retry- frequency-seconds |
省略可能 |
プールが接続を作成しようとする再試行の間隔。 デフォルト値 : 0 |
connection-reserve-timeout-seconds |
省略可能 |
プールの接続を予約する呼び出しがタイムアウトするまでの秒数を指定する。 デフォルト値 : -1 (リソースを予約する場合はブロックしない) |
test-frequency-seconds |
省略可能 |
プールの接続をテストする頻度。 デフォルト値 : 0 |
test-connections-on-create |
省略可能 |
新しく作成された接続のテストを有効にする。 デフォルト値 : false |
test-connections-on-release |
省略可能 |
解放されてプールに戻されるときの接続のテストを有効にする。 デフォルト値 : false |
test-connections-on-reserve |
省略可能 |
予約時の接続のテストを有効にする。 デフォルト値 : false |
profile-harvest-frequency-seconds |
省略可能 |
接続プールのプロファイルを収集する頻度を指定する。 |
ignore-in-use-connections-enabled |
省略可能 |
この要素を使用して、接続プールが停止されるときに、その時点で使用中の接続を無視するかどうかを指定する。 |
match-connections-supported |
省略可能 |
リソース アダプタが デフォルト値 : true |
logging
要素は default-connection-properties
要素の下位要素です。logging
要素の内部には以下の要素を定義できます。
表 A-15 logging の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
log-filename |
省略可能 |
ファイル名は絶対アドレスで指定する必要がある。 |
logging-enabled |
省略可能 |
デフォルト値 : false |
rotation-type |
省略可能 |
ファイルのローテーション タイプを設定する。 指定できる値は
デフォルト値 : |
number-of-files-limited |
省略可能 |
古いログ メッセージを保存するためにこのサーバ インスタンスが作成するファイルの数を制限するかどうかを指定する (rotation-type で
デフォルト値 : false |
file-count |
省略可能 |
サーバがログをローテーションする際に作成するログ ファイルの最大数。この数には、現在のメッセージを格納するためにサーバで使用されているファイルは含まれない ( デフォルト値 : 7 |
file-size-limit |
省略可能 |
サーバがログ メッセージを別のファイルに移動するきっかけとなるサイズ (rotation-type で デフォルト値 : 500 |
rotate-log-on-startup |
省略可能 |
起動サイクル中にサーバがログ ファイルをローテーションするかどうかを指定する。 デフォルト値 : true |
log-file-rotation-dir |
省略可能 |
ローテーションされたログ ファイルが格納されるディレクトリ パスを指定する。 |
rotation-time |
省略可能 |
ログ ファイルの時間ベースのローテーション シーケンスの開始時間。フォーマットは 指定した時間がすでに過ぎている場合、サーバは直ちにファイルのローテーションを開始する。 デフォルトでは、ローテーション サイクルは直ちに開始される。 |
file-time-span |
省略可能 |
古いログ メッセージが別のファイルに移される間隔 (単位は時間)。 デフォルト値 : 24 |
connection-definition-group
要素は接続定義グループを定義するのに使用します。connection-definition-group
要素を使用して、ra.xml
デプロイメント記述子で指定された特定の接続ファクトリに属する、すべての発信接続に適用されるパラメータを、グループ レベルで指定します。ra.xml
の接続ファクトリと weblogic-ra.xml
の接続定義グループの間には、1 対 1 の対応関係があります。グループで指定されたプロパティは、グローバル レベルで指定されたパラメータをオーバーライドします。
connection-factory-interface
要素 (connection-definition-group
要素の下位要素) は、各 connection-definition-group
に必須のユニークな要素 (キー) として機能します。weblogic-ra.xml connection-definition-interface
要素と ra.xml connectiondefinition-interface
要素間には、1 対 1 の関係がなければなりません。
connection-definition-group
要素は outbound-resource-adapter
要素の下位要素です。connection-definition-group
要素の内部に以下の要素を定義できます。
表 A-16 connection-definition-group の下位要素
要素 | 説明 |
---|---|
connection-factory-interface |
すべての接続定義グループにはキー (必須のユニークな要素) がある。このキーが
|
default-connection-properties |
この複合要素を使用して、発信接続のプロパティをグループ レベルで定義する。 |
connection-instance |
各接続定義グループの下に、接続インスタンスを指定できる。これは、リソース アダプタに対する個別の接続プールに相当する。このレベルでパラメータを指定すると、グループ レベルやグローバル レベルで指定された同じパラメータをオーバーライドできる。 この要素では、接続プールの説明を指定する (接続インスタンスは接続プールに相当する)。接続プールの説明に使用される。 「connection-instance」を参照。 |
connection-instance
の下に以下の下位要素を定義できます。
表 A-17 connection-instance の下位要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
description |
省略可能 |
接続インスタンスの説明を指定する。 |
jndi-name resource-link |
必須 |
接続インスタンスの参照名を定義する接続定義グループ。参照名は JNDI 名またはリソース リンク。 |
connection-properties |
省略可能 |
接続インスタンスに適用されるすべてのプロパティを定義する。
|