この付録では、WebLogic Server固有のデプロイメント記述子 weblogic-ra.xml
で定義できるWebLogic Server 12.1.3のデプロイメント記述子要素について説明します。
weblogic-ra.xml
のスキーマはhttp://xmlns.oracle.com/weblogic/weblogic-connector/1.5/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 |
省略可能 |
『JSR 322: Java EE Connector Architecture 1.6』で規定されているように、リソース・アダプタがアプリケーション(つまりEAR)の内部にパッケージ化されている場合、そのアプリケーション内のコンポーネントのみがリソース・アダプタにアクセスできます。この要素を使用すると、この機能をオーバーライドできます。 注意: この要素はスタンドアロンのリソース・アダプタには適用されません。 デフォルト値: 注意: falseに設定した場合、リソース・アダプタと同じアプリケーション内のクライアントのみが、リソース・アダプタにアクセスできます。 (このリリースでサポートされる)バージョン1.0リソース・アダプタでは、この要素のデフォルト値は |
enable-global-access-to-classes |
省略可能 |
デフォルト値は この値は通常、スタンドアロン・アダプタの場合
|
deploy-as-a-whole |
省略可能 |
デフォルト値: |
work-manager |
省略可能 |
この複合要素では、リソース・アダプタBeanで使用されるワーク・マネージャを作成するための、すべての構成可能な要素を指定します。 ワーク・マネージャは、デッドロックを回避し、同時実行性の制約を受けながら最適なスループットを実現するために、作業スレッドの数を動的に調整します。レスポンス時間の目標値、シェア、優先度などの目標も達成します。
|
connector-work-manager |
省略可能 |
この複合要素では、このアダプタ・モジュールそのもののコネクタ・ワーク・マネージャのすべての構成可能な要素を指定します。 この要素を使用する構成は、標準のワーク・マネージャではサポートされません。
|
security |
省略可能 |
この複合要素では、リソース・アダプタの処理に関するすべてのセキュリティ・パラメータを指定します。 コネクタ・コンテナが使用するセキュリティのデフォルトについては、「security」を参照してください。 |
properties |
省略可能 |
この複合要素は、
|
admin-objects |
省略可能 |
この複合要素では、リソース・アダプタのすべての管理オブジェクトを定義します。
|
outbound-resource-adapter |
省略可能 |
この複合要素では、リソース・アダプタのアウトバウンド・コンポーネントについて記述します。
|
work-manager
要素は、リソース・アダプタBeanで使用されるワーク・マネージャを作成するときに構成可能な、すべての要素の指定に使用する複合要素です。work-manager
要素はweblogic-javaee.xsd
スキーマからインポートされます。work-manager
要素の中に以下のサブ要素を構成できます。
表A-2 work-managerのサブ要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
name |
必須 |
ワーク・マネージャの名前を指定します。 『JSR 322: Java EE Connector Architecture 1.6』では、リソース・アダプタがアプリケーション・サーバーに作業スレッドを発行する方法が指定されています。この作業スレッドは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つの要素から選択できます。
|
connector-work-manager
要素は、リソース・アダプタ・モジュールに対するコネクタ・ワーク・マネージャのすべての構成可能な要素を指定するために使用される複合要素です。この要素を使用する構成は、標準のWebLogicワーク・マネージャではサポートされません。次のサブ要素をconnector-work-manager
要素で構成できます。
表A-3 connector-work-managerのサブ要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
max-concurrent-long-running-requests |
省略可能 |
リソース・アダプタ・インスタンスに対して、同時に長時間実行する 長時間実行する各 デフォルト値: 10 |
security
複合要素には、コネクタ・コンテナに対して構成可能なデフォルトのセキュリティ情報が含まれます。詳細は、「リソース・アダプタのセキュリティIDの構成」を参照してください。
表A-4 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」を参照してください。 |
security-work-context |
省略可能 |
この複合要素では、 『JSR 322: Java EE Connector Architecture 1.6』に記述されている、Workインスタンスの呼出し側のIDの確立に関連する2つの選択肢は次のとおりです。
要素 この要素のサブ要素については、「security-work-context」を参照してください。 |
default-principal-name
要素には以下のサブ要素が含まれます。
manage-as-principal-name
要素には以下のサブ要素が含まれます。
run-as-principal-name
要素には以下のサブ要素が含まれます。
run-work-as-principal-name
要素には以下のサブ要素が含まれます。
security-work-context
要素には以下のサブ要素が含まれます。
表A-9 security-work-contextのサブ要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
inbound-mapping-required |
省略可能 |
デフォルト値は
デフォルト値: |
caller-principal-default-mapped |
省略可能 |
EISユーザー名から、特定のWebLogicユーザー名またはWebLogicユーザー つまり、EISユーザーに対するWebLogicユーザー名が見つからない場合、このデフォルト・マッピングが使用されます。この要素のサブ要素については、「caller-principal-default-mapped」を参照してください。 |
caller-principal-mapping |
省略可能 |
EISユーザー名から、特定のWebLogicユーザー名またはWebLogicの この要素のサブ要素については、「caller-principal-mapping」を参照してください。 |
group-principal-default-mapped |
省略可能 |
EISグループ名から、特定のWebLogicグループ名へのデフォルト・マッピングを指定します。 つまり、EISグループに対するWebLogicグループ名が見つからない場合、このデフォルト・マッピングが使用されます。 |
group-principal-mapping |
省略可能 |
EISグループ名から、特定のWebLogicグループ名へのマッピングを指定します。ゼロまたはそれ以上の このマッピングのサブ要素については、「group-principal-mapping」を参照してください。 |
caller-principal-default-mapped
要素には以下のサブ要素が含まれます。
caller-principal-mapping
複合要素は、EISグループ名からWebLogicグループ名へのマッピングの指定に使用されます。次のサブ要素が含まれます。
properties
要素はweblogic-connector
要素のサブ要素であり、ra.xml
でリソース・アダプタBeanに対して指定されたプロパティのコンテナです。1つまたは複数のproperty
要素を保持します。
properties
要素の内部にproperty
要素を次のように定義します。
表A-13 propertiesのサブ要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
property |
必須 |
2つのサブ要素があります。
|
admin-objects
複合要素では、リソース・アダプタのすべての管理オブジェクトを定義します。outbound-resource-adapter複合要素と同様に、admin-objects
複合要素には、指定できる3つの階層的なプロパティ・レベルがあります。
admin-objects
要素はweblogic-connector
要素のサブ要素です。admin-objects
要素の内部に以下の要素を定義できます。
表A-14 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-15 admin-object-group
要素 | 必須/省略可能 | 説明 |
---|---|---|
admin-object-interface |
必須 |
|
admin-object-class |
1.6アダプタで必須 |
|
default-properties |
省略可能 |
この管理オブジェクト・グループ内のすべての管理オブジェクトに適用される、すべてのデフォルト・プロパティを指定します。
|
admin-object-instance |
1つまたは複数 |
管理オブジェクト・グループ内の1つまたは複数のオブジェクト・インスタンス(リソース・アダプタの管理オブジェクト・インスタンスに相当する)を指定します。インスタンス・レベルでプロパティを指定すると、グループ・レベルやグローバル・レベルで指定された同じプロパティをオーバーライドできます。サブ要素については、「admin-object-instance」を参照してください。 |
admin-object-instance
の下に以下のサブ要素を定義できます。
表A-16 admin-object-instanceのサブ要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
jndi-name |
必須 |
接続インスタンスの参照名を定義するJNDI名。 接続プールは、アプリケーション外部のクライアントが表示できるJNDIにバインドされます。 注意: enable-access-outside-app要素を |
properties |
省略可能 |
管理オブジェクト・インスタンスに適用されるすべてのプロパティを定義します。
|
outbound-resource-adapter
要素はweblogic-connector
要素のサブ要素です。outbound-resource-adapter
要素の内部に以下の要素を定義できます。
表A-17 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-18 default-connection-propertiesのサブ要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
pool-params |
省略可能 |
この接続ファクトリの接続プール固有のパラメータを指定するための親要素となります。WebLogic Serverはここでの指定を使用して、ManagedConnectionのプールの動作を制御します。 この要素は省略可能です。この要素またはこの要素の特定の項目を指定しない場合は、デフォルト値が割り当てられます。指定されているデフォルト値については、それぞれの要素の説明を参照してください。 サブ要素については、「pool-params」を参照してください。 |
logging |
省略可能 |
リソース・アダプタの サブ要素については、「logging」を参照してください。 |
transaction-support |
省略可能 |
特定の接続ファクトリのトランザクション・サポートのレベルを指定します。 transaction-supportの値は以下のいずれか。 NoTransaction LocalTransaction XATransaction 関連情報については、第6章「接続管理」を参照してください。 |
authentication-mechanism |
省略可能 |
|
reauthentication-support |
省略可能 |
特定の接続ファクトリで、既存の |
properties |
省略可能 |
|
res-auth |
省略可能 |
コンテナ管理によるセキュリティまたはアプリケーション管理によるセキュリティのどちらを使用するかを指定します。この要素の値は |
pool-params
要素はdefault-connection-properties
要素のサブ要素です。pool-params
要素の内部に以下の要素を定義できます。
表A-19 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-20 loggingのサブ要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
log-filename |
省略可能 |
ファイル名は絶対アドレスで指定する必要があります。 |
logging-enabled |
省略可能 |
デフォルト値: false |
rotation-type |
省略可能 |
ファイルのローテーション・タイプを設定します。 使用可能な値は、
デフォルト値: |
number-of-files-limited |
省略可能 |
古いログ・メッセージを保存するためにこのサーバー・インスタンスが作成するファイルの数を制限するかどうかを指定します。(
デフォルト値: 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-21 connection-definition-groupのサブ要素
要素 | 説明 |
---|---|
connection-factory-interface |
すべての接続定義グループにはキー(必須の一意の要素)があります。このキーは
|
default-connection-properties |
この複合要素を使用して、アウトバウンド接続のプロパティをグループ・レベルで定義します。 「default-connection-properties」を参照してください。 |
connection-instance |
各接続定義グループの下に、接続インスタンスを指定できます。これは、リソース・アダプタに対する個別の接続プールに相当します。このレベルでパラメータを指定すると、グループ・レベルやグローバル・レベルで指定された同じパラメータをオーバーライドできます。 この要素では、接続プールの説明を指定します。(接続インスタンスは接続プールに相当します。)接続プールの説明に使用されます。 「connection-instance」を参照してください。 |
connection-instance
の下に以下のサブ要素を定義できます。
表A-22 connection-instanceのサブ要素
要素 | 必須/省略可能 | 説明 |
---|---|---|
description |
省略可能 |
接続インスタンスの説明を指定します。 |
jndi-name |
必須 |
接続インスタンスの参照名を定義するJNDI名。 |
connection-properties |
省略可能 |
接続インスタンスに適用されるすべてのプロパティを定義します。
|