Usar descritores de implementação Java EE para definir as referências de ambiente

Esta regra sinaliza os elementos Context <Environment> localizados no arquivo META-INF/context.xml que devem ser transformados nos elementos <env-entry> no arquivo WEB-INF/web.xml.

O Apache Tomcat permite que os elementos Context <Environment> sejam definidos nestes locais:

O arquivo META-INF/context.xml
O arquivo de configuração XML do aplicativo no diretório conf do Tomcat
O elemento <Host> no conf/server.xml

Como a ferramenta de migração pode não ter acesso ao diretório de configuração do Tomcat, ela sinaliza somente o Context <Environment> no arquivo META-INF/context.xml. As informações Context <Environment> definidas nos outros locais podem ser copiadas para o arquivo META-INF/context.xml para que sejam processadas pela ferramenta.

Se existir um WEB-INF/web.xml no projeto da web:

Os elementos Context <Environment> serão sinalizados sob qualquer uma das condições a seguir:

A entrada não tem uma entrada correspondente no arquivo web.xml.
A entrada tem um tipo diferente da entrada correspondente no arquivo web.xml.
A entrada tem um valor diferente da entrada correspondente no web.xml e seu sinalizador de substituição configurado como false.

Há uma correção rápida para essa regra disponível no scanner de origem. A correção rápida incluirá um novo elemento <env-entry> no arquivo web.xml que representa o elemento Context <Environment> se ele ainda não existir no arquivo web.xml. Se a entrada existir, ela será atualizada.

Se WEB-INF/web.xml não existir:

Todos os elementos Context <Environment> será sinalizados.

A correção rápida criará um arquivo WEB-INF/web.xml que inclui os elementos <env-entry> apropriados, se o projeto da web estiver em Java EE 5 ou superior. A correção rápida relatará um erro se o projeto da web estiver em J2EE 1.4 ou inferior.

Por exemplo, considere um arquivo META-INF/context.xml com o conteúdo a seguir:

Com o arquivo web.xml a seguir no aplicativo:

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

Depois que a correção rápida for aplicada, o web.xml será atualizado para conter:

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