Red Hat Training

A Red Hat training course is available for Red Hat JBoss Enterprise Application Platform

Chapitre 20. Références de configuration

20.1. Référence de configuration jboss-web.xml

Introduction

Les descripteurs de déploiement jboss-web.xml et web.xml sont tous les deux mis dans le répertoire WEB-INF du déploiement. jboss-web.xml est un descripteur de déploiement d'une application web de JBoss EAP qui contient des options de configuration supplémentaires qui servent à des fonctionnalités supplémentaires de JBoss Web. Ce descripteur peut être utilisé pour remplacer les paramètres de configuration du descripteur web.xml et définir les paraméètres spécifiques àJBoss EAP.

Mappage des ressources globales aux prérequis WAR

La plupart des paramètres de configuration font correspondre les prérequis définis dans le fichier web.xml de l'application à des ressources locales. Pour plus d'explications sur les paramètres de configuration de web.xml consulter http://docs.oracle.com/cd/E13222_01/wls/docs81/webapp/web_xml.html.

Ainsi, si web.xml requiert jdbc/MyDataSource, alors jboss-web.xml fera sans doute correspondre la source de données globale java:/DefaultDS pour remplir ce besoin. Le WAR utilise la source de données globale pour faire correspondre jdbc/MyDataSource.

Tableau 20.1. Attributs de haut niveau communs de jboss-web.xml

Attribut Description
servlet
L'élément de servelt spécifie les liaisons spécifiques au servlet.
max-active-sessions
Indique le nombre maximum de sessions actives autorisées. Si le nombre de sessions gérées par le gestionnaire de sessions dépasse cette valeur et que la passivation est activée, l'excès sera passivé sur la base du passivation-min-idle-time configuré.
Si défini sur -1, cela signifie aucune limite.
replication-config
L'élément replication-config est utilisé pour la réplication de sessions configurées dans le fichier jboss-web.xml.
passivation-config
L'élément passivation-config est utilisé pour configurer la passivation de sessions dans le fichier jboss-web.xml.
distinct-name
L'élément distinct-name indique le nom précis EJB3 de l'application web.
data-source
Un mappage à data-source requis par web.xml.
context-root Le contexte root de l'application. La valeur par défaut est le nom du déploiement sans le suffixe .war.
virtual-host Le nom de l'hôte virtuel HTTP à partir duquel l'application accepte les requêtes. Se réfère au contenu de l'en-tête de l'Host HTTP.
annotation Décrit une annotation utilisée par l'application. Voir <annotation> pour plus d'information.
listener Décrit un listener utilisée par l'application. Voir <listener> pour plus d'information.
session-config Cet élément remplit la même fonction que l'élément <session-config> du fichier web.xml et est inclus dans un but de compatibilité seulement.
valve Décrit une valve utilisée par l'application. Voir <valve> pour plus d'information.
overlay Le nom d'une couche supplémentaire à ajouter à l'application.
security-domain Le nom du domaine de sécurité utilisé par l'application. Le domaine de sécurité lui-même est configuré à partir de la console de gestion basée web ou l'interface CLI.
security-role Cet élément remplit la même fonction que l'élément <session-role> du fichier web.xml et est inclus dans un but de compatibilité seulement.
jacc-star-role-allow
L'élément jacc-star-role-allow indique si l'agent générant les permissions jacc de la couche web a besoin de générer une permission WebResourcePermission pour qu'un fournisseur jacc puisse prendre la décision de passer outre l'autorisation ou non.
use-jboss-authorization Si cet élément est présent et contient la valeur non sensible à la casse "true", la pile d'autorisation web JBoss sera utilisée. S'il n'est pas présent ou contient une valeur non "true", alors seuls les mécanismes d'autorisation indiqués dans les spécifications Java Enterprise Edition seront utilisés. Cet élément est nouveau dans JBoss EAP 6.
disable-audit Définir cet élément de booléen à false pour activer et à true pour désactiver l'auditing web. L'auditing de sécurité web ne fait pas partie de la spécification Java EE. Cet élément est nouveau dans JBoss EAP 6.
disable-cross-context Si sur false, l'application sera en mesure d'appeler un autre contexte d'application. La valeur par défaut est true.
enable-websockets Définir cet élément à true dans jboss-web.xml pour spécifier si l'accès websocket doit être actif pour l'application web.
Les éléments suivants ont chacun des éléments enfants.
<annotation>
Décrit une annotation utilisée par l'application. Le tableau suivant liste les éléments enfants d'une <annotation>.

Tableau 20.2. Éléments de configuration d'une annotation

Attribut Description
class-name
Nom de la classe de l'annotation
servlet-security
L'élément, comme @ServletSecurity, qui représente la sécurité du servlet.
run-as
L'élément, comme @RunAs, qui représente l'information run-as
multipart-config
L'élément, comme @MultiPart, qui représente l'information multi-config.
<listener>
Décrit un listener. Le tableau suivant liste les éléments enfants d'un <listener>.

Tableau 20.3. Éléments de configuration d'un listener

Attribut Description
class-name
Nom de la classe du listener
listener-type
Liste les éléments de condition qui indiquent quelle sorte de listener ajouter au contexte de l'application. Les choix valides sont les suivants :
CONTAINER
Ajoute un ContainerListener au contexte.
LIFECYCLE
Ajoute un LifecycleListener au contexte.
SERVLET_INSTANCE
Ajoute un InstanceListener au contexte
SERVLET_CONTAINER
Ajoute un WrapperListener au contexte.
SERVLET_LIFECYCLE
Ajoute un WrapperLifecycle au contexte.
module
Le nom du module qui contient la classe du listener.
param
Un paramètre. Contient deux éléments enfants, <param-name> et <param-value>.
<valve>
Décrit une valve de l'application. Resssemble au <listener>, comprend des élément de param, nom de classe, et module.