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

web-app_2_2.dtd

<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-ref Any number

env-entry Any number

error-page Any number

icon One or none

login-config One or none

mime-mapping 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*, servlet*, servlet-mapping*, session-config?, mime-mapping*, welcome-file-list?, error-page*, taglib*, resource-ref*, security-constraint*, login-config?, security-role*, env-entry*, ejb-ref*)

<icon>

Child of servlet, web-app

The icon element contains a small-icon and a large-icon element which specify the location within the web application for a small and large image used to represent the web application in a GUI tool. At a minimum, tools must accept GIF and JPEG format images.

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

<small-icon>

Child of icon

The small-icon element contains the location within the web application of a file containing a small (16x16 pixel) icon image.

<small-icon>'s attributes

Name Values Default

id Match the ID rules.

<large-icon>

Child of icon

The large-icon element contains the location within the web application of a file containing a large (32x32 pixel) icon image.

<large-icon>'s attributes

Name Values Default

id Match the ID rules.

<display-name>

Child of servlet, web-app

The display-name element contains a short name that is intended to be displayed by GUI tools

<display-name>'s attributes

Name Values Default

id Match the ID rules.

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

The description element is used to provide descriptive text about the parent element.

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

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

<context-param>

Child of web-app

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

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

<param-name>

Child of context-param, init-param

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

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

<param-value>'s attributes

Name Values Default

id Match the ID rules.

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.

<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

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?, security-role-ref*)

<servlet-name>

Child of servlet, servlet-mapping

The servlet-name element contains the canonical name of the servlet.

<servlet-name>'s attributes

Name Values Default

id Match the ID rules.

<servlet-class>

Child of servlet

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

<servlet-class>'s attributes

Name Values Default

id Match the ID rules.

<jsp-file>

Child of servlet

The jsp-file element contains the full path to a JSP file within the web application.

<jsp-file>'s attributes

Name Values Default

id Match the ID rules.

<init-param>

Child of servlet

The init-param element contains a name/value pair as an initialization param of the 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?)

<load-on-startup>

Child of servlet

The load-on-startup element indicates that this servlet should be loaded on the startup of the web application. The optional contents of these element must be a positive integer indicating the order in which the servlet should be loaded. Lower integers are loaded before higher integers. If no value is specified, or if the value specified is not a positive integer, the container is free to load it at any time in the startup sequence.

<load-on-startup>'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

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

<url-pattern>

Child of servlet-mapping, web-resource-collection

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

<url-pattern>'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.

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

<session-timeout>'s attributes

Name Values Default

id Match the ID rules.

<mime-mapping>

Child of web-app

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

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

Child of mime-mapping

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

<extension>'s attributes

Name Values Default

id Match the ID rules.

<mime-type>

Child of mime-mapping

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

<mime-type>'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.

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

<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

<welcome-file>'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.

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

<taglib-uri>'s attributes

Name Values Default

id Match the ID rules.

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

<taglib-location>'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

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

<error-code>

Child of error-page

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

<error-code>'s attributes

Name Values Default

id Match the ID rules.

<exception-type>

Child of error-page

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

<exception-type>'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

<location>'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.

<resource-ref>'s children

Name Cardinality

description One or none

res-auth Only one

res-ref-name Only one

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

Child of resource-ref

The res-ref-name element specifies the name of the resource factory reference name.

<res-ref-name>'s attributes

Name Values Default

id Match the ID rules.

<res-type>

Child of resource-ref

The res-type element specifies the (Java class) type of the data source.

<res-type>'s attributes

Name Values Default

id Match the ID rules.

<res-auth>

Child of resource-ref

The res-auth element indicates whether the application component code performs resource signon programmatically or whether the container signs onto the resource based on the principle mapping information supplied by the deployer. Must be CONTAINER or SERVLET

<res-auth>'s attributes

Name Values Default

id Match the ID rules.

<security-constraint>

Child of web-app

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

<security-constraint>'s children

Name Cardinality

auth-constraint 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:

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

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

<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

<web-resource-name>'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 |...)

<http-method>'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

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

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

<transport-guarantee>'s attributes

Name Values Default

id Match the ID rules.

<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 used here must appear in a security-role-ref element.

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

<role-name>

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

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

<role-name>'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.

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

<realm-name>

Child of login-config

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

<realm-name>'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.

<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

<form-login-page>'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

<form-error-page>'s attributes

Name Values Default

id Match the ID rules.

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

<auth-method>'s attributes

Name Values Default

id Match the ID rules.

<security-role>

Child of web-app

The security-role element contains the declaration of a security role which is used in the security-constraints placed on the web application.

<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 role-name element contains the name of a role. This element must contain a non-empty string.

<security-role-ref>'s children

Name Cardinality

description One or none

role-link Only one

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)

<role-link>

Child of security-role-ref

The role-link element is used to link a security role 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.

<role-link>'s attributes

Name Values Default

id Match the ID rules.

<env-entry>

Child of web-app

The env-entry element contains the declaration of an application's environment entry. This element is required to be honored on in J2EE compliant servlet containers.

<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 contains the name of an application's environment entry

<env-entry-name>'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 an application's environment entry

<env-entry-value>'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 application code. The following are the legal values of env-entry-type: java.lang.Boolean, java.lang.String, java.lang.Integer, java.lang.Double, java.lang.Float.

<env-entry-type>'s attributes

Name Values Default

id Match the ID rules.

<ejb-ref>

Child of web-app

The ejb-ref element is used to declare a reference to an enterprise bean.

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

The ejb-ref-name element contains the name of an EJB reference. This is the JNDI name that the servlet code uses to get a reference to the enterprise bean.

<ejb-ref-name>'s attributes

Name Values Default

id Match the ID rules.

<ejb-ref-type>

Child of ejb-ref

The ejb-ref-type element contains the expected java class type of the referenced EJB.

<ejb-ref-type>'s attributes

Name Values Default

id Match the ID rules.

<home>

Child of ejb-ref

The ejb-home element contains the fully qualified name of the EJB's home interface

<home>'s attributes

Name Values Default

id Match the ID rules.

Child of ejb-ref

The ejb-remote element contains the fully qualified name of the EJB's remote interface

<remote>'s attributes

Name Values Default

id Match the ID rules.

<ejb-link>

Child of ejb-ref

The ejb-link element is used in the ejb-ref element to specify that an EJB reference is linked to an EJB in an encompassing Java2 Enterprise Edition (J2EE) application package. The value of the ejb-link element must be the ejb-name of and EJB in the J2EE application package.

<ejb-link>'s attributes

Name Values Default

id Match the ID rules.

@id	Attribute of web-app

The ID mechanism is to allow tools to easily make tool-specific references to the elements of the deployment descriptor. This allows 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 tools-specific files to the information in the standard web-app deployment descriptor.