Usar os descritores de implementação Java EE para definir os parâmetros de contexto

Esta regra sinaliza os elementos Context <Parameter> localizados no arquivo META-INF/context.xml.

O Apache Tomcat permite que os elementos Context <Parameter> sejam definidos nesses 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

A ferramenta de migração migra apenas os elementos do parâmetro no arquivo META-INF/context.xml. As informações de parâmetro definidas nos outros locais podem ser copiadas para o arquivo META-INF/context.xml para que sejam processadas.

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

Os elementos Context <Parameter> serão sinalizados sob as condições a seguir:

• A entrada não tem uma 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 <context-param> no arquivo web.xml que representa o elemento Context <Parameter> 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 <Parameter> serão sinalizados.

A correção rápida criará um arquivo WEB-INF/web.xml que inclui os elementos <context-param> 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:

<Parameter description="Trigger because it does not exist" name="newEntry" override="false" value="abc123"/> <Parameter description="Trigger because of different value" name="parameter_1" override="false" value="new Value"/> <Parameter description="Will not trigger because of override set to true" name="parameter_2" override="true" value="123"/>

Com o arquivo web.xml a seguir no aplicativo:

<context-param> <description>Trigger because of different value</description> <param-name>parameter_1</param-name> <param-value>oldValue</param-value> </context-param> <context-param> <description>Will not trigger because of override set to true</description> <param-name>parameter_2</param-name> <param-value>123456789</param-value> </context-param>

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

<context-param> <description>Trigger because it does not exist</description> <param-name>newEntry</param-name> <param-value>abc123</param-value> </context-param> <context-param> <description>Trigger because of different value</description> <param-name>parameter_1</param-name> <param-value>new Value</param-value> </context-param> <context-param> <description>Will not trigger because of override set to true</description> <param-name>parameter_2</param-name> <param-value>123456789</param-value> </context-param>

Para obter informações adicionais sobre o parâmetro de contexto no Tomcat, consulte:

• Referência de configuração do Apache Tomcat - Parâmetros de contexto.