使用 Java EE 部署描述子來定義環境參照

此規則會標示 Context <Environment> 元素，這些元素是在 META-INF/context.xml 檔中找到，並且必須在 WEB-INF/web.xml 檔中轉換成 <env-entry> 元素。

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-INF/web.xml 存在於 Web 專案中：

在下列任何情況下，將會標示 Context <Environment> 元素：

• 該項目在 web.xml 檔中沒有相符項。
• 該項目的類型與 web.xml 檔中的相符項不同。
• 該項目的值與 web.xml 檔中的相符項不同，且其置換旗標設為 false。

原始檔掃描器提供了此規則的快速修正程式。 如果 <env-entry> 元素不存在於 web.xml 檔中，快速修正程式會在 web.xml 檔中新增它，來代表 Context <Environment> 元素。如果該項目存在，就會更新它。

如果 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>