スタンドアロン クライアント プログラマーズ ガイド
クライアント アプリケーションのデプロイメント記述子の要素
以下の節では、WebLogic Server の Java EE クライアント アプリケーションのデプロイメント記述子について説明します。
クライアント アプリケーションのデプロイメント記述子の要素の概要
Java EE アプリケーションの場合、ユーザの関心は通常サーバサイドのモジュール (Web アプリケーション、EJB、およびコネクタ) にあります。サーバサイドのモジュールのコンフィグレーションには、『WebLogic Server アプリケーションの開発』の「エンタープライズ アプリケーションのデプロイメント記述子の要素」に説明されている application.xml デプロイメント記述子を使用します。
しかし、クライアント モジュール (JAR ファイル) を EAR ファイルに含めることもできます。この JAR ファイルは、クライアントサイドでのみ使用するもので、このクライアント モジュールのコンフィグレーションには application-client.xml デプロイメント記述子を使用します。この方法により、クライアントサイドとサーバサイド、両方のモジュールのパッケージ化が可能になります。サーバはサーバが関係する部分 (application.xml ファイルによる) だけを参照し、クライアントはクライアントが関係する部分 (application-client.xml ファイルによる) だけを参照します。
クライアントサイド モジュールには、application-client.xml
という Java EE の標準デプロイメント記述子、およびクライアント アプリケーションの JAR ファイルから派生した名前を持つ WebLogic 固有の実行時デプロイメント記述子の 2 種類が必要です。
application-client.xml デプロイメント記述子の要素
application-client.xml
ファイルは、Java EE クライアント アプリケーションのデプロイメント記述子です。以下の DOCTYPE 宣言を最初に指定する必要があります。
以降の節では、ファイル内に表示される各要素について説明します。
application-client
application-client
は、アプリケーション クライアントのデプロイメント記述子のルート要素です。アプリケーション クライアントのデプロイメント記述子は、クライアント アプリケーションで使用する EJB モジュールおよびその他のリソースを記述します。
次の表では、application-client
要素内で定義できる要素について説明します。
表 A-1 application-client 要素
|
|
|
|
|
GUI ツールでアプリケーションを表す小さい画像または大きい画像の場所。この要素は現在、WebLogic Server では使用されていない。
|
|
|
アプリケーションの表示名 (GUI ツールで表示することを想定した短い名前)。
|
|
|
|
|
|
クライアント アプリケーションの環境エントリの宣言が含まれる。
env-entry 要素内で定義できる要素は、次のとおり。
description - 省略可。description 要素には、特定の環境エントリの説明が格納される。
env-entry-name - env-entry-name 要素には、クライアント アプリケーションの環境エントリの名前が格納される。
env-entry-type - env-entry-type 要素には、Java タイプの環境エントリの完全修飾名が格納される。指定できる値は、java.lang.Boolean 、java.lang.String 、java.lang.Integer 、java.lang.Double 、java.lang.Byte 、java.lang.Short 、java.lang.Long 、および java.lang.Float 。
env-entry-value - 省略可。env-entry-value 要素には、クライアント アプリケーションの環境エントリの値が格納される。値には、指定した env-entry-type のコンストラクタで有効な文字列値を指定する必要がある。
|
|
|
クライアント アプリケーションで参照される EJB への参照の宣言に使用される。
ejb-ref 要素内で定義できる要素は、次のとおり。
description - 省略可。description 要素は、参照される EJB の説明文を提供する。
ejb-ref-name - 参照される EJB の名前が格納される。通常、名前には、ejb/Deposit のように ejb/ というプレフィックスが付けられる。
ejb-ref-type - 参照される EJB で予期されるタイプ、Session または Entity が格納される。
home - 参照される EJB のホーム インタフェースの完全修飾名が格納される。
remote - 参照される EJB のリモート インタフェースの完全修飾名が格納される。
ejb-link - EJB 参照が Java EE アプリケーション パッケージのエンタープライズ JavaBean にリンクされるように指定する。ejb-link 要素の値は、同じ Java EE アプリケーションにおける EJB の ejb-name の名前と同じでなければならない。
|
|
|
クライアント アプリケーションの、外部リソースへの参照の宣言が格納される。
resource-ref 要素内で定義できる要素は、次のとおり。
description - 省略可。description 要素は、参照される外部リソースの説明文を格納する。
res-ref-name - リソース ファクトリ参照名を指定する。リソース ファクトリ参照名は、値にデータ ソースの JNDI 名が含まれるクライアント アプリケーションの環境エントリの名前。
res-type - データ ソースのタイプを指定する。このタイプは、データ ソースによって実装されると予期される Java インタフェースまたはクラスによって指定される。
res-auth - EJB コードによってプログラムでリソース マネージャに対するサインオンを行うか、または EJB の代わりにコンテナによってリソース マネージャに対するサインオンを行うかを指定する。後者の場合、コンテナは、デプロイヤから提供される情報を使用する。res-auth 要素には、Application または Container のうち 1 つまたは複数を指定できる。
|
weblogic-appclient.xml 記述子の要素
この XML 形式のデプロイメント記述子は、他のデプロイメント記述子とは異なり、クライアント アプリケーションの JAR ファイル内には保存されませんが、クライアント アプリケーションの JAR ファイルと同じディレクトリに保存する必要があります。
デプロイメント記述子のファイル名は、JAR ファイルの基本名に .runtime.xml
という拡張子が付けられます。たとえば、クライアント アプリケーションが c:\applications\ClientMain.jar
というファイルにパッケージングされている場合、実行時デプロイメント記述子は c:\applications\ClientMain.runtime.xml
というファイルにあります。
application-client
application-client
要素は、WebLogic 固有のクライアント実行時デプロイメント記述子のルート要素です。次の表では、application-client
要素内で定義できる要素について説明します。
表 A-2 application-client 要素
|
|
|
|
|
デプロイメント記述子で宣言される環境エントリの値を指定する。
env-entry 要素内で定義できる要素は、次のとおり。
|
|
|
デプロイメント記述子内の宣言された EJB 参照の JNDI 名を指定する。
ejb-ref 要素内で定義できる要素は、次のとおり。
|
|
|
アプリケーション クライアントの外部リソースへの参照を宣言する。要素には、リソース ファクトリの参照名が指定される。この参照名は、アプリケーション クライアントのコードで予期されているリソース ファクトリのタイプ、および認証のタイプ (Bean かコンテナか) を示す。
<resource-ref> <res-ref-name>EmployeeAppDB</res-ref-name> <jndi-name>enterprise/databases/HR1984</jndi-name> </resource-ref>
resource-ref 要素内で定義できる要素は、次のとおり。
res-ref-name - リソース ファクトリ参照名。リソース ファクトリ参照名は、値にデータ ソースの JNDI 名が含まれるアプリケーション クライアントの環境エントリの名前。
jndi-name - リソースの JNDI 名。
|