XML DTD - web-app_2_3.dtd

<style type="text/css"> .c {cursor:hand} .b {color:red; font-family:'Courier New'; font-weight:bold; text-decoration:none} .e {margin-left:1em; text-indent:-1em; margin-right:1em} .k {margin-left:1em; text-indent:-1em; margin-right:1em} .t {color:#660000} .et {color:#0000FF} .xdra {color:#00FF00} .xt {color:#990099} .ns {color:red} .m {color:blue} .tx {font-weight:bold} .db {text-indent:0px; margin-left:1em; margin-top:0px; margin-bottom:0px; padding-left:.3em; border-left:1px solid #CCCCCC; font:small Courier} .di {font:small Courier} .d {color:blue} .pi {color:blue} .cb {text-indent:0px; margin-left:1em; margin-top:0px; margin-bottom:0px; padding-left:.3em; font:small Courier; color:#888888} .ci {font:small Courier; color:#888888} PRE {margin:0px; display:inline} h1 { font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 18pt; color: #000000} .heading { text-align:right;} .content { vertical-align: baseline; } .note { color:gray;} .names {font-family:' Arial, Helvetica'; font-weight:bold; font-size:12 } .source {font-family:'Courier New'; font-size:12 } .values {font-family:'Verdana, Arial, Helvetica'; font-size:12 } .headers {font-family:'Verdana, Arial, Helvetica'; font-weight:bold; font-size:12 } .descriptions {font-family:'Courier New'; color:redfont-size:10 } .names:hover{color:yellowfont-size:12} .names:active{color:yellowfont-size:12} .names:link{color:yellowfont-size:12} .names:visited{color:yellowfont-size:12} A:visited { COLOR: #00BB00; } </style> <!--livedocs:no-->

The URL of the document:http://livedocs.adobe.com/jrun/4/descriptordocs/web/web-app_2_3.htm#ELEMENT_web-app

XML DTD -web-app_2_3.dtd
Schema has:
77element definitions and154element attribute definitions.
Possible root elements:<web-app>

Element list

Elementweb-app
diagramelement image
descriptionThe web-app element is the root of the deployment descriptor fora web application.
attributesid
uses icondisplay-namedescriptiondistributablecontext-paramfilterfilter-mappinglistenerservletservlet-mappingsession-configmime-mappingwelcome-file-listerror-pagetaglibresource-env-refresource-refsecurity-constraintlogin-configsecurity-roleenv-entryejb-refejb-local-ref
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementauth-constraint
diagramelement image
description The auth-constraint element indicates the user roles that shouldbe permitted access to this resource collection. The role-nameused here must either correspond to the role-name of one of thesecurity-role elements defined for this web application, or bethe specially reserved role-name "*" that is a compact syntax forindicating all roles in the web application. If both "*" androlenames appear, the container interprets this as all roles.If no roles are defined, no user is allowed access to the portion ofthe web application described by the containing security-constraint.The container matches role names case sensitively when determiningaccess.

Used in: security-constraint

attributesid
uses descriptionrole-name
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)The ID mechanism is to allow tools that produce additional deploymentinformation (i.e., information beyond the standard deploymentdescriptor information) to store the non-standard information in aseparate file, and easily refer from these tool-specific files to theinformation in the standard deployment descriptor.Tools are not allowed to add the non-standard information into thestandard deployment descriptor.

Elementauth-method
diagramelement image
description The auth-method element is used to configure the authenticationmechanism for the web application. As a prerequisite to gaining access to any web resources which are protected by an authorizationconstraint, a user must have authenticated using the configuredmechanism. Legal values for this element are "BASIC", "DIGEST","FORM", or "CLIENT-CERT".

Used in: login-config

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementcontext-param
diagramelement image
description The context-param element contains the declaration of a webapplication's servlet context initialization parameters.

Used in: web-app

attributesid
uses param-nameparam-valuedescription
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementdescription
diagramelement image
description The description element is used to provide text describing the parentelement. The description element should include any information thatthe web application war file producer wants to provide to the consumer ofthe web application war file (i.e., to the Deployer). Typically, the toolsused by the web application war file consumer will display the descriptionwhen 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

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementdisplay-name
diagramelement image
description The display-name element contains a short name that is intended to bedisplayed 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>

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementdistributable
diagramelement image
description The distributable element, by its presence in a web applicationdeployment descriptor, indicates that this web application isprogrammed appropriately to be deployed into a distributed servletcontainer

Used in: web-app

attributesid
uses
contentempty
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementejb-link
diagramelement image
description The ejb-link element is used in the ejb-ref or ejb-local-refelements to specify that an EJB reference is linked to anenterprise bean.The name in the ejb-link element is composed of apath name specifying the ejb-jar containing the referenced enterprisebean with the ejb-name of the target bean appended and separated fromthe path name by "#". The path name is relative to the war filecontaining the web application that is referencing the enterprise bean.This allows multiple enterprise beans with the same ejb-name to beuniquely identified.

Used in: ejb-local-ref, ejb-refExamples:<ejb-link>EmployeeRecord</ejb-link><ejb-link>../products/product.jar#ProductEJB</ejb-link>

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementejb-local-ref
diagramelement image
description The ejb-local-ref element is used for the declaration of a reference toan 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

attributesid
uses descriptionejb-ref-nameejb-ref-typelocal-homelocalejb-link
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementejb-ref
diagramelement image
description The ejb-ref element is used for the declaration of a reference toan 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

attributesid
uses descriptionejb-ref-nameejb-ref-typehomeremoteejb-link
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementejb-ref-name
diagramelement image
description The ejb-ref-name element contains the name of an EJB reference. TheEJB reference is an entry in the web application's environment and isrelative to the java:comp/env context. The name must be uniquewithin 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>

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementejb-ref-type
diagramelement image
description The ejb-ref-type element contains the expected type of thereferenced 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

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementenv-entry
diagramelement image
descriptionThe env-entry element contains the declaration of a web application'senvironment entry. The declaration consists of an optionaldescription, the name of the environment entry, and an optionalvalue. If a value is not specified, one must be suppliedduring deployment.
attributesid
uses descriptionenv-entry-nameenv-entry-valueenv-entry-type
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementenv-entry-name
diagramelement image
description The env-entry-name element contains the name of a web applications'senvironment entry. The name is a JNDI name relative to thejava:comp/env context. The name must be unique within a web application.

Example:

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

Used in: env-entry

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementenv-entry-type
diagramelement image
description The env-entry-type element contains the fully-qualified Java type ofthe environment entry value that is expected by the web application'scode.The following are the legal values of env-entry-type:java.lang.Booleanjava.lang.Bytejava.lang.Characterjava.lang.Stringjava.lang.Shortjava.lang.Integerjava.lang.Longjava.lang.Floatjava.lang.Double

Used in: env-entry

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementenv-entry-value
diagramelement image
description The env-entry-value element contains the value of a web application'senvironment entry. The value must be a String that is valid for theconstructor of the specified type that takes a single Stringparameter, or for java.lang.Character, a single character.

Example:

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

Used in: env-entry

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementerror-code
diagramelement image
description The error-code contains an HTTP error code, ex: 404

Used in: error-page

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementerror-page
diagramelement image
description The error-page element contains a mapping between an error codeor exception type to the path of a resource in the web application

Used in: web-app

attributesid
uses error-codeexception-typelocation
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementexception-type
diagramelement image
description The exception type contains a fully qualified class name of aJava exception type.

Used in: error-page

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementextension
diagramelement image
description The extension element contains a string describing anextension.

Example:

"txt"

Used in: mime-mapping

attributesid
uses
td bgcolor="#eeeeeeee" class="values" width="85%"/>
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementfilter
diagramelement image
description Declares a filter in the web application. The filter is mapped toeither a servlet or a URL pattern in the filter-mapping element, usingthe filter-name value to reference. Filters can access theinitialization parameters declared in the deployment descriptor atruntime via the FilterConfig interface.

Used in: web-app

attributesid
uses iconfilter-namedisplay-namedescriptionfilter-classinit-param
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementfilter-class
diagramelement image
description The fully qualified classname of the filter.

Used in: filter

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

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

Used in: web-app

attributesid
uses filter-nameurl-patternservlet-name
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementfilter-name
diagramelement image
description 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

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementform-error-page
diagramelement image
description The form-error-page element defines the location in the web appwhere the error page that is displayed when login is not successfulcan be found. The path begins with a leading / and is interpretedrelative to the root of the WAR.

Used in: form-login-config

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementform-login-config
diagramelement image
description The form-login-config element specifies the login and error pagesthat should be used in form based login. If form based authenticationis not used, these elements are ignored.

Used in: login-config

attributesid
uses form-login-pageform-error-page
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementform-login-page
diagramelement image
description The form-login-page element defines the location in the web appwhere the page that can be used for login can be found. The pathbegins with a leading / and is interpreted relative to the root of the WAR.

Used in: form-login-config

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementhome
diagramelement image
description The home element contains the fully-qualified name of the enterprisebean's home interface.

Used in: ejb-ref

Example:

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

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementhttp-method
diagramelement image
description The http-method contains an HTTP method (GET | POST |...).

Used in: web-resource-collection

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementicon
diagramelement image
description The icon element contains small-icon and large-icon elements thatspecify the file names for small and a large GIF or JPEG icon imagesused to represent the parent element in a GUI tool.

Used in: filter, servlet, web-app

attributesid
uses small-iconlarge-icon
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementinit-param
diagramelement image
description The init-param element contains a name/value pair as aninitialization param of the servlet

Used in: filter, servlet

attributesid
uses param-nameparam-valuedescription
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementjsp-file
diagramelement image
description The jsp-file element contains the full path to a JSP file withinthe web application beginning with a `/'.

Used in: servlet

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementlarge-icon
diagramelement image
description The large-icon element contains the name of a filecontaining a large (32 x 32) icon image. The filename is a relative path within the web application'swar 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>

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementlistener
diagramelement image
description The listener element indicates the deployment properties for a webapplication listener bean.

Used in: web-app

attributesid
uses listener-class
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementlistener-class
diagramelement image
description The listener-class element declares a class in the application must beregistered as a web application listener bean. The value is the fully qualified classname of the listener class.

Used in: listener

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

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

Used in: servlet

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementlocal
diagramelement image
description The local element contains the fully-qualified name of theenterprise bean's local interface.

Used in: ejb-local-ref

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementlocal-home
diagramelement image
description The local-home element contains the fully-qualified name of theenterprise bean's local home interface.

Used in: ejb-local-ref

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementlocation
diagramelement image
description The location element contains the location of the resource in the webapplication relative to the root of the web application. The value ofthe location must have a leading `/'.

Used in: error-page

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementlogin-config
diagramelement image
description The login-config element is used to configure the authenticationmethod that should be used, the realm name that should be used forthis application, and the attributes that are needed by the form loginmechanism.

Used in: web-app

attributesid
uses auth-methodrealm-nameform-login-config
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementmime-mapping
diagramelement image
description The mime-mapping element defines a mapping between an extensionand a mime type.

Used in: web-app

attributesid
uses extensionmime-type
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementmime-type
diagramelement image
description The mime-type element contains a defined mime type.

Example:

"text/plain"

Used in: mime-mapping

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementparam-name
diagramelement image
description The param-name element contains the name of a parameter. Each parametername must be unique in the web application.

Used in: context-param, init-param

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementparam-value
diagramelement image
description The param-value element contains the value of a parameter.

Used in: context-param, init-param

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementrealm-name
diagramelement image
description The realm name element specifies the realm name to use in HTTPBasic authorization.

Used in: login-config

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementremote
diagramelement image
description The remote element contains the fully-qualified name of the enterprisebean's remote interface.

Used in: ejb-ref

Example:

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

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementres-auth
diagramelement image
description The res-auth element specifies whether the web application code signson programmatically to the resource manager, or whether the Containerwill sign on to the resource manager on behalf of the web application. In thelatter case, the Container uses information that is supplied by theDeployer.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

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementres-ref-name
diagramelement image
description The res-ref-name element specifies the name of a resource managerconnection factory reference. The name is a JNDI name relative to thejava:comp/env context. The name must be unique within a web application.

Used in: resource-ref

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementres-sharing-scope
diagramelement image
description The res-sharing-scope element specifies whether connections obtainedthrough the given resource manager connection factory reference can beshared. The value of this element, if specified, must be one of thetwo following:<res-sharing-scope>Shareable</res-sharing-scope><res-sharing-scope>Unshareable</res-sharing-scope>The default value is Shareable.

Used in: resource-ref

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementres-type
diagramelement image
description The res-type element specifies the type of the data source. The typeis specified by the fully qualified Java language class or interfaceexpected to be implemented by the data source.

Used in: resource-ref

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementresource-env-ref
diagramelement image
description The resource-env-ref element contains a declaration of a web application'sreference to an administered object associated with a resourcein the web application's environment. It consists of an optionaldescription, the resource environment reference name, and anindication of the resource environment reference type expected bythe 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>

attributesid
uses descriptionresource-env-ref-nameresource-env-ref-type
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementresource-env-ref-name
diagramelement image
description The resource-env-ref-name element specifies the name of a resourceenvironment reference; its value is the environment entry name used inthe web application code. The name is a JNDI name relative to thejava:comp/env context and must be unique within a web application.

Used in: resource-env-ref

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementresource-env-ref-type
diagramelement image
description The resource-env-ref-type element specifies the type of a resourceenvironment reference. It is the fully qualified name of a Javalanguage class or interface.

Used in: resource-env-ref

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementresource-ref
diagramelement image
description The resource-ref element contains a declaration of a web application'sreference to an external resource. It consists of an optionaldescription, the resource manager connection factory reference name,the indication of the resource manager connection factory typeexpected by the web application code, the type of authentication(Application or Container), and an optional specification of theshareability of connections obtained from the resource (Shareable orUnshareable).

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>

attributesid
uses descriptionres-ref-nameres-typeres-authres-sharing-scope
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementrole-link
diagramelement image
description The role-link element is a reference to a defined security role. Therole-link element must contain the name of one of the security rolesdefined in the security-role elements.

Used in: security-role-ref

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementrole-name
diagramelement image
description 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

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementrun-as
diagramelement image
description The run-as element specifies the run-as identity to be used for theexecution of the web application. It contains an optional description, andthe name of a security role.

Used in: servlet

attributesid
uses descriptionrole-name
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementsecurity-constraint
diagramelement image
description The security-constraint element is used to associate securityconstraints with one or more web resource collections

Used in: web-app

attributesid
uses display-nameweb-resource-collectionauth-constraintuser-data-constraint
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementsecurity-role
diagramelement image
description The security-role element contains the definition of a securityrole. The definition consists of an optional description of thesecurity 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>

attributesid
uses descriptionrole-name
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementsecurity-role-ref
diagramelement image
description The security-role-ref element contains the declaration of a securityrole reference in the web application's code. The declaration consistsof an optional description, the security role name used in the code,and an optional link to a security role. If the security role is notspecified, the Deployer must choose an appropriate security role.The value of the role-name element must be the String used as theparameter to the EJBContext.isCallerInRole(String roleName) methodor the HttpServletRequest.isUserInRole(String role) method.

Used in: servlet

attributesid
uses descriptionrole-namerole-link
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementservlet
diagramelement image
description The servlet element contains the declarative data of aservlet. If a jsp-file is specified and the load-on-startup element ispresent, then the JSP should be precompiled and loaded.

Used in: web-app

attributesid
uses iconservlet-namedisplay-namedescriptionservlet-classjsp-fileinit-paramload-on-startuprun-assecurity-role-ref
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementservlet-class
diagramelement image
description The servlet-class element contains the fully qualified class nameof the servlet.

Used in: servlet

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementservlet-mapping
diagramelement image
description The servlet-mapping element defines a mapping between a servletand a url pattern

Used in: web-app

attributesid
uses servlet-nameurl-pattern
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementservlet-name
diagramelement image
description The servlet-name element contains the canonical name of theservlet. Each servlet name is unique within the web application.

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

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementsession-config
diagramelement image
description The session-config element defines the session parameters forthis web application.

Used in: web-app

attributesid
uses session-timeout
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementsession-timeout
diagramelement image
description The session-timeout element defines the default session timeoutinterval for all sessions created in this web application. Thespecified timeout must be expressed in a whole number of minutes.If the timeout is 0 or less, the container ensures the defaultbehaviour of sessions is never to time out.

Used in: session-config

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementsmall-icon
diagramelement image
description The small-icon element contains the name of a filecontaining a small (16 x 16) icon image. The filename is a relative path within the web application'swar 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>

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementtaglib
diagramelement image
description The taglib element is used to describe a JSP tag library.

Used in: web-app

attributesid
uses taglib-uritaglib-location
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementtaglib-location
diagramelement image
description the taglib-location element contains the location (as a resourcerelative to the root of the web application) where to find the TagLibary Description file for the tag library.

Used in: taglib

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementtaglib-uri
diagramelement image
description The taglib-uri element describes a URI, relative to the locationof the web.xml document, identifying a Tag Library used in the WebApplication.

Used in: taglib

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementtransport-guarantee
diagramelement image
description The transport-guarantee element specifies that the communicationbetween client and server should be NONE, INTEGRAL, orCONFIDENTIAL. NONE means that the application does not require anytransport guarantees. A value of INTEGRAL means that the applicationrequires that the data sent between the client and server be sent insuch a way that it can't be changed in transit. CONFIDENTIAL meansthat the application requires that the data be transmitted in afashion that prevents other entities from observing the contents ofthe transmission. In most cases, the presence of the INTEGRAL orCONFIDENTIAL flag will indicate that the use of SSL is required.

Used in: user-data-constraint

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementurl-pattern
diagramelement image
description The url-pattern element contains the url pattern of the mapping. Mustfollow the rules specified in Section 11.2 of the Servlet APISpecification.

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

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementuser-data-constraint
diagramelement image
description The user-data-constraint element is used to indicate how datacommunicated between the client and container should be protected.

Used in: security-constraint

attributesid
uses descriptiontransport-guarantee
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementweb-resource-collection
diagramelement image
description The web-resource-collection element is used to identify a subsetof the resources and HTTP methods on those resources within a webapplication to which a security constraint applies. If no HTTP methodsare specified, then the security constraint applies to all HTTPmethods.

Used in: security-constraint

attributesid
uses web-resource-namedescriptionurl-patternhttp-method
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementweb-resource-name
diagramelement image
description The web-resource-name contains the name of this web resourcecollection.

Used in: web-resource-collection

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementwelcome-file
diagramelement image
description The welcome-file element contains file name to use as a defaultwelcome file, such as index.html

Used in: welcome-file-list

attributesid
uses
contentcharacter data
occurrence
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

Elementwelcome-file-list
diagramelement image
description The welcome-file-list contains an ordered list of welcome fileselements.

Used in: web-app

attributesid
uses welcome-file
contenta sequence of elements
occurrencerequired (default)
AttributeDatatypeRequiredValuesDefaultComments
idIDno (default)

The URL of the documenthttp://livedocs.adobe.com/jrun/4/descriptordocs/web/web-app_2_3.htm#ELEMENT_web-app

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值