アプリケーション デプロイメント記述子の要素

以下の節では、WebLogic Server の J2EE アプリケーションのデプロイメント記述子について説明します。デプロイメント記述子は、application.xml という J2EE 標準デプロイメント記述子と、weblogic-application.xml という WebLogic 固有のアプリケーション デプロイメント記述子の 2 つが必要です。weblogic-application.xml ファイルは、WebLogic Server の拡張機能を使用していない場合は省略可能です。

• application.xml デプロイメント記述子の要素

• weblogic-application.xml デプロイメント記述子の要素

 

---

application.xml デプロイメント記述子の要素

以下の節では、application.xml ファイルについて説明します。

application.xml ファイルは、エンタープライズ アプリケーション アーカイブのデプロイメント記述子です。ファイルは、アプリケーション アーカイブの META-INF サブディレクトリにあります。以下の DOCTYPE 宣言を最初に指定しなければなりません。

<!DOCTYPE application PUBLIC "-//Sun Microsystems,
Inc.//DTD J2EE Application 1.3//EN"
"http://java.sun.com/dtd/application_1_3.dtd">

以下の図は、application.xml デプロイメント記述子の構造を示しています。

 

以降の節では、ファイル内に表示される各要素について説明します。

 

---

application

application は、アプリケーションのデプロイメント記述子のルート要素です。application 要素内の各要素については、以降の節で説明します。

icon

省略可能。icon 要素は、GUI ツールでアプリケーションを表す小さい画像または大きい画像の位置を指定します。この要素は現在、WebLogic Server では使用されていません。

small-icon

省略可能。GUI ツールでアプリケーションを表す小さい (16x16 ピクセル) .gif 画像または .jpg 画像です。この要素は現在、WebLogic Server では使用されていません。

large-icon

省略可能。GUI ツールでアプリケーションを表す大きい (32x32 ピクセル) .gif 画像または .jpg 画像です。この要素は現在、WebLogic Server では使用されていません。

display-name

省略可能。display-name 要素は、アプリケーションの表示名 (GUI ツールで表示することを想定した短い名前) を指定します。

description

省略可能。アプリケーションに関する説明文です。

module

application.xml デプロイメント記述子には、エンタープライズ アーカイブ ファイル内の各モジュールに対する module 要素があります。各 module 要素には、アプリケーション内のモジュールのタイプと場所を示す ejb 要素、java 要素、または web 要素を指定できます。省略可能な alt-dd 要素は、後でアセンブリするデプロイメント記述子へのオプション URI を指定します。

alt-dd

特定の J2EE モジュールに対して、後でアセンブリするデプロイメント記述子ファイルへのオプション URI を指定します。この URI は、アプリケーションのルート ディレクトリに対する、デプロイメント記述子ファイルの絶対パス名を指定します。alt-dd を指定しない場合、各コンポーネントの仕様に必須であるデフォルトの場所およびファイル名からデプロイメント記述子が読み込まれます。

connector

リソース アダプタ (コネクタ) アーカイブ ファイルの URI (アプリケーション パッケージの最上位に対する相対位置) を指定します。

ejb

アプリケーション ファイルの EJB モジュールを定義します。アプリケーションの EJB JAR ファイルへのパスも含まれます。

例 :

<ejb>petStore_EJB.jar</ejb>

java

アプリケーション ファイルのクライアント アプリケーション モジュールを定義します。

例 :

<java>client_app.jar</java>

web

application.xml ファイル内の Web アプリケーション モジュールを定義します。web 要素には、web-uri 要素、および context-root 要素があります。context-root の値を宣言しない場合、web-uri 要素のベース名が Web アプリケーションのコンテキスト パスとして使用されます (コンテキスト パスは、Web サーバ内でユニークな値にします。これは、複数の Web アプリケーションで同一の Web サーバを使用する場合があり、それらの複数アプリケーション間でコンテキスト パスが競合しないようにする必要があるからです)。

web-uri

application.xml ファイル内の Web モジュールの場所を定義します。これは WAR ファイルの名前になります。

context-root

Web アプリケーションのコンテキスト ルートです。

例 :

<web>
  <web-uri>petStore.war</web-uri>
  <context-root>estore</context-root>
</web>

security-role

security-role 要素には、アプリケーション共通のセキュリティ ロールが指定されます。各 security-role 要素には、description 要素 (省略可能) および role-name 要素があります。

description

省略可能。セキュリティ ロールの説明文です。

role-name

アプリケーション内の認可に使用するセキュリティ ロールまたはプリンシパルの名前を定義します。各ロールは、weblogic-application.xml デプロイメント記述子の WebLogic Server ユーザまたはグループにマップされます。

例 :

<security-role>
  <description>the gold customer role</description>
  <role-name>gold_customer</role-name>
</security-role>
<security-role>
  <description>the customer role</description>
  <role-name>customer</role-name>
</security-role>

 

---

weblogic-application.xml デプロイメント記述子の要素

以下の節では、weblogic-application.xml ファイルについて説明します。weblogic-application.xml ファイルは、Sun Microsystems から提供された application.xml デプロイメント記述子を拡張した BEA WebLogic Server 固有のデプロイメント記述子です。このファイルによって、アプリケーション スコープの JDBC プールや EJB キャッシュなどの機能のコンフィグレーションを行います。

ファイルは、アプリケーション アーカイブの META-INF サブディレクトリにあります。以下の DOCTYPE 宣言を最初に指定しなければなりません。

<!DOCTYPE weblogic-application PUBLIC "-//BEA Systems, Inc.//DTD WebLogic Application 7.0.0//EN"

"http://www.bea.com/servers/wls700/dtd/weblogic-application_1_0.dtd";>

 

以降の節では、ファイル内に表示される各要素について説明します。

 

---

weblogic-application

weblogic-application 要素は、アプリケーションのデプロイメント記述子のルート要素です。

ejb

省略可能。ejb 要素には、WebLogic アプリケーションの構成要素となる EJB モジュールに固有の情報が含まれます。現在、ejb 要素では、アプリケーションのエンティティ Bean によって使用される任意の数のアプリケーション レベル キャッシュを指定できます。

entity-cache

1 つまたは複数、指定します。entity-cache 要素は、実行時にエンティティ EJB インスタンスをキャッシュに入れるときに使用される名前付きアプリケーションレベル キャッシュの定義に使用されます。個々のエンティティ Bean は、使用するアプリケーションレベル キャッシュのキャッシュ名を参照します。個々のキャッシュを参照するエンティティ Bean の数に制限はありません。

アプリケーションレベル キャッシュは、エンティティ Bean が weblogic-ejb-jar.xml 記述子で独自のキャッシュを指定しない場合に、デフォルトとして使用されます。その場合、ExclusiveCache および MultiVersionCache という 2 つのデフォルト キャッシュが使用されます。アプリケーションの設定で、これらのデフォルト キャッシュを明示的に定義して、非デフォルト値を指定する場合もあります。キャッシング方式では、デフォルト キャッシュは変更できません。デフォルトで、キャッシュは最大サイズとして値 1000 を指定して max-beans-in-cache を使用します。

例 :

<entity-cache> 

	<entity-cache-name>ExclusiveCache</entity-cache-name> 

	<max-cache-size> 

		<megabytes>50</megabytes> 

	</max-cache-size> 

</entity-cache>

entity-cache-name

entity-cache-name 要素は、エンティティ Bean キャッシュにユニークな名前を指定します。この名前は、ear ファイル内でユニークなものとし、空の文字列は使用できません。

例 :

<entity-cache-name>ExclusiveCache</entity-cache-name>

max-beans-in-cache

省略可能。max-beans-in-cache 要素は、キャッシュに入れることができるエンティティ Bean の最大数を指定します。限度に達すると、Bean に対してパッシベーションが行われる場合があります。このメカニズムでは、個々のエンティティ Bean が必要とする実際のメモリ サイズは考慮されません。この要素は、1 以上の値に設定できます。

デフォルト値 : 1000

max-cache-size

max-cache-size 要素は、エンティティ キャッシュのメモリ サイズの限度をバイト単位または MB 単位で指定するときに使用されます。max-cache-size 要素を使用して最大サイズが指定されたキャッシュを Bean が使用する場合、Bean プロバイダで weblogic-ejb-jar.xml 記述子の Bean の平均サイズを見積もる必要があります。デフォルトでは、Bean の平均サイズは 100 バイトと想定されています。

• bytes | megabytes − バイト単位または MB 単位で示されるエンティティ キャッシュのメモリ サイズ。max-cache-size 要素で使用されます。

caching-strategy

省略可能。caching-strategy 要素は、EJB コンテナが特定のアプリケーション レベル キャッシュでエンティティ Bean インスタンスを管理するときに使用する一般的な方式を指定します。キャッシュによって、メモリ内のエンティティ Bean インスタンスがバッファに移され、対応する主キー値に関連付けられます。

caching-strategy 要素の値は、以下のいずれかに限られます。

• Exclusive − 各主キー値ごとにメモリ内の Bean インスタンスを 1 つキャッシュに入れます。この固有のインスタンスは、通常、使用時に EJB コンテナの排他的ロックを使用してロックされ、同時にそのインスタンスを使用するトランザクションは 1 つだけになります。

• MultiVersion − 各主キー値に対してメモリ内の複数の Bean インスタンスをキャッシュに入れます。各インスタンスを複数のトランザクションで同時に使用できます。

デフォルト値 : MultiVersion

例 :

<caching-strategy>Exclusive</caching-strategy>

start-mdbs-with-application

省略可能。アプリケーションを使用してメッセージ駆動型 Bean (MDBS) を起動できるように EJB コンテナをコンフィグレーションできます。true に設定されると、コンテナはアプリケーションの一部として MDBS を起動します。false に設定されると、コンテナは MDBS をキューに保持し、ポートでのリスンが開始されたときにサーバによって MDBS が起動されます。

xml

省略可能。xml 要素では、対象アプリケーションに固有な XML 処理のパーサおよびエンティティ マッピングに関する情報を指定します。

parser-factory

省略可能。parser-factory 要素には、saxparser-factory、document-builder-factory、および transformer-factory という 3 つの要素があります。

saxparser-factory

省略可能。saxparser-factory 要素では、対象アプリケーションだけで必要とされる XML 解析用の SAXParser ファクトリを設定できます。この要素によって、SAX スタイル解析に使用されるファクトリが指定されます。saxparser-factory 要素の設定をしないと、サーバ XML レジストリでコンフィグレーションされた SAXParser ファクトリ スタイルが使用されます。

デフォルト値 : サーバ XML レジストリの設定

document-builder-factory

省略可能。document-builder-factory 要素では、対象アプリケーションだけで必要とされる XML 解析用のドキュメント ビルダ ファクトリを設定できます。この要素によって、DOM スタイル解析に使用されるファクトリが決定されます。document-builder-factory 要素を設定しないと、サーバ XML レジストリでコンフィグレーションされた DOM スタイルが使用されます。

デフォルト値 : サーバ XML レジストリの設定

transformer-factory

省略可能。transformer-factory 要素では、対象アプリケーションだけで必要とされるスタイル シート処理用のトランスフォーマ エンジンを設定できます。この要素の値を指定しないと、サーバ XML レジストリでコンフィグレーションされた値が使用されます。

デフォルト値 : サーバ XML レジストリの設定

entity-mapping

ゼロまたは 1 つ以上、指定します。entity-mapping 要素はエンティティ マッピングの指定に使用されます。マッピングにより、特定のパブリック ID またはシステム ID の代替エンティティ URI が指定されます。このエンティティ URI を検索するデフォルトの場所は、lib/xml/registry ディレクトリです。

entity-mapping-name

entity-mapping-name 要素は、エンティティ マッピングの名前を指定します。

public-id

省略可能。public-id 要素は、マップされたエンティティのパブリック ID を指定します。

system-id

省略可能。system-id 要素は、マップされたエンティティのシステム ID を指定します。

entity-uri

省略可能。entity-uri 要素は、マップされたエンティティの EntityURI を指定します。

when-to-cache

省略可能。有効値は、次のとおりです。

• cache-on-reference

• cache-at-initialization

• cache-never

デフォルト値は cache-on-reference です。

cache-timeout-interval

省略可能。cache-timeout-interval 要素には、秒単位の整数値を指定できます。

jdbc-connection-pool

ゼロまたは 1 つ以上、指定します。jdbc-connection-pool 要素は、アプリケーション スコープの JDBC 接続プールを指定します。

data-source-name

data-source-name 要素は、アプリケーション固有の JNDI ツリーにある JNDI 名を指定します。

connection-factory

connection-factory 要素は、プールの初期化時に作成される物理的なデータベースの接続数を定義します。デフォルト値は 1 です。

factory-name

factory-name 要素は、config.xml ファイル内の JDBCDataSourceFactoryMBean の名前を指定します。

connection-properties

省略可能。connection-properties 要素は、デフォルトの接続ファクトリ設定のオーバーライドを定義する接続パラメータを指定します。

• user-name − 省略可能。user-name 要素は、JDBCDataSourceFactoryMBean の UserName のオーバーライドに使用されます。

• url − 省略可能。url 要素は、JDBCDataSourceFactoryMBean の URL のオーバーライドに使用されます。

• driver-class-name − 省略可能。driver-class-name 要素は、JDBCDataSourceFactoryMBean の DriverName のオーバーライドに使用されます。

• connection-params − ゼロまたは 1 つ以上。

  • parameter+ (param-value, param-name) − 1 つまたは複数。

pool-params

省略可能。pool-params 要素は、プール動作を変更するパラメータを定義します。

size-params

省略可能。size-params 要素は、プール内の接続数を変更するパラメータを定義します。

• initial-capacity − 省略可能。initial-capacity 要素は、プールの初期化時に作成される物理的なデータベース接続数を定義します。デフォルト値は 1 です。

• max-capacity − 省略可能。max-capacity 要素は、プールに含める物理的なデータベースの最大接続数を定義します。ただし、JDBC ドライバによってこの値がさらに制限されることがあります。デフォルト値は 1 です。

• capacity-increment − 省略可能。capacity-increment 要素は、プール容量を拡張するときの増分を定義します。サービス要求のために利用可能となる物理的な接続が他にないとき、プールは必要なデータベースの物理的な接続数を作成し、プールに追加します。プール内の接続数は、max-capacity で設定された物理的な最大接続数を超えないように保持されます。デフォルト値は 1 です。

• shrinking-enabled − 省略可能。shrinking-enabled 要素は、使用されていない接続が検出された場合に、プールの容量を initial-capacity に戻すかどうかを指定します。

• shrink-period-minutes − 省略可能。shrink-period-minutes 要素は、要求を満たすためにインクリメンタルに増やした接続プールを縮小するまで待機する時間 (分単位) を定義します。縮小を可能にするには、shrinking-enabled 要素を true に設定しておく必要があります。

xa-params

省略可能。xa-params 要素は、XA DataSource のパラメータを定義します。

• debug-level − 省略可能。整数。debug-level 要素は XA 処理のデバッグ レベルを定義します。デフォルト値は 0 です。

• keep-conn-until-tx-complete-enabled − 省略可能。ブール値。keep-conn-until-tx-complete-enabled 要素を true に設定すると、トランザクションが完了するまで、XA 接続プールによって同一の XA 接続が分散トランザクションに関連付けられます。

• end-only-once-enabled −省略可能。ブール値。end-only-once-enabled 要素を true に設定すると、保留中の各 XAResource.start() メソッドに対する XAResource.end() メソッドの呼び出しが 1 度に限られます。

• recover-only-once-enabled −省略可能。ブール値。recover-only-once-enabled 要素を true に設定すると、リソースに対する回復の呼び出しが 1 度に限られます。

• tx-context-on-close-needed − 省略可能。tx-context-on-close-needed 要素は、さまざまな JDBC オブジェクト (例 : 結果セット、ステートメント、接続など) を閉じるときに XA ドライバで分散トランザクション コンテキストが必要な場合、true に設定します。true に設定されると、JDBC オブジェクトを閉じるときに送出される SQL 例外のうち、トランザクション コンテキストでないものは無条件で受信されます。

• new-conn-for-commit-enabled −省略可能。ブール値。new-conn-for-commit-enabled 要素を true に設定すると、特定の分散トランザクションのコミットおよびロールバック処理に専用の XA 接続が使用されます。

• prepared-statement-cache-size − 省略可能。prepared-statement-cache-size 要素は、Prepared Statement のキャッシュ サイズの設定に使用します。このキャッシュ サイズは、特定の接続から作成される Prepared Statement の数を表し、後で使用できるようにキャッシュに格納されます。Prepared Statement キャッシュ サイズを 0 に設定すると、キャッシュがオフになります。

• keep-logical-conn-open-on-release − 省略可能。ブール値。keep-logical-conn-open-on-release 要素を true に設定すると、XA の物理的な接続が XA 接続プールに返されても JDBC の論理的な接続はオープンしたまま保持されます。デフォルト値は false です。

• local-transaction-supported − 省略可能。ブール値。XA ドライバがグローバル トランザクションを使用しない SQL をサポートする場合には local-transaction-supported を true に設定します。そうでない場合は、false に設定してください。デフォルト値は false です。

• resource-health-monitoring-enabled − 省略可能。resource-health-monitoring-enabled 要素は、対象接続プールに対して JTA リソース状態モニタ機能を有効にする場合には true に設定します。

login-delay-seconds

省略可能。整数値。login-delay-seconds 要素は、各データベースの物理的な接続を作成するまで待機する遅延時間を秒単位で設定します。データベース サーバによっては、複数の接続リクエストが短い間隔で繰り返されると処理できないものもあります。このプロパティを使用すると、データベース サーバの処理が追いつくように、少しの間隔をあけることができます。この遅延は、データベースの物理的な接続が確立すると、プールの初期作成時とプールの有効期間中の両方で必ず行われます。

leak-profiling-enabled

省略可能。leak-profiling-enabled 要素は、JDBC 接続リーク プロファイルを有効にします。接続リークは、プールからの接続が close() メソッドの呼び出しで明示的にクローズされていない場合に発生します。接続リーク プロファイルがアクティブの場合、プールは接続オブジェクトがプールから割り当てられ、クライアントに与えられたときにスタック トレースを格納します。接続リークが検出されたとき (接続オブジェクトのガベージ コレクションが行われたとき) に、このスタック トレースが報告されます。

この要素はリソースを余計に使用し、接続プール処理を遅くする可能性があるので、プロダクション環境での使用はお勧めできません。

connection-check-params

省略可能。connection-check-params 要素は、プール内の接続がまだ有効であることを確認するチェックを行うかどうか指定し、行う場合の時機と方法を定義します。

• table-name − 省略可能。table-name 要素は、スキーマ内でクエリできるテーブルを定義します。

• check-on-reserve-enabled − 省略可能。check-on-reserve-enabled 要素が true に設定されると、ユーザに接続が渡される前に毎回接続がテストされます。

• check-on-release-enabled − 省略可能。check-on-release-enabled 要素が true に設定されると、ユーザが接続をプールに返すときに毎回接続がテストされます。

• refresh-minutes − 省略可能。refresh-minutes 要素が定義されると、定期的 (指定された分単位の時間) にトリガされます。トリガによって、プール内の各接続がまだ有効であることを確認するチェックが行われます。

driver-params

省略可能。driver-params 要素は、WebLogic Server ドライバ上の動作を設定します。

statement

省略可能。

• profiling-enabled −省略可能。ブール値。profiling-enabled 要素は、JDBC SQL の応答プロファイルの実行を有効にします。有効化されると、後で分析するため SQL 文のテキスト、実行時間、その他のメトリックが外部的に格納されます。この機能では多くのリソースを使用するため、プロダクション環境のサーバではオフにすることをお勧めします。デフォルト値は false です。

prepared-statement

省略可能。profiling-enabled はブール値。prepared-statement 要素は、JDBC Prepared Statement のキャッシュ プロファイルの実行を有効にします。有効化されると、Prepared Statement のキャッシュ プロファイルが後で分析できるように外部ストレージに格納されます。この機能では多くのリソースを使用するため、プロダクション環境のサーバではオフにすることをお勧めします。デフォルト値は false です。

• profiling-enabled − 省略可能。

• cache-profiling-threshold − 省略可能。cache-profiling-threshold 要素は、Prepared Statement キャッシュの状態がログに記録されるステートメント要求の数を定義します。この要素は出力量を最小にします。この機能では多くのリソースを使用するため、プロダクション環境のサーバではオフにすることをお勧めします。

• cache-size − 省略可能。cache-size 要素は、Prepared Statement キャッシュのサイズを返します。このキャッシュ サイズは、特定の接続から作成される Prepared Statement の数を表し、後で使用できるようにキャッシュに格納されます。

• parameter-logging-enabled − 省略可能。SQL 応答プロファイリング時、Prepared Statement パラメータの値を格納できます。parameter-logging-enabled 要素を使用すると、ステートメント パラメータを格納できるようになります。この機能では多くのリソースを使用するため、プロダクション環境のサーバではオフにすることをお勧めします。

• max-parameter-length − 省略可能。SQL 応答プロファイリング時、Prepared Statement パラメータの値を格納できます。max-parameter-length 要素は、JDBC SQL 応答プロファイリングのパラメータとして渡される文字列の最大の長さを定義します。この機能は多くのリソースを使用するため、パラメータのデータ長を制限して、出力量を減らすようにしてください。

row-prefetch-enabled

省略可能。

row-prefetch-size

省略可能。

stream-chunk-size

省略可能。

acl-name

省略可能。

application-param

ゼロまたは 1 つ以上、指定します。application-param 要素は、コンテナ動作に関係するさまざまなパラメータを定義します。定義可能なパラメータは以下のとおりです。

• webapp.encoding.usevmdefault

• webapp.encoding.default

• webapp.getrealpath.accept_context_path