web-app_2_3.dtd 33 KB

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