web-app_2_4.xsd 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <xsd:schema xmlns="http://www.w3.org/2001/XMLSchema"
  3. targetNamespace="http://java.sun.com/xml/ns/j2ee"
  4. xmlns:j2ee="http://java.sun.com/xml/ns/j2ee"
  5. xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  6. elementFormDefault="qualified"
  7. attributeFormDefault="unqualified"
  8. version="2.4">
  9. <xsd:annotation>
  10. <xsd:documentation>
  11. @(#)web-app_2_4.xsds 1.60 03/08/26
  12. </xsd:documentation>
  13. </xsd:annotation>
  14. <xsd:annotation>
  15. <xsd:documentation>
  16. Copyright 2004 Sun Microsystems, Inc., 901 San Antonio
  17. Road, Palo Alto, California 94303, U.S.A. All rights
  18. reserved.
  19. Sun Microsystems, Inc. has intellectual property rights
  20. relating to technology described in this document. In
  21. particular, and without limitation, these intellectual
  22. property rights may include one or more of the U.S. patents
  23. listed at http://www.sun.com/patents and one or more
  24. additional patents or pending patent applications in the
  25. U.S. and other countries.
  26. This document and the technology which it describes are
  27. distributed under licenses restricting their use, copying,
  28. distribution, and decompilation. No part of this document
  29. may be reproduced in any form by any means without prior
  30. written authorization of Sun and its licensors, if any.
  31. Third-party software, including font technology, is
  32. copyrighted and licensed from Sun suppliers.
  33. Sun, Sun Microsystems, the Sun logo, Solaris, Java, J2EE,
  34. JavaServer Pages, Enterprise JavaBeans and the Java Coffee
  35. Cup logo are trademarks or registered trademarks of Sun
  36. Microsystems, Inc. in the U.S. and other countries.
  37. Federal Acquisitions: Commercial Software - Government Users
  38. Subject to Standard License Terms and Conditions.
  39. </xsd:documentation>
  40. </xsd:annotation>
  41. <xsd:annotation>
  42. <xsd:documentation>
  43. <![CDATA[
  44. This is the XML Schema for the Servlet 2.4 deployment descriptor.
  45. The deployment descriptor must be named "WEB-INF/web.xml" in the
  46. web application's war file. All Servlet deployment descriptors
  47. must indicate the web application schema by using the J2EE
  48. namespace:
  49. http://java.sun.com/xml/ns/j2ee
  50. and by indicating the version of the schema by
  51. using the version element as shown below:
  52. <web-app xmlns="http://java.sun.com/xml/ns/j2ee"
  53. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  54. xsi:schemaLocation="..."
  55. version="2.4">
  56. ...
  57. </web-app>
  58. The instance documents may indicate the published version of
  59. the schema using the xsi:schemaLocation attribute for J2EE
  60. namespace with the following location:
  61. http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd
  62. ]]>
  63. </xsd:documentation>
  64. </xsd:annotation>
  65. <xsd:annotation>
  66. <xsd:documentation>
  67. The following conventions apply to all J2EE
  68. deployment descriptor elements unless indicated otherwise.
  69. - In elements that specify a pathname to a file within the
  70. same JAR file, relative filenames (i.e., those not
  71. starting with "/") are considered relative to the root of
  72. the JAR file's namespace. Absolute filenames (i.e., those
  73. starting with "/") also specify names in the root of the
  74. JAR file's namespace. In general, relative names are
  75. preferred. The exception is .war files where absolute
  76. names are preferred for consistency with the Servlet API.
  77. </xsd:documentation>
  78. </xsd:annotation>
  79. <xsd:include schemaLocation="j2ee_1_4.xsd"/>
  80. <xsd:include schemaLocation="jsp_2_0.xsd"/>
  81. <!-- **************************************************** -->
  82. <xsd:element name="web-app" type="j2ee:web-appType">
  83. <xsd:annotation>
  84. <xsd:documentation>
  85. The web-app element is the root of the deployment
  86. descriptor for a web application. Note that the sub-elements
  87. of this element can be in the arbitrary order. Because of
  88. that, the multiplicity of the elements of distributable,
  89. session-config, welcome-file-list, jsp-config, login-config,
  90. and locale-encoding-mapping-list was changed from "?" to "*"
  91. in this schema. However, the deployment descriptor instance
  92. file must not contain multiple elements of session-config,
  93. jsp-config, and login-config. When there are multiple elements of
  94. welcome-file-list or locale-encoding-mapping-list, the container
  95. must concatinate the element contents. The multiple occurance
  96. of the element distributable is redundant and the container
  97. treats that case exactly in the same way when there is only
  98. one distributable.
  99. </xsd:documentation>
  100. </xsd:annotation>
  101. <xsd:unique name="web-app-servlet-name-uniqueness">
  102. <xsd:annotation>
  103. <xsd:documentation>
  104. The servlet element contains the name of a servlet.
  105. The name must be unique within the web application.
  106. </xsd:documentation>
  107. </xsd:annotation>
  108. <xsd:selector xpath="j2ee:servlet"/>
  109. <xsd:field xpath="j2ee:servlet-name"/>
  110. </xsd:unique>
  111. <xsd:unique name="web-app-filter-name-uniqueness">
  112. <xsd:annotation>
  113. <xsd:documentation>
  114. The filter element contains the name of a filter.
  115. The name must be unique within the web application.
  116. </xsd:documentation>
  117. </xsd:annotation>
  118. <xsd:selector xpath="j2ee:filter"/>
  119. <xsd:field xpath="j2ee:filter-name"/>
  120. </xsd:unique>
  121. <xsd:unique name="web-app-ejb-local-ref-name-uniqueness">
  122. <xsd:annotation>
  123. <xsd:documentation>
  124. The ejb-local-ref-name element contains the name of an EJB
  125. reference. The EJB reference is an entry in the web
  126. application's environment and is relative to the
  127. java:comp/env context. The name must be unique within
  128. the web application.
  129. It is recommended that name is prefixed with "ejb/".
  130. </xsd:documentation>
  131. </xsd:annotation>
  132. <xsd:selector xpath="j2ee:ejb-local-ref"/>
  133. <xsd:field xpath="j2ee:ejb-ref-name"/>
  134. </xsd:unique>
  135. <xsd:unique name="web-app-ejb-ref-name-uniqueness">
  136. <xsd:annotation>
  137. <xsd:documentation>
  138. The ejb-ref-name element contains the name of an EJB
  139. reference. The EJB reference is an entry in the web
  140. application's environment and is relative to the
  141. java:comp/env context. The name must be unique within
  142. the web application.
  143. It is recommended that name is prefixed with "ejb/".
  144. </xsd:documentation>
  145. </xsd:annotation>
  146. <xsd:selector xpath="j2ee:ejb-ref"/>
  147. <xsd:field xpath="j2ee:ejb-ref-name"/>
  148. </xsd:unique>
  149. <xsd:unique name="web-app-resource-env-ref-uniqueness">
  150. <xsd:annotation>
  151. <xsd:documentation>
  152. The resource-env-ref-name element specifies the name of
  153. a resource environment reference; its value is the
  154. environment entry name used in the web application code.
  155. The name is a JNDI name relative to the java:comp/env
  156. context and must be unique within a web application.
  157. </xsd:documentation>
  158. </xsd:annotation>
  159. <xsd:selector xpath="j2ee:resource-env-ref"/>
  160. <xsd:field xpath="j2ee:resource-env-ref-name"/>
  161. </xsd:unique>
  162. <xsd:unique name="web-app-message-destination-ref-uniqueness">
  163. <xsd:annotation>
  164. <xsd:documentation>
  165. The message-destination-ref-name element specifies the name of
  166. a message destination reference; its value is the
  167. environment entry name used in the web application code.
  168. The name is a JNDI name relative to the java:comp/env
  169. context and must be unique within a web application.
  170. </xsd:documentation>
  171. </xsd:annotation>
  172. <xsd:selector xpath="j2ee:message-destination-ref"/>
  173. <xsd:field xpath="j2ee:message-destination-ref-name"/>
  174. </xsd:unique>
  175. <xsd:unique name="web-app-res-ref-name-uniqueness">
  176. <xsd:annotation>
  177. <xsd:documentation>
  178. The res-ref-name element specifies the name of a
  179. resource manager connection factory reference. The name
  180. is a JNDI name relative to the java:comp/env context.
  181. The name must be unique within a web application.
  182. </xsd:documentation>
  183. </xsd:annotation>
  184. <xsd:selector xpath="j2ee:resource-ref"/>
  185. <xsd:field xpath="j2ee:res-ref-name"/>
  186. </xsd:unique>
  187. <xsd:unique name="web-app-env-entry-name-uniqueness">
  188. <xsd:annotation>
  189. <xsd:documentation>
  190. The env-entry-name element contains the name of a web
  191. application's environment entry. The name is a JNDI
  192. name relative to the java:comp/env context. The name
  193. must be unique within a web application.
  194. </xsd:documentation>
  195. </xsd:annotation>
  196. <xsd:selector xpath="j2ee:env-entry"/>
  197. <xsd:field xpath="j2ee:env-entry-name"/>
  198. </xsd:unique>
  199. <xsd:key name="web-app-role-name-key">
  200. <xsd:annotation>
  201. <xsd:documentation>
  202. A role-name-key is specified to allow the references
  203. from the security-role-refs.
  204. </xsd:documentation>
  205. </xsd:annotation>
  206. <xsd:selector xpath="j2ee:security-role"/>
  207. <xsd:field xpath="j2ee:role-name"/>
  208. </xsd:key>
  209. <xsd:keyref name="web-app-role-name-references"
  210. refer="j2ee:web-app-role-name-key">
  211. <xsd:annotation>
  212. <xsd:documentation>
  213. The keyref indicates the references from
  214. security-role-ref to a specified role-name.
  215. </xsd:documentation>
  216. </xsd:annotation>
  217. <xsd:selector xpath="j2ee:servlet/j2ee:security-role-ref"/>
  218. <xsd:field xpath="j2ee:role-link"/>
  219. </xsd:keyref>
  220. </xsd:element>
  221. <!-- **************************************************** -->
  222. <xsd:complexType name="auth-constraintType">
  223. <xsd:annotation>
  224. <xsd:documentation>
  225. The auth-constraintType indicates the user roles that
  226. should be permitted access to this resource
  227. collection. The role-name used here must either correspond
  228. to the role-name of one of the security-role elements
  229. defined for this web application, or be the specially
  230. reserved role-name "*" that is a compact syntax for
  231. indicating all roles in the web application. If both "*"
  232. and rolenames appear, the container interprets this as all
  233. roles. If no roles are defined, no user is allowed access
  234. to the portion of the web application described by the
  235. containing security-constraint. The container matches
  236. role names case sensitively when determining access.
  237. </xsd:documentation>
  238. </xsd:annotation>
  239. <xsd:sequence>
  240. <xsd:element name="description"
  241. type="j2ee:descriptionType"
  242. minOccurs="0" maxOccurs="unbounded"/>
  243. <xsd:element name="role-name"
  244. type="j2ee:role-nameType"
  245. minOccurs="0" maxOccurs="unbounded"/>
  246. </xsd:sequence>
  247. <xsd:attribute name="id" type="xsd:ID"/>
  248. </xsd:complexType>
  249. <!-- **************************************************** -->
  250. <xsd:complexType name="auth-methodType">
  251. <xsd:annotation>
  252. <xsd:documentation>
  253. The auth-methodType is used to configure the authentication
  254. mechanism for the web application. As a prerequisite to
  255. gaining access to any web resources which are protected by
  256. an authorization constraint, a user must have authenticated
  257. using the configured mechanism. Legal values are "BASIC",
  258. "DIGEST", "FORM", "CLIENT-CERT", or a vendor-specific
  259. authentication scheme.
  260. Used in: login-config
  261. </xsd:documentation>
  262. </xsd:annotation>
  263. <xsd:simpleContent>
  264. <xsd:restriction base="j2ee:string"/>
  265. </xsd:simpleContent>
  266. </xsd:complexType>
  267. <!-- **************************************************** -->
  268. <xsd:complexType name="dispatcherType">
  269. <xsd:annotation>
  270. <xsd:documentation>
  271. The dispatcher has four legal values: FORWARD, REQUEST, INCLUDE,
  272. and ERROR. A value of FORWARD means the Filter will be applied
  273. under RequestDispatcher.forward() calls. A value of REQUEST
  274. means the Filter will be applied under ordinary client calls to
  275. the path or servlet. A value of INCLUDE means the Filter will be
  276. applied under RequestDispatcher.include() calls. A value of
  277. ERROR means the Filter will be applied under the error page
  278. mechanism. The absence of any dispatcher elements in a
  279. filter-mapping indicates a default of applying filters only under
  280. ordinary client calls to the path or servlet.
  281. </xsd:documentation>
  282. </xsd:annotation>
  283. <xsd:simpleContent>
  284. <xsd:restriction base="j2ee:string">
  285. <xsd:enumeration value="FORWARD"/>
  286. <xsd:enumeration value="INCLUDE"/>
  287. <xsd:enumeration value="REQUEST"/>
  288. <xsd:enumeration value="ERROR"/>
  289. </xsd:restriction>
  290. </xsd:simpleContent>
  291. </xsd:complexType>
  292. <!-- **************************************************** -->
  293. <xsd:simpleType name="encodingType">
  294. <xsd:annotation>
  295. <xsd:documentation>
  296. The encodingType defines IANA character sets.
  297. </xsd:documentation>
  298. </xsd:annotation>
  299. <xsd:restriction base="xsd:string">
  300. <xsd:pattern value="[^\s]+"/>
  301. </xsd:restriction>
  302. </xsd:simpleType>
  303. <!-- **************************************************** -->
  304. <xsd:complexType name="error-codeType">
  305. <xsd:annotation>
  306. <xsd:documentation>
  307. The error-code contains an HTTP error code, ex: 404
  308. Used in: error-page
  309. </xsd:documentation>
  310. </xsd:annotation>
  311. <xsd:simpleContent>
  312. <xsd:restriction base="j2ee:xsdPositiveIntegerType">
  313. <xsd:pattern value="\d{3}"/>
  314. <xsd:attribute name="id" type="xsd:ID"/>
  315. </xsd:restriction>
  316. </xsd:simpleContent>
  317. </xsd:complexType>
  318. <!-- **************************************************** -->
  319. <xsd:complexType name="error-pageType">
  320. <xsd:annotation>
  321. <xsd:documentation>
  322. The error-pageType contains a mapping between an error code
  323. or exception type to the path of a resource in the web
  324. application.
  325. Used in: web-app
  326. </xsd:documentation>
  327. </xsd:annotation>
  328. <xsd:sequence>
  329. <xsd:choice>
  330. <xsd:element name="error-code"
  331. type="j2ee:error-codeType"/>
  332. <xsd:element name="exception-type"
  333. type="j2ee:fully-qualified-classType">
  334. <xsd:annotation>
  335. <xsd:documentation>
  336. The exception-type contains a fully qualified class
  337. name of a Java exception type.
  338. </xsd:documentation>
  339. </xsd:annotation>
  340. </xsd:element>
  341. </xsd:choice>
  342. <xsd:element name="location"
  343. type="j2ee:war-pathType">
  344. <xsd:annotation>
  345. <xsd:documentation>
  346. The location element contains the location of the
  347. resource in the web application relative to the root of
  348. the web application. The value of the location must have
  349. a leading `/'.
  350. </xsd:documentation>
  351. </xsd:annotation>
  352. </xsd:element>
  353. </xsd:sequence>
  354. <xsd:attribute name="id" type="xsd:ID"/>
  355. </xsd:complexType>
  356. <!-- **************************************************** -->
  357. <xsd:complexType name="filter-mappingType">
  358. <xsd:annotation>
  359. <xsd:documentation>
  360. Declaration of the filter mappings in this web
  361. application is done by using filter-mappingType.
  362. The container uses the filter-mapping
  363. declarations to decide which filters to apply to a request,
  364. and in what order. The container matches the request URI to
  365. a Servlet in the normal way. To determine which filters to
  366. apply it matches filter-mapping declarations either on
  367. servlet-name, or on url-pattern for each filter-mapping
  368. element, depending on which style is used. The order in
  369. which filters are invoked is the order in which
  370. filter-mapping declarations that match a request URI for a
  371. servlet appear in the list of filter-mapping elements.The
  372. filter-name value must be the value of the filter-name
  373. sub-elements of one of the filter declarations in the
  374. deployment descriptor.
  375. </xsd:documentation>
  376. </xsd:annotation>
  377. <xsd:sequence>
  378. <xsd:element name="filter-name"
  379. type="j2ee:filter-nameType"/>
  380. <xsd:choice>
  381. <xsd:element name="url-pattern"
  382. type="j2ee:url-patternType"/>
  383. <xsd:element name="servlet-name"
  384. type="j2ee:servlet-nameType"/>
  385. </xsd:choice>
  386. <xsd:element name="dispatcher"
  387. type="j2ee:dispatcherType"
  388. minOccurs="0" maxOccurs="4"/>
  389. </xsd:sequence>
  390. <xsd:attribute name="id" type="xsd:ID"/>
  391. </xsd:complexType>
  392. <!-- **************************************************** -->
  393. <xsd:complexType name="filter-nameType">
  394. <xsd:annotation>
  395. <xsd:documentation>
  396. The logical name of the filter is declare
  397. by using filter-nameType. This name is used to map the
  398. filter. Each filter name is unique within the web
  399. application.
  400. Used in: filter, filter-mapping
  401. </xsd:documentation>
  402. </xsd:annotation>
  403. <xsd:simpleContent>
  404. <xsd:extension base="j2ee:nonEmptyStringType"/>
  405. </xsd:simpleContent>
  406. </xsd:complexType>
  407. <!-- **************************************************** -->
  408. <xsd:complexType name="filterType">
  409. <xsd:annotation>
  410. <xsd:documentation>
  411. The filterType is used to declare a filter in the web
  412. application. The filter is mapped to either a servlet or a
  413. URL pattern in the filter-mapping element, using the
  414. filter-name value to reference. Filters can access the
  415. initialization parameters declared in the deployment
  416. descriptor at runtime via the FilterConfig interface.
  417. Used in: web-app
  418. </xsd:documentation>
  419. </xsd:annotation>
  420. <xsd:sequence>
  421. <xsd:group ref="j2ee:descriptionGroup"/>
  422. <xsd:element name="filter-name"
  423. type="j2ee:filter-nameType"/>
  424. <xsd:element name="filter-class"
  425. type="j2ee:fully-qualified-classType">
  426. <xsd:annotation>
  427. <xsd:documentation>
  428. The fully qualified classname of the filter.
  429. </xsd:documentation>
  430. </xsd:annotation>
  431. </xsd:element>
  432. <xsd:element name="init-param"
  433. type="j2ee:param-valueType"
  434. minOccurs="0" maxOccurs="unbounded">
  435. <xsd:annotation>
  436. <xsd:documentation>
  437. The init-param element contains a name/value pair as
  438. an initialization param of a servlet filter
  439. </xsd:documentation>
  440. </xsd:annotation>
  441. </xsd:element>
  442. </xsd:sequence>
  443. <xsd:attribute name="id" type="xsd:ID"/>
  444. </xsd:complexType>
  445. <!-- **************************************************** -->
  446. <xsd:complexType name="form-login-configType">
  447. <xsd:annotation>
  448. <xsd:documentation>
  449. The form-login-configType specifies the login and error
  450. pages that should be used in form based login. If form based
  451. authentication is not used, these elements are ignored.
  452. Used in: login-config
  453. </xsd:documentation>
  454. </xsd:annotation>
  455. <xsd:sequence>
  456. <xsd:element name="form-login-page"
  457. type="j2ee:war-pathType">
  458. <xsd:annotation>
  459. <xsd:documentation>
  460. The form-login-page element defines the location in the web
  461. app where the page that can be used for login can be
  462. found. The path begins with a leading / and is interpreted
  463. relative to the root of the WAR.
  464. </xsd:documentation>
  465. </xsd:annotation>
  466. </xsd:element>
  467. <xsd:element name="form-error-page"
  468. type="j2ee:war-pathType">
  469. <xsd:annotation>
  470. <xsd:documentation>
  471. The form-error-page element defines the location in
  472. the web app where the error page that is displayed
  473. when login is not successful can be found.
  474. The path begins with a leading / and is interpreted
  475. relative to the root of the WAR.
  476. </xsd:documentation>
  477. </xsd:annotation>
  478. </xsd:element>
  479. </xsd:sequence>
  480. <xsd:attribute name="id" type="xsd:ID"/>
  481. </xsd:complexType>
  482. <!-- **************************************************** -->
  483. <xsd:complexType name="http-methodType">
  484. <xsd:annotation>
  485. <xsd:documentation>
  486. The http-method contains an HTTP method recognized by the
  487. web-app, for example GET, POST, ...
  488. </xsd:documentation>
  489. </xsd:annotation>
  490. <xsd:simpleContent>
  491. <xsd:restriction base="j2ee:string">
  492. <xsd:enumeration value="GET"/>
  493. <xsd:enumeration value="POST"/>
  494. <xsd:enumeration value="PUT"/>
  495. <xsd:enumeration value="DELETE"/>
  496. <xsd:enumeration value="HEAD"/>
  497. <xsd:enumeration value="OPTIONS"/>
  498. <xsd:enumeration value="TRACE"/>
  499. </xsd:restriction>
  500. </xsd:simpleContent>
  501. </xsd:complexType>
  502. <!-- **************************************************** -->
  503. <xsd:complexType name="locale-encoding-mapping-listType">
  504. <xsd:annotation>
  505. <xsd:documentation>
  506. The locale-encoding-mapping-list contains one or more
  507. locale-encoding-mapping(s).
  508. </xsd:documentation>
  509. </xsd:annotation>
  510. <xsd:sequence>
  511. <xsd:element name="locale-encoding-mapping"
  512. type="j2ee:locale-encoding-mappingType"
  513. maxOccurs="unbounded"/>
  514. </xsd:sequence>
  515. <xsd:attribute name="id" type="xsd:ID"/>
  516. </xsd:complexType>
  517. <!-- **************************************************** -->
  518. <xsd:complexType name="locale-encoding-mappingType">
  519. <xsd:annotation>
  520. <xsd:documentation>
  521. The locale-encoding-mapping contains locale name and
  522. encoding name. The locale name must be either "Language-code",
  523. such as "ja", defined by ISO-639 or "Language-code_Country-code",
  524. such as "ja_JP". "Country code" is defined by ISO-3166.
  525. </xsd:documentation>
  526. </xsd:annotation>
  527. <xsd:sequence>
  528. <xsd:element name="locale"
  529. type="j2ee:localeType"/>
  530. <xsd:element name="encoding"
  531. type="j2ee:encodingType"/>
  532. </xsd:sequence>
  533. <xsd:attribute name="id" type="xsd:ID"/>
  534. </xsd:complexType>
  535. <!-- **************************************************** -->
  536. <xsd:simpleType name="localeType">
  537. <xsd:annotation>
  538. <xsd:documentation>
  539. The localeType defines valid locale defined by ISO-639-1
  540. and ISO-3166.
  541. </xsd:documentation>
  542. </xsd:annotation>
  543. <xsd:restriction base="xsd:string">
  544. <xsd:pattern value="[a-z]{2}(_|-)?([\p{L}\-\p{Nd}]{2})?"/>
  545. </xsd:restriction>
  546. </xsd:simpleType>
  547. <!-- **************************************************** -->
  548. <xsd:complexType name="login-configType">
  549. <xsd:annotation>
  550. <xsd:documentation>
  551. The login-configType is used to configure the authentication
  552. method that should be used, the realm name that should be
  553. used for this application, and the attributes that are
  554. needed by the form login mechanism.
  555. Used in: web-app
  556. </xsd:documentation>
  557. </xsd:annotation>
  558. <xsd:sequence>
  559. <xsd:element name="auth-method"
  560. type="j2ee:auth-methodType"
  561. minOccurs="0"/>
  562. <xsd:element name="realm-name"
  563. type="j2ee:string" minOccurs="0">
  564. <xsd:annotation>
  565. <xsd:documentation>
  566. The realm name element specifies the realm name to
  567. use in HTTP Basic authorization.
  568. </xsd:documentation>
  569. </xsd:annotation>
  570. </xsd:element>
  571. <xsd:element name="form-login-config"
  572. type="j2ee:form-login-configType"
  573. minOccurs="0"/>
  574. </xsd:sequence>
  575. <xsd:attribute name="id" type="xsd:ID"/>
  576. </xsd:complexType>
  577. <!-- **************************************************** -->
  578. <xsd:complexType name="mime-mappingType">
  579. <xsd:annotation>
  580. <xsd:documentation>
  581. The mime-mappingType defines a mapping between an extension
  582. and a mime type.
  583. Used in: web-app
  584. </xsd:documentation>
  585. </xsd:annotation>
  586. <xsd:sequence>
  587. <xsd:annotation>
  588. <xsd:documentation>
  589. The extension element contains a string describing an
  590. extension. example: "txt"
  591. </xsd:documentation>
  592. </xsd:annotation>
  593. <xsd:element name="extension"
  594. type="j2ee:string"/>
  595. <xsd:element name="mime-type"
  596. type="j2ee:mime-typeType"/>
  597. </xsd:sequence>
  598. <xsd:attribute name="id" type="xsd:ID"/>
  599. </xsd:complexType>
  600. <!-- **************************************************** -->
  601. <xsd:complexType name="mime-typeType">
  602. <xsd:annotation>
  603. <xsd:documentation>
  604. The mime-typeType is used to indicate a defined mime type.
  605. Example:
  606. "text/plain"
  607. Used in: mime-mapping
  608. </xsd:documentation>
  609. </xsd:annotation>
  610. <xsd:simpleContent>
  611. <xsd:restriction base="j2ee:string">
  612. <xsd:pattern value="[^\p{Cc}^\s]+/[^\p{Cc}^\s]+"/>
  613. </xsd:restriction>
  614. </xsd:simpleContent>
  615. </xsd:complexType>
  616. <!-- **************************************************** -->
  617. <xsd:complexType name="nonEmptyStringType">
  618. <xsd:annotation>
  619. <xsd:documentation>
  620. This type defines a string which contains at least one
  621. character.
  622. </xsd:documentation>
  623. </xsd:annotation>
  624. <xsd:simpleContent>
  625. <xsd:restriction base="j2ee:string">
  626. <xsd:minLength value="1"/>
  627. </xsd:restriction>
  628. </xsd:simpleContent>
  629. </xsd:complexType>
  630. <!-- **************************************************** -->
  631. <xsd:complexType name="security-constraintType">
  632. <xsd:annotation>
  633. <xsd:documentation>
  634. The security-constraintType is used to associate
  635. security constraints with one or more web resource
  636. collections
  637. Used in: web-app
  638. </xsd:documentation>
  639. </xsd:annotation>
  640. <xsd:sequence>
  641. <xsd:element name="display-name"
  642. type="j2ee:display-nameType"
  643. minOccurs="0"
  644. maxOccurs="unbounded"/>
  645. <xsd:element name="web-resource-collection"
  646. type="j2ee:web-resource-collectionType"
  647. maxOccurs="unbounded"/>
  648. <xsd:element name="auth-constraint"
  649. type="j2ee:auth-constraintType"
  650. minOccurs="0"/>
  651. <xsd:element name="user-data-constraint"
  652. type="j2ee:user-data-constraintType"
  653. minOccurs="0"/>
  654. </xsd:sequence>
  655. <xsd:attribute name="id" type="xsd:ID"/>
  656. </xsd:complexType>
  657. <!-- **************************************************** -->
  658. <xsd:complexType name="servlet-mappingType">
  659. <xsd:annotation>
  660. <xsd:documentation>
  661. The servlet-mappingType defines a mapping between a
  662. servlet and a url pattern.
  663. Used in: web-app
  664. </xsd:documentation>
  665. </xsd:annotation>
  666. <xsd:sequence>
  667. <xsd:element name="servlet-name"
  668. type="j2ee:servlet-nameType"/>
  669. <xsd:element name="url-pattern"
  670. type="j2ee:url-patternType"/>
  671. </xsd:sequence>
  672. <xsd:attribute name="id" type="xsd:ID"/>
  673. </xsd:complexType>
  674. <!-- **************************************************** -->
  675. <xsd:complexType name="servlet-nameType">
  676. <xsd:annotation>
  677. <xsd:documentation>
  678. The servlet-name element contains the canonical name of the
  679. servlet. Each servlet name is unique within the web
  680. application.
  681. </xsd:documentation>
  682. </xsd:annotation>
  683. <xsd:simpleContent>
  684. <xsd:extension base="j2ee:nonEmptyStringType"/>
  685. </xsd:simpleContent>
  686. </xsd:complexType>
  687. <!-- **************************************************** -->
  688. <xsd:complexType name="servletType">
  689. <xsd:annotation>
  690. <xsd:documentation>
  691. The servletType is used to declare a servlet.
  692. It contains the declarative data of a
  693. servlet. If a jsp-file is specified and the load-on-startup
  694. element is present, then the JSP should be precompiled and
  695. loaded.
  696. Used in: web-app
  697. </xsd:documentation>
  698. </xsd:annotation>
  699. <xsd:sequence>
  700. <xsd:group ref="j2ee:descriptionGroup"/>
  701. <xsd:element name="servlet-name"
  702. type="j2ee:servlet-nameType"/>
  703. <xsd:choice>
  704. <xsd:element name="servlet-class"
  705. type="j2ee:fully-qualified-classType">
  706. <xsd:annotation>
  707. <xsd:documentation>
  708. The servlet-class element contains the fully
  709. qualified class name of the servlet.
  710. </xsd:documentation>
  711. </xsd:annotation>
  712. </xsd:element>
  713. <xsd:element name="jsp-file"
  714. type="j2ee:jsp-fileType"/>
  715. </xsd:choice>
  716. <xsd:element name="init-param"
  717. type="j2ee:param-valueType"
  718. minOccurs="0" maxOccurs="unbounded"/>
  719. <xsd:element name="load-on-startup"
  720. type="j2ee:xsdIntegerType"
  721. minOccurs="0">
  722. <xsd:annotation>
  723. <xsd:documentation>
  724. The load-on-startup element indicates that this
  725. servlet should be loaded (instantiated and have
  726. its init() called) on the startup of the web
  727. application. The optional contents of these
  728. element must be an integer indicating the order in
  729. which the servlet should be loaded. If the value
  730. is a negative integer, or the element is not
  731. present, the container is free to load the servlet
  732. whenever it chooses. If the value is a positive
  733. integer or 0, the container must load and
  734. initialize the servlet as the application is
  735. deployed. The container must guarantee that
  736. servlets marked with lower integers are loaded
  737. before servlets marked with higher integers. The
  738. container may choose the order of loading of
  739. servlets with the same load-on-start-up value.
  740. </xsd:documentation>
  741. </xsd:annotation>
  742. </xsd:element>
  743. <xsd:element name="run-as"
  744. type="j2ee:run-asType"
  745. minOccurs="0"/>
  746. <xsd:element name="security-role-ref"
  747. type="j2ee:security-role-refType"
  748. minOccurs="0" maxOccurs="unbounded"/>
  749. </xsd:sequence>
  750. <xsd:attribute name="id" type="xsd:ID"/>
  751. </xsd:complexType>
  752. <!-- **************************************************** -->
  753. <xsd:complexType name="session-configType">
  754. <xsd:annotation>
  755. <xsd:documentation>
  756. The session-configType defines the session parameters
  757. for this web application.
  758. Used in: web-app
  759. </xsd:documentation>
  760. </xsd:annotation>
  761. <xsd:sequence>
  762. <xsd:element name="session-timeout"
  763. type="j2ee:xsdIntegerType"
  764. minOccurs="0">
  765. <xsd:annotation>
  766. <xsd:documentation>
  767. The session-timeout element defines the default
  768. session timeout interval for all sessions created
  769. in this web application. The specified timeout
  770. must be expressed in a whole number of minutes.
  771. If the timeout is 0 or less, the container ensures
  772. the default behaviour of sessions is never to time
  773. out. If this element is not specified, the container
  774. must set its default timeout period.
  775. </xsd:documentation>
  776. </xsd:annotation>
  777. </xsd:element>
  778. </xsd:sequence>
  779. <xsd:attribute name="id" type="xsd:ID"/>
  780. </xsd:complexType>
  781. <!-- **************************************************** -->
  782. <xsd:complexType name="transport-guaranteeType">
  783. <xsd:annotation>
  784. <xsd:documentation>
  785. The transport-guaranteeType specifies that the communication
  786. between client and server should be NONE, INTEGRAL, or
  787. CONFIDENTIAL. NONE means that the application does not
  788. require any transport guarantees. A value of INTEGRAL means
  789. that the application requires that the data sent between the
  790. client and server be sent in such a way that it can't be
  791. changed in transit. CONFIDENTIAL means that the application
  792. requires that the data be transmitted in a fashion that
  793. prevents other entities from observing the contents of the
  794. transmission. In most cases, the presence of the INTEGRAL or
  795. CONFIDENTIAL flag will indicate that the use of SSL is
  796. required.
  797. Used in: user-data-constraint
  798. </xsd:documentation>
  799. </xsd:annotation>
  800. <xsd:simpleContent>
  801. <xsd:restriction base="j2ee:string">
  802. <xsd:enumeration value="NONE"/>
  803. <xsd:enumeration value="INTEGRAL"/>
  804. <xsd:enumeration value="CONFIDENTIAL"/>
  805. </xsd:restriction>
  806. </xsd:simpleContent>
  807. </xsd:complexType>
  808. <!-- **************************************************** -->
  809. <xsd:complexType name="user-data-constraintType">
  810. <xsd:annotation>
  811. <xsd:documentation>
  812. The user-data-constraintType is used to indicate how
  813. data communicated between the client and container should be
  814. protected.
  815. Used in: security-constraint
  816. </xsd:documentation>
  817. </xsd:annotation>
  818. <xsd:sequence>
  819. <xsd:element name="description"
  820. type="j2ee:descriptionType"
  821. minOccurs="0"
  822. maxOccurs="unbounded"/>
  823. <xsd:element name="transport-guarantee"
  824. type="j2ee:transport-guaranteeType"/>
  825. </xsd:sequence>
  826. <xsd:attribute name="id" type="xsd:ID"/>
  827. </xsd:complexType>
  828. <!-- **************************************************** -->
  829. <xsd:complexType name="war-pathType">
  830. <xsd:annotation>
  831. <xsd:documentation>
  832. The elements that use this type designate a path starting
  833. with a "/" and interpreted relative to the root of a WAR
  834. file.
  835. </xsd:documentation>
  836. </xsd:annotation>
  837. <xsd:simpleContent>
  838. <xsd:restriction base="j2ee:string">
  839. <xsd:pattern value="/.*"/>
  840. </xsd:restriction>
  841. </xsd:simpleContent>
  842. </xsd:complexType>
  843. <!-- **************************************************** -->
  844. <xsd:simpleType name="web-app-versionType">
  845. <xsd:annotation>
  846. <xsd:documentation>
  847. This type contains the recognized versions of
  848. web-application supported. It is used to designate the
  849. version of the web application.
  850. </xsd:documentation>
  851. </xsd:annotation>
  852. <xsd:restriction base="xsd:token">
  853. <xsd:enumeration value="2.4"/>
  854. </xsd:restriction>
  855. </xsd:simpleType>
  856. <!-- **************************************************** -->
  857. <xsd:complexType name="web-appType">
  858. <xsd:choice minOccurs="0" maxOccurs="unbounded">
  859. <xsd:group ref="j2ee:descriptionGroup"/>
  860. <xsd:element name="distributable"
  861. type="j2ee:emptyType"/>
  862. <xsd:element name="context-param"
  863. type="j2ee:param-valueType">
  864. <xsd:annotation>
  865. <xsd:documentation>
  866. The context-param element contains the declaration
  867. of a web application's servlet context
  868. initialization parameters.
  869. </xsd:documentation>
  870. </xsd:annotation>
  871. </xsd:element>
  872. <xsd:element name="filter"
  873. type="j2ee:filterType"/>
  874. <xsd:element name="filter-mapping"
  875. type="j2ee:filter-mappingType"/>
  876. <xsd:element name="listener"
  877. type="j2ee:listenerType"/>
  878. <xsd:element name="servlet"
  879. type="j2ee:servletType"/>
  880. <xsd:element name="servlet-mapping"
  881. type="j2ee:servlet-mappingType"/>
  882. <xsd:element name="session-config"
  883. type="j2ee:session-configType"/>
  884. <xsd:element name="mime-mapping"
  885. type="j2ee:mime-mappingType"/>
  886. <xsd:element name="welcome-file-list"
  887. type="j2ee:welcome-file-listType"/>
  888. <xsd:element name="error-page"
  889. type="j2ee:error-pageType"/>
  890. <xsd:element name="jsp-config"
  891. type="j2ee:jsp-configType"/>
  892. <xsd:element name="security-constraint"
  893. type="j2ee:security-constraintType"/>
  894. <xsd:element name="login-config"
  895. type="j2ee:login-configType"/>
  896. <xsd:element name="security-role"
  897. type="j2ee:security-roleType"/>
  898. <xsd:group ref="j2ee:jndiEnvironmentRefsGroup"/>
  899. <xsd:element name="message-destination"
  900. type="j2ee:message-destinationType"/>
  901. <xsd:element name="locale-encoding-mapping-list"
  902. type="j2ee:locale-encoding-mapping-listType"/>
  903. </xsd:choice>
  904. <xsd:attribute name="version"
  905. type="j2ee:web-app-versionType"
  906. use="required"/>
  907. <xsd:attribute name="id" type="xsd:ID"/>
  908. </xsd:complexType>
  909. <!-- **************************************************** -->
  910. <xsd:complexType name="web-resource-collectionType">
  911. <xsd:annotation>
  912. <xsd:documentation>
  913. The web-resource-collectionType is used to identify a subset
  914. of the resources and HTTP methods on those resources within
  915. a web application to which a security constraint applies. If
  916. no HTTP methods are specified, then the security constraint
  917. applies to all HTTP methods.
  918. Used in: security-constraint
  919. </xsd:documentation>
  920. </xsd:annotation>
  921. <xsd:sequence>
  922. <xsd:element name="web-resource-name"
  923. type="j2ee:string">
  924. <xsd:annotation>
  925. <xsd:documentation>
  926. The web-resource-name contains the name of this web
  927. resource collection.
  928. </xsd:documentation>
  929. </xsd:annotation>
  930. </xsd:element>
  931. <xsd:element name="description"
  932. type="j2ee:descriptionType"
  933. minOccurs="0"
  934. maxOccurs="unbounded"/>
  935. <xsd:element name="url-pattern"
  936. type="j2ee:url-patternType"
  937. maxOccurs="unbounded"/>
  938. <xsd:element name="http-method"
  939. type="j2ee:http-methodType"
  940. minOccurs="0" maxOccurs="unbounded"/>
  941. </xsd:sequence>
  942. <xsd:attribute name="id" type="xsd:ID"/>
  943. </xsd:complexType>
  944. <!-- **************************************************** -->
  945. <xsd:complexType name="welcome-file-listType">
  946. <xsd:annotation>
  947. <xsd:documentation>
  948. The welcome-file-list contains an ordered list of welcome
  949. files elements.
  950. Used in: web-app
  951. </xsd:documentation>
  952. </xsd:annotation>
  953. <xsd:sequence>
  954. <xsd:element name="welcome-file"
  955. type="xsd:string"
  956. maxOccurs="unbounded">
  957. <xsd:annotation>
  958. <xsd:documentation>
  959. The welcome-file element contains file name to use
  960. as a default welcome file, such as index.html
  961. </xsd:documentation>
  962. </xsd:annotation>
  963. </xsd:element>
  964. </xsd:sequence>
  965. <xsd:attribute name="id" type="xsd:ID"/>
  966. </xsd:complexType>
  967. </xsd:schema>