cauchy/JavaEE/1.3/application-client_1_3.dtd

   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 <!--
  79 This is the XML DTD for the J2EE 1.3 application client deployment
  80 descriptor.  All J2EE 1.3 application client deployment descriptors
  81 must include a DOCTYPE of the following form:
  82
  83   <!DOCTYPE application-client PUBLIC
  84         "-//Sun Microsystems, Inc.//DTD J2EE Application Client 1.3//EN"
  85         "http://java.sun.com/dtd/application-client_1_3.dtd">
  86
  87 -->
  88
  89 <!--
  90 The following conventions apply to all J2EE deployment descriptor
  91 elements unless indicated otherwise.
  92
  93 - In elements that contain PCDATA, leading and trailing whitespace
  94   in the data may be ignored.
  95
  96 - In elements whose value is an "enumerated type", the value is
  97   case sensitive.
  98
  99 - In elements that specify a pathname to a file within the same
 100   JAR file, relative filenames (i.e., those not starting with "/")
 101   are considered relative to the root of the JAR file's namespace.
 102   Absolute filenames (i.e., those starting with "/") also specify
 103   names in the root of the JAR file's namespace.  In general, relative
 104   names are preferred.  The exception is .war files where absolute
 105   names are preferred for consistency with the servlet API.
 106 -->
 107
 108
 109 <!--
 110 The application-client element is the root element of an application
 111 client deployment descriptor.  The application client deployment
 112 descriptor describes the EJB components and external resources
 113 referenced by the application client.
 114 -->
 115 <!ELEMENT application-client (icon?, display-name, description?,
 116                 env-entry*, ejb-ref*, resource-ref*, resource-env-ref*,
 117                 callback-handler?)>
 118
 119 <!--
 120 The callback-handler element names a class provided by the
 121 application.  The class must have a no args constructor and must
 122 implement the javax.security.auth.callback.CallbackHandler interface.
 123 The class will be instantiated by the application client container and
 124 used by the container to collect authentication information from the
 125 user.
 126
 127 Used in: application-client
 128 -->
 129 <!ELEMENT callback-handler (#PCDATA)>
 130
 131 <!--
 132 The description element is used to provide text describing the parent
 133 element.  The description element should include any information that
 134 the application client jar file producer wants to provide to the consumer of
 135 the application client jar file (i.e., to the Deployer). Typically, the tools
 136 used by the application client jar file consumer will display the description
 137 when processing the parent element that contains the description.
 138
 139 Used in: application-client, ejb-ref, env-entry, resource-env-ref,
 140 resource-ref
 141 -->
 142 <!ELEMENT description (#PCDATA)>
 143
 144 <!--
 145 The display-name element contains a short name that is intended to be
 146 displayed by tools.  The display name need not be unique.
 147
 148 Used in: application-client
 149
 150 Example:
 151
 152 <display-name>Employee Self Service</display-name>
 153 -->
 154 <!ELEMENT display-name (#PCDATA)>
 155
 156 <!--
 157 The ejb-link element is used in the ejb-ref element
 158 to specify that an EJB reference is linked to an
 159 enterprise bean.
 160
 161 The name in the ejb-link element is composed of a
 162 path name specifying the ejb-jar containing the referenced enterprise
 163 bean with the ejb-name of the target bean appended and separated from
 164 the path name by "#".  The path name is relative to the jar file
 165 containing the application client that is referencing the enterprise bean.
 166 This allows multiple enterprise beans with the same ejb-name to be
 167 uniquely identified.
 168
 169 Used in: ejb-ref
 170
 171 Examples:
 172
 173         <ejb-link>EmployeeRecord</ejb-link>
 174
 175         <ejb-link>../products/product.jar#ProductEJB</ejb-link>
 176
 177 -->
 178 <!ELEMENT ejb-link (#PCDATA)>
 179
 180 <!--
 181 The ejb-ref element is used for the declaration of a reference to
 182 an enterprise bean's home. The declaration consists of:
 183
 184         - an optional description
 185         - the EJB reference name used in the code of
 186           the application client that's referencing the enterprise bean
 187         - the expected type of the referenced enterprise bean
 188         - the expected home and remote interfaces of the referenced
 189           enterprise bean
 190         - optional ejb-link information, used to specify the referenced
 191           enterprise bean
 192
 193 Used in: application-client
 194 -->
 195 <!ELEMENT ejb-ref (description?, ejb-ref-name, ejb-ref-type,
 196                 home, remote, ejb-link?)>
 197
 198 <!--
 199 The ejb-ref-name element contains the name of an EJB reference. The
 200 EJB reference is an entry in the application client's environment and is
 201 relative to the java:comp/env context.  The name must be unique
 202 within the application client.
 203
 204 It is recommended that name is prefixed with "ejb/".
 205
 206 Used in: ejb-ref
 207
 208 Example:
 209
 210 <ejb-ref-name>ejb/Payroll</ejb-ref-name>
 211 -->
 212 <!ELEMENT ejb-ref-name (#PCDATA)>
 213
 214 <!--
 215 The ejb-ref-type element contains the expected type of the
 216 referenced enterprise bean.
 217
 218 The ejb-ref-type element must be one of the following:
 219
 220         <ejb-ref-type>Entity</ejb-ref-type>
 221         <ejb-ref-type>Session</ejb-ref-type>
 222
 223 Used in: ejb-ref
 224 -->
 225 <!ELEMENT ejb-ref-type (#PCDATA)>
 226
 227 <!--
 228 The env-entry element contains the declaration of an application client's
 229 environment entry. The declaration consists of an optional
 230 description, the name of the environment entry, and an optional
 231 value.  If a value is not specified, one must be supplied
 232 during deployment.
 233
 234 Used in: application-client
 235 -->
 236 <!ELEMENT env-entry (description?, env-entry-name, env-entry-type,
 237                 env-entry-value?)>
 238
 239 <!--
 240 The env-entry-name element contains the name of an application client's
 241 environment entry.  The name is a JNDI name relative to the
 242 java:comp/env context.  The name must be unique within an application client.
 243
 244 Used in: env-entry
 245
 246 Example:
 247
 248 <env-entry-name>minAmount</env-entry-name>
 249 -->
 250 <!ELEMENT env-entry-name (#PCDATA)>
 251
 252 <!--
 253 The env-entry-type element contains the fully-qualified Java type of
 254 the environment entry value that is expected by the application client's
 255 code.
 256
 257 The following are the legal values of env-entry-type:
 258
 259         java.lang.Boolean
 260         java.lang.Byte
 261         java.lang.Character
 262         java.lang.String
 263         java.lang.Short
 264         java.lang.Integer
 265         java.lang.Long
 266         java.lang.Float
 267         java.lang.Double
 268
 269
 270 Used in: env-entry
 271
 272 Example:
 273
 274 <env-entry-type>java.lang.Boolean</env-entry-type>
 275 -->
 276 <!ELEMENT env-entry-type (#PCDATA)>
 277
 278 <!--
 279 The env-entry-value element contains the value of an application client's
 280 environment entry. The value must be a String that is valid for the
 281 constructor of the specified type that takes a single String
 282 parameter, or for java.lang.Character, a single character.
 283
 284 Used in: env-entry
 285
 286 Example:
 287
 288 <env-entry-value>100.00</env-entry-value>
 289 -->
 290 <!ELEMENT env-entry-value (#PCDATA)>
 291
 292 <!--
 293 The home element contains the fully-qualified name of the enterprise
 294 bean's home interface.
 295
 296 Used in: ejb-ref
 297
 298 Example:
 299
 300 <home>com.aardvark.payroll.PayrollHome</home>
 301 -->
 302 <!ELEMENT home (#PCDATA)>
 303
 304 <!--
 305 The icon element contains small-icon and large-icon elements that
 306 specify the file names for small and a large GIF or JPEG icon images
 307 used to represent the parent element in a GUI tool.
 308
 309 Used in: application-client
 310 -->
 311 <!ELEMENT icon (small-icon?, large-icon?)>
 312
 313 <!--
 314 The large-icon element contains the name of a file
 315 containing a large (32 x 32) icon image. The file
 316 name is a relative path within the application client's
 317 jar file.
 318
 319 The image may be either in the JPEG or GIF format.
 320 The icon can be used by tools.
 321
 322 Used in: icon
 323
 324 Example:
 325
 326 <large-icon>employee-service-icon32x32.jpg</large-icon>
 327 -->
 328 <!ELEMENT large-icon (#PCDATA)>
 329
 330 <!--
 331 The remote element contains the fully-qualified name of the enterprise
 332 bean's remote interface.
 333
 334 Used in: ejb-ref
 335
 336 Example:
 337
 338 <remote>com.wombat.empl.EmployeeService</remote>
 339 -->
 340 <!ELEMENT remote (#PCDATA)>
 341
 342 <!--
 343 The res-auth element specifies whether the application client code signs
 344 on programmatically to the resource manager, or whether the Container
 345 will sign on to the resource manager on behalf of the application client. In the
 346 latter case, the Container uses information that is supplied by the
 347 Deployer.
 348
 349 The value of this element must be one of the two following:
 350
 351         <res-auth>Application</res-auth>
 352         <res-auth>Container</res-auth>
 353
 354 Used in: resource-ref
 355 -->
 356 <!ELEMENT res-auth (#PCDATA)>
 357
 358 <!--
 359 The res-ref-name element specifies the name of a resource manager
 360 connection factory reference.  The name is a JNDI name relative to the
 361 java:comp/env context.  The name must be unique within an application client.
 362
 363 Used in: resource-ref
 364 -->
 365 <!ELEMENT res-ref-name (#PCDATA)>
 366
 367 <!--
 368 The res-sharing-scope element specifies whether connections obtained
 369 through the given resource manager connection factory reference can be
 370 shared. The value of this element, if specified, must be one of the
 371 two following:
 372
 373         <res-sharing-scope>Shareable</res-sharing-scope>
 374         <res-sharing-scope>Unshareable</res-sharing-scope>
 375
 376 The default value is Shareable.
 377
 378 Used in: resource-ref
 379 -->
 380 <!ELEMENT res-sharing-scope (#PCDATA)>
 381
 382 <!--
 383 The res-type element specifies the type of the data source. The type
 384 is specified by the fully qualified Java language class or interface
 385 expected to be implemented by the data source.
 386
 387 Used in: resource-ref
 388 -->
 389 <!ELEMENT res-type (#PCDATA)>
 390
 391 <!--
 392 The resource-env-ref element contains a declaration of an application client's
 393 reference to an administered object associated with a resource
 394 in the application client's environment.  It consists of an optional
 395 description, the resource environment reference name, and an
 396 indication of the resource environment reference type expected by
 397 the application client code.
 398
 399 Used in: application-client
 400
 401 Example:
 402
 403 <resource-env-ref>
 404     <resource-env-ref-name>jms/StockQueue</resource-env-ref-name>
 405     <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type>
 406 </resource-env-ref>
 407 -->
 408 <!ELEMENT resource-env-ref (description?, resource-env-ref-name,
 409                 resource-env-ref-type)>
 410
 411 <!--
 412 The resource-env-ref-name element specifies the name of a resource
 413 environment reference; its value is the environment entry name used in
 414 the application client code.  The name is a JNDI name relative to the
 415 java:comp/env context and must be unique within an application client.
 416
 417 Used in: resource-env-ref
 418 -->
 419 <!ELEMENT resource-env-ref-name (#PCDATA)>
 420
 421 <!--
 422 The resource-env-ref-type element specifies the type of a resource
 423 environment reference.  It is the fully qualified name of a Java
 424 language class or interface.
 425
 426 Used in: resource-env-ref
 427 -->
 428 <!ELEMENT resource-env-ref-type (#PCDATA)>
 429
 430 <!--
 431 The resource-ref element contains a declaration of an application client's
 432 reference to an external resource. It consists of an optional
 433 description, the resource manager connection factory reference name,
 434 the indication of the resource manager connection factory type
 435 expected by the application client code, the type of authentication
 436 (Application or Container), and an optional specification of the
 437 shareability of connections obtained from the resource (Shareable or
 438 Unshareable).
 439
 440 Used in: application-client
 441
 442 Example:
 443
 444     <resource-ref>
 445         <res-ref-name>jdbc/EmployeeAppDB</res-ref-name>
 446         <res-type>javax.sql.DataSource</res-type>
 447         <res-auth>Container</res-auth>
 448         <res-sharing-scope>Shareable</res-sharing-scope>
 449     </resource-ref>
 450 -->
 451 <!ELEMENT resource-ref (description?, res-ref-name, res-type, res-auth,
 452                 res-sharing-scope?)>
 453
 454 <!--
 455 The small-icon element contains the name of a file
 456 containing a small (16 x 16) icon image. The file
 457 name is a relative path within the application client's
 458 jar file.
 459
 460 The image may be either in the JPEG or GIF format.
 461 The icon can be used by tools.
 462
 463 Used in: icon
 464
 465 Example:
 466
 467 <small-icon>employee-service-icon16x16.jpg</small-icon>
 468 -->
 469 <!ELEMENT small-icon (#PCDATA)>
 470
 471 <!--
 472 The ID mechanism is to allow tools that produce additional deployment
 473 information (i.e., information beyond the standard deployment
 474 descriptor information) to store the non-standard information in a
 475 separate file, and easily refer from these tool-specific files to the
 476 information in the standard deployment descriptor.
 477
 478 Tools are not allowed to add the non-standard information into the
 479 standard deployment descriptor.
 480 -->
 481
 482 <!ATTLIST application-client id ID #IMPLIED>
 483 <!ATTLIST callback-handler id ID #IMPLIED>
 484 <!ATTLIST description id ID #IMPLIED>
 485 <!ATTLIST display-name id ID #IMPLIED>
 486 <!ATTLIST ejb-link id ID #IMPLIED>
 487 <!ATTLIST ejb-ref id ID #IMPLIED>
 488 <!ATTLIST ejb-ref-name id ID #IMPLIED>
 489 <!ATTLIST ejb-ref-type id ID #IMPLIED>
 490 <!ATTLIST env-entry id ID #IMPLIED>
 491 <!ATTLIST env-entry-name id ID #IMPLIED>
 492 <!ATTLIST env-entry-type id ID #IMPLIED>
 493 <!ATTLIST env-entry-value id ID #IMPLIED>
 494 <!ATTLIST home id ID #IMPLIED>
 495 <!ATTLIST icon id ID #IMPLIED>
 496 <!ATTLIST large-icon id ID #IMPLIED>
 497 <!ATTLIST remote id ID #IMPLIED>
 498 <!ATTLIST res-auth id ID #IMPLIED>
 499 <!ATTLIST res-ref-name id ID #IMPLIED>
 500 <!ATTLIST res-sharing-scope id ID #IMPLIED>
 501 <!ATTLIST res-type id ID #IMPLIED>
 502 <!ATTLIST resource-env-ref id ID #IMPLIED>
 503 <!ATTLIST resource-env-ref-name id ID #IMPLIED>
 504 <!ATTLIST resource-env-ref-type id ID #IMPLIED>
 505 <!ATTLIST resource-ref id ID #IMPLIED>
 506 <!ATTLIST small-icon id ID #IMPLIED>