Utilizaţi descriptori de implementare Java EE pentru a defini referinţe de mediu

Această regulă semnalează elementele Context <Environment> găsite în fişierul META-INF/context.xml care trebuie să fie transformate în elemente <env-entry> în fişierul WEB-INF/web.xml.

Apache Tomcat permite elementelor Context <Environment> să fie definite în aceste locaţii:

Fişierul META-INF/context.xml
Fişierul de configuraţie XML al aplicaţiei din directorul Tomcat conf
Elementul <Host> din conf/server.xml

De vreme ce este posibil ca unealta de migrare să nu aibă acces la directorul de configurare Tomcat, aceasta semnalează Context <Environment> în fişierul META-INF/context.xml. Informaţiile Context <Environment> definite în alte locaţii pot fi copiate în fişierul META-INF/context.xml pentru a fi procesate de unealtă.

Dacă există un fişier WEB-INF/web.xml în proiectul web:

Elementele Context <Environment> vor fi semnalate în oricare dintre următoarele condiţii:

Intrarea nu are o intrare care să se potrivească în fişierul web.xml.
Intrarea are un alt tip decât intrarea care se potriveşte în fişierul web.xml.
Intrarea are o valoare diferită decât cea care se potriveşte în fişierul web.xml şi steguleţul de înlocuire setat la false.

În scanerul de sursă este disponibilă o corecţie rapidă pentru această regulă. Corecţia rapidă va adăuga un element <env-entry> în fişierul web.xml care reprezintă elementul Context <Environment> dacă acesta nu există deja în fişierul web.xml. Dacă intrarea există, aceasta va fi actualizată.

Dacă nu există fişierul WEB-INF/web.xml:

Toate elementele Context <Environment> vor fi semnalate.

Corecţia rapidă va crea un fişier WEB-INF/web.xml care include elementele corespunzătoare <env-entry> dacă proiectul web este la versiunea Java EE 5 sau una ulterioară. Corecţia rapidă va raporta o eroare dacă proiectul web este la versiunea J2EE 1.4 sau una anterioară.

De exemplu, luaţi în considerare un fişier META-INF/context.xml cu următorul conţinut:

cu următorul fişier web.xml în aplicaţie:

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

După ce este aplicată corecţia rapidă, fişierul web.xml va fi actualizat să conţină:

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