web-app_2_3.dtd: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES

web-app_2_3.dtd

This product or document is protected by copyright and distributed under licenses restricting its use, copying, distribution, and decompilation. No part of this product or documentation may be reproduced in any form by any means without prior written authorization of Sun and its licensors, if any.

Third party software, including font technology, is copyrighted and licensed from Sun suppliers.

Sun, Sun Microsystems, the Sun Logo, Solaris, Java, JavaServer Pages, Java Naming and Directory Interface, JDBC, JDK, JavaMail and Enterprise JavaBeans, are trademarks or registered trademarks of Sun Microsystems, Inc in the U.S. and other countries.

All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc.

PostScript is a registered trademark of Adobe Systems, Inc.

Federal Acquisitions: Commercial Software - Government Users Subject to Standard License Terms and Conditions.

DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

_________________________________________________________________________

Ce produit ou document est prote'ge' par un copyright et distribue' avec des licences qui en restreignent l'utilisation, la copie, la distribution, et la de'compilation. Aucune partie de ce produit ou de sa documentation associe'e ne peut e^tre reproduite sous aucune forme, par quelque moyen que ce soit, sans l'autorisation pre'alable et e'crite de Sun et de ses bailleurs de licence, s'il y en a.

Le logiciel de'tenu par des tiers, et qui comprend la technologie relative aux polices de caracte`res, est prote'ge' par un copyright et licencie' par des fournisseurs de Sun.

Sun, Sun Microsystems, le logo Sun, Solaris, Java, JavaServer Pages, Java Naming and Directory Interface, JDBC, JDK, JavaMail, et Enterprise JavaBeans, sont des marques de fabrique ou des marques de'pose'es de Sun Microsystems, Inc. aux Etats-Unis et dans d'autres pays.

Toutes les marques SPARC sont utilise'es sous licence et sont des marques de fabrique ou des marques de'pose'es de SPARC International, Inc. aux Etats-Unis et dans d'autres pays. Les produits portant les marques SPARC sont base's sur une architecture de'veloppe'e par Sun Microsystems, Inc.

Postcript est une marque enregistre'e d'Adobe Systems Inc.

LA DOCUMENTATION EST FOURNIE "EN L'ETAT" ET TOUTES AUTRES CONDITIONS, DECLARATIONS ET GARANTIES EXPRESSES OU TACITES SONT FORMELLEMENT EXCLUES, DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS NOTAMMENT TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE, A L'APTITUDE A UNE UTILISATION PARTICULIERE OU A L'ABSENCE DE CONTREFACON.

<web-app>

Root element

The web-app element is the root of the deployment descriptor for a web application.

<web-app>'s children

Name Cardinality

context-param Any number

description One or none

display-name One or none

distributable One or none

ejb-local-ref Any number

ejb-ref Any number

env-entry Any number

error-page Any number

filter Any number

filter-mapping Any number

icon One or none

listener Any number

login-config One or none

mime-mapping Any number

resource-env-ref Any number

resource-ref Any number

security-constraint Any number

security-role Any number

servlet Any number

servlet-mapping Any number

session-config One or none

taglib Any number

welcome-file-list One or none

<web-app>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(icon?, display-name?, description?, distributable?, context-param*, filter*, filter-mapping*, listener*, servlet*, servlet-mapping*, session-config?, mime-mapping*, welcome-file-list?, error-page*, taglib*, resource-env-ref*, resource-ref*, security-constraint*, login-config?, security-role*, env-entry*, ejb-ref*, ejb-local-ref*)

<auth-constraint>

Child of security-constraint

The auth-constraint element indicates the user roles that should be permitted access to this resource collection. The role-name used here must either correspond to the role-name of one of the security-role elements defined for this web application, or be the specially reserved role-name "*" that is a compact syntax for indicating all roles in the web application. If both "*" and rolenames appear, the container interprets this as all roles. If no roles are defined, no user is allowed access to the portion of the web application described by the containing security-constraint. The container matches role names case sensitively when determining access.

Used in: security-constraint

<auth-constraint>'s children

Name Cardinality

description One or none

role-name Any number

<auth-constraint>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, role-name*)

<auth-method>

Child of login-config

The auth-method element is used to configure the authentication mechanism for the web application. As a prerequisite to gaining access to any web resources which are protected by an authorization constraint, a user must have authenticated using the configured mechanism. Legal values for this element are "BASIC", "DIGEST", "FORM", or "CLIENT-CERT".

Used in: login-config

<auth-method>'s attributes

Name Values Default

id Match the ID rules.

<context-param>

Child of web-app

The context-param element contains the declaration of a web application's servlet context initialization parameters.

Used in: web-app

<context-param>'s children

Name Cardinality

description One or none

param-name Only one

param-value Only one

<context-param>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(param-name, param-value, description?)

Child of security-role, init-param, resource-ref, resource-env-ref, web-resource-collection, env-entry, security-role-ref, run-as, auth-constraint, context-param, web-app, user-data-constraint, ejb-local-ref, filter, ejb-ref, servlet

The description element is used to provide text describing the parent element. The description element should include any information that the web application war file producer wants to provide to the consumer of the web application war file (i.e., to the Deployer). Typically, the tools used by the web application war file consumer will display the description when processing the parent element that contains the description.

Used in: auth-constraint, context-param, ejb-local-ref, ejb-ref, env-entry, filter, init-param, resource-env-ref, resource-ref, run-as, security-role, security-role-ref, servlet, user-data-constraint, web-app, web-resource-collection

<description>'s attributes

Name Values Default

id Match the ID rules.

<display-name>

Child of web-app, filter, security-constraint, servlet

The display-name element contains a short name that is intended to be displayed by tools. The display name need not be unique.

Used in: filter, security-constraint, servlet, web-app

Example:

<display-name>Employee Self Service</display-name>

<display-name>'s attributes

Name Values Default

id Match the ID rules.

Child of web-app

The distributable element, by its presence in a web application deployment descriptor, indicates that this web application is programmed appropriately to be deployed into a distributed servlet container

Used in: web-app

<distributable>'s attributes

Name Values Default

id Match the ID rules.

<distributable>'s attributes

Name	Values	Default

id	Match the ID rules.

This element is always empty.

<ejb-link>

Child of ejb-local-ref, ejb-ref

The ejb-link element is used in the ejb-ref or ejb-local-ref elements to specify that an EJB reference is linked to an enterprise bean.

The name in the ejb-link element is composed of a path name specifying the ejb-jar containing the referenced enterprise bean with the ejb-name of the target bean appended and separated from the path name by "#". The path name is relative to the war file containing the web application that is referencing the enterprise bean. This allows multiple enterprise beans with the same ejb-name to be uniquely identified.

Used in: ejb-local-ref, ejb-ref

Examples:

<ejb-link>EmployeeRecord</ejb-link>

<ejb-link>../products/product.jar#ProductEJB</ejb-link>

<ejb-link>'s attributes

Name Values Default

id Match the ID rules.

<ejb-local-ref>

Child of web-app

The ejb-local-ref element is used for the declaration of a reference to an enterprise bean's local home. The declaration consists of:

- an optional description - the EJB reference name used in the code of the web application that's referencing the enterprise bean - the expected type of the referenced enterprise bean - the expected local home and local interfaces of the referenced enterprise bean - optional ejb-link information, used to specify the referenced enterprise bean

Used in: web-app

<ejb-local-ref>'s children

Name Cardinality

description One or none

ejb-link One or none

ejb-ref-name Only one

ejb-ref-type Only one

local Only one

local-home Only one

<ejb-local-ref>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, ejb-ref-name, ejb-ref-type, local-home, local, ejb-link?)

<ejb-ref>

Child of web-app

The ejb-ref element is used for the declaration of a reference to an enterprise bean's home. The declaration consists of:

- an optional description - the EJB reference name used in the code of the web application that's referencing the enterprise bean - the expected type of the referenced enterprise bean - the expected home and remote interfaces of the referenced enterprise bean - optional ejb-link information, used to specify the referenced enterprise bean

Used in: web-app

<ejb-ref>'s children

Name Cardinality

description One or none

ejb-link One or none

ejb-ref-name Only one

ejb-ref-type Only one

home Only one

remote Only one

<ejb-ref>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, ejb-ref-name, ejb-ref-type, home, remote, ejb-link?)

<ejb-ref-name>

Child of ejb-local-ref, ejb-ref

The ejb-ref-name element contains the name of an EJB reference. The EJB reference is an entry in the web application's environment and is relative to the java:comp/env context. The name must be unique within the web application.

It is recommended that name is prefixed with "ejb/".

Used in: ejb-local-ref, ejb-ref

Example:

<ejb-ref-name>ejb/Payroll</ejb-ref-name>

<ejb-ref-name>'s attributes

Name Values Default

id Match the ID rules.

<ejb-ref-type>

Child of ejb-local-ref, ejb-ref

The ejb-ref-type element contains the expected type of the referenced enterprise bean.

The ejb-ref-type element must be one of the following:

<ejb-ref-type>Entity</ejb-ref-type> <ejb-ref-type>Session</ejb-ref-type>

Used in: ejb-local-ref, ejb-ref

<ejb-ref-type>'s attributes

Name Values Default

id Match the ID rules.

<env-entry>

Child of web-app

The env-entry element contains the declaration of a web application's environment entry. The declaration consists of an optional description, the name of the environment entry, and an optional value. If a value is not specified, one must be supplied during deployment.

<env-entry>'s children

Name Cardinality

description One or none

env-entry-name Only one

env-entry-type Only one

env-entry-value One or none

<env-entry>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, env-entry-name, env-entry-value?, env-entry-type)

<env-entry-name>

Child of env-entry

The env-entry-name element contains the name of a web applications's environment entry. The name is a JNDI name relative to the java:comp/env context. The name must be unique within a web application.

Example:

<env-entry-name>minAmount</env-entry-name>

Used in: env-entry

<env-entry-name>'s attributes

Name Values Default

id Match the ID rules.

<env-entry-type>

Child of env-entry

The env-entry-type element contains the fully-qualified Java type of the environment entry value that is expected by the web application's code.

The following are the legal values of env-entry-type:

java.lang.Boolean java.lang.Byte java.lang.Character java.lang.String java.lang.Short java.lang.Integer java.lang.Long java.lang.Float java.lang.Double

Used in: env-entry

<env-entry-type>'s attributes

Name Values Default

id Match the ID rules.

<env-entry-value>

Child of env-entry

The env-entry-value element contains the value of a web application's environment entry. The value must be a String that is valid for the constructor of the specified type that takes a single String parameter, or for java.lang.Character, a single character.

Example:

<env-entry-value>100.00</env-entry-value>

Used in: env-entry

<env-entry-value>'s attributes

Name Values Default

id Match the ID rules.

<error-code>

Child of error-page

The error-code contains an HTTP error code, ex: 404

Used in: error-page

<error-code>'s attributes

Name Values Default

id Match the ID rules.

<error-page>

Child of web-app

The error-page element contains a mapping between an error code or exception type to the path of a resource in the web application

Used in: web-app

<error-page>'s children

Name Cardinality

error-code One or none

exception-type One or none

location Only one

<error-page>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

((error-code | exception-type), location)

<exception-type>

Child of error-page

The exception type contains a fully qualified class name of a Java exception type.

Used in: error-page

<exception-type>'s attributes

Name Values Default

id Match the ID rules.

Child of mime-mapping

The extension element contains a string describing an extension. example: "txt"

Used in: mime-mapping

<extension>'s attributes

Name Values Default

id Match the ID rules.

Child of web-app

Declares a filter in the web application. The filter is mapped to either a servlet or a URL pattern in the filter-mapping element, using the filter-name value to reference. Filters can access the initialization parameters declared in the deployment descriptor at runtime via the FilterConfig interface.

Used in: web-app

<filter>'s children

Name Cardinality

description One or none

display-name One or none

filter-class Only one

filter-name Only one

icon One or none

init-param Any number

<filter>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(icon?, filter-name, display-name?, description?, filter-class, init-param*)

<filter-class>

Child of filter

The fully qualified classname of the filter.

Used in: filter

<filter-class>'s attributes

Name Values Default

id Match the ID rules.

<filter-mapping>

Child of web-app

Declaration of the filter mappings in this web application. The container uses the filter-mapping declarations to decide which filters to apply to a request, and in what order. The container matches the request URI to a Servlet in the normal way. To determine which filters to apply it matches filter-mapping declarations either on servlet-name, or on url-pattern for each filter-mapping element, depending on which style is used. The order in which filters are invoked is the order in which filter-mapping declarations that match a request URI for a servlet appear in the list of filter-mapping elements.The filter-name value must be the value of the <filter-name> sub-elements of one of the <filter> declarations in the deployment descriptor.

Used in: web-app

<filter-mapping>'s children

Name Cardinality

filter-name Only one

servlet-name One or none

url-pattern One or none

<filter-mapping>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(filter-name, (url-pattern | servlet-name))

<filter-name>

Child of filter, filter-mapping

The logical name of the filter. This name is used to map the filter. Each filter name is unique within the web application.

Used in: filter, filter-mapping

<filter-name>'s attributes

Name Values Default

id Match the ID rules.

<form-error-page>

Child of form-login-config

The form-error-page element defines the location in the web app where the error page that is displayed when login is not successful can be found. The path begins with a leading / and is interpreted relative to the root of the WAR.

Used in: form-login-config

<form-error-page>'s attributes

Name Values Default

id Match the ID rules.

<form-login-config>

Child of login-config

The form-login-config element specifies the login and error pages that should be used in form based login. If form based authentication is not used, these elements are ignored.

Used in: login-config

<form-login-config>'s children

Name Cardinality

form-error-page Only one

form-login-page Only one

<form-login-config>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(form-login-page, form-error-page)

<form-login-page>

Child of form-login-config

The form-login-page element defines the location in the web app where the page that can be used for login can be found. The path begins with a leading / and is interpreted relative to the root of the WAR.

Used in: form-login-config

<form-login-page>'s attributes

Name Values Default

id Match the ID rules.

<home>

Child of ejb-ref

The home element contains the fully-qualified name of the enterprise bean's home interface.

Used in: ejb-ref

Example:

<home>com.aardvark.payroll.PayrollHome</home>

<home>'s attributes

Name Values Default

id Match the ID rules.

<http-method>

Child of web-resource-collection

The http-method contains an HTTP method (GET | POST |...).

Used in: web-resource-collection

<http-method>'s attributes

Name Values Default

id Match the ID rules.

<icon>

Child of web-app, filter, servlet

The icon element contains small-icon and large-icon elements that specify the file names for small and a large GIF or JPEG icon images used to represent the parent element in a GUI tool.

Used in: filter, servlet, web-app

<icon>'s children

Name Cardinality

large-icon One or none

small-icon One or none

<icon>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(small-icon?, large-icon?)

<init-param>

Child of filter, servlet

The init-param element contains a name/value pair as an initialization param of the servlet

Used in: filter, servlet

<init-param>'s children

Name Cardinality

description One or none

param-name Only one

param-value Only one

<init-param>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(param-name, param-value, description?)

<jsp-file>

Child of servlet

The jsp-file element contains the full path to a JSP file within the web application beginning with a `/'.

Used in: servlet

<jsp-file>'s attributes

Name Values Default

id Match the ID rules.

<large-icon>

Child of icon

The large-icon element contains the name of a file containing a large (32 x 32) icon image. The file name is a relative path within the web application's war file.

The image may be either in the JPEG or GIF format. The icon can be used by tools.

Used in: icon

Example:

<large-icon>employee-service-icon32x32.jpg</large-icon>

<large-icon>'s attributes

Name Values Default

id Match the ID rules.

Child of web-app

The listener element indicates the deployment properties for a web application listener bean.

Used in: web-app

<listener>'s children

Name Cardinality

listener-class Only one

<listener>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(listener-class)

<listener-class>

Child of listener

The listener-class element declares a class in the application must be registered as a web application listener bean. The value is the fully qualified classname of the listener class.

Used in: listener

<listener-class>'s attributes

Name Values Default

id Match the ID rules.

<load-on-startup>

Child of servlet

The load-on-startup element indicates that this servlet should be loaded (instantiated and have its init() called) on the startup of the web application. The optional contents of these element must be an integer indicating the order in which the servlet should be loaded. If the value is a negative integer, or the element is not present, the container is free to load the servlet whenever it chooses. If the value is a positive integer or 0, the container must load and initialize the servlet as the application is deployed. The container must guarantee that servlets marked with lower integers are loaded before servlets marked with higher integers. The container may choose the order of loading of servlets with the same load-on-start-up value.

Used in: servlet

<load-on-startup>'s attributes

Name Values Default

id Match the ID rules.

<local>

Child of ejb-local-ref

The local element contains the fully-qualified name of the enterprise bean's local interface.

Used in: ejb-local-ref

<local>'s attributes

Name Values Default

id Match the ID rules.

<local-home>

Child of ejb-local-ref

The local-home element contains the fully-qualified name of the enterprise bean's local home interface.

Used in: ejb-local-ref

<local-home>'s attributes

Name Values Default

id Match the ID rules.

Child of error-page

The location element contains the location of the resource in the web application relative to the root of the web application. The value of the location must have a leading `/'.

Used in: error-page

<location>'s attributes

Name Values Default

id Match the ID rules.

<login-config>

Child of web-app

The login-config element is used to configure the authentication method that should be used, the realm name that should be used for this application, and the attributes that are needed by the form login mechanism.

Used in: web-app

<login-config>'s children

Name Cardinality

auth-method One or none

form-login-config One or none

realm-name One or none

<login-config>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(auth-method?, realm-name?, form-login-config?)

<mime-mapping>

Child of web-app

The mime-mapping element defines a mapping between an extension and a mime type.

Used in: web-app

<mime-mapping>'s children

Name Cardinality

extension Only one

mime-type Only one

<mime-mapping>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(extension, mime-type)

<mime-type>

Child of mime-mapping

The mime-type element contains a defined mime type. example: "text/plain"

Used in: mime-mapping

<mime-type>'s attributes

Name Values Default

id Match the ID rules.

<param-name>

Child of context-param, init-param

The param-name element contains the name of a parameter. Each parameter name must be unique in the web application.

Used in: context-param, init-param

<param-name>'s attributes

Name Values Default

id Match the ID rules.

<param-value>

Child of context-param, init-param

The param-value element contains the value of a parameter.

Used in: context-param, init-param

<param-value>'s attributes

Name Values Default

id Match the ID rules.

<realm-name>

Child of login-config

The realm name element specifies the realm name to use in HTTP Basic authorization.

Used in: login-config

<realm-name>'s attributes

Name Values Default

id Match the ID rules.

Child of ejb-ref

The remote element contains the fully-qualified name of the enterprise bean's remote interface.

Used in: ejb-ref

Example:

<remote>com.wombat.empl.EmployeeService</remote>

<remote>'s attributes

Name Values Default

id Match the ID rules.

<res-auth>

Child of resource-ref

The res-auth element specifies whether the web application code signs on programmatically to the resource manager, or whether the Container will sign on to the resource manager on behalf of the web application. In the latter case, the Container uses information that is supplied by the Deployer.

The value of this element must be one of the two following:

<res-auth>Application</res-auth> <res-auth>Container</res-auth>

Used in: resource-ref

<res-auth>'s attributes

Name Values Default

id Match the ID rules.

<res-ref-name>

Child of resource-ref

The res-ref-name element specifies the name of a resource manager connection factory reference. The name is a JNDI name relative to the java:comp/env context. The name must be unique within a web application.

Used in: resource-ref

<res-ref-name>'s attributes

Name Values Default

id Match the ID rules.

<res-sharing-scope>

Child of resource-ref

The res-sharing-scope element specifies whether connections obtained through the given resource manager connection factory reference can be shared. The value of this element, if specified, must be one of the two following:

<res-sharing-scope>Shareable</res-sharing-scope> <res-sharing-scope>Unshareable</res-sharing-scope>

The default value is Shareable.

Used in: resource-ref

<res-sharing-scope>'s attributes

Name Values Default

id Match the ID rules.

<res-type>

Child of resource-ref

The res-type element specifies the type of the data source. The type is specified by the fully qualified Java language class or interface expected to be implemented by the data source.

Used in: resource-ref

<res-type>'s attributes

Name Values Default

id Match the ID rules.

<resource-env-ref>

Child of web-app

The resource-env-ref element contains a declaration of a web application's reference to an administered object associated with a resource in the web application's environment. It consists of an optional description, the resource environment reference name, and an indication of the resource environment reference type expected by the web application code.

Used in: web-app

Example:

<resource-env-ref> <resource-env-ref-name>jms/StockQueue</resource-env-ref-name> <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type> </resource-env-ref>

<resource-env-ref>'s children

Name Cardinality

description One or none

resource-env-ref-name Only one

resource-env-ref-type Only one

<resource-env-ref>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, resource-env-ref-name, resource-env-ref-type)

<resource-env-ref-name>

Child of resource-env-ref

The resource-env-ref-name element specifies the name of a resource environment reference; its value is the environment entry name used in the web application code. The name is a JNDI name relative to the java:comp/env context and must be unique within a web application.

Used in: resource-env-ref

<resource-env-ref-name>'s attributes

Name Values Default

id Match the ID rules.

<resource-env-ref-type>

Child of resource-env-ref

The resource-env-ref-type element specifies the type of a resource environment reference. It is the fully qualified name of a Java language class or interface.

Used in: resource-env-ref

<resource-env-ref-type>'s attributes

Name Values Default

id Match the ID rules.

<resource-ref>

Child of web-app

The resource-ref element contains a declaration of a web application's reference to an external resource. It consists of an optional description, the resource manager connection factory reference name, the indication of the resource manager connection factory type expected by the web application code, the type of authentication (Application or Container), and an optional specification of the shareability of connections obtained from the resource (Shareable or Unshareable).

Used in: web-app

Example:

<resource-ref> <res-ref-name>jdbc/EmployeeAppDB</res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> <res-sharing-scope>Shareable</res-sharing-scope> </resource-ref>

<resource-ref>'s children

Name Cardinality

description One or none

res-auth Only one

res-ref-name Only one

res-sharing-scope One or none

res-type Only one

<resource-ref>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, res-ref-name, res-type, res-auth, res-sharing-scope?)

<role-link>

Child of security-role-ref

The role-link element is a reference to a defined security role. The role-link element must contain the name of one of the security roles defined in the security-role elements.

Used in: security-role-ref

<role-link>'s attributes

Name Values Default

id Match the ID rules.

<role-name>

Child of security-role, security-role-ref, run-as, auth-constraint

The role-name element contains the name of a security role.

The name must conform to the lexical rules for an NMTOKEN.

Used in: auth-constraint, run-as, security-role, security-role-ref

<role-name>'s attributes

Name Values Default

id Match the ID rules.

<run-as>

Child of servlet

The run-as element specifies the run-as identity to be used for the execution of the web application. It contains an optional description, and the name of a security role.

Used in: servlet

<run-as>'s children

Name Cardinality

description One or none

role-name Only one

<run-as>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, role-name)

<security-constraint>

Child of web-app

The security-constraint element is used to associate security constraints with one or more web resource collections

Used in: web-app

<security-constraint>'s children

Name Cardinality

auth-constraint One or none

display-name One or none

user-data-constraint One or none

web-resource-collection At least one

<security-constraint>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(display-name?, web-resource-collection+, auth-constraint?, user-data-constraint?)

<security-role>

Child of web-app

The security-role element contains the definition of a security role. The definition consists of an optional description of the security role, and the security role name.

Used in: web-app

Example:

<security-role> <description> This role includes all employees who are authorized to access the employee service application. </description> <role-name>employee</role-name> </security-role>

<security-role>'s children

Name Cardinality

description One or none

role-name Only one

<security-role>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, role-name)

<security-role-ref>

Child of servlet

The security-role-ref element contains the declaration of a security role reference in the web application's code. The declaration consists of an optional description, the security role name used in the code, and an optional link to a security role. If the security role is not specified, the Deployer must choose an appropriate security role.

The value of the role-name element must be the String used as the parameter to the EJBContext.isCallerInRole(String roleName) method or the HttpServletRequest.isUserInRole(String role) method.

Used in: servlet

<security-role-ref>'s children

Name Cardinality

description One or none

role-link One or none

role-name Only one

<security-role-ref>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, role-name, role-link?)

Child of web-app

The servlet element contains the declarative data of a servlet. If a jsp-file is specified and the load-on-startup element is present, then the JSP should be precompiled and loaded.

Used in: web-app

<servlet>'s children

Name Cardinality

description One or none

display-name One or none

icon One or none

init-param Any number

jsp-file One or none

load-on-startup One or none

run-as One or none

security-role-ref Any number

servlet-class One or none

servlet-name Only one

<servlet>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(icon?, servlet-name, display-name?, description?, (servlet-class | jsp-file), init-param*, load-on-startup?, run-as?, security-role-ref*)

<servlet-class>

Child of servlet

The servlet-class element contains the fully qualified class name of the servlet.

Used in: servlet

<servlet-class>'s attributes

Name Values Default

id Match the ID rules.

<servlet-mapping>

Child of web-app

The servlet-mapping element defines a mapping between a servlet and a url pattern

Used in: web-app

<servlet-mapping>'s children

Name Cardinality

servlet-name Only one

url-pattern Only one

<servlet-mapping>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(servlet-name, url-pattern)

<servlet-name>

Child of servlet-mapping, filter-mapping, servlet

The servlet-name element contains the canonical name of the servlet. Each servlet name is unique within the web application.

Used in: filter-mapping, servlet, servlet-mapping

<servlet-name>'s attributes

Name Values Default

id Match the ID rules.

<session-config>

Child of web-app

The session-config element defines the session parameters for this web application.

Used in: web-app

<session-config>'s children

Name Cardinality

session-timeout One or none

<session-config>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(session-timeout?)

<session-timeout>

Child of session-config

The session-timeout element defines the default session timeout interval for all sessions created in this web application. The specified timeout must be expressed in a whole number of minutes. If the timeout is 0 or less, the container ensures the default behaviour of sessions is never to time out.

Used in: session-config

<session-timeout>'s attributes

Name Values Default

id Match the ID rules.

<small-icon>

Child of icon

The small-icon element contains the name of a file containing a small (16 x 16) icon image. The file name is a relative path within the web application's war file.

The image may be either in the JPEG or GIF format. The icon can be used by tools.

Used in: icon

Example:

<small-icon>employee-service-icon16x16.jpg</small-icon>

<small-icon>'s attributes

Name Values Default

id Match the ID rules.

Child of web-app

The taglib element is used to describe a JSP tag library.

Used in: web-app

<taglib>'s children

Name Cardinality

taglib-location Only one

taglib-uri Only one

<taglib>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(taglib-uri, taglib-location)

<taglib-location>

Child of taglib

the taglib-location element contains the location (as a resource relative to the root of the web application) where to find the Tag Libary Description file for the tag library.

Used in: taglib

<taglib-location>'s attributes

Name Values Default

id Match the ID rules.

<taglib-uri>

Child of taglib

The taglib-uri element describes a URI, relative to the location of the web.xml document, identifying a Tag Library used in the Web Application.

Used in: taglib

<taglib-uri>'s attributes

Name Values Default

id Match the ID rules.

<transport-guarantee>

Child of user-data-constraint

The transport-guarantee element specifies that the communication between client and server should be NONE, INTEGRAL, or CONFIDENTIAL. NONE means that the application does not require any transport guarantees. A value of INTEGRAL means that the application requires that the data sent between the client and server be sent in such a way that it can't be changed in transit. CONFIDENTIAL means that the application requires that the data be transmitted in a fashion that prevents other entities from observing the contents of the transmission. In most cases, the presence of the INTEGRAL or CONFIDENTIAL flag will indicate that the use of SSL is required.

Used in: user-data-constraint

<transport-guarantee>'s attributes

Name Values Default

id Match the ID rules.

<url-pattern>

Child of web-resource-collection, servlet-mapping, filter-mapping

The url-pattern element contains the url pattern of the mapping. Must follow the rules specified in Section 11.2 of the Servlet API Specification.

Used in: filter-mapping, servlet-mapping, web-resource-collection

<url-pattern>'s attributes

Name Values Default

id Match the ID rules.

<user-data-constraint>

Child of security-constraint

The user-data-constraint element is used to indicate how data communicated between the client and container should be protected.

Used in: security-constraint

<user-data-constraint>'s children

Name Cardinality

description One or none

transport-guarantee Only one

<user-data-constraint>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(description?, transport-guarantee)

<web-resource-collection>

Child of security-constraint

The web-resource-collection element is used to identify a subset of the resources and HTTP methods on those resources within a web application to which a security constraint applies. If no HTTP methods are specified, then the security constraint applies to all HTTP methods.

Used in: security-constraint

<web-resource-collection>'s children

Name Cardinality

description One or none

http-method Any number

url-pattern Any number

web-resource-name Only one

<web-resource-collection>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(web-resource-name, description?, url-pattern*, http-method*)

<web-resource-name>

Child of web-resource-collection

The web-resource-name contains the name of this web resource collection.

Used in: web-resource-collection

<web-resource-name>'s attributes

Name Values Default

id Match the ID rules.

<welcome-file>

Child of welcome-file-list

The welcome-file element contains file name to use as a default welcome file, such as index.html

Used in: welcome-file-list

<welcome-file>'s attributes

Name Values Default

id Match the ID rules.

<welcome-file-list>

Child of web-app

The welcome-file-list contains an ordered list of welcome files elements.

Used in: web-app

<welcome-file-list>'s children

Name Cardinality

welcome-file At least one

<welcome-file-list>'s attributes

Name Values Default

id Match the ID rules.

Element's model:

(welcome-file+)

@id	Attribute of auth-constraint

The ID mechanism is to allow tools that produce additional deployment information (i.e., information beyond the standard deployment descriptor information) to store the non-standard information in a separate file, and easily refer from these tool-specific files to the information in the standard deployment descriptor.

Tools are not allowed to add the non-standard information into the standard deployment descriptor.