WebLogic J2EE コネクタアーキテクチャ

コンフィグレーション

以下の節では、WebLogic J2EE コネクタアーキテクチャ実装のコンフィグレーション要件について説明します。

リソースアダプタの開発者向けツール

BEA では、リソースアダプタの作成とコンフィグレーションを支援するツールを提供しています。この節では、これらのツールについて説明します。

スケルトンデプロイメント記述子を作成する ANT タスク

スケルトンデプロイメント記述子を作成するときに、WebLogic ANT ユーティリティを利用できます。Ant ユーティリティは WebLogic Server 配布キットと共に出荷されている Java クラスです。ANT タスクによって、リソースアダプタを含むディレクトリが調べられ、そのリソースアダプタで検出されたファイルを基にデプロイメント記述子が作成されます。ANT ユーティリティは、個別のリソースアダプタに必要なコンフィグレーションやマッピングに関する情報をすべて備えているわけではないので、ANT ユーティリティによって作成されるスケルトンデプロイメント記述子は不完全なものです。ANT ユーティリティがスケルトンデプロイメント記述子を作成した後で、テキストエディタ、XML エディタ、または Administration Console を使ってデプロイメント記述子を編集し、リソースアダプタのコンフィグレーションを完全なものにしてください。

ANT ユーティリティを使用してデプロイメント記述子を作成する方法の詳細については、『WebLogic Server アプリケーションの開発』の「WebLogic Server アプリケーションの作成」を参照してください。

WebLogic Builder

WebLogic Builder は、アプリケーションのデプロイメント記述子 XML ファイルを視覚的に編集するための環境を提供します。WebLogic Builder では記述子ファイルを表示して視覚的に編集できるため、テキストでこれらの XML ファイルを編集する必要がありません。詳細については、『WebLogic Builder オンラインヘルプ』を参照してください。

XML エディタ

dev2dev にある BEA XML エディタや XMLSpy などの DTD 検証機能付き XML エディタを使用できます (このバージョンの WebLogic Server には XMLSpy の評価版が付属しています)。BEA dev2dev Online (http://www.beasys.co.jp/dev2dev/index.html) を参照してください。

リソースアダプタのコンフィグレーション

この節では、WebLogic Server にデプロイするためのリソースアダプタをコンフィグレーションする方法について説明します。

リソースアダプタの概要

WebLogic J2EE コネクタアーキテクチャを使用すると、エンタープライズ情報システム (EIS) ベンダとサードパーティアプリケーション開発者は、Sun Microsystems の J2EE プラットフォーム仕様、バージョン 1.3 に準拠しているアプリケーションサーバにデプロイ可能なリソースアダプタを開発できます。

リソースアダプタは WebLogic J2EE コネクタアーキテクチャの中核をなすもので、クライアントコンポーネントと EIS との間の J2EE コネクタとして機能します。リソースアダプタを WebLogic Server 環境にデプロイすると、リモート EIS システムにアクセスする堅牢な J2EE プラットフォームアプリケーションを開発できるようになります。リソースアダプタには、Java コンポーネントに加えて、必要な場合には EIS との対話に必要なネイティブコンポーネントが入っています。

リソースアダプタの作成については、Sun Microsystems の J2EE コネクタアーキテクチャのページと「J2EE コネクタ仕様、バージョン 1.0、最終リリース」を参照してください。これらの参照先は Sun Microsystems の Web サイトで公開されており、それぞれの URL は以下のとおりです。

http://java.sun.com/j2ee/connector/

http://java.sun.com/j2ee/download.html#connectorspec

リソースアダプタの作成と変更 : 主な手順

リソースアダプタを作成するには、個々のリソースアダプタ用のクラス (ConnectionFactory や Connection など) とコネクタ固有のデプロイメント記述子を作成してから、それらを WebLogic Server にデプロイする jar ファイルにすべてパッケージ化する必要があります。

新規リソースアダプタアーカイブ (RAR) を作成する

リソースアダプタアーカイブ (RAR) を作成する主な手順を以下に説明します。

「J2EE コネクタ仕様、バージョン 1.0、最終リリース」(http://java.sun.com/j2ee/download.html#connectorspec) に準拠して、リソースアダプタ (ConnectionFactory など) に必要な各種クラスの Java コードを記述します。

リソースアダプタを実装するときは、以下のように ra.xml ファイルでクラスを指定しなければなりません。次に例を示します。

<managedconnectionfactory-class>com.sun.connector.blackbox.LocalTxManagedConnectionFactory</managedconnectionfactory-class>
<connectionfactory-interface>javax.sql.DataSource</connectionfactory-interface>
<connectionfactory-impl-class>com.sun.connector.blackbox.JdbcDataSource</connectionfactory-impl-class>
<connection-interface>java.sql.Connection</connection-interface>
<connection-impl-class>com.sun.connector.blackbox.JdbcConnection</connection-impl-class>

インタフェースと実装の Java コードを、標準コンパイラを使用してクラスファイルにコンパイルします。

コンパイルの手順については、『WebLogic Server アプリケーションの開発』の「Java コードのコンパイル」を参照してください。

リソースコネクタ固有のデプロイメント記述子を作成します。

ra.xml は、Sun Microsystems の標準 DTD を使用して、リソースアダプタ関連の属性タイプとそのデプロイメントプロパティを記述します。
weblogic-ra.xml ファイルは、WebLogic Server 固有のデプロイメント情報を追加します。

コネクタ固有のデプロイメント記述子の作成については、「weblogic-ra.xml デプロイメント記述子の要素」を参照してください。

Java クラスを Java アーカイブ (JAR) ファイルにパッケージ化します。

JAR ファイルの作成では、まず、ハードディスクの任意の場所にコネクタのステージングディレクトリを作成します。JAR ファイルをステージングディレクトリに置き、デプロイメント記述子を META-INF というサブディレクトリに置きます。
次に、ステージングディレクトリで次のように jar コマンドを実行して、リソースアダプタアーカイブを作成します。 jar cvf myRAR.rar *

テストを行うため、RAR リソースアダプタアーカイブファイルを WebLogic Server に自動デプロイします。

コンポーネントおよびアプリケーションの自動デプロイの詳細については、『WebLogic Server アプリケーションのデプロイメント』の「デプロイメントツールのリファレンス」を参照してください。
リソースアダプタのテストでは、リソースアダプタのデプロイメント記述子の編集が必要になる場合があります。その場合、手動で編集することも、WebLogic Builder を使用することもできます。
詳細については、『WebLogic Builder オンラインヘルプ』を参照してください。デプロイメント記述子の要素の詳細については、「weblogic-ra.xml デプロイメント記述子の要素」を参照してください。

RAR リソースアダプタファイルを WebLogic Server にデプロイするか、またはエンタープライズアプリケーションの一部としてデプロイするエンタープライズアーカイブ (EAR) ファイルに含めます。

コンポーネントおよびアプリケーションのデプロイメントの詳細については、『WebLogic Server アプリケーションのデプロイメント』を参照してください。

既存のリソースアダプタ (RAR) を変更する

以下に示すのは、既存のリソースアダプタ (RAR) を、WebLogic Server にデプロイするための変更方法の例です。この場合、デプロイメント記述子 weblogic-ra.xml を追加し、再パッケージ化する必要があります。

ハードディスクの任意の場所にリソースアダプタのステージング用の一時ディレクトリを作成します。

	mkdir c:/stagedir

一時ディレクトリにデプロイするリソースアダプタをコピーします。

	cp blackbox-notx.rar c:/stagedir

リソースアダプタアーカイブの中身を展開します。

	cd c:/stagedir

	jar xf blackbox-notx.rar

ステージングディレクトリには、以下のものが格納されます。

リソースアダプタを実装する Java クラスが入った jar ファイル
Manifest.mf および ra.xml ファイルが入った META-INF ディレクトリ

以下のコマンドを実行してこれらのファイルを確認します。

	c:/stagedir> ls

		blackbox-notx.rar

		META-INF

	c:/stagedir> ls META-INF

		Manifest.mf

		ra.xml

weblogic-ra.xml ファイルを作成します。このファイルは、リソースアダプタ用の WebLogic 固有のデプロイメント記述子です。このファイルには、接続ファクトリ、接続プール、およびセキュリティマッピングのパラメータを指定します。

weblogic-ra.xml DTD の詳細については、「weblogic-ra.xml デプロイメント記述子の要素」を参照してください。

weblogic-ra.xml ファイルを一時ディレクトリの META-INF サブディレクトリにコピーします。META-INF ディレクトリは、RAR ファイルを展開した一時ディレクトリ、またはリソースアダプタを展開ディレクトリ形式で格納しているディレクトリ内にあります。以下のコマンドを使用します。

	cp weblogic-ra.xml c:/stagedir/META-INF

	c:/stagedir> ls META-INF

		Manifest.mf

		ra.xml

		weblogic-ra.xml

リソースアダプタアーカイブを作成します。

	jar cvf blackbox-notx.rar -C c:/stagedir

WebLogic Server にリソースアダプタをデプロイします。コンポーネントおよびアプリケーションのデプロイの詳細については、『WebLogic Server アプリケーションのデプロイメント』の「デプロイメントツールのリファレンス」を参照してください。

ra.xml ファイルのコンフィグレーション

ra.xml ファイルがない場合は、手動で作成するか、または既存のファイルを編集して、リソースアダプタに必要なデプロイメントプロパティを設定します。プロパティの編集には、テキストエディタを使用します。ra.xml ファイルの作成の詳細については、「J2EE コネクタ仕様、バージョン 1.0、最終リリース」(http://java.sun.com/j2ee/download.html#connectorspec) を参照してください。

weblogic-ra.xml ファイルのコンフィグレーション

標準リソースアダプタコンフィグレーション ra.xml ファイルの機能サポートに加え、BEA WebLogic Server は追加デプロイメント記述子ファイルの weblogic-ra.xml ファイルを定義します。このファイルには、リソースアダプタを WebLogic Server でコンフィグレーションし、デプロイする作業に固有のパラメータが含まれます。このファイルは、WebLogic Server の EJB および Web アプリケーション用の拡張子 .xml のファイルと同じ機能を持つほか、WebLogic 固有のデプロイ記述子をデプロイ可能なアーカイブに追加するものです。基本の RAR またはデプロイメントディレクトリは、そのまま WebLogic Server にデプロイすることができません。最初に weblogic-ra.xml ファイルで、WebLogic Server 固有のデプロイメントプロパティを作成およびコンフィグレーションし、その XML ファイルをデプロイメントに追加する必要があります。

weblogic-ra.xml ファイルには以下の属性を指定します。

接続ファクトリの名前
接続ファクトリの説明用テキスト
接続ファクトリにバインドされる JNDI 名
現在のリソースアダプタと共有可能なリソースアダプタコンポーネントを含み、別にデプロイされた接続ファクトリへの参照
すべての共有ライブラリをコピーするディレクトリ
以下の動作を設定する接続プールパラメータ

WebLogic Server がデプロイ時に割り当てようとする管理対象接続の初期数
WebLogic Server が一度に割り当て可能な管理対象接続の最大数
WebLogic Server が新規接続のリクエストに応じるときに割り当てようとする管理対象接続の数
システムリソースを節約するために WebLogic Server が未使用の管理対象接続を再利用しようとするかどうか
未使用の管理対象接続の再利用を試みるまで WebLogic Server が待機する時間

J2EE リソースアダプタデプロイメント記述子 ra.xml の <config-entry> 要素で定義するコンフィグレーションプロパティの値
ManagedConnectionFactory または ManagedConnection に関するロギングが必要かどうかを示すフラグ
ManagedConnectionFactory または ManagedConnection に関するロギング情報を保存するファイル
接続がアイドル状態を保つことができる時間
各接続の割り当て先コールスタックの格納の有無

注意 : weblogic-ra.xml のパラメータの設定については、「weblogic-ra.xml デプロイメント記述子の要素」の weblogic-ra.xml DTD を参照してください。ダウンロード製品に付属する Simple Black Box リソースアダプタ例に含まれている weblogic-ra.xml ファイルを参照することもできます。

注意 : リソースアダプタの接続プロパティのコンフィグレーションの詳細については、「接続管理」を参照してください。

weblogic-ra.xml ファイルの自動生成

WebLogic Server では、リソースアダプタアーカイブ (RAR) に、J2EE コネクタ 1.0 仕様で指定された ra.xml デプロイメント記述子ファイルに加えて、weblogic-ra.xml デプロイメント記述子ファイルが必要です。ただし、リソースアダプタが weblogic-ra.xml ファイルを使用せずに WebLogic Server にデプロイされると、デフォルト要素値が含まれる weblogic-ra.xml テンプレートファイルが自動的にリソースアダプタに追加されます。この自動リソースファイル生成により、リソースアダプタを WebLogic Server にデプロイするために必要なパラメータを決定するプロセスが簡略化されます。

RAR に weblogic-ra.xml ファイルが含まれない場合、WebLogic Server はこのファイルを自動的に作成します。この機能により、大幅な変更を加えなくてもサードパーティ製リソースアダプタを WebLogic Server にデプロイすることができます。変更の必要があるのは、WebLogic Server が weblogic-ra.xml ファイルに生成する 2 つのデフォルト属性の値、<connection-factory-name> と <jndi-name> だけです。

WebLogic Server は、デフォルト値 __TMP_CFNAME_ の前に <connection-factory-name> を付加します。
デフォルト値 __TMP_JNDINAME_ の前には <jndi-name> が付加されます。

これらのデフォルト値の変更方法については、「weblogic-ra.xml デプロイメント記述子の要素」を参照してください。

生成された weblogic-ra.xml ファイルは、デフォルト値を変更する前には以下のようになります。

コードリスト 6-1 weblogic-ra.xml のデフォルト値

<weblogic-connection-factory-dd>

<connection-factory-name>__TMP_CFNAME_.\config\mydomain\applications\whitebox-notx.rar</connection-factory-name>

<jndi-name>__TMP_JNDINAME_.\config\mydomain\applications\whitebox-notx.rar</jndi-name>

	<pool-params>

		<initial-capacity>0</initial-capacity>

		<max-capacity>1</max-capacity>

		<capacity-increment>1</capacity-increment>

		<shrinking-enabled>false</shrinking-enabled>

	    <shrink-frequency-seconds>900</shrink-frequency-seconds>

	</pool-params>

	<security-principal-map>

	</security-principal-map>

</weblogic-connection-factory-dd>

ra-link-ref 要素のコンフィグレーション

オプションの <ra-link-ref> 要素を使用すると、デプロイ済みの複数のリソースアダプタを 1 つのデプロイ済みリソースアダプタに関連付けることができます。つまり、属性のサブセットを変更するだけで、基本リソースアダプタでコンフィグレーションされているリソースを別のリソースアダプタにリンク (再利用) できます。<ra-link-ref> 要素を使用すると、可能な場合、リソース (クラス、JAR、イメージファイルなど) の重複を防ぐことができます。デプロイ済みの基本リソースアダプタで定義されている値はすべて、<ra-link-ref> 要素でそれ以外の値が指定されていない限り、リンク先のリソースアダプタが継承します。

オプションの <ra-link-ref> 要素を使用する場合は、<pool-params> 要素のすべての値を指定するか、まったく指定しないかのどちらかです。<pool-params> 要素は、基本リソースアダプタからリンク先のリソースアダプタに部分的には継承されません。

以下のいずれかを実行します。

<max-capacity> 要素に 0 (ゼロ) を割り当てる。これにより、リンク先のリソースアダプタは基本リソースアダプタから <pool-params> 要素の値を継承できます。
<max-capacity> 要素に 0 (ゼロ) 以外の任意の値を割り当てる。リンク先リソースアダプタは、基本リソースアダプタから値を継承しなくなります。このオプションを選択する場合は、リンク先リソースアダプタの <pool-params> 要素のすべての値を指定する必要があります。

weblogic-ra.xml ファイルの編集の詳細については、「weblogic-ra.xml デプロイメント記述子の要素」を参照してください。

トランザクションレベルタイプのコンフィグレーション

リソースアダプタがサポートするトランザクションレベルタイプを ra.xml デプロイメント記述子ファイルに指定する必要があります。トランザクションのサポートレベルを指定するには次の手順に従います。

トランザクション非サポートの場合、次のエントリを ra.xml デプロイメント記述子ファイルに追加します。<transaction-support>NoTransaction</transaction-support>
XA トランザクションの場合、次のエントリを ra.xml デプロイメント記述子ファイルに追加します。<transaction-support>XATransaction</transaction-support>
ローカルトランザクションの場合、次のエントリを ra.xml デプロイメント記述子ファイルに追加します。<transaction-support>LocalTransaction</transaction-support>

.xml ファイルの編集手順については、「weblogic-ra.xml デプロイメント記述子の要素」を参照してください。

RAR コンフィグレーションでのトランザクションレベルの指定方法については、「J2EE コネクタ仕様、バージョン 1.0、最終リリース」(http://java.sun.com/j2ee/download.html#connectorspec) で「Packaging and Deployment」の章の「Resource Adapter XML DTD」を参照してください。

コンフィグレーション

リソース アダプタの開発者向けツール

スケルトン デプロイメント記述子を作成する ANT タスク