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

以下の節では、WebLogic ServerのJava EEクライアント・アプリケーションのデプロイメント記述子について説明します。

• クライアント・アプリケーションのデプロイメント記述子の要素の概要

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

• weblogic-appclient.xml記述子の要素

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

Java EEアプリケーションに関しては、サーバー側のモジュール(Webアプリケーション、EJB、およびコネクタ)にのみユーザーの関心がある場合があります。サーバー側モジュールの構成には、application.xmlデプロイメント記述子を使用します(『Oracle WebLogic Serverアプリケーションの開発』のエンタープライズ・アプリケーションのデプロイメント記述子の要素に関する項を参照してください)。

しかし、クライアント・モジュール(JARファイル)をEARファイルに含めることもできます。このJARファイルは、クライアント側でのみ使用するもので、このクライアント・モジュールの構成にはapplication-client.xmlデプロイメント記述子を使用します。この方法により、クライアント側とサーバー側、両方のモジュールのパッケージ化が可能になります。サーバーはサーバーが関係する部分(application.xmlファイルに基づく)だけを参照し、クライアントはクライアントが関係する部分(application-client.xmlファイルに基づく)だけを参照します。

クライアント側モジュールには、2つのデプロイメント記述子が必要です。1つはapplication-client.xmlというJava EEの標準デプロイメント記述子、もう1つはクライアント・アプリケーションのJARファイルから派生した名前を持つWebLogic固有の実行時デプロイメント記述子です。

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

application-client.xmlファイルは、Java EEクライアント・アプリケーションのデプロイメント記述子です。以下のDOCTYPE宣言を最初に指定する必要があります。

<!DOCTYPE application-client PUBLIC "-//Sun Microsystems, 
Inc.//DTD Java EE Application Client 1.2//EN" 
"http://java.sun.com/j2ee/dtds/application-client_1_2.dtd">

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

application-client

application-client要素は、アプリケーション・クライアントのデプロイメント記述子のルート要素です。アプリケーション・クライアントのデプロイメント記述子は、クライアント・アプリケーションで使用するEJBモジュールおよびその他のリソースを記述します。

表A-1は、application-client要素内で定義できる要素について説明します。

表A-1 application-client要素

要素	説明
<icon>	オプション。GUIツールでアプリケーションを表す小さい画像および大きい画像の場所。この要素は現在、WebLogic Serverでは使用されていません。
<display-name>	アプリケーションの表示名(GUIツールで表示することを想定した短い名前)。
<description>	オプション。クライアント・アプリケーションの説明。
<env-entry>	クライアント・アプリケーションの環境エントリの宣言が含まれます。 env-entry要素内で定義できる要素は、次のとおりです。 description: オプション。特定の環境エントリの説明が格納されます。 env-entry-name: クライアント・アプリケーションの環境エントリの名前が格納されます。 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-typeのコンストラクタで有効な文字列とする必要があります。
<ejb-ref>	クライアント・アプリケーションで参照されるEJBへの参照の宣言に使用されます。 ejb-ref要素内で定義できる要素は、次のとおりです。 description: オプション。参照されるEJBの説明を提供します。 ejb-ref-name: 参照されるEJBの名前が格納されます。通常、名前には、ejb/Depositのようにejb/という接頭辞が付きます。 ejb-ref-type: 参照されるEJBの予期されるタイプ(SessionまたはEntity)が格納されます。 home - 参照されるEJBのホーム・インタフェースの完全修飾名が格納されます。 remote - 参照されるEJBのリモート・インタフェースの完全修飾名が格納されます。 ejb-link: EJB参照がJava EEアプリケーション・パッケージのEnterprise JavaBeansにリンクされるように指定します。ejb-link要素の値は、同じJava EEアプリケーションにおけるEJBのejb-nameの名前と同じであることが必要です。
<resource-ref>	クライアント・アプリケーションの、外部リソースへの参照の宣言が格納されます。 resource-ref要素内で定義できる要素は、次のとおりです。 description: オプション。参照される外部リソースの説明が格納されます。 res-ref-name - リソース・ファクトリ参照名を指定します。リソース・ファクトリ参照名は、値にデータ・ソースのJNDI名が含まれるクライアント・アプリケーションの環境エントリの名前。 res-type - データ・ソースのタイプを指定します。このタイプは、データ・ソースによって実装されると予期されるJavaインタフェースまたはクラスによって指定されます。 res-auth: EJBコードによってプログラムでリソース・マネージャに対するサインオンを行うか、EJBのかわりにコンテナによってリソース・マネージャに対するサインオンを行うかを指定します。後者の場合、コンテナは、デプロイヤから提供される情報を使用します。res-auth要素には、ApplicationとContainerのいずれかを指定できます。

weblogic-appclient.xml記述子の要素

weblogic-appclient.xmlのデプロイメント記述子は、他のデプロイメント記述子とは異なり、クライアント・アプリケーションのJARファイル内には保存されませんが、クライアント・アプリケーションのJARファイルと同じディレクトリに保存する必要があります。

デプロイメント記述子のファイル名は、JARファイルの基本名に.runtime.xmlという拡張子を付けたものです。たとえば、クライアント・アプリケーションがc:\applications\ClientMain.jarというファイルにパッケージングされている場合、実行時デプロイメント記述子はc:\applications\ClientMain.runtime.xmlというファイルにあります。

application-client

application-client要素は、WebLogic固有のランタイム・クライアント・デプロイメント記述子のルート要素です。表A-2は、application-client要素内で定義できる要素について説明します。

表A-2 application-client要素

要素	説明
<env-entry>	デプロイメント記述子で宣言される環境エントリの値を指定します。 env-entry要素内で定義できる要素は、次のとおりです。 env-entry-name: アプリケーション・クライアントの環境エントリの名前。たとえば、<env-entry-name>EmployeeAppDB</env-entry-name>となります。 env-entry-value: アプリケーション・クライアントの環境エントリの値。値は、単独の文字列パラメータをとる、指定したタイプのコンストラクタで有効な文字列値とする必要があります。
<ejb-ref>	デプロイメント記述子内の宣言されたEJB参照のJNDI名を指定します。 ejb-ref要素内で定義できる要素は、次のとおりです。 ejb-ref-name: EJB参照の名前。EJB参照は、アプリケーション・クライアントの環境のエントリです。名前の前にejb/を付けてください。たとえば、<ejb-ref-name>ejb/Payroll</ejb-ref-name>となります。 jndi-name - EJBのJNDI名
<resource-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名
<resource-description>	サーバー・リソースのJNDI名をWebLogic ServerにおけるEJBリソース参照にマップします。 resource-description要素内で定義できる要素は、次のとおりです。 res-ref-name: リソース参照名を指定します。 jndi-name: リソースのJNDI名を指定します。
<resource-env-description>	ejb-jar.xmlデプロイメント記述子で宣言されたresource-env-refを、それが表しているサーバー・リソースのJNDI名にマップします。 resource-env-description要素内で定義できる要素は、次のとおりです。 res-env-ref-name: リソース環境参照名を指定します。 jndi-name: リソース環境参照のJNDI名を指定します。
<ejb-reference-description>	ejb-reference-description要素内で定義できる要素は、次のとおりです。 ejb-ref-name: Webアプリケーションで使用するEJB参照の名前を指定します。 jndi-name: 参照のJNDI名を指定します。
<service-reference-description>	ejb-reference-description要素内で定義できる要素は、次のとおりです。 service-ref-name wsdl-url call-property: call-property要素には次の下位要素があります。 name value port-info: port-info要素には次の下位要素があります。 port-name stub-property call-property