web-app_2_5.xsd 37 KB

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