david_williams | e073de1 | 2007-04-28 04:01:44 +0000 | [diff] [blame] | 1 | <!-- |
| 2 | Copyright (c) 2000 Sun Microsystems, Inc., |
| 3 | 901 San Antonio Road, |
| 4 | Palo Alto, California 94303, U.S.A. |
| 5 | All rights reserved. |
| 6 | |
| 7 | Sun Microsystems, Inc. has intellectual property rights relating to |
| 8 | technology embodied in the product that is described in this document. |
| 9 | In particular, and without limitation, these intellectual property |
| 10 | rights may include one or more of the U.S. patents listed at |
| 11 | http://www.sun.com/patents and one or more additional patents or |
| 12 | pending patent applications in the U.S. and in other countries. |
| 13 | |
| 14 | This document and the product to which it pertains are distributed |
| 15 | under licenses restricting their use, copying, distribution, and |
| 16 | decompilation. This document may be reproduced and distributed but may |
| 17 | not be changed without prior written authorization of Sun and its |
| 18 | licensors, if any. |
| 19 | |
| 20 | Third-party software, including font technology, is copyrighted and |
| 21 | licensed from Sun suppliers. |
| 22 | |
| 23 | Sun, Sun Microsystems, the Sun logo, Java, JavaServer Pages, Java |
| 24 | Naming and Directory Interface, JDBC, JDK, JavaMail and and |
| 25 | Enterprise JavaBeans are trademarks or registered trademarks of Sun |
| 26 | Microsystems, Inc. in the U.S. and other countries. |
| 27 | |
| 28 | Federal Acquisitions: Commercial Software - Government Users Subject to |
| 29 | Standard License Terms and Conditions. |
| 30 | |
| 31 | DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED |
| 32 | CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED |
| 33 | WARRANTY OF MERCHANTABILITY, FITNESS FOR FOR A PARTICULAR PURPOSE OR |
| 34 | NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH |
| 35 | DISCLAIMERS ARE HELD TO BE LEGALLY INVALID. |
| 36 | |
| 37 | |
| 38 | _________________________________________________________________________ |
| 39 | |
| 40 | Copyright (c) 2000 Sun Microsystems, Inc., |
| 41 | 901 San Antonio Road, |
| 42 | Palo Alto, California 94303, E'tats-Unis. |
| 43 | Tous droits re'serve's. |
| 44 | |
| 45 | Sun Microsystems, Inc. a les droits de proprie'te' intellectuels |
| 46 | relatants a` la technologie incorpore'e dans le produit qui est de'crit |
| 47 | dans ce document. En particulier, et sans la limitation, ces droits de |
| 48 | proprie'te' intellectuels peuvent inclure un ou plus des brevets |
| 49 | ame'ricains e'nume're's a` http://www.sun.com/patents et un ou les |
| 50 | brevets plus supple'mentaires ou les applications de brevet en attente |
| 51 | dans les E'tats-Unis et dans les autres pays. |
| 52 | |
| 53 | Ce produit ou document est prote'ge' par un copyright et distribue' |
| 54 | avec des licences qui en restreignent l'utilisation, la copie, la |
| 55 | distribution, et la de'compilation. Ce documention associe n peut |
| 56 | e^tre reproduite et distribuer, par quelque moyen que ce soit, sans |
| 57 | l'autorisation pre'alable et e'crite de Sun et de ses bailleurs de |
| 58 | licence, le cas e'che'ant. |
| 59 | |
| 60 | Le logiciel de'tenu par des tiers, et qui comprend la technologie |
| 61 | relative aux polices de caracte`res, est prote'ge' par un copyright et |
| 62 | licencie' par des fournisseurs de Sun. |
| 63 | |
| 64 | Sun, Sun Microsystems, le logo Sun, Java, JavaServer Pages, Java |
| 65 | Naming and Directory Interface, JDBC, JDK, JavaMail et and |
| 66 | Enterprise JavaBeans sont des marques de fabrique ou des marques |
| 67 | de'pose'es de Sun Microsystems, Inc. aux E'tats-Unis et dans d'autres |
| 68 | pays. |
| 69 | |
| 70 | LA DOCUMENTATION EST FOURNIE "EN L'E'TAT" ET TOUTES AUTRES CONDITIONS, |
| 71 | DECLARATIONS ET GARANTIES EXPRESSES OU TACITES SONT FORMELLEMENT |
| 72 | EXCLUES, DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS |
| 73 | NOTAMMENT TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE, A |
| 74 | L'APTITUDE A UNE UTILISATION PARTICULIERE OU A L'ABSENCE DE |
| 75 | CONTREFAC,ON. |
| 76 | --> |
| 77 | |
| 78 | <!-- |
| 79 | This is the XML DTD for the Servlet 2.3 deployment descriptor. |
| 80 | All Servlet 2.3 deployment descriptors must include a DOCTYPE |
| 81 | of the following form: |
| 82 | |
| 83 | <!DOCTYPE web-app PUBLIC |
| 84 | "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" |
| 85 | "http://java.sun.com/dtd/web-app_2_3.dtd"> |
| 86 | |
| 87 | --> |
| 88 | |
| 89 | <!-- |
| 90 | The following conventions apply to all J2EE deployment descriptor |
| 91 | elements unless indicated otherwise. |
| 92 | |
| 93 | - In elements that contain PCDATA, leading and trailing whitespace |
| 94 | in the data may be ignored. |
| 95 | |
| 96 | - In elements whose value is an "enumerated type", the value is |
| 97 | case sensitive. |
| 98 | |
| 99 | - In elements that specify a pathname to a file within the same |
| 100 | JAR file, relative filenames (i.e., those not starting with "/") |
| 101 | are considered relative to the root of the JAR file's namespace. |
| 102 | Absolute filenames (i.e., those starting with "/") also specify |
| 103 | names in the root of the JAR file's namespace. In general, relative |
| 104 | names are preferred. The exception is .war files where absolute |
| 105 | names are preferred for consistency with the servlet API. |
| 106 | --> |
| 107 | |
| 108 | |
| 109 | <!-- |
| 110 | The web-app element is the root of the deployment descriptor for |
| 111 | a web application. |
| 112 | --> |
| 113 | <!ELEMENT web-app (icon?, display-name?, description?, distributable?, |
| 114 | context-param*, filter*, filter-mapping*, listener*, servlet*, |
| 115 | servlet-mapping*, session-config?, mime-mapping*, welcome-file-list?, |
| 116 | error-page*, taglib*, resource-env-ref*, resource-ref*, security-constraint*, |
| 117 | login-config?, security-role*, env-entry*, ejb-ref*, ejb-local-ref*)> |
| 118 | |
| 119 | <!-- |
| 120 | The auth-constraint element indicates the user roles that should |
| 121 | be permitted access to this resource collection. The role-name |
| 122 | used here must either correspond to the role-name of one of the |
| 123 | security-role elements defined for this web application, or be |
| 124 | the specially reserved role-name "*" that is a compact syntax for |
| 125 | indicating all roles in the web application. If both "*" and |
| 126 | rolenames appear, the container interprets this as all roles. |
| 127 | If no roles are defined, no user is allowed access to the portion of |
| 128 | the web application described by the containing security-constraint. |
| 129 | The container matches role names case sensitively when determining |
| 130 | access. |
| 131 | |
| 132 | |
| 133 | Used in: security-constraint |
| 134 | --> |
| 135 | <!ELEMENT auth-constraint (description?, role-name*)> |
| 136 | |
| 137 | <!-- |
| 138 | The auth-method element is used to configure the authentication |
| 139 | mechanism for the web application. As a prerequisite to gaining access to any web resources which are protected by an authorization |
| 140 | constraint, a user must have authenticated using the configured |
| 141 | mechanism. Legal values for this element are "BASIC", "DIGEST", |
| 142 | "FORM", or "CLIENT-CERT". |
| 143 | |
| 144 | Used in: login-config |
| 145 | --> |
| 146 | <!ELEMENT auth-method (#PCDATA)> |
| 147 | |
| 148 | <!-- |
| 149 | The context-param element contains the declaration of a web |
| 150 | application's servlet context initialization parameters. |
| 151 | |
| 152 | Used in: web-app |
| 153 | --> |
| 154 | <!ELEMENT context-param (param-name, param-value, description?)> |
| 155 | |
| 156 | <!-- |
| 157 | The description element is used to provide text describing the parent |
| 158 | element. The description element should include any information that |
| 159 | the web application war file producer wants to provide to the consumer of |
| 160 | the web application war file (i.e., to the Deployer). Typically, the tools |
| 161 | used by the web application war file consumer will display the description |
| 162 | when processing the parent element that contains the description. |
| 163 | |
| 164 | Used in: auth-constraint, context-param, ejb-local-ref, ejb-ref, |
| 165 | env-entry, filter, init-param, resource-env-ref, resource-ref, run-as, |
| 166 | security-role, security-role-ref, servlet, user-data-constraint, |
| 167 | web-app, web-resource-collection |
| 168 | --> |
| 169 | <!ELEMENT description (#PCDATA)> |
| 170 | |
| 171 | <!-- |
| 172 | The display-name element contains a short name that is intended to be |
| 173 | displayed by tools. The display name need not be unique. |
| 174 | |
| 175 | Used in: filter, security-constraint, servlet, web-app |
| 176 | |
| 177 | Example: |
| 178 | |
| 179 | <display-name>Employee Self Service</display-name> |
| 180 | --> |
| 181 | <!ELEMENT display-name (#PCDATA)> |
| 182 | |
| 183 | <!-- |
| 184 | The distributable element, by its presence in a web application |
| 185 | deployment descriptor, indicates that this web application is |
| 186 | programmed appropriately to be deployed into a distributed servlet |
| 187 | container |
| 188 | |
| 189 | Used in: web-app |
| 190 | --> |
| 191 | <!ELEMENT distributable EMPTY> |
| 192 | |
| 193 | <!-- |
| 194 | The ejb-link element is used in the ejb-ref or ejb-local-ref |
| 195 | elements to specify that an EJB reference is linked to an |
| 196 | enterprise bean. |
| 197 | |
| 198 | The name in the ejb-link element is composed of a |
| 199 | path name specifying the ejb-jar containing the referenced enterprise |
| 200 | bean with the ejb-name of the target bean appended and separated from |
| 201 | the path name by "#". The path name is relative to the war file |
| 202 | containing the web application that is referencing the enterprise bean. |
| 203 | This allows multiple enterprise beans with the same ejb-name to be |
| 204 | uniquely identified. |
| 205 | |
| 206 | Used in: ejb-local-ref, ejb-ref |
| 207 | |
| 208 | Examples: |
| 209 | |
| 210 | <ejb-link>EmployeeRecord</ejb-link> |
| 211 | |
| 212 | <ejb-link>../products/product.jar#ProductEJB</ejb-link> |
| 213 | |
| 214 | --> |
| 215 | <!ELEMENT ejb-link (#PCDATA)> |
| 216 | |
| 217 | <!-- |
| 218 | The ejb-local-ref element is used for the declaration of a reference to |
| 219 | an enterprise bean's local home. The declaration consists of: |
| 220 | |
| 221 | - an optional description |
| 222 | - the EJB reference name used in the code of the web application |
| 223 | that's referencing the enterprise bean |
| 224 | - the expected type of the referenced enterprise bean |
| 225 | - the expected local home and local interfaces of the referenced |
| 226 | enterprise bean |
| 227 | - optional ejb-link information, used to specify the referenced |
| 228 | enterprise bean |
| 229 | |
| 230 | Used in: web-app |
| 231 | --> |
| 232 | <!ELEMENT ejb-local-ref (description?, ejb-ref-name, ejb-ref-type, |
| 233 | local-home, local, ejb-link?)> |
| 234 | |
| 235 | <!-- |
| 236 | The ejb-ref element is used for the declaration of a reference to |
| 237 | an enterprise bean's home. The declaration consists of: |
| 238 | |
| 239 | - an optional description |
| 240 | - the EJB reference name used in the code of |
| 241 | the web application that's referencing the enterprise bean |
| 242 | - the expected type of the referenced enterprise bean |
| 243 | - the expected home and remote interfaces of the referenced |
| 244 | enterprise bean |
| 245 | - optional ejb-link information, used to specify the referenced |
| 246 | enterprise bean |
| 247 | |
| 248 | Used in: web-app |
| 249 | --> |
| 250 | <!ELEMENT ejb-ref (description?, ejb-ref-name, ejb-ref-type, |
| 251 | home, remote, ejb-link?)> |
| 252 | |
| 253 | <!-- |
| 254 | The ejb-ref-name element contains the name of an EJB reference. The |
| 255 | EJB reference is an entry in the web application's environment and is |
| 256 | relative to the java:comp/env context. The name must be unique |
| 257 | within the web application. |
| 258 | |
| 259 | It is recommended that name is prefixed with "ejb/". |
| 260 | |
| 261 | Used in: ejb-local-ref, ejb-ref |
| 262 | |
| 263 | Example: |
| 264 | |
| 265 | <ejb-ref-name>ejb/Payroll</ejb-ref-name> |
| 266 | --> |
| 267 | <!ELEMENT ejb-ref-name (#PCDATA)> |
| 268 | |
| 269 | <!-- |
| 270 | The ejb-ref-type element contains the expected type of the |
| 271 | referenced enterprise bean. |
| 272 | |
| 273 | The ejb-ref-type element must be one of the following: |
| 274 | |
| 275 | <ejb-ref-type>Entity</ejb-ref-type> |
| 276 | <ejb-ref-type>Session</ejb-ref-type> |
| 277 | |
| 278 | Used in: ejb-local-ref, ejb-ref |
| 279 | --> |
| 280 | <!ELEMENT ejb-ref-type (#PCDATA)> |
| 281 | |
| 282 | <!-- |
| 283 | The env-entry element contains the declaration of a web application's |
| 284 | environment entry. The declaration consists of an optional |
| 285 | description, the name of the environment entry, and an optional |
| 286 | value. If a value is not specified, one must be supplied |
| 287 | during deployment. |
| 288 | --> |
| 289 | <!ELEMENT env-entry (description?, env-entry-name, env-entry-value?, |
| 290 | env-entry-type)> |
| 291 | |
| 292 | <!-- |
| 293 | The env-entry-name element contains the name of a web applications's |
| 294 | environment entry. The name is a JNDI name relative to the |
| 295 | java:comp/env context. The name must be unique within a web application. |
| 296 | |
| 297 | Example: |
| 298 | |
| 299 | <env-entry-name>minAmount</env-entry-name> |
| 300 | |
| 301 | Used in: env-entry |
| 302 | --> |
| 303 | <!ELEMENT env-entry-name (#PCDATA)> |
| 304 | |
| 305 | <!-- |
| 306 | The env-entry-type element contains the fully-qualified Java type of |
| 307 | the environment entry value that is expected by the web application's |
| 308 | code. |
| 309 | |
| 310 | The following are the legal values of env-entry-type: |
| 311 | |
| 312 | java.lang.Boolean |
| 313 | java.lang.Byte |
| 314 | java.lang.Character |
| 315 | java.lang.String |
| 316 | java.lang.Short |
| 317 | java.lang.Integer |
| 318 | java.lang.Long |
| 319 | java.lang.Float |
| 320 | java.lang.Double |
| 321 | |
| 322 | Used in: env-entry |
| 323 | --> |
| 324 | <!ELEMENT env-entry-type (#PCDATA)> |
| 325 | |
| 326 | <!-- |
| 327 | The env-entry-value element contains the value of a web application's |
| 328 | environment entry. The value must be a String that is valid for the |
| 329 | constructor of the specified type that takes a single String |
| 330 | parameter, or for java.lang.Character, a single character. |
| 331 | |
| 332 | Example: |
| 333 | |
| 334 | <env-entry-value>100.00</env-entry-value> |
| 335 | |
| 336 | Used in: env-entry |
| 337 | --> |
| 338 | <!ELEMENT env-entry-value (#PCDATA)> |
| 339 | |
| 340 | <!-- |
| 341 | The error-code contains an HTTP error code, ex: 404 |
| 342 | |
| 343 | Used in: error-page |
| 344 | --> |
| 345 | <!ELEMENT error-code (#PCDATA)> |
| 346 | |
| 347 | <!-- |
| 348 | The error-page element contains a mapping between an error code |
| 349 | or exception type to the path of a resource in the web application |
| 350 | |
| 351 | Used in: web-app |
| 352 | --> |
| 353 | <!ELEMENT error-page ((error-code | exception-type), location)> |
| 354 | |
| 355 | <!-- |
| 356 | The exception type contains a fully qualified class name of a |
| 357 | Java exception type. |
| 358 | |
| 359 | Used in: error-page |
| 360 | --> |
| 361 | <!ELEMENT exception-type (#PCDATA)> |
| 362 | |
| 363 | <!-- |
| 364 | The extension element contains a string describing an |
| 365 | extension. example: "txt" |
| 366 | |
| 367 | Used in: mime-mapping |
| 368 | --> |
| 369 | <!ELEMENT extension (#PCDATA)> |
| 370 | |
| 371 | <!-- |
| 372 | Declares a filter in the web application. The filter is mapped to |
| 373 | either a servlet or a URL pattern in the filter-mapping element, using |
| 374 | the filter-name value to reference. Filters can access the |
| 375 | initialization parameters declared in the deployment descriptor at |
| 376 | runtime via the FilterConfig interface. |
| 377 | |
| 378 | Used in: web-app |
| 379 | --> |
| 380 | <!ELEMENT filter (icon?, filter-name, display-name?, description?, |
| 381 | filter-class, init-param*)> |
| 382 | |
| 383 | <!-- |
| 384 | The fully qualified classname of the filter. |
| 385 | |
| 386 | Used in: filter |
| 387 | --> |
| 388 | <!ELEMENT filter-class (#PCDATA)> |
| 389 | |
| 390 | <!-- |
| 391 | Declaration of the filter mappings in this web application. The |
| 392 | container uses the filter-mapping declarations to decide which filters |
| 393 | to apply to a request, and in what order. The container matches the |
| 394 | request URI to a Servlet in the normal way. To determine which filters |
| 395 | to apply it matches filter-mapping declarations either on servlet-name, |
| 396 | or on url-pattern for each filter-mapping element, depending on which |
| 397 | style is used. The order in which filters are invoked is the order in |
| 398 | which filter-mapping declarations that match a request URI for a |
| 399 | servlet appear in the list of filter-mapping elements.The filter-name |
| 400 | value must be the value of the <filter-name> sub-elements of one of the |
| 401 | <filter> declarations in the deployment descriptor. |
| 402 | |
| 403 | Used in: web-app |
| 404 | --> |
| 405 | <!ELEMENT filter-mapping (filter-name, (url-pattern | servlet-name))> |
| 406 | |
| 407 | <!-- |
| 408 | The logical name of the filter. This name is used to map the filter. |
| 409 | Each filter name is unique within the web application. |
| 410 | |
| 411 | Used in: filter, filter-mapping |
| 412 | --> |
| 413 | <!ELEMENT filter-name (#PCDATA)> |
| 414 | |
| 415 | <!-- |
| 416 | The form-error-page element defines the location in the web app |
| 417 | where the error page that is displayed when login is not successful |
| 418 | can be found. The path begins with a leading / and is interpreted |
| 419 | relative to the root of the WAR. |
| 420 | |
| 421 | Used in: form-login-config |
| 422 | --> |
| 423 | <!ELEMENT form-error-page (#PCDATA)> |
| 424 | |
| 425 | <!-- |
| 426 | The form-login-config element specifies the login and error pages |
| 427 | that should be used in form based login. If form based authentication |
| 428 | is not used, these elements are ignored. |
| 429 | |
| 430 | Used in: login-config |
| 431 | --> |
| 432 | <!ELEMENT form-login-config (form-login-page, form-error-page)> |
| 433 | |
| 434 | <!-- |
| 435 | The form-login-page element defines the location in the web app |
| 436 | where the page that can be used for login can be found. The path |
| 437 | begins with a leading / and is interpreted relative to the root of the WAR. |
| 438 | |
| 439 | Used in: form-login-config |
| 440 | --> |
| 441 | <!ELEMENT form-login-page (#PCDATA)> |
| 442 | |
| 443 | <!-- |
| 444 | The home element contains the fully-qualified name of the enterprise |
| 445 | bean's home interface. |
| 446 | |
| 447 | Used in: ejb-ref |
| 448 | |
| 449 | Example: |
| 450 | |
| 451 | <home>com.aardvark.payroll.PayrollHome</home> |
| 452 | --> |
| 453 | <!ELEMENT home (#PCDATA)> |
| 454 | |
| 455 | <!-- |
| 456 | The http-method contains an HTTP method (GET | POST |...). |
| 457 | |
| 458 | Used in: web-resource-collection |
| 459 | --> |
| 460 | <!ELEMENT http-method (#PCDATA)> |
| 461 | |
| 462 | <!-- |
| 463 | The icon element contains small-icon and large-icon elements that |
| 464 | specify the file names for small and a large GIF or JPEG icon images |
| 465 | used to represent the parent element in a GUI tool. |
| 466 | |
| 467 | Used in: filter, servlet, web-app |
| 468 | --> |
| 469 | <!ELEMENT icon (small-icon?, large-icon?)> |
| 470 | |
| 471 | <!-- |
| 472 | The init-param element contains a name/value pair as an |
| 473 | initialization param of the servlet |
| 474 | |
| 475 | Used in: filter, servlet |
| 476 | --> |
| 477 | <!ELEMENT init-param (param-name, param-value, description?)> |
| 478 | |
| 479 | <!-- |
| 480 | The jsp-file element contains the full path to a JSP file within |
| 481 | the web application beginning with a `/'. |
| 482 | |
| 483 | Used in: servlet |
| 484 | --> |
| 485 | <!ELEMENT jsp-file (#PCDATA)> |
| 486 | |
| 487 | <!-- |
| 488 | The large-icon element contains the name of a file |
| 489 | containing a large (32 x 32) icon image. The file |
| 490 | name is a relative path within the web application's |
| 491 | war file. |
| 492 | |
| 493 | The image may be either in the JPEG or GIF format. |
| 494 | The icon can be used by tools. |
| 495 | |
| 496 | Used in: icon |
| 497 | |
| 498 | Example: |
| 499 | |
| 500 | <large-icon>employee-service-icon32x32.jpg</large-icon> |
| 501 | --> |
| 502 | <!ELEMENT large-icon (#PCDATA)> |
| 503 | |
| 504 | <!-- |
| 505 | The listener element indicates the deployment properties for a web |
| 506 | application listener bean. |
| 507 | |
| 508 | Used in: web-app |
| 509 | --> |
| 510 | <!ELEMENT listener (listener-class)> |
| 511 | |
| 512 | <!-- |
| 513 | The listener-class element declares a class in the application must be |
| 514 | registered as a web application listener bean. The value is the fully qualified classname of the listener class. |
| 515 | |
| 516 | |
| 517 | Used in: listener |
| 518 | --> |
| 519 | <!ELEMENT listener-class (#PCDATA)> |
| 520 | |
| 521 | <!-- |
| 522 | The load-on-startup element indicates that this servlet should be |
| 523 | loaded (instantiated and have its init() called) on the startup |
| 524 | of the web application. The optional contents of |
| 525 | these element must be an integer indicating the order in which |
| 526 | the servlet should be loaded. If the value is a negative integer, |
| 527 | or the element is not present, the container is free to load the |
| 528 | servlet whenever it chooses. If the value is a positive integer |
| 529 | or 0, the container must load and initialize the servlet as the |
| 530 | application is deployed. The container must guarantee that |
| 531 | servlets marked with lower integers are loaded before servlets |
| 532 | marked with higher integers. The container may choose the order |
| 533 | of loading of servlets with the same load-on-start-up value. |
| 534 | |
| 535 | Used in: servlet |
| 536 | --> |
| 537 | <!ELEMENT load-on-startup (#PCDATA)> |
| 538 | |
| 539 | <!-- |
| 540 | |
| 541 | The local element contains the fully-qualified name of the |
| 542 | enterprise bean's local interface. |
| 543 | |
| 544 | Used in: ejb-local-ref |
| 545 | |
| 546 | --> |
| 547 | <!ELEMENT local (#PCDATA)> |
| 548 | |
| 549 | <!-- |
| 550 | |
| 551 | The local-home element contains the fully-qualified name of the |
| 552 | enterprise bean's local home interface. |
| 553 | |
| 554 | Used in: ejb-local-ref |
| 555 | --> |
| 556 | <!ELEMENT local-home (#PCDATA)> |
| 557 | |
| 558 | <!-- |
| 559 | The location element contains the location of the resource in the web |
| 560 | application relative to the root of the web application. The value of |
| 561 | the location must have a leading `/'. |
| 562 | |
| 563 | Used in: error-page |
| 564 | --> |
| 565 | <!ELEMENT location (#PCDATA)> |
| 566 | |
| 567 | <!-- |
| 568 | The login-config element is used to configure the authentication |
| 569 | method that should be used, the realm name that should be used for |
| 570 | this application, and the attributes that are needed by the form login |
| 571 | mechanism. |
| 572 | |
| 573 | Used in: web-app |
| 574 | --> |
| 575 | <!ELEMENT login-config (auth-method?, realm-name?, form-login-config?)> |
| 576 | |
| 577 | <!-- |
| 578 | The mime-mapping element defines a mapping between an extension |
| 579 | and a mime type. |
| 580 | |
| 581 | Used in: web-app |
| 582 | --> |
| 583 | <!ELEMENT mime-mapping (extension, mime-type)> |
| 584 | |
| 585 | <!-- |
| 586 | The mime-type element contains a defined mime type. example: |
| 587 | "text/plain" |
| 588 | |
| 589 | Used in: mime-mapping |
| 590 | --> |
| 591 | <!ELEMENT mime-type (#PCDATA)> |
| 592 | |
| 593 | <!-- |
| 594 | The param-name element contains the name of a parameter. Each parameter |
| 595 | name must be unique in the web application. |
| 596 | |
| 597 | |
| 598 | Used in: context-param, init-param |
| 599 | --> |
| 600 | <!ELEMENT param-name (#PCDATA)> |
| 601 | |
| 602 | <!-- |
| 603 | The param-value element contains the value of a parameter. |
| 604 | |
| 605 | Used in: context-param, init-param |
| 606 | --> |
| 607 | <!ELEMENT param-value (#PCDATA)> |
| 608 | |
| 609 | <!-- |
| 610 | The realm name element specifies the realm name to use in HTTP |
| 611 | Basic authorization. |
| 612 | |
| 613 | Used in: login-config |
| 614 | --> |
| 615 | <!ELEMENT realm-name (#PCDATA)> |
| 616 | |
| 617 | <!-- |
| 618 | The remote element contains the fully-qualified name of the enterprise |
| 619 | bean's remote interface. |
| 620 | |
| 621 | Used in: ejb-ref |
| 622 | |
| 623 | Example: |
| 624 | |
| 625 | <remote>com.wombat.empl.EmployeeService</remote> |
| 626 | --> |
| 627 | <!ELEMENT remote (#PCDATA)> |
| 628 | |
| 629 | <!-- |
| 630 | The res-auth element specifies whether the web application code signs |
| 631 | on programmatically to the resource manager, or whether the Container |
| 632 | will sign on to the resource manager on behalf of the web application. In the |
| 633 | latter case, the Container uses information that is supplied by the |
| 634 | Deployer. |
| 635 | |
| 636 | The value of this element must be one of the two following: |
| 637 | |
| 638 | <res-auth>Application</res-auth> |
| 639 | <res-auth>Container</res-auth> |
| 640 | |
| 641 | Used in: resource-ref |
| 642 | --> |
| 643 | <!ELEMENT res-auth (#PCDATA)> |
| 644 | |
| 645 | <!-- |
| 646 | The res-ref-name element specifies the name of a resource manager |
| 647 | connection factory reference. The name is a JNDI name relative to the |
| 648 | java:comp/env context. The name must be unique within a web application. |
| 649 | |
| 650 | Used in: resource-ref |
| 651 | --> |
| 652 | <!ELEMENT res-ref-name (#PCDATA)> |
| 653 | |
| 654 | <!-- |
| 655 | The res-sharing-scope element specifies whether connections obtained |
| 656 | through the given resource manager connection factory reference can be |
| 657 | shared. The value of this element, if specified, must be one of the |
| 658 | two following: |
| 659 | |
| 660 | <res-sharing-scope>Shareable</res-sharing-scope> |
| 661 | <res-sharing-scope>Unshareable</res-sharing-scope> |
| 662 | |
| 663 | The default value is Shareable. |
| 664 | |
| 665 | Used in: resource-ref |
| 666 | --> |
| 667 | <!ELEMENT res-sharing-scope (#PCDATA)> |
| 668 | |
| 669 | <!-- |
| 670 | The res-type element specifies the type of the data source. The type |
| 671 | is specified by the fully qualified Java language class or interface |
| 672 | expected to be implemented by the data source. |
| 673 | |
| 674 | Used in: resource-ref |
| 675 | --> |
| 676 | <!ELEMENT res-type (#PCDATA)> |
| 677 | |
| 678 | <!-- |
| 679 | The resource-env-ref element contains a declaration of a web application's |
| 680 | reference to an administered object associated with a resource |
| 681 | in the web application's environment. It consists of an optional |
| 682 | description, the resource environment reference name, and an |
| 683 | indication of the resource environment reference type expected by |
| 684 | the web application code. |
| 685 | |
| 686 | Used in: web-app |
| 687 | |
| 688 | Example: |
| 689 | |
| 690 | <resource-env-ref> |
| 691 | <resource-env-ref-name>jms/StockQueue</resource-env-ref-name> |
| 692 | <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type> |
| 693 | </resource-env-ref> |
| 694 | --> |
| 695 | <!ELEMENT resource-env-ref (description?, resource-env-ref-name, |
| 696 | resource-env-ref-type)> |
| 697 | |
| 698 | <!-- |
| 699 | The resource-env-ref-name element specifies the name of a resource |
| 700 | environment reference; its value is the environment entry name used in |
| 701 | the web application code. The name is a JNDI name relative to the |
| 702 | java:comp/env context and must be unique within a web application. |
| 703 | |
| 704 | Used in: resource-env-ref |
| 705 | --> |
| 706 | <!ELEMENT resource-env-ref-name (#PCDATA)> |
| 707 | |
| 708 | <!-- |
| 709 | The resource-env-ref-type element specifies the type of a resource |
| 710 | environment reference. It is the fully qualified name of a Java |
| 711 | language class or interface. |
| 712 | |
| 713 | Used in: resource-env-ref |
| 714 | --> |
| 715 | <!ELEMENT resource-env-ref-type (#PCDATA)> |
| 716 | |
| 717 | <!-- |
| 718 | The resource-ref element contains a declaration of a web application's |
| 719 | reference to an external resource. It consists of an optional |
| 720 | description, the resource manager connection factory reference name, |
| 721 | the indication of the resource manager connection factory type |
| 722 | expected by the web application code, the type of authentication |
| 723 | (Application or Container), and an optional specification of the |
| 724 | shareability of connections obtained from the resource (Shareable or |
| 725 | Unshareable). |
| 726 | |
| 727 | Used in: web-app |
| 728 | |
| 729 | Example: |
| 730 | |
| 731 | <resource-ref> |
| 732 | <res-ref-name>jdbc/EmployeeAppDB</res-ref-name> |
| 733 | <res-type>javax.sql.DataSource</res-type> |
| 734 | <res-auth>Container</res-auth> |
| 735 | <res-sharing-scope>Shareable</res-sharing-scope> |
| 736 | </resource-ref> |
| 737 | --> |
| 738 | <!ELEMENT resource-ref (description?, res-ref-name, res-type, res-auth, |
| 739 | res-sharing-scope?)> |
| 740 | |
| 741 | <!-- |
| 742 | The role-link element is a reference to a defined security role. The |
| 743 | role-link element must contain the name of one of the security roles |
| 744 | defined in the security-role elements. |
| 745 | |
| 746 | Used in: security-role-ref |
| 747 | --> |
| 748 | <!ELEMENT role-link (#PCDATA)> |
| 749 | |
| 750 | <!-- |
| 751 | The role-name element contains the name of a security role. |
| 752 | |
| 753 | The name must conform to the lexical rules for an NMTOKEN. |
| 754 | |
| 755 | Used in: auth-constraint, run-as, security-role, security-role-ref |
| 756 | --> |
| 757 | <!ELEMENT role-name (#PCDATA)> |
| 758 | |
| 759 | <!-- |
| 760 | The run-as element specifies the run-as identity to be used for the |
| 761 | execution of the web application. It contains an optional description, and |
| 762 | the name of a security role. |
| 763 | |
| 764 | Used in: servlet |
| 765 | --> |
| 766 | <!ELEMENT run-as (description?, role-name)> |
| 767 | |
| 768 | <!-- |
| 769 | The security-constraint element is used to associate security |
| 770 | constraints with one or more web resource collections |
| 771 | |
| 772 | Used in: web-app |
| 773 | --> |
| 774 | <!ELEMENT security-constraint (display-name?, web-resource-collection+, |
| 775 | auth-constraint?, user-data-constraint?)> |
| 776 | |
| 777 | <!-- |
| 778 | The security-role element contains the definition of a security |
| 779 | role. The definition consists of an optional description of the |
| 780 | security role, and the security role name. |
| 781 | |
| 782 | Used in: web-app |
| 783 | |
| 784 | Example: |
| 785 | |
| 786 | <security-role> |
| 787 | <description> |
| 788 | This role includes all employees who are authorized |
| 789 | to access the employee service application. |
| 790 | </description> |
| 791 | <role-name>employee</role-name> |
| 792 | </security-role> |
| 793 | --> |
| 794 | <!ELEMENT security-role (description?, role-name)> |
| 795 | |
| 796 | <!-- |
| 797 | The security-role-ref element contains the declaration of a security |
| 798 | role reference in the web application's code. The declaration consists |
| 799 | of an optional description, the security role name used in the code, |
| 800 | and an optional link to a security role. If the security role is not |
| 801 | specified, the Deployer must choose an appropriate security role. |
| 802 | |
| 803 | The value of the role-name element must be the String used as the |
| 804 | parameter to the EJBContext.isCallerInRole(String roleName) method |
| 805 | or the HttpServletRequest.isUserInRole(String role) method. |
| 806 | |
| 807 | Used in: servlet |
| 808 | |
| 809 | --> |
| 810 | <!ELEMENT security-role-ref (description?, role-name, role-link?)> |
| 811 | |
| 812 | <!-- |
| 813 | The servlet element contains the declarative data of a |
| 814 | servlet. If a jsp-file is specified and the load-on-startup element is |
| 815 | present, then the JSP should be precompiled and loaded. |
| 816 | |
| 817 | Used in: web-app |
| 818 | --> |
| 819 | <!ELEMENT servlet (icon?, servlet-name, display-name?, description?, |
| 820 | (servlet-class|jsp-file), init-param*, load-on-startup?, run-as?, security-role-ref*)> |
| 821 | |
| 822 | <!-- |
| 823 | The servlet-class element contains the fully qualified class name |
| 824 | of the servlet. |
| 825 | |
| 826 | Used in: servlet |
| 827 | --> |
| 828 | <!ELEMENT servlet-class (#PCDATA)> |
| 829 | |
| 830 | <!-- |
| 831 | The servlet-mapping element defines a mapping between a servlet |
| 832 | and a url pattern |
| 833 | |
| 834 | Used in: web-app |
| 835 | --> |
| 836 | <!ELEMENT servlet-mapping (servlet-name, url-pattern)> |
| 837 | |
| 838 | <!-- |
| 839 | The servlet-name element contains the canonical name of the |
| 840 | servlet. Each servlet name is unique within the web application. |
| 841 | |
| 842 | Used in: filter-mapping, servlet, servlet-mapping |
| 843 | --> |
| 844 | <!ELEMENT servlet-name (#PCDATA)> |
| 845 | |
| 846 | <!-- |
| 847 | The session-config element defines the session parameters for |
| 848 | this web application. |
| 849 | |
| 850 | Used in: web-app |
| 851 | --> |
| 852 | <!ELEMENT session-config (session-timeout?)> |
| 853 | |
| 854 | <!-- |
| 855 | The session-timeout element defines the default session timeout |
| 856 | interval for all sessions created in this web application. The |
| 857 | specified timeout must be expressed in a whole number of minutes. |
| 858 | If the timeout is 0 or less, the container ensures the default |
| 859 | behaviour of sessions is never to time out. |
| 860 | |
| 861 | Used in: session-config |
| 862 | --> |
| 863 | <!ELEMENT session-timeout (#PCDATA)> |
| 864 | |
| 865 | <!-- |
| 866 | The small-icon element contains the name of a file |
| 867 | containing a small (16 x 16) icon image. The file |
| 868 | name is a relative path within the web application's |
| 869 | war file. |
| 870 | |
| 871 | The image may be either in the JPEG or GIF format. |
| 872 | The icon can be used by tools. |
| 873 | |
| 874 | Used in: icon |
| 875 | |
| 876 | Example: |
| 877 | |
| 878 | <small-icon>employee-service-icon16x16.jpg</small-icon> |
| 879 | --> |
| 880 | <!ELEMENT small-icon (#PCDATA)> |
| 881 | |
| 882 | <!-- |
| 883 | The taglib element is used to describe a JSP tag library. |
| 884 | |
| 885 | Used in: web-app |
| 886 | --> |
| 887 | <!ELEMENT taglib (taglib-uri, taglib-location)> |
| 888 | |
| 889 | <!-- |
| 890 | the taglib-location element contains the location (as a resource |
| 891 | relative to the root of the web application) where to find the Tag |
| 892 | Libary Description file for the tag library. |
| 893 | |
| 894 | Used in: taglib |
| 895 | --> |
| 896 | <!ELEMENT taglib-location (#PCDATA)> |
| 897 | |
| 898 | <!-- |
| 899 | The taglib-uri element describes a URI, relative to the location |
| 900 | of the web.xml document, identifying a Tag Library used in the Web |
| 901 | Application. |
| 902 | |
| 903 | Used in: taglib |
| 904 | --> |
| 905 | <!ELEMENT taglib-uri (#PCDATA)> |
| 906 | |
| 907 | <!-- |
| 908 | The transport-guarantee element specifies that the communication |
| 909 | between client and server should be NONE, INTEGRAL, or |
| 910 | CONFIDENTIAL. NONE means that the application does not require any |
| 911 | transport guarantees. A value of INTEGRAL means that the application |
| 912 | requires that the data sent between the client and server be sent in |
| 913 | such a way that it can't be changed in transit. CONFIDENTIAL means |
| 914 | that the application requires that the data be transmitted in a |
| 915 | fashion that prevents other entities from observing the contents of |
| 916 | the transmission. In most cases, the presence of the INTEGRAL or |
| 917 | CONFIDENTIAL flag will indicate that the use of SSL is required. |
| 918 | |
| 919 | Used in: user-data-constraint |
| 920 | --> |
| 921 | <!ELEMENT transport-guarantee (#PCDATA)> |
| 922 | |
| 923 | <!-- |
| 924 | The url-pattern element contains the url pattern of the mapping. Must |
| 925 | follow the rules specified in Section 11.2 of the Servlet API |
| 926 | Specification. |
| 927 | |
| 928 | Used in: filter-mapping, servlet-mapping, web-resource-collection |
| 929 | --> |
| 930 | <!ELEMENT url-pattern (#PCDATA)> |
| 931 | |
| 932 | <!-- |
| 933 | The user-data-constraint element is used to indicate how data |
| 934 | communicated between the client and container should be protected. |
| 935 | |
| 936 | Used in: security-constraint |
| 937 | --> |
| 938 | <!ELEMENT user-data-constraint (description?, transport-guarantee)> |
| 939 | |
| 940 | <!-- |
| 941 | The web-resource-collection element is used to identify a subset |
| 942 | of the resources and HTTP methods on those resources within a web |
| 943 | application to which a security constraint applies. If no HTTP methods |
| 944 | are specified, then the security constraint applies to all HTTP |
| 945 | methods. |
| 946 | |
| 947 | Used in: security-constraint |
| 948 | --> |
| 949 | <!ELEMENT web-resource-collection (web-resource-name, description?, |
| 950 | url-pattern*, http-method*)> |
| 951 | |
| 952 | <!-- |
| 953 | The web-resource-name contains the name of this web resource |
| 954 | collection. |
| 955 | |
| 956 | Used in: web-resource-collection |
| 957 | --> |
| 958 | <!ELEMENT web-resource-name (#PCDATA)> |
| 959 | |
| 960 | <!-- |
| 961 | The welcome-file element contains file name to use as a default |
| 962 | welcome file, such as index.html |
| 963 | |
| 964 | Used in: welcome-file-list |
| 965 | --> |
| 966 | <!ELEMENT welcome-file (#PCDATA)> |
| 967 | |
| 968 | <!-- |
| 969 | The welcome-file-list contains an ordered list of welcome files |
| 970 | elements. |
| 971 | |
| 972 | Used in: web-app |
| 973 | --> |
| 974 | <!ELEMENT welcome-file-list (welcome-file+)> |
| 975 | |
| 976 | <!-- |
| 977 | The ID mechanism is to allow tools that produce additional deployment |
| 978 | information (i.e., information beyond the standard deployment |
| 979 | descriptor information) to store the non-standard information in a |
| 980 | separate file, and easily refer from these tool-specific files to the |
| 981 | information in the standard deployment descriptor. |
| 982 | |
| 983 | Tools are not allowed to add the non-standard information into the |
| 984 | standard deployment descriptor. |
| 985 | --> |
| 986 | |
| 987 | <!ATTLIST auth-constraint id ID #IMPLIED> |
| 988 | <!ATTLIST auth-method id ID #IMPLIED> |
| 989 | <!ATTLIST context-param id ID #IMPLIED> |
| 990 | <!ATTLIST description id ID #IMPLIED> |
| 991 | <!ATTLIST display-name id ID #IMPLIED> |
| 992 | <!ATTLIST distributable id ID #IMPLIED> |
| 993 | <!ATTLIST ejb-link id ID #IMPLIED> |
| 994 | <!ATTLIST ejb-local-ref id ID #IMPLIED> |
| 995 | <!ATTLIST ejb-ref id ID #IMPLIED> |
| 996 | <!ATTLIST ejb-ref-name id ID #IMPLIED> |
| 997 | <!ATTLIST ejb-ref-type id ID #IMPLIED> |
| 998 | <!ATTLIST env-entry id ID #IMPLIED> |
| 999 | <!ATTLIST env-entry-name id ID #IMPLIED> |
| 1000 | <!ATTLIST env-entry-type id ID #IMPLIED> |
| 1001 | <!ATTLIST env-entry-value id ID #IMPLIED> |
| 1002 | <!ATTLIST error-code id ID #IMPLIED> |
| 1003 | <!ATTLIST error-page id ID #IMPLIED> |
| 1004 | <!ATTLIST exception-type id ID #IMPLIED> |
| 1005 | <!ATTLIST extension id ID #IMPLIED> |
| 1006 | <!ATTLIST filter id ID #IMPLIED> |
| 1007 | <!ATTLIST filter-class id ID #IMPLIED> |
| 1008 | <!ATTLIST filter-mapping id ID #IMPLIED> |
| 1009 | <!ATTLIST filter-name id ID #IMPLIED> |
| 1010 | <!ATTLIST form-error-page id ID #IMPLIED> |
| 1011 | <!ATTLIST form-login-config id ID #IMPLIED> |
| 1012 | <!ATTLIST form-login-page id ID #IMPLIED> |
| 1013 | <!ATTLIST home id ID #IMPLIED> |
| 1014 | <!ATTLIST http-method id ID #IMPLIED> |
| 1015 | <!ATTLIST icon id ID #IMPLIED> |
| 1016 | <!ATTLIST init-param id ID #IMPLIED> |
| 1017 | <!ATTLIST jsp-file id ID #IMPLIED> |
| 1018 | <!ATTLIST large-icon id ID #IMPLIED> |
| 1019 | <!ATTLIST listener id ID #IMPLIED> |
| 1020 | <!ATTLIST listener-class id ID #IMPLIED> |
| 1021 | <!ATTLIST load-on-startup id ID #IMPLIED> |
| 1022 | <!ATTLIST local id ID #IMPLIED> |
| 1023 | <!ATTLIST local-home id ID #IMPLIED> |
| 1024 | <!ATTLIST location id ID #IMPLIED> |
| 1025 | <!ATTLIST login-config id ID #IMPLIED> |
| 1026 | <!ATTLIST mime-mapping id ID #IMPLIED> |
| 1027 | <!ATTLIST mime-type id ID #IMPLIED> |
| 1028 | <!ATTLIST param-name id ID #IMPLIED> |
| 1029 | <!ATTLIST param-value id ID #IMPLIED> |
| 1030 | <!ATTLIST realm-name id ID #IMPLIED> |
| 1031 | <!ATTLIST remote id ID #IMPLIED> |
| 1032 | <!ATTLIST res-auth id ID #IMPLIED> |
| 1033 | <!ATTLIST res-ref-name id ID #IMPLIED> |
| 1034 | <!ATTLIST res-sharing-scope id ID #IMPLIED> |
| 1035 | <!ATTLIST res-type id ID #IMPLIED> |
| 1036 | <!ATTLIST resource-env-ref id ID #IMPLIED> |
| 1037 | <!ATTLIST resource-env-ref-name id ID #IMPLIED> |
| 1038 | <!ATTLIST resource-env-ref-type id ID #IMPLIED> |
| 1039 | <!ATTLIST resource-ref id ID #IMPLIED> |
| 1040 | <!ATTLIST role-link id ID #IMPLIED> |
| 1041 | <!ATTLIST role-name id ID #IMPLIED> |
| 1042 | <!ATTLIST run-as id ID #IMPLIED> |
| 1043 | <!ATTLIST security-constraint id ID #IMPLIED> |
| 1044 | <!ATTLIST security-role id ID #IMPLIED> |
| 1045 | <!ATTLIST security-role-ref id ID #IMPLIED> |
| 1046 | <!ATTLIST servlet id ID #IMPLIED> |
| 1047 | <!ATTLIST servlet-class id ID #IMPLIED> |
| 1048 | <!ATTLIST servlet-mapping id ID #IMPLIED> |
| 1049 | <!ATTLIST servlet-name id ID #IMPLIED> |
| 1050 | <!ATTLIST session-config id ID #IMPLIED> |
| 1051 | <!ATTLIST session-timeout id ID #IMPLIED> |
| 1052 | <!ATTLIST small-icon id ID #IMPLIED> |
| 1053 | <!ATTLIST taglib id ID #IMPLIED> |
| 1054 | <!ATTLIST taglib-location id ID #IMPLIED> |
| 1055 | <!ATTLIST taglib-uri id ID #IMPLIED> |
| 1056 | <!ATTLIST transport-guarantee id ID #IMPLIED> |
| 1057 | <!ATTLIST url-pattern id ID #IMPLIED> |
| 1058 | <!ATTLIST user-data-constraint id ID #IMPLIED> |
| 1059 | <!ATTLIST web-app id ID #IMPLIED> |
| 1060 | <!ATTLIST web-resource-collection id ID #IMPLIED> |
| 1061 | <!ATTLIST web-resource-name id ID #IMPLIED> |
| 1062 | <!ATTLIST welcome-file id ID #IMPLIED> |
| 1063 | <!ATTLIST welcome-file-list id ID #IMPLIED> |