A.5. Referência da Configuração jboss-web.xml

Introdução

O jboss-web.xml é um arquivo com o seu diretório WEB-INF ou META-INF da implantação. Ele contém informação de configuração sobre os recursos que o contêiner do JBoss Web adiciona à especificação Servlet 3.0. As configurações específicas à especificação Servlet 3.0 são posicionadas no web.xml do mesmo diretório.

O elemento de nível superior no arquivo jboss-web.xml é o elemento <jboss-web>.
Requerimentos WAR dos Recursos Globais de Mapeamento

Muitos dos requerimentos de mapeamento da configuração disponíveis configurados no web.ml do aplicativo aos recursos locais. As explicações das configurações web.xml podem ser encontradas no http://docs.oracle.com/cd/E13222_01/wls/docs81/webapp/web_xml.html.

Por exemplo, caso o web.xml solicitar o jdbc/MyDataSource, o jboss-web.xml poderá mapear o java:/DefaultDS da fonte de dados global para preencher esta necessidade para o jdbc/MyDataSource.

Tabela A.42. Os atributos de Nível Superior Comuns

Função Descrição
env-entry
O mapeamento a um env-entry solicitado pelo web.xml.
ejb-ref
O mapeamento a um ejb-ref solicitado pelo web.xml.
ejb-local-ref
Um mapeamento a um ejb-local-ref solicitado pelo web.xml.
service-ref
O mapeamento a um service-ref solicitado pelo web.xml.
resource-ref
O mapeamento a um resource-ref solicitado pelo web.xml.
resource-env-ref
O mapeamento a um resource-env-ref solicitado pelo web.xml.
message-destination-ref
O mapeamento a um message-destination-ref solicitado pelo web.xml.
persistence-context-ref
O mapeamento a um persistence-context-ref solicitado pelo web.xml.
persistence-unit-ref
O mapeamento a um persistence-unit-ref solicitado pelo web.xml.
post-construct
O mapeamento a um post-context solicitado pelo web.xml.
pre-destroy
O mapeamento a um pre-destroy solicitado pelo web.xml.
data-source
O mapeamento a um data-source solicitado pelo web.xml.
context-root O contexto raiz do aplicativo. O valor default é o nome da implantação sem o sufixo .war.
virtual-host O nome do host virtual HTTP que o aplicativo aceita as solicitações. Isto refere-se aos conteúdos do cabeçalho HTTP Host.
anotação Descreve uma anotação usada pelo aplicativo. Refira-se ao <annotation> para maiores informações.
listener (ouvinte) Descreve um ouvinte usado pelo aplicativo. Refira-se ao <listener> para maiores informações.
session-config O elemento preenche a mesma função ao do elemento <session-config> do web.xml e é incluído apenas para compatibilidade.
valve Descreve a válvula usada pelo aplicativo. Refira-se ao <valve> para maiores informações.
overlay O nome da sobreposição para adição ao aplicativo.
security-domain O nome do security domain usado pelo aplicativo. O próprio security domain é configurado no console baseado na web ou no Management CLI.
security-role Este elemento preenche a mesma função como o elemento <security-role> do web.xml e é incluído apenas para a compatibilidade.
use-jboss-authorization Caso este elemento estiver presente e conter o valor de insensibilidade do caso como "verdadeiro", a pilha de autorização do JBoss web será usada. Caso ele não estiver presente ou conter qualquer valor que não é "verdadeiro", apenas os mecanismos da autorização especificados nas especificações do Java Enterprise Edition serão usados. Este elemento é novo para o JBoss Enterprise Application Plataform 6.
disable-audit Caso este elemento vazio estiver presente, a auditoria de segurança da web será desabilitada. Do contrário, isto será habilitado. A auditoria de segurança da web não faz parte da especificação do Java EE. Este elemento é novo no JBoss Enterprise Application Plataform 6.
disable-cross-context Caso false, o aplicativo está apto a chamar outro contexto de aplicativo. O default é true.
Os seguintes elementos de cada elemento filho.
<annotation>

Descreve uma anotação usada pelo aplicativo. A seguinte tabela lista os elementos filho de um <annotation>.

Tabela A.43. Elementos de Configuração da Anotação

Função Descrição
class-name
Nome da classe de anotação
servlet-security
O elemento, tal como @ServletSecurity, que representa a segurança servlet.
run-as
O elemento, tal como @RunAs, que representa a informação run-as.
multi-part
O elemento, tal como @MultiPart, que representa a informação múltipla em partes.
<listener>

Descreve um ouvinte. A seguinte tabela lista os elementos filhos de um <listener>.

Tabela A.44. Elementos de Configuração Ouvinte

Função Descrição
class-name
O nome da classe do ouvinte.
listener-type
Lista os elementos condition que indicam qual o tipo de ouvinte deve ser adicionado ao Contexto do aplicativo. As escolhas válidas são:
CONTAINER
Adiciona um ContainerListener ao Contexto.
LIFECYCLE
Adiciona um LifecycleListener ao Contexto.
SERVLET_INSTANCE
Adiciona um InstanceListener ao Contexto
SERVLET_CONTAINER
Adiciona um WrapperListener ao Contexto.
SERVLET_LIFECYCLE
Adiciona um WrapperLifeCycle ao Contexto.
module
O nome do módulo contendo a classe ouvinte.
param
O parâmetro. Isto contém dois elementos filhos, <param-name> e <param-value>.
<valve>

Descreve a válvula do aplicativo. Ele contém os mesmos elementos de configuração como o <listener>.