| blob | bc9eb57965c81821fb9771e61f821bb5cf2f8f8b |
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.
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.
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.
20 Third-party software, including font technology, is copyrighted and
21 licensed from Sun suppliers.
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.
28 Federal Acquisitions: Commercial Software - Government Users Subject to
29 Standard License Terms and Conditions.
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.
38 _________________________________________________________________________
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.
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.
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.
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.
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.
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 -->
78 <!--
79 This is the XML DTD for the EJB 2.0 deployment descriptor.
80 All EJB 2.0 deployment descriptors must include a DOCTYPE
81 of the following form:
83 <!DOCTYPE ejb-jar PUBLIC
84 "-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN"
85 "http://java.sun.com/dtd/ejb-jar_2_0.dtd">
87 -->
89 <!--
90 The following conventions apply to all J2EE deployment descriptor
91 elements unless indicated otherwise.
93 - In elements that contain PCDATA, leading and trailing whitespace
94 in the data may be ignored.
96 - In elements whose value is an "enumerated type", the value is
97 case sensitive.
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 -->
109 <!--
110 The ejb-jar element is the root element of the EJB deployment
111 descriptor. It contains
113 - an optional description of the ejb-jar file
114 - an optional display name
115 - an optional small icon file name
116 - an optional large icon file name
117 - mandatory structural information about all included
118 enterprise beans
119 - a descriptor for container managed relationships, if any
120 - an optional application-assembly descriptor
121 - an optional name of an ejb-client-jar file for the ejb-jar.
122 -->
123 <!ELEMENT ejb-jar (description?, display-name?, small-icon?,
124 large-icon?, enterprise-beans, relationships?, assembly-descriptor?,
125 ejb-client-jar?)>
127 <!--
128 The abstract-schema-name element specifies the name of the abstract
129 schema type of an entity bean with cmp-version 2.x. It is used in EJB
130 QL queries.
132 For example, the abstract-schema-name for an entity bean whose local
133 interface is com.acme.commerce.Order might be Order.
135 Used in: entity
136 -->
139 <!--
141 The acknowledge-mode element specifies whether JMS AUTO_ACKNOWLEDGE or
142 DUPS_OK_ACKNOWLEDGE message acknowledgment semantics should be used
143 for the onMessage message of a message-driven bean that uses bean
144 managed transaction demarcation.
146 The acknowledge-mode element must be one of the two following:
148 <acknowledge-mode>Auto-acknowledge</acknowledge-mode>
149 <acknowledge-mode>Dups-ok-acknowledge</acknowledge-mode>
151 Used in: message-driven
152 -->
155 <!--
156 The assembly-descriptor element contains application-assembly information.
158 The application-assembly information consists of the following parts:
159 the definition of security roles, the definition of method
160 permissions, the definition of transaction attributes for
161 enterprise beans with container-managed transaction demarcation and
162 a list of methods to be excluded from being invoked.
164 All the parts are optional in the sense that they are omitted if the
165 lists represented by them are empty.
167 Providing an assembly-descriptor in the deployment descriptor is
168 optional for the ejb-jar file producer.
170 Used in: ejb-jar
171 -->
172 <!ELEMENT assembly-descriptor (security-role*, method-permission*,
173 container-transaction*, exclude-list?)>
175 <!--
176 The cascade-delete element specifies that, within a particular
177 relationship, the lifetime of one or more entity beans is dependent
178 upon the lifetime of another entity bean. The cascade-delete element
179 can only be specified for an ejb-relationship-role element contained
180 in an ejb-relation element in which the other ejb-relationship-role
181 element specifies a multiplicity of One.
183 Used in: ejb-relationship-role
184 -->
187 <!--
188 The cmp-field element describes a container-managed field. The
189 field element includes an optional description of the field, and the
190 name of the field.
192 Used in: entity
193 -->
196 <!--
197 The cmp-version element specifies the version of an entity bean
198 with container-managed persistence.
200 The cmp-version element must be one of the two following:
202 <cmp-version>1.x</cmp-version>
203 <cmp-version>2.x</cmp-version>
205 The default value of the cmp-version element is 2.x.
207 Used in: entity
208 -->
211 <!--
213 The cmr-field element describes the bean provider's view of a
214 relationship. It consists of an optional description, and the name and
215 the class type of a field in the source of a role of a
216 relationship. The cmr-field-name element corresponds to the name used
217 for the get and set accessor methods for the relationship. The
218 cmr-field-type element is used only for collection-valued
219 cmr-fields. It specifies the type of the collection that is used.
221 Used in: ejb-relationship-role
222 -->
225 <!--
226 The cmr-field-name element specifies the name of a logical
227 relationship field in the entity bean class. The name of the cmr-field
228 must begin with a lowercase letter. This field is accessed by methods
229 whose names consist of the name of the field specified by
230 cmr-field-name in which the first letter is uppercased, prefixed by
231 "get" or "set".
233 Used in: cmr-field
234 -->
237 <!--
238 The cmr-field-type element specifies the class of a
239 collection-valued logical relationship field in the entity bean
240 class. The value of the cmr-field-type element must be either:
241 java.util.Collection or java.util.Set.
243 Used in: cmr-field
244 -->
247 <!--
248 The container-transaction element specifies how the container
249 must manage transaction scopes for the enterprise bean's method
250 invocations. The element consists of an optional description, a list
251 of method elements, and a transaction attribute. The transaction
252 attribute is to be applied to all the specified methods.
254 Used in: assembly-descriptor
255 -->
258 <!--
259 The description element is used to provide text describing the parent
260 element. The description element should include any information that
261 the enterprise bean ejb-jar file producer wants to provide to the consumer of
262 the enterprise bean ejb-jar file (i.e., to the Deployer). Typically, the tools
263 used by the enterprise bean ejb-jar file consumer will display the description
264 when processing the parent element that contains the description.
266 Used in: cmp-field, cmr-field, container-transaction, ejb-jar,
267 ejb-local-ref, ejb-ref, ejb-relation, ejb-relationship-role, entity,
268 env-entry, exclude-list, message-driven, method, method-permission,
269 query, relationship-role-source, relationships, resource-env-ref,
270 resource-ref, run-as, security-identity, security-role,
271 security-role-ref, session
272 -->
275 <!--
276 The destination-type element specifies the type of the JMS
277 destination. The type is specified by the Java interface expected to
278 be implemented by the destination.
280 The destination-type element must be one of the two following:
282 <destination-type>javax.jms.Queue</destination-type>
283 <destination-type>javax.jms.Topic</destination-type>
285 Used in: message-driven-destination
286 -->
289 <!--
290 The display-name element contains a short name that is intended to be
291 displayed by tools. The display name need not be unique.
293 Used in: ejb-jar, entity, message-driven, session
295 Example:
297 <display-name>Employee Self Service</display-name>
298 -->
301 <!--
302 The ejb-class element contains the fully-qualified name of the
303 enterprise bean's class.
305 Used in: entity, message-driven, session
307 Example:
309 <ejb-class>com.wombat.empl.EmployeeServiceBean</ejb-class>
310 -->
313 <!--
314 The optional ejb-client-jar element specifies a JAR file that contains
315 the class files necessary for a client program to access the
316 enterprise beans in the ejb-jar file.
318 Used in: ejb-jar
320 Example:
322 <ejb-client-jar>employee_service_client.jar</ejb-client-jar>
323 -->
326 <!--
327 The ejb-link element is used in the ejb-ref or ejb-local-ref
328 elements to specify that an EJB reference is linked to an
329 enterprise bean.
331 The value of the ejb-link element must be the ejb-name of an
332 enterprise bean in the same ejb-jar file or in another ejb-jar
333 file in the same J2EE application unit.
335 Alternatively, the name in the ejb-link element may be composed of a
336 path name specifying the ejb-jar containing the referenced enterprise
337 bean with the ejb-name of the target bean appended and separated from
338 the path name by "#". The path name is relative to the ejb-jar file
339 containing the enterprise bean that is referencing the enterprise bean.
340 This allows multiple enterprise beans with the same ejb-name to be
341 uniquely identified.
343 Used in: ejb-local-ref, ejb-ref
345 Examples:
347 <ejb-link>EmployeeRecord</ejb-link>
349 <ejb-link>../products/product.jar#ProductEJB</ejb-link>
351 -->
354 <!--
355 The ejb-local-ref element is used for the declaration of a reference to
356 an enterprise bean's local home. The declaration consists of:
358 - an optional description
359 - the EJB reference name used in the code of the enterprise bean
360 that's referencing the enterprise bean
361 - the expected type of the referenced enterprise bean
362 - the expected local home and local interfaces of the referenced
363 enterprise bean
364 - optional ejb-link information, used to specify the referenced
365 enterprise bean
367 Used in: entity, message-driven, session
368 -->
369 <!ELEMENT ejb-local-ref (description?, ejb-ref-name, ejb-ref-type,
370 local-home, local, ejb-link?)>
372 <!--
373 The ejb-name element specifies an enterprise bean's name. This name is
374 assigned by the ejb-jar file producer to name the enterprise bean in
375 the ejb-jar file's deployment descriptor. The name must be unique
376 among the names of the enterprise beans in the same ejb-jar file.
378 There is no architected relationship between the ejb-name in the
379 deployment descriptor and the JNDI name that the Deployer will assign
380 to the enterprise bean's home.
382 The name for an entity bean with cmp-version 2.x must conform to the
383 lexical rules for an NMTOKEN. The name for an entity bean with
384 cmp-version 2.x must not be a reserved literal in EJB QL.
386 Used in: entity, message-driven, method, relationship-role-source,
387 session
389 Example:
391 <ejb-name>EmployeeService</ejb-name>
392 -->
395 <!--
396 The ejb-ql element contains the EJB QL query string that defines
397 a finder or select query. This element is defined within the scope of
398 a query element whose contents specify the finder or the select method
399 that uses the query. The content must be a valid EJB QL query string
400 for the entity bean for which the query is specified.
402 The ejb-ql element must be specified for all queries that are
403 expressible in EJB QL.
405 Used in: query
407 Example:
408 <query>
409 <query-method>
410 <method-name>ejbSelectPendingLineitems</method-name>
411 <method-params/>
412 </query-method>
413 <ejb-ql>SELECT OBJECT(l) FROM LineItems l WHERE l.shipped <> TRUE
414 </ejb-ql>
415 </query>
417 -->
420 <!--
421 The ejb-ref element is used for the declaration of a reference to
422 an enterprise bean's home. The declaration consists of:
424 - an optional description
425 - the EJB reference name used in the code of
426 the enterprise bean that's referencing the enterprise bean
427 - the expected type of the referenced enterprise bean
428 - the expected home and remote interfaces of the referenced
429 enterprise bean
430 - optional ejb-link information, used to specify the referenced
431 enterprise bean
433 Used in: entity, message-driven, session
434 -->
435 <!ELEMENT ejb-ref (description?, ejb-ref-name, ejb-ref-type,
436 home, remote, ejb-link?)>
438 <!--
439 The ejb-ref-name element contains the name of an EJB reference. The
440 EJB reference is an entry in the enterprise bean's environment and is
441 relative to the java:comp/env context. The name must be unique
442 within the enterprise bean.
444 It is recommended that name is prefixed with "ejb/".
446 Used in: ejb-local-ref, ejb-ref
448 Example:
450 <ejb-ref-name>ejb/Payroll</ejb-ref-name>
451 -->
454 <!--
455 The ejb-ref-type element contains the expected type of the
456 referenced enterprise bean.
458 The ejb-ref-type element must be one of the following:
460 <ejb-ref-type>Entity</ejb-ref-type>
461 <ejb-ref-type>Session</ejb-ref-type>
463 Used in: ejb-local-ref, ejb-ref
464 -->
467 <!--
469 The ejb-relation element describes a relationship between two
470 entity beans with container-managed persistence. An ejb-relation
471 element contains a description; an optional ejb-relation-name element;
472 and exactly two relationship role declarations, defined by the
473 ejb-relationship-role elements. The name of the relationship, if
474 specified, is unique within the ejb-jar file.
476 Used in: relationships
477 -->
478 <!ELEMENT ejb-relation (description?, ejb-relation-name?, ejb-relationship-role,
479 ejb-relationship-role)>
481 <!--
482 The ejb-relation-name element provides a unique name for a relationship.
484 Used in: ejb-relation
485 -->
488 <!--
489 The ejb-relationship-role element describes a role within a
490 relationship. There are two roles in each relationship.
492 The ejb-relationship-role element contains an optional description; an
493 optional name for the relationship role; a specification of the
494 multiplicity of the role; an optional specification of cascade-delete
495 functionality for the role; the role source; and a declaration of the
496 cmr-field, if any, by means of which the other side of the
497 relationship is accessed from the perspective of the role source.
499 The multiplicity and role-source element are mandatory.
501 The relationship-role-source element designates an entity bean by
502 means of an ejb-name element. For bidirectional relationships, both
503 roles of a relationship must declare a relationship-role-source
504 element that specifies a cmr-field in terms of which the relationship
505 is accessed. The lack of a cmr-field element in an
506 ejb-relationship-role specifies that the relationship is
507 unidirectional in navigability and the entity bean that participates
508 in the relationship is "not aware" of the relationship.
510 Used in: ejb-relation
512 Example:
514 <ejb-relation>
515 <ejb-relation-name>Product-LineItem</ejb-relation-name>
516 <ejb-relationship-role>
517 <ejb-relationship-role-name>product-has-lineitems
518 </ejb-relationship-role-name>
519 <multiplicity>One</multiplicity>
520 <relationship-role-source>
521 <ejb-name>ProductEJB</ejb-name>
522 </relationship-role-source>
523 </ejb-relationship-role>
525 -->
526 <!ELEMENT ejb-relationship-role (description?, ejb-relationship-role-name?,
527 multiplicity, cascade-delete?, relationship-role-source, cmr-field?)>
529 <!--
530 The ejb-relationship-role-name element defines a name for a role that
531 is unique within an ejb-relation. Different relationships can use the
532 same name for a role.
534 Used in: ejb-relationship-role
535 -->
538 <!--
539 The enterprise-beans element contains the declarations of one or more
540 enterprise beans.
541 -->
544 <!--
545 The entity element declares an entity bean. The declaration
546 consists of:
548 - an optional description
549 - an optional display name
550 - an optional small icon file name
551 - an optional large icon file name
552 - a unique name assigned to the enterprise bean
553 in the deployment descriptor
554 - the names of the entity bean's remote home and remote
555 interfaces, if any
556 - the names of the entity bean's local home and local
557 interfaces, if any
558 - the entity bean's implementation class
559 - the entity bean's persistence management type
560 - the entity bean's primary key class name
561 - an indication of the entity bean's reentrancy
562 - an optional specification of the entity bean's cmp-version
563 - an optional specification of the entity bean's abstract
564 schema name
565 - an optional list of container-managed fields
566 - an optional specification of the primary key field
567 - an optional declaration of the bean's environment entries
568 - an optional declaration of the bean's EJB references
569 - an optional declaration of the bean's local EJB references
570 - an optional declaration of the security role references
571 - an optional declaration of the security identity
572 to be used for the execution of the bean's methods
573 - an optional declaration of the bean's resource manager
574 connection factory references
575 - an optional declaration of the bean's
576 resource environment references
577 - an optional set of query declarations
578 for finder and select methods for an entity
579 bean with cmp-version 2.x.
581 The optional abstract-schema-name element must be specified for an
582 entity bean with container-managed persistence and cmp-version 2.x.
584 The optional primkey-field may be present in the descriptor if the
585 entity's persistence-type is Container.
587 The optional cmp-version element may be present in the descriptor if
588 the entity's persistence-type is Container. If the persistence-type is
589 Container and the cmp-version element is not specified, its value
590 defaults to 2.x.
592 The optional home and remote elements must be specified if the entity
593 bean cmp-version is 1.x.
595 The optional home and remote elements must be specified if the entity
596 bean has a remote home and remote interface.
598 The optional local-home and local elements must be specified if the
599 entity bean has a local home and local interface.
601 Either both the local-home and the local elements or both the
602 home and the remote elements must be specified.
604 The optional query elements must be present if the persistence-type is
605 Container and the cmp-version is 2.x and query methods other than
606 findByPrimaryKey have been defined for the entity bean.
608 The other elements that are optional are "optional" in the sense that
609 they are omitted if the lists represented by them are empty.
611 At least one cmp-field element must be present in the descriptor if
612 the entity's persistence-type is Container and the cmp-version is 1.x,
613 and none must not be present if the entity's persistence-type is Bean.
615 Used in: enterprise-beans
617 -->
618 <!ELEMENT entity (description?, display-name?, small-icon?,
619 large-icon?, ejb-name, home?, remote?, local-home?,
620 local?, ejb-class, persistence-type, prim-key-class,
621 reentrant, cmp-version?, abstract-schema-name?,
622 cmp-field*, primkey-field?, env-entry*, ejb-ref*,
623 ejb-local-ref*, security-role-ref*, security-identity?,
624 resource-ref*, resource-env-ref*, query*)>
626 <!--
627 The env-entry element contains the declaration of an enterprise bean's
628 environment entry. The declaration consists of an optional
629 description, the name of the environment entry, and an optional
630 value. If a value is not specified, one must be supplied
631 during deployment.
633 Used in: entity, message-driven, session
634 -->
635 <!ELEMENT env-entry (description?, env-entry-name, env-entry-type,
636 env-entry-value?)>
638 <!--
639 The env-entry-name element contains the name of an enterprise bean's
640 environment entry. The name is a JNDI name relative to the
641 java:comp/env context. The name must be unique within an enterprise bean.
643 Used in: env-entry
645 Example:
647 <env-entry-name>minAmount</env-entry-name>
648 -->
651 <!--
652 The env-entry-type element contains the fully-qualified Java type of
653 the environment entry value that is expected by the enterprise bean's
654 code.
656 The following are the legal values of env-entry-type:
658 java.lang.Boolean
659 java.lang.Byte
660 java.lang.Character
661 java.lang.String
662 java.lang.Short
663 java.lang.Integer
664 java.lang.Long
665 java.lang.Float
666 java.lang.Double
669 Used in: env-entry
671 Example:
673 <env-entry-type>java.lang.Boolean</env-entry-type>
674 -->
677 <!--
678 The env-entry-value element contains the value of an enterprise bean's
679 environment entry. The value must be a String that is valid for the
680 constructor of the specified type that takes a single String
681 parameter, or for java.lang.Character, a single character.
683 Used in: env-entry
685 Example:
687 <env-entry-value>100.00</env-entry-value>
688 -->
691 <!--
692 The exclude list element specifies one or more methods which the
693 Assembler marks to be uncallable.
695 If the method permission relation contains methods that are in the
696 exclude list, the Deployer should consider those methods to be
697 uncallable.
699 Used in: assembly-descriptor
700 -->
703 <!--
704 The field-name element specifies the name of a container managed
705 field.
707 The name of the cmp-field of an entity bean with cmp-version 2.x must
708 begin with a lowercase letter. This field is accessed by methods whose
709 names consists of the name of the field specified by field-name in
710 which the first letter is uppercased, prefixed by "get" or "set".
712 The name of the cmp-field of an entity bean with cmp-version 1.x must
713 denote a public field of the enterprise bean class or one of its
714 superclasses.
716 Used in: cmp-field
718 Example:
721 <field-name>firstName</field-Name>
723 -->
726 <!--
727 The home element contains the fully-qualified name of the enterprise
728 bean's home interface.
730 Used in: ejb-ref, entity, session
732 Example:
734 <home>com.aardvark.payroll.PayrollHome</home>
735 -->
738 <!--
739 The large-icon element contains the name of a file
740 containing a large (32 x 32) icon image. The file
741 name is a relative path within the enterprise bean's
742 ejb-jar file.
744 The image may be either in the JPEG or GIF format.
745 The icon can be used by tools.
747 Used in: ejb-jar, entity, message-driven, session
749 Example:
751 <large-icon>employee-service-icon32x32.jpg</large-icon>
752 -->
755 <!--
757 The local element contains the fully-qualified name of the
758 enterprise bean's local interface.
760 Used in: ejb-local-ref, entity, session
762 -->
765 <!--
767 The local-home element contains the fully-qualified name of the
768 enterprise bean's local home interface.
770 Used in: ejb-local-ref, entity, session
771 -->
774 <!--
776 The message-driven element declares a message-driven bean. The
777 declaration consists of:
779 - an optional description
780 - an optional display name
781 - an optional small icon file name
782 - an optional large icon file name
783 - a name assigned to the enterprise bean in
784 the deployment descriptor
785 - the message-driven bean's implementation class
786 - the message-driven bean's transaction management type
787 - an optional declaration of the message-driven bean's
788 message selector
789 - an optional declaration of the
790 acknowledgment mode for the message-driven bean
791 if bean-managed transaction demarcation is used
792 - an optional declaration of the
793 intended destination type of the message-driven bean
794 - an optional declaration of the bean's environment entries
795 - an optional declaration of the bean's EJB references
796 - an optional declaration of the bean's local EJB references
797 - an optional declaration of the security
798 identity to be used for the execution of the bean's methods
799 - an optional declaration of the bean's resource manager
800 connection factory references
801 - an optional declaration of the bean's resource
802 environment references.
804 Used in: enterprise-beans
805 -->
806 <!ELEMENT message-driven (description?, display-name?, small-icon?,
807 large-icon?, ejb-name, ejb-class, transaction-type,
808 message-selector?, acknowledge-mode?,
809 message-driven-destination?, env-entry*, ejb-ref*,
810 ejb-local-ref*, security-identity?, resource-ref*,
811 resource-env-ref*)>
813 <!--
814 The message-driven-destination element provides advice to the Deployer
815 as to whether a message-driven bean is intended for a Queue or a
816 Topic. The declaration consists of: the type of the message-driven
817 bean's intended destination and an optional declaration of whether a
818 durable or non-durable subscription should be used if the
819 destination-type is javax.jms.Topic.
821 Used in: message-driven
822 -->
823 <!ELEMENT message-driven-destination (destination-type,
824 subscription-durability?)>
826 <!--
827 The message-selector element is used to specify the JMS message
828 selector to be used in determining which messages a message-driven
829 bean is to receive.
831 Example:
832 <message-selector>JMSType = `car' AND color = `blue' AND weight > 2500
833 </message-selector>
835 Used in: message-driven
836 -->
839 <!--
841 The method element is used to denote a method of an enterprise
842 bean's home or component interface, or, in the case of a message-driven
843 bean, the bean's onMessage method, or a set of methods. The ejb-name
844 element must be the name of one of the enterprise beans declared in
845 the deployment descriptor; the optional method-intf element allows to
846 distinguish between a method with the same signature that is multiply
847 defined across in both the home and component interfaces; the
848 method-name element specifies the method name; and the optional
849 method-params elements identify a single method among multiple methods
850 with an overloaded method name.
852 There are three possible styles of the method element syntax:
854 1.
855 <method>
856 <ejb-name>EJBNAME</ejb-name>
857 <method-name>*</method-name>
858 </method>
860 This style is used to refer to all the methods of the specified
861 enterprise bean's home and component interfaces.
863 2.
864 <method>
865 <ejb-name>EJBNAME</ejb-name>
866 <method-name>METHOD</method-name>
867 </method>>
869 This style is used to refer to the specified method of the
870 specified enterprise bean. If there are multiple methods with
871 the same overloaded name, the element of this style refers to
872 all the methods with the overloaded name.
875 3.
876 <method>
877 <ejb-name>EJBNAME</ejb-name>
878 <method-name>METHOD</method-name>
879 <method-params>
880 <method-param>PARAM-1</method-param>
881 <method-param>PARAM-2</method-param>
882 ...
883 <method-param>PARAM-n</method-param>
884 </method-params>
885 <method>
888 This style is used to refer to a single method within a set of
889 methods with an overloaded name. PARAM-1 through PARAM-n are the
890 fully-qualified Java types of the method's input parameters (if
891 the method has no input arguments, the method-params element
892 contains no method-param elements). Arrays are specified by the
893 array element's type, followed by one or more pair of square
894 brackets (e.g. int[][]). If there are multiple methods with the
895 same overloaded name, this style refers to all of the overloaded
896 methods.
899 Used in: container-transaction, exclude-list, method-permission
901 Examples:
903 Style 1: The following method element refers to all the methods of
904 the EmployeeService bean's home and component interfaces:
906 <method>
907 <ejb-name>EmployeeService</ejb-name>
908 <method-name>*</method-name>
909 </method>
911 Style 2: The following method element refers to all the create
912 methods of the EmployeeService bean's home interface(s).
914 <method>
915 <ejb-name>EmployeeService</ejb-name>
916 <method-name>create</method-name>
917 </method>
920 Style 3: The following method element refers to the
921 create(String firstName, String LastName) method of the
922 EmployeeService bean's home interface(s).
924 <method>
925 <ejb-name>EmployeeService</ejb-name>
926 <method-name>create</method-name>
927 <method-params>
928 <method-param>java.lang.String</method-param>
929 <method-param>java.lang.String</method-param>
930 </method-params>
931 </method>
934 The following example illustrates a Style 3 element with
935 more complex parameter types. The method
936 foobar(char s, int i, int[] iar, mypackage.MyClass mycl,
937 mypackage.MyClass[][] myclaar) would be specified as:
939 <method>
940 <ejb-name>EmployeeService</ejb-name>
941 <method-name>foobar</method-name>
942 <method-params>
943 <method-param>char</method-param>
944 <method-param>int</method-param>
945 <method-param>int[]</method-param>
946 <method-param>mypackage.MyClass</method-param>
947 <method-param>mypackage.MyClass[][]</method-param>
948 </method-params>
949 </method>
952 The optional method-intf element can be used when it becomes necessary
953 to differentiate between a method that is multiply defined across the
954 enterprise bean's home and component interfaces with the same name and
955 signature.
958 For example, the method element
960 <method>
961 <ejb-name>EmployeeService</ejb-name>
962 <method-intf>Remote</method-intf>
963 <method-name>create</method-name>
964 <method-params>
965 <method-param>java.lang.String</method-param>
966 <method-param>java.lang.String</method-param>
967 </method-params>
968 </method>
971 can be used to differentiate the create(String, String) method defined
972 in the remote interface from the create(String, String) method defined
973 in the remote home interface, which would be defined as
976 <method>
977 <ejb-name>EmployeeService</ejb-name>
978 <method-intf>Home</method-intf>
979 <method-name>create</method-name>
980 <method-params>
981 <method-param>java.lang.String</method-param>
982 <method-param>java.lang.String</method-param>
983 </method-params>
984 </method>
986 and the create method that is defined in the local home interface
987 which would be defined as
989 <method>
990 <ejb-name>EmployeeService</ejb-name>
991 <method-intf>LocalHome</method-intf>
992 <method-name>create</method-name>
993 <method-params>
994 <method-param>java.lang.String</method-param>
995 <method-param>java.lang.String</method-param>
996 </method-params>
997 </method>
1000 The method-intf element can be used with all three Styles of the
1001 method element usage. For example, the following method element
1002 example could be used to refer to all the methods of the
1003 EmployeeService bean's remote home interface.
1006 <method>
1007 <ejb-name>EmployeeService</ejb-name>
1008 <method-intf>Home</method-intf>
1009 <method-name>*</method-name>
1010 </method>
1012 -->
1013 <!ELEMENT method (description?, ejb-name, method-intf?, method-name,
1014 method-params?)>
1016 <!--
1018 The method-intf element allows a method element to differentiate
1019 between the methods with the same name and signature that are multiply
1020 defined across the component and home interfaces (e.g, in both an
1021 enterprise bean's remote and local interfaces; in both an enterprise bean's
1022 home and remote interfaces, etc.)
1024 The method-intf element must be one of the following:
1026 <method-intf>Home</method-intf>
1027 <method-intf>Remote</method-intf>
1028 <method-intf>LocalHome</method-intf>
1029 <method-intf>Local</method-intf>
1031 Used in: method
1032 -->
1035 <!--
1036 The method-name element contains a name of an enterprise bean method
1037 or the asterisk (*) character. The asterisk is used when the element
1038 denotes all the methods of an enterprise bean's component and home
1039 interfaces.
1041 Used in: method, query-method
1042 -->
1045 <!--
1046 The method-param element contains the fully-qualified Java type name
1047 of a method parameter.
1049 Used in: method-params
1050 -->
1053 <!--
1054 The method-params element contains a list of the fully-qualified Java
1055 type names of the method parameters.
1057 Used in: method, query-method
1058 -->
1061 <!--
1063 The method-permission element specifies that one or more security
1064 roles are allowed to invoke one or more enterprise bean methods. The
1065 method-permission element consists of an optional description, a list
1066 of security role names or an indicator to state that the method is
1067 unchecked for authorization, and a list of method elements.
1069 The security roles used in the method-permission element must be
1070 defined in the security-role elements of the deployment descriptor,
1071 and the methods must be methods defined in the enterprise bean's
1072 component and/or home interfaces.
1075 Used in: assembly-descriptor
1076 -->
1079 <!--
1080 The multiplicity element describes the multiplicity of the role that
1081 participates in a relation.
1083 The multiplicity element must be one of the two following:
1085 <multiplicity>One</multiplicity>
1086 <multiplicity>Many</multiplicity>
1088 Used in: ejb-relationship-role
1089 -->
1092 <!--
1093 The persistence-type element specifies an entity bean's persistence
1094 management type.
1096 The persistence-type element must be one of the two following:
1098 <persistence-type>Bean</persistence-type>
1099 <persistence-type>Container</persistence-type>
1101 Used in: entity
1102 -->
1105 <!--
1106 The prim-key-class element contains the fully-qualified name of an
1107 entity bean's primary key class.
1109 If the definition of the primary key class is deferred to deployment
1110 time, the prim-key-class element should specify java.lang.Object.
1112 Used in: entity
1114 Examples:
1116 <prim-key-class>java.lang.String</prim-key-class>
1118 <prim-key-class>com.wombat.empl.EmployeeID</prim-key-class>
1120 <prim-key-class>java.lang.Object</prim-key-class>
1122 -->
1125 <!--
1126 The primkey-field element is used to specify the name of the primary
1127 key field for an entity with container-managed persistence.
1129 The primkey-field must be one of the fields declared in the cmp-field
1130 element, and the type of the field must be the same as the primary key
1131 type.
1133 The primkey-field element is not used if the primary key maps to
1134 multiple container-managed fields (i.e. the key is a compound key). In
1135 this case, the fields of the primary key class must be public, and
1136 their names must correspond to the field names of the entity bean
1137 class that comprise the key.
1139 Used in: entity
1141 Example:
1143 <primkey-field>EmployeeId</primkey-field>
1145 -->
1148 <!--
1149 The query element is used to specify a finder or select query. It
1150 contains
1151 - an optional description of the query
1152 - the specification of the finder or select
1153 method it is used by
1154 - an optional specification of the result type mapping, if
1155 the query is for a select method and entity objects are
1156 returned.
1157 - the EJB QL query string that defines the query.
1159 Queries that are expressible in EJB QL must use the ejb-ql element to
1160 specify the query. If a query is not expressible in EJB QL, the
1161 description element should be used to describe the semantics of the
1162 query and the ejb-ql element should be empty.
1164 The result-type-mapping is an optional element. It can only be present
1165 if the query-method specifies a select method that returns entity
1166 objects. The default value for the result-type-mapping element is
1167 "Local".
1170 Used in: entity
1171 -->
1174 <!--
1175 The query-method element is used to specify the method for a finder or
1176 select query.
1178 The method-name element specifies the name of a finder or select
1179 method in the entity bean's implementation class.
1181 Each method-param must be defined for a query-method using the
1182 method-params element.
1184 Used in: query
1186 Example:
1188 <query>
1189 <description>Method finds large orders</description>
1190 <query-method>
1191 <method-name>findLargeOrders</method-name>
1192 <method-params></method-params>
1193 </query-method>
1194 <ejb-ql>SELECT OBJECT(o) FROM Order o WHERE o.amount > 1000</ejb-ql>
1195 </query>
1197 -->
1200 <!--
1201 The reentrant element specifies whether an entity bean is reentrant or
1202 not.
1204 The reentrant element must be one of the two following:
1206 <reentrant>True</reentrant>
1207 <reentrant>False</reentrant>
1209 Used in: entity
1210 -->
1213 <!--
1215 The relationship-role-source element designates the source of a role
1216 that participates in a relationship. A relationship-role-source
1217 element uniquely identifies an entity bean.
1219 Used in: ejb-relationship-role
1220 -->
1223 <!--
1224 The relationships element describes the relationships in which
1225 entity beans with container-managed persistence participate. The
1226 relationships element contains an optional description; and a list of
1227 ejb-relation elements, which specify the container managed
1228 relationships.
1231 Used in: ejb-jar
1232 -->
1235 <!--
1236 The remote element contains the fully-qualified name of the enterprise
1237 bean's remote interface.
1239 Used in: ejb-ref, entity, session
1241 Example:
1243 <remote>com.wombat.empl.EmployeeService</remote>
1244 -->
1247 <!--
1248 The res-auth element specifies whether the enterprise bean code signs
1249 on programmatically to the resource manager, or whether the Container
1250 will sign on to the resource manager on behalf of the enterprise bean. In the
1251 latter case, the Container uses information that is supplied by the
1252 Deployer.
1254 The value of this element must be one of the two following:
1256 <res-auth>Application</res-auth>
1257 <res-auth>Container</res-auth>
1259 Used in: resource-ref
1260 -->
1263 <!--
1264 The res-ref-name element specifies the name of a resource manager
1265 connection factory reference. The name is a JNDI name relative to the
1266 java:comp/env context. The name must be unique within an enterprise bean.
1268 Used in: resource-ref
1269 -->
1272 <!--
1273 The res-sharing-scope element specifies whether connections obtained
1274 through the given resource manager connection factory reference can be
1275 shared. The value of this element, if specified, must be one of the
1276 two following:
1278 <res-sharing-scope>Shareable</res-sharing-scope>
1279 <res-sharing-scope>Unshareable</res-sharing-scope>
1281 The default value is Shareable.
1283 Used in: resource-ref
1284 -->
1287 <!--
1288 The res-type element specifies the type of the data source. The type
1289 is specified by the fully qualified Java language class or interface
1290 expected to be implemented by the data source.
1292 Used in: resource-ref
1293 -->
1296 <!--
1297 The resource-env-ref element contains a declaration of an enterprise bean's
1298 reference to an administered object associated with a resource
1299 in the enterprise bean's environment. It consists of an optional
1300 description, the resource environment reference name, and an
1301 indication of the resource environment reference type expected by
1302 the enterprise bean code.
1304 Used in: entity, message-driven, session
1306 Example:
1308 <resource-env-ref>
1309 <resource-env-ref-name>jms/StockQueue</resource-env-ref-name>
1310 <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type>
1311 </resource-env-ref>
1312 -->
1313 <!ELEMENT resource-env-ref (description?, resource-env-ref-name,
1314 resource-env-ref-type)>
1316 <!--
1317 The resource-env-ref-name element specifies the name of a resource
1318 environment reference; its value is the environment entry name used in
1319 the enterprise bean code. The name is a JNDI name relative to the
1320 java:comp/env context and must be unique within an enterprise bean.
1322 Used in: resource-env-ref
1323 -->
1326 <!--
1327 The resource-env-ref-type element specifies the type of a resource
1328 environment reference. It is the fully qualified name of a Java
1329 language class or interface.
1331 Used in: resource-env-ref
1332 -->
1335 <!--
1336 The resource-ref element contains a declaration of an enterprise bean's
1337 reference to an external resource. It consists of an optional
1338 description, the resource manager connection factory reference name,
1339 the indication of the resource manager connection factory type
1340 expected by the enterprise bean code, the type of authentication
1341 (Application or Container), and an optional specification of the
1342 shareability of connections obtained from the resource (Shareable or
1343 Unshareable).
1345 Used in: entity, message-driven, session
1347 Example:
1349 <resource-ref>
1350 <res-ref-name>jdbc/EmployeeAppDB</res-ref-name>
1351 <res-type>javax.sql.DataSource</res-type>
1352 <res-auth>Container</res-auth>
1353 <res-sharing-scope>Shareable</res-sharing-scope>
1354 </resource-ref>
1355 -->
1356 <!ELEMENT resource-ref (description?, res-ref-name, res-type, res-auth,
1357 res-sharing-scope?)>
1359 <!--
1361 The result-type-mapping element is used in the query element to specify
1362 whether an abstract schema type returned by a query for a select method
1363 is to be mapped to an EJBLocalObject or EJBObject type.
1365 The result-type-mapping element must be one of the following:
1367 <result-type-mapping>Local</result-type-mapping>
1368 <result-type-mapping>Remote</result-type-mapping>
1370 Used in: query
1371 -->
1374 <!--
1375 The role-link element is a reference to a defined security role. The
1376 role-link element must contain the name of one of the security roles
1377 defined in the security-role elements.
1379 Used in: security-role-ref
1380 -->
1383 <!--
1384 The role-name element contains the name of a security role.
1386 The name must conform to the lexical rules for an NMTOKEN.
1388 Used in: method-permission, run-as, security-role, security-role-ref
1389 -->
1392 <!--
1393 The run-as element specifies the run-as identity to be used for the
1394 execution of the enterprise bean. It contains an optional description, and
1395 the name of a security role.
1397 Used in: security-identity
1398 -->
1401 <!--
1403 The security-identity element specifies whether the caller's
1404 security identity is to be used for the execution of the methods of
1405 the enterprise bean or whether a specific run-as identity is to be
1406 used. It contains an optional description and a specification of the
1407 security identity to be used.
1409 Used in: entity, message-driven, session
1410 -->
1413 <!--
1414 The security-role element contains the definition of a security
1415 role. The definition consists of an optional description of the
1416 security role, and the security role name.
1418 Used in: assembly-descriptor
1420 Example:
1422 <security-role>
1423 <description>
1424 This role includes all employees who are authorized
1425 to access the employee service application.
1426 </description>
1427 <role-name>employee</role-name>
1428 </security-role>
1429 -->
1432 <!--
1433 The security-role-ref element contains the declaration of a security
1434 role reference in the enterprise bean's code. The declaration consists
1435 of an optional description, the security role name used in the code,
1436 and an optional link to a security role. If the security role is not
1437 specified, the Deployer must choose an appropriate security role.
1439 The value of the role-name element must be the String used as the
1440 parameter to the EJBContext.isCallerInRole(String roleName) method
1441 or the HttpServletRequest.isUserInRole(String role) method.
1443 Used in: entity, session
1445 -->
1448 <!--
1449 The session element declares an session bean. The declaration consists
1450 of:
1451 - an optional description
1452 - an optional display name
1453 - an optional small icon file name
1454 - an optional large icon file name
1455 - a name assigned to the enterprise bean
1456 in the deployment description
1457 - the names of the session bean's remote home and
1458 remote interfaces, if any
1459 - the names of the session bean's local home and
1460 local interfaces, if any
1461 - the session bean's implementation class
1462 - the session bean's state management type
1463 - the session bean's transaction management type
1464 - an optional declaration of the bean's environment entries
1465 - an optional declaration of the bean's EJB references
1466 - an optional declaration of the bean's local EJB references
1467 - an optional declaration of the security role references
1468 - an optional declaration of the security identity to be
1469 used for the execution of the bean's methods
1470 - an optional declaration of the bean's resource manager
1471 connection factory references
1472 - an optional declaration of the bean's resource environment
1473 references.
1475 The elements that are optional are "optional" in the sense that they
1476 are omitted when if lists represented by them are empty.
1478 Either both the local-home and the local elements or both the
1479 home and the remote elements must be specified for the session bean.
1481 Used in: enterprise-beans
1482 -->
1483 <!ELEMENT session (description?, display-name?, small-icon?,
1484 large-icon?, ejb-name, home?, remote?, local-home?, local?,
1485 ejb-class, session-type, transaction-type, env-entry*, ejb-ref*,
1486 ejb-local-ref*, security-role-ref*, security-identity?, resource-ref*,
1487 resource-env-ref*)>
1489 <!--
1490 The session-type element describes whether the session bean is a
1491 stateful session or stateless session.
1493 The session-type element must be one of the two following:
1495 <session-type>Stateful</session-type>
1496 <session-type>Stateless</session-type>
1497 -->
1500 <!--
1501 The small-icon element contains the name of a file
1502 containing a small (16 x 16) icon image. The file
1503 name is a relative path within the enterprise bean's
1504 ejb-jar file.
1506 The image may be either in the JPEG or GIF format.
1507 The icon can be used by tools.
1509 Used in: ejb-jar, entity, message-driven, session
1511 Example:
1513 <small-icon>employee-service-icon16x16.jpg</small-icon>
1514 -->
1517 <!--
1518 The subscription-durability element specifies whether a JMS topic
1519 subscription is intended to be durable or nondurable.
1521 The subscription-durability element must be one of the two following:
1523 <subscription-durability>Durable</subscription-durability>
1524 <subscription-durability>NonDurable</subscription-durability>
1526 Used in: message-driven-destination
1527 -->
1530 <!--
1531 The trans-attribute element specifies how the container must manage
1532 the transaction boundaries when delegating a method invocation to an
1533 enterprise bean's business method.
1535 The value of trans-attribute must be one of the following:
1538 <trans-attribute>NotSupported</trans-attribute>
1539 <trans-attribute>Supports</trans-attribute>
1540 <trans-attribute>Required</trans-attribute>
1541 <trans-attribute>RequiresNew</trans-attribute>
1542 <trans-attribute>Mandatory</trans-attribute>
1543 <trans-attribute>Never</trans-attribute>
1545 Used in: container-transaction
1546 -->
1549 <!--
1550 The transaction-type element specifies an enterprise bean's
1551 transaction management type.
1553 The transaction-type element must be one of the two following:
1555 <transaction-type>Bean</transaction-type>
1556 <transaction-type>Container</transaction-type>
1558 Used in: message-driven, session
1559 -->
1562 <!--
1563 The unchecked element specifies that a method is not checked for authorization
1564 by the container prior to invocation of the method.
1566 Used in: method-permission
1567 -->
1570 <!--
1572 The use-caller-identity element specifies that the caller's security
1573 identity be used as the security identity for the execution of the
1574 enterprise bean's methods.
1576 Used in: security-identity
1577 -->
1580 <!--
1581 The ID mechanism is to allow tools that produce additional deployment
1582 information (i.e., information beyond the standard deployment
1583 descriptor information) to store the non-standard information in a
1584 separate file, and easily refer from these tool-specific files to the
1585 information in the standard deployment descriptor.
1587 Tools are not allowed to add the non-standard information into the
1588 standard deployment descriptor.
1589 -->