blob: 5f439f42cd9b7ab8302fa9e41be696b63f0a16b0 [file] [log] [blame]
david_williamse073de12007-04-28 04:01:44 +00001<!--
2Copyright 1999 Sun Microsystems, Inc. 901 San Antonio Road,
3Palo Alto, CA 94303, U.S.A. All rights reserved.
4
5This product or document is protected by copyright and distributed
6under licenses restricting its use, copying, distribution, and
7decompilation. No part of this product or documentation may be
8reproduced in any form by any means without prior written authorization
9of Sun and its licensors, if any.
10
11Third party software, including font technology, is copyrighted and
12licensed from Sun suppliers.
13
14Sun, Sun Microsystems, the Sun Logo, Solaris, Java, JavaServer Pages, Java
15Naming and Directory Interface, JDBC, JDK, JavaMail and Enterprise JavaBeans,
16are trademarks or registered trademarks of Sun Microsystems, Inc in the U.S.
17and other countries.
18
19All SPARC trademarks are used under license and are trademarks
20or registered trademarks of SPARC International, Inc.
21in the U.S. and other countries. Products bearing SPARC
22trademarks are based upon an architecture developed by Sun Microsystems, Inc.
23
24PostScript is a registered trademark of Adobe Systems, Inc.
25
26
27Federal Acquisitions: Commercial Software - Government Users Subject to
28Standard License Terms and Conditions.
29
30
31
32DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED
33CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY
34IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
35PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT
36TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY
37INVALID.
38
39_________________________________________________________________________
40Copyright 1999 Sun Microsystems, Inc.,
41901 San Antonio Road, Palo Alto, CA 94303, Etats-Unis.
42Tous droits re'serve's.
43
44
45Ce produit ou document est prote'ge' par un copyright et distribue' avec
46des licences qui en restreignent l'utilisation, la copie, la distribution,
47et la de'compilation. Aucune partie de ce produit ou de sa documentation
48associe'e ne peut e^tre reproduite sous aucune forme, par quelque moyen
49que ce soit, sans l'autorisation pre'alable et e'crite de Sun et de ses
50bailleurs de licence, s'il y en a.
51
52Le logiciel de'tenu par des tiers, et qui comprend la technologie
53relative aux polices de caracte`res, est prote'ge' par un copyright
54et licencie' par des fournisseurs de Sun.
55
56Sun, Sun Microsystems, le logo Sun, Solaris, Java, JavaServer Pages, Java
57Naming and Directory Interface, JDBC, JDK, JavaMail, et Enterprise JavaBeans,
58sont des marques de fabrique ou des marques de'pose'es de Sun
59Microsystems, Inc. aux Etats-Unis et dans d'autres pays.
60
61Toutes les marques SPARC sont utilise'es sous licence et sont
62des marques de fabrique ou des marques de'pose'es de SPARC
63International, Inc. aux Etats-Unis et dans
64d'autres pays. Les produits portant les marques SPARC sont
65base's sur une architecture de'veloppe'e par Sun Microsystems, Inc.
66
67Postcript est une marque enregistre'e d'Adobe Systems Inc.
68
69LA DOCUMENTATION EST FOURNIE "EN L'ETAT" ET TOUTES AUTRES CONDITIONS,
70DECLARATIONS ET GARANTIES EXPRESSES OU TACITES SONT FORMELLEMENT EXCLUES,
71DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS NOTAMMENT
72TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE, A L'APTITUDE
73A UNE UTILISATION PARTICULIERE OU A L'ABSENCE DE CONTREFACON.
74-->
75
76<!--
77The web-app element is the root of the deployment descriptor for
78a web application
79-->
80
81<!ELEMENT web-app (icon?, display-name?, description?, distributable?,
82context-param*, servlet*, servlet-mapping*, session-config?,
83mime-mapping*, welcome-file-list?, error-page*, taglib*,
84resource-ref*, security-constraint*, login-config?, security-role*,
85env-entry*, ejb-ref*)>
86
87<!--
88The icon element contains a small-icon and a large-icon element
89which specify the location within the web application for a small and
90large image used to represent the web application in a GUI tool. At a
91minimum, tools must accept GIF and JPEG format images.
92-->
93
94<!ELEMENT icon (small-icon?, large-icon?)>
95
96<!--
97The small-icon element contains the location within the web
98application of a file containing a small (16x16 pixel) icon image.
99-->
100
101<!ELEMENT small-icon (#PCDATA)>
102
103<!--
104The large-icon element contains the location within the web
105application of a file containing a large (32x32 pixel) icon image.
106-->
107
108<!ELEMENT large-icon (#PCDATA)>
109
110<!--
111The display-name element contains a short name that is intended
112to be displayed by GUI tools
113-->
114
115<!ELEMENT display-name (#PCDATA)>
116
117<!--
118The description element is used to provide descriptive text about
119the parent element.
120-->
121
122<!ELEMENT description (#PCDATA)>
123
124<!--
125The distributable element, by its presence in a web application
126deployment descriptor, indicates that this web application is
127programmed appropriately to be deployed into a distributed servlet
128container
129-->
130
131<!ELEMENT distributable EMPTY>
132
133<!--
134The context-param element contains the declaration of a web
135application's servlet context initialization parameters.
136-->
137
138<!ELEMENT context-param (param-name, param-value, description?)>
139
140<!--
141The param-name element contains the name of a parameter.
142-->
143
144<!ELEMENT param-name (#PCDATA)>
145
146<!--
147The param-value element contains the value of a parameter.
148-->
149
150<!ELEMENT param-value (#PCDATA)>
151
152<!--
153The servlet element contains the declarative data of a
154servlet. If a jsp-file is specified and the load-on-startup element is
155present, then the JSP should be precompiled and loaded.
156-->
157
158<!ELEMENT servlet (icon?, servlet-name, display-name?, description?,
159(servlet-class|jsp-file), init-param*, load-on-startup?, security-role-ref*)>
160
161<!--
162The servlet-name element contains the canonical name of the
163servlet.
164-->
165
166<!ELEMENT servlet-name (#PCDATA)>
167
168<!--
169The servlet-class element contains the fully qualified class name
170of the servlet.
171-->
172
173<!ELEMENT servlet-class (#PCDATA)>
174
175<!--
176The jsp-file element contains the full path to a JSP file within
177the web application.
178-->
179
180<!ELEMENT jsp-file (#PCDATA)>
181
182<!--
183The init-param element contains a name/value pair as an
184initialization param of the servlet
185-->
186
187<!ELEMENT init-param (param-name, param-value, description?)>
188
189<!--
190The load-on-startup element indicates that this servlet should be
191loaded on the startup of the web application. The optional contents of
192these element must be a positive integer indicating the order in which
193the servlet should be loaded. Lower integers are loaded before higher
194integers. If no value is specified, or if the value specified is not a
195positive integer, the container is free to load it at any time in the
196startup sequence.
197-->
198
199<!ELEMENT load-on-startup (#PCDATA)>
200
201<!--
202The servlet-mapping element defines a mapping between a servlet
203and a url pattern
204-->
205
206<!ELEMENT servlet-mapping (servlet-name, url-pattern)>
207
208<!--
209The url-pattern element contains the url pattern of the
210mapping. Must follow the rules specified in Section 10 of the Servlet
211API Specification.
212-->
213
214<!ELEMENT url-pattern (#PCDATA)>
215
216<!--
217The session-config element defines the session parameters for
218this web application.
219-->
220
221<!ELEMENT session-config (session-timeout?)>
222
223<!--
224The session-timeout element defines the default session timeout
225interval for all sessions created in this web application. The
226specified timeout must be expressed in a whole number of minutes.
227-->
228
229<!ELEMENT session-timeout (#PCDATA)>
230
231<!--
232The mime-mapping element defines a mapping between an extension
233and a mime type.
234-->
235
236<!ELEMENT mime-mapping (extension, mime-type)>
237
238<!--
239The extension element contains a string describing an
240extension. example: "txt"
241-->
242
243<!ELEMENT extension (#PCDATA)>
244
245<!--
246The mime-type element contains a defined mime type. example:
247"text/plain"
248-->
249
250<!ELEMENT mime-type (#PCDATA)>
251
252<!--
253The welcome-file-list contains an ordered list of welcome files
254elements.
255-->
256
257<!ELEMENT welcome-file-list (welcome-file+)>
258
259<!--
260The welcome-file element contains file name to use as a default
261welcome file, such as index.html
262-->
263
264<!ELEMENT welcome-file (#PCDATA)>
265
266<!--
267The taglib element is used to describe a JSP tag library.
268-->
269
270<!ELEMENT taglib (taglib-uri, taglib-location)>
271
272<!--
273The taglib-uri element describes a URI, relative to the location
274of the web.xml document, identifying a Tag Library used in the Web
275Application.
276-->
277
278<!ELEMENT taglib-uri (#PCDATA)>
279
280<!--
281the taglib-location element contains the location (as a resource
282relative to the root of the web application) where to find the Tag
283Libary Description file for the tag library.
284-->
285
286<!ELEMENT taglib-location (#PCDATA)>
287
288<!--
289The error-page element contains a mapping between an error code
290or exception type to the path of a resource in the web application
291-->
292
293<!ELEMENT error-page ((error-code | exception-type), location)>
294
295<!--
296The error-code contains an HTTP error code, ex: 404
297-->
298
299<!ELEMENT error-code (#PCDATA)>
300
301<!--
302The exception type contains a fully qualified class name of a
303Java exception type.
304-->
305
306<!ELEMENT exception-type (#PCDATA)>
307
308<!--
309The location element contains the location of the resource in the
310web application
311-->
312
313<!ELEMENT location (#PCDATA)>
314
315<!--
316The resource-ref element contains a declaration of a Web
317Application's reference to an external resource.
318-->
319
320<!ELEMENT resource-ref (description?, res-ref-name, res-type, res-auth)>
321
322<!--
323The res-ref-name element specifies the name of the resource
324factory reference name.
325-->
326
327<!ELEMENT res-ref-name (#PCDATA)>
328
329<!--
330The res-type element specifies the (Java class) type of the data
331source.
332-->
333
334<!ELEMENT res-type (#PCDATA)>
335
336<!--
337The res-auth element indicates whether the application component
338code performs resource signon programmatically or whether the
339container signs onto the resource based on the principle mapping
340information supplied by the deployer. Must be CONTAINER or SERVLET
341-->
342
343<!ELEMENT res-auth (#PCDATA)>
344
345<!--
346The security-constraint element is used to associate security
347constraints with one or more web resource collections
348-->
349
350<!ELEMENT security-constraint (web-resource-collection+,
351auth-constraint?, user-data-constraint?)>
352
353<!--
354The web-resource-collection element is used to identify a subset
355of the resources and HTTP methods on those resources within a web
356application to which a security constraint applies. If no HTTP methods
357are specified, then the security constraint applies to all HTTP
358methods.
359-->
360
361<!ELEMENT web-resource-collection (web-resource-name, description?,
362url-pattern*, http-method*)>
363
364<!--
365The web-resource-name contains the name of this web resource
366collection
367-->
368
369<!ELEMENT web-resource-name (#PCDATA)>
370
371<!--
372The http-method contains an HTTP method (GET | POST |...)
373-->
374
375<!ELEMENT http-method (#PCDATA)>
376
377<!--
378The user-data-constraint element is used to indicate how data
379communicated between the client and container should be protected
380-->
381
382<!ELEMENT user-data-constraint (description?, transport-guarantee)>
383
384<!--
385The transport-guarantee element specifies that the communication
386between client and server should be NONE, INTEGRAL, or
387CONFIDENTIAL. NONE means that the application does not require any
388transport guarantees. A value of INTEGRAL means that the application
389requires that the data sent between the client and server be sent in
390such a way that it can't be changed in transit. CONFIDENTIAL means
391that the application requires that the data be transmitted in a
392fashion that prevents other entities from observing the contents of
393the transmission. In most cases, the presence of the INTEGRAL or
394CONFIDENTIAL flag will indicate that the use of SSL is required.
395-->
396
397<!ELEMENT transport-guarantee (#PCDATA)>
398
399<!--
400The auth-constraint element indicates the user roles that should
401be permitted access to this resource collection. The role used here
402must appear in a security-role-ref element.
403-->
404
405<!ELEMENT auth-constraint (description?, role-name*)>
406
407<!--
408The role-name element contains the name of a security role.
409-->
410
411<!ELEMENT role-name (#PCDATA)>
412
413<!--
414The login-config element is used to configure the authentication
415method that should be used, the realm name that should be used for
416this application, and the attributes that are needed by the form login
417mechanism.
418-->
419
420<!ELEMENT login-config (auth-method?, realm-name?, form-login-config?)>
421
422<!--
423The realm name element specifies the realm name to use in HTTP
424Basic authorization
425-->
426
427<!ELEMENT realm-name (#PCDATA)>
428
429<!--
430The form-login-config element specifies the login and error pages
431that should be used in form based login. If form based authentication
432is not used, these elements are ignored.
433-->
434
435<!ELEMENT form-login-config (form-login-page, form-error-page)>
436
437<!--
438The form-login-page element defines the location in the web app
439where the page that can be used for login can be found
440-->
441
442<!ELEMENT form-login-page (#PCDATA)>
443
444<!--
445The form-error-page element defines the location in the web app
446where the error page that is displayed when login is not successful
447can be found
448-->
449
450<!ELEMENT form-error-page (#PCDATA)>
451
452<!--
453The auth-method element is used to configure the authentication
454mechanism for the web application. As a prerequisite to gaining access
455to any web resources which are protected by an authorization
456constraint, a user must have authenticated using the configured
457mechanism. Legal values for this element are "BASIC", "DIGEST",
458"FORM", or "CLIENT-CERT".
459-->
460
461<!ELEMENT auth-method (#PCDATA)>
462
463<!--
464The security-role element contains the declaration of a security
465role which is used in the security-constraints placed on the web
466application.
467-->
468
469<!ELEMENT security-role (description?, role-name)>
470
471<!--
472The role-name element contains the name of a role. This element
473must contain a non-empty string.
474-->
475
476<!ELEMENT security-role-ref (description?, role-name, role-link)>
477
478<!--
479The role-link element is used to link a security role reference
480to a defined security role. The role-link element must contain the
481name of one of the security roles defined in the security-role
482elements.
483-->
484
485<!ELEMENT role-link (#PCDATA)>
486
487<!--
488The env-entry element contains the declaration of an
489application's environment entry. This element is required to be
490honored on in J2EE compliant servlet containers.
491-->
492
493<!ELEMENT env-entry (description?, env-entry-name, env-entry-value?,
494env-entry-type)>
495
496<!--
497The env-entry-name contains the name of an application's
498environment entry
499-->
500
501<!ELEMENT env-entry-name (#PCDATA)>
502
503<!--
504The env-entry-value element contains the value of an
505application's environment entry
506-->
507
508<!ELEMENT env-entry-value (#PCDATA)>
509
510<!--
511The env-entry-type element contains the fully qualified Java type
512of the environment entry value that is expected by the application
513code. The following are the legal values of env-entry-type:
514java.lang.Boolean, java.lang.String, java.lang.Integer,
515java.lang.Double, java.lang.Float.
516-->
517
518<!ELEMENT env-entry-type (#PCDATA)>
519
520<!--
521The ejb-ref element is used to declare a reference to an
522enterprise bean.
523-->
524
525<!ELEMENT ejb-ref (description?, ejb-ref-name, ejb-ref-type, home, remote,
526ejb-link?)>
527
528<!--
529The ejb-ref-name element contains the name of an EJB
530reference. This is the JNDI name that the servlet code uses to get a
531reference to the enterprise bean.
532-->
533
534<!ELEMENT ejb-ref-name (#PCDATA)>
535
536<!--
537The ejb-ref-type element contains the expected java class type of
538the referenced EJB.
539-->
540
541<!ELEMENT ejb-ref-type (#PCDATA)>
542
543<!--
544The ejb-home element contains the fully qualified name of the
545EJB's home interface
546-->
547
548<!ELEMENT home (#PCDATA)>
549
550<!--
551The ejb-remote element contains the fully qualified name of the
552EJB's remote interface
553-->
554
555<!ELEMENT remote (#PCDATA)>
556
557<!--
558The ejb-link element is used in the ejb-ref element to specify
559that an EJB reference is linked to an EJB in an encompassing Java2
560Enterprise Edition (J2EE) application package. The value of the
561ejb-link element must be the ejb-name of and EJB in the J2EE
562application package.
563-->
564
565<!ELEMENT ejb-link (#PCDATA)>
566
567<!--
568The ID mechanism is to allow tools to easily make tool-specific
569references to the elements of the deployment descriptor. This allows
570tools that produce additional deployment information (i.e information
571beyond the standard deployment descriptor information) to store the
572non-standard information in a separate file, and easily refer from
573these tools-specific files to the information in the standard web-app
574deployment descriptor.
575-->
576
577<!ATTLIST web-app id ID #IMPLIED>
578<!ATTLIST icon id ID #IMPLIED>
579<!ATTLIST small-icon id ID #IMPLIED>
580<!ATTLIST large-icon id ID #IMPLIED>
581<!ATTLIST display-name id ID #IMPLIED>
582<!ATTLIST description id ID #IMPLIED>
583<!ATTLIST distributable id ID #IMPLIED>
584<!ATTLIST context-param id ID #IMPLIED>
585<!ATTLIST param-name id ID #IMPLIED>
586<!ATTLIST param-value id ID #IMPLIED>
587<!ATTLIST servlet id ID #IMPLIED>
588<!ATTLIST servlet-name id ID #IMPLIED>
589<!ATTLIST servlet-class id ID #IMPLIED>
590<!ATTLIST jsp-file id ID #IMPLIED>
591<!ATTLIST init-param id ID #IMPLIED>
592<!ATTLIST load-on-startup id ID #IMPLIED>
593<!ATTLIST servlet-mapping id ID #IMPLIED>
594<!ATTLIST url-pattern id ID #IMPLIED>
595<!ATTLIST session-config id ID #IMPLIED>
596<!ATTLIST session-timeout id ID #IMPLIED>
597<!ATTLIST mime-mapping id ID #IMPLIED>
598<!ATTLIST extension id ID #IMPLIED>
599<!ATTLIST mime-type id ID #IMPLIED>
600<!ATTLIST welcome-file-list id ID #IMPLIED>
601<!ATTLIST welcome-file id ID #IMPLIED>
602<!ATTLIST taglib id ID #IMPLIED>
603<!ATTLIST taglib-uri id ID #IMPLIED>
604<!ATTLIST taglib-location id ID #IMPLIED>
605<!ATTLIST error-page id ID #IMPLIED>
606<!ATTLIST error-code id ID #IMPLIED>
607<!ATTLIST exception-type id ID #IMPLIED>
608<!ATTLIST location id ID #IMPLIED>
609<!ATTLIST resource-ref id ID #IMPLIED>
610<!ATTLIST res-ref-name id ID #IMPLIED>
611<!ATTLIST res-type id ID #IMPLIED>
612<!ATTLIST res-auth id ID #IMPLIED>
613<!ATTLIST security-constraint id ID #IMPLIED>
614<!ATTLIST web-resource-collection id ID #IMPLIED>
615<!ATTLIST web-resource-name id ID #IMPLIED>
616<!ATTLIST http-method id ID #IMPLIED>
617<!ATTLIST user-data-constraint id ID #IMPLIED>
618<!ATTLIST transport-guarantee id ID #IMPLIED>
619<!ATTLIST auth-constraint id ID #IMPLIED>
620<!ATTLIST role-name id ID #IMPLIED>
621<!ATTLIST login-config id ID #IMPLIED>
622<!ATTLIST realm-name id ID #IMPLIED>
623<!ATTLIST form-login-config id ID #IMPLIED>
624<!ATTLIST form-login-page id ID #IMPLIED>
625<!ATTLIST form-error-page id ID #IMPLIED>
626<!ATTLIST auth-method id ID #IMPLIED>
627<!ATTLIST security-role id ID #IMPLIED>
628<!ATTLIST security-role-ref id ID #IMPLIED>
629<!ATTLIST role-link id ID #IMPLIED>
630<!ATTLIST env-entry id ID #IMPLIED>
631<!ATTLIST env-entry-name id ID #IMPLIED>
632<!ATTLIST env-entry-value id ID #IMPLIED>
633<!ATTLIST env-entry-type id ID #IMPLIED>
634<!ATTLIST ejb-ref id ID #IMPLIED>
635<!ATTLIST ejb-ref-name id ID #IMPLIED>
636<!ATTLIST ejb-ref-type id ID #IMPLIED>
637<!ATTLIST home id ID #IMPLIED>
638<!ATTLIST remote id ID #IMPLIED>
639<!ATTLIST ejb-link id ID #IMPLIED>