3.5.2 J2EEアプリケーション(EARファイル)のdeployment descriptor

J2EEアプリケーション(EARファイル)のdeployment descriptor(application.xml)は、J2EEアプリケーションの動作環境を設定します。
ここでは、application.xmlの記述方法について説明します。

application.xmlの記述形式

application.xmlは、J2EEアプリケーション(EARファイル)についてのdeployment descriptorです。
J2EEアプリケーションの構成物のパスや、セキュリティロールを記述します。パスは、EARファイルにパッケージングした時のモジュール内のパスを記述します。
deployment descriptorの記述形式はXML形式です。deployment descriptorの記述形式を以下に示します。

<?xml version="1.0" encoding="UTF-8"?>
<application xmlns="http://java.sun.com/xml/ns/j2ee"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
    http://java.sun.com/xml/ns/j2ee/application_1_4.xsd"
  version="1.4">
  <display-name>display_name</display-name>
  <module>
    <connector>uri</connector>
    <alt-dd>uri</alt-dd>
  </module>
  <module>
    <ejb>uri</ejb>
    <alt-dd>uri</alt-dd>
  </module>
  <module>
    <java>uri</java>
    <alt-dd>uri</alt-dd>
  </module>
  <module>
    <web>
      <web-uri>uri</web-uri>
      <context-root>context-root</context-root>
    </web>
    <alt-dd>uri</alt-dd>
  </module>
  <security-role>
    <role-name>role-name</role-name>
  </security-role>
</application>

注意

記述にあたっての注意事項

先頭の<?xml...>は、XML宣言を記述しているため、deployment descriptorファイルの先頭で必ず記述してください。
applicationタグ、およびapplicationタグの各属性は、J2EE名前空間のアプリケーションスキーマのバージョンを記述しているため、XML宣言の後に必ず記述してください。
<application>、</application>は、XMLファイルの開始と終了を示すルートタグです。必ず指定してください。
各タグの記載順序は、上記の記載順序に従ってください。
大文字・小文字は区別します。
J2EE1.2または1.3のdeployment descriptorの記述形式も使用できます。

application.xmlのタグ

J2EEアプリケーション(EARファイル)のdeployment descriptor(application.xml)には、以下のタグを指定できます。

タグ名	説明	タグの省略	複数の指定
application	J2EEアプリケーション(EARファイル)のdeployment descriptorの開始と終了を定義します。	×	×
display-name	J2EEアプリケーション(EARファイル)の名前を定義します。	○	×
module	一つのモジュールに関する定義を記述します。注) connector、ejb、java、webのいずれかを必ず定義する必要があります。	×	○
connector	connector(RARファイル)のパスを定義します。	×	×
ejb	EJBモジュール(ejb-jarファイル)のパスを定義します。	×	×
java	J2EEアプリケーションクライアント(client-jarファイル)のパスを定義します。	×	×
web	Webモジュールに関する定義を記述します。	×	×
web-uri	Webモジュール(WARファイル)のパスを定義します。	×	×
context-root	Webアプリケーション名を定義します。注) EARファイル内で一意な値でなければなりません	×	×
alt-dd	モジュールのdeployment descriptorのパスを定義します。省略した場合は、モジュールに含まれるdeployment descriptorが使用されます。	○	×
security-role	アクセス制限で使用するセキュリティロールを定義します。	○	○
role-name	セキュリティロール名を定義します。ロール名には、セキュリティ機能の運用設定(Interstage ディレクトリサービス)で定義したセキュリティロール名を指定してください。注) EARファイル内で一意な値でなければなりません	×	×

注意

省略が“×”であるタグは、省略すると配備できません。
複数の指定が“×”であるタグを重複して指定すると配備できません。

例

モジュール構成が、以下の場合のdeployment descriptorの例です。

EARファイルが以下を含む
- connector.rar
- ejb.jar
- client.jar
- web.war
- connector.xml
- ejb.xml
- client.xml
- web.xml

<?xml version="1.0" encoding="UTF-8"?>
<application xmlns="http://java.sun.com/xml/ns/j2ee"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
    http://java.sun.com/xml/ns/j2ee/application_1_4.xsd"
  version="1.4">
  <display-name>J2EEApplication</display-name>
  <module>
    <connector>connector.rar</connector>
    <alt-dd>connector.xml</alt-dd>
  </module>
  <module>
    <ejb>ejb.jar</ejb>
    <alt-dd>ejb.xml</alt-dd>
  </module>
  <module>
    <java>client.jar</java>
    <alt-dd>client.xml</alt-dd>
  </module>
  <module>
    <web>
      <web-uri>web.war</web-uri >
      <context-root>WebApplication</context-root>
    </web>
    <alt-dd>web.xml</alt-dd>
  </module>
  <security-role>
    <role-name>Administrator</role-name>
  </security-role>
  <security-role>
    <role-name>Operator</role-name>
  </security-role></application>