← Back to branch summary

~ubuntu-branches/ubuntu/quantal/jetty/quantal

« back to all changes in this revision

Viewing changes to etc/dtd/web-app_2_3.dtd

  • Committer: Bazaar Package Importer
  • Author(s): Ludovic Claude
  • Date: 2009-09-07 00:22:20 UTC
  • mfrom: (1.1.5 upstream) (2.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20090907002220-8w7luxa3m4otve4g
Tags: 6.1.20-2
* Move documentation to /usr/share/doc/libjetty-java
* Better postinst and postrm scripts, aligned with tomcat6 scripts:
   - postinst: user jetty is created with its own group
   - postrm: better cleanup of temporary data,
     thourough remove and purge of data
* debian/changelog:
  - fix suggest for package libjetty-java-doc, add libjetty-java-doc
    to the list of Suggests for libjetty-java
  - add libjetty-extra to the list of Suggests for package jetty.

Show diffs side-by-side

added added

removed removed

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