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