環境参照の定義に Java EE デプロイメント記述子を使用する

この規則により、META-INF/context.xml ファイルに見つかり、WEB-INF/web.xml ファイル内の <env-entry> エレメントに変換する必要がある Context <Environment> エレメントにフラグを立てます。

Apache Tomcat では、Context <Environment> エレメントを以下の場所で定義できます。

• META-INF/context.xml ファイル
• Tomcat の conf ディレクトリー内のアプリケーション XML 構成ファイル
• conf/server.xml 内の <Host> エレメント

マイグレーション・ツールは Tomcat 構成ディレクトリーにアクセスできない場合もあるため、マイグレーション・ツールが行うのは META-INF/context.xml ファイル内の Context <Environment> にフラグを立てることだけです。その他の場所で定義された Context <Environment> 情報は、このツールで処理できるように、META-INF/context.xml ファイルにコピーできます。

Web プロジェクトに WEB-INF/web.xml が存在するとします。

以下のいずれかの条件が該当すると、Context <Environment> エレメントにフラグが立てられます。

• エントリーに web.xml ファイル内の対応するエレメントがない。
• エントリーのタイプが web.xml ファイル内の対応するエレメントと異なっている。
• エントリーの値が web.xml ファイル内の対応するエレメントと異なっていて、そのオーバーライド・フラグが false に設定されている。

ソース・スキャナーで、この規則のクイック・フィックスが使用可能です。web.xml ファイル内に Context <Environment> エレメントを表す <env-entry> エレメントがまだ存在していなければ、クイック・フィックスがそのエレメントを新規に web.xml ファイルに追加します。 エントリーが存在する場合は、更新されます。

WEB-INF/web.xml が存在しない場合は、以下のようになります。

すべての Context <Environment> エレメントにフラグが立てられます。

Web プロジェクトが Java EE 5 以降である場合、クイック・フィックスは適切な <env-entry> エレメントを含む WEB-INF/web.xml ファイルを作成します。Web プロジェクトが J2EE 1.4 以下である場合、クイック・フィックスはエラーを報告します。

例えば、META-INF/context.xml ファイルに以下のようなコンテンツがあります。

<Environment description="Trigger because it does not exist" name="newEntry" override="false" type="java.lang.String" value="abc123"/> <Environment description="Trigger because of different value" name="contextEnvString_1" override="false" type="java.lang.String" value="new Value"/> <Environment description="Trigger because of different type" name="contextEnvString_2" override="false" type="java.lang.Integer" value="123"/> <Environment description="will not Trigger because of override set to true." name="contextEnvString_3" override="true" type="java.lang.Integer" value="123"/>

このファイルに関連して、アプリケーションには以下の web.xml ファイルがあります。

<env-entry> <description>Trigger because of different value</description> <env-entry-name>contextEnvString_1</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>oldValue</env-entry-value> </env-entry> <env-entry> <description>Trigger because of different type</description> <env-entry-name>contextEnvString_2</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>123</env-entry-value> </env-entry> <env-entry> <description>will not Trigger because of override set to true.</description> <env-entry-name>contextEnvString_3</env-entry-name> <env-entry-type>java.lang.Integer</env-entry-type> <env-entry-value>123456789</env-entry-value> </env-entry>

クイック・フィックスが適用されると、web.xml は、以下を含むように更新されます。

<env-entry> <description>Trigger because of different value</description> <env-entry-name>contextEnvString_1</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>new Value</env-entry-value> </env-entry> <env-entry> <description>Trigger because of different type</description> <env-entry-name>contextEnvString_2</env-entry-name> <env-entry-type>java.lang.Integer</env-entry-type> <env-entry-value>123</env-entry-value> </env-entry> <env-entry> <description>will not Trigger because of override set to true.</description> <env-entry-name>contextEnvString_3</env-entry-name> <env-entry-type>java.lang.Integer</env-entry-type> <env-entry-value>123456789</env-entry-value> </env-entry> <env-entry> <description>Trigger becasue it does not exist</description> <env-entry-name>newEntry</env-entry-name> <env-entry-type>java.lang.String</env-entry-type> <env-entry-value>abc123</env-entry-value> </env-entry>