blob: 6c58cc9363cbe5bacba8a9cdeb1cb855a4303d46 [file] [log] [blame]
david_williamse073de12007-04-28 04:01:44 +00001<!--
2Copyright 1999 Sun Microsystems, Inc. 901 San Antonio Road,
3Palo Alto, CA 94303, U.S.A. All rights reserved.
4
5This product or document is protected by copyright and distributed
6under licenses restricting its use, copying, distribution, and
7decompilation. No part of this product or documentation may be
8reproduced in any form by any means without prior written authorization
9of Sun and its licensors, if any.
10
11Third party software, including font technology, is copyrighted and
12licensed from Sun suppliers.
13
14Sun, Sun Microsystems, the Sun Logo, Solaris, Java, JavaServer Pages, Java
15Naming and Directory Interface, JDBC, JDK, JavaMail and Enterprise JavaBeans,
16are trademarks or registered trademarks of Sun Microsystems, Inc in the U.S.
17and other countries.
18
19All SPARC trademarks are used under license and are trademarks
20or registered trademarks of SPARC International, Inc.
21in the U.S. and other countries. Products bearing SPARC
22trademarks are based upon an architecture developed by Sun Microsystems, Inc.
23
24PostScript is a registered trademark of Adobe Systems, Inc.
25
26
27Federal Acquisitions: Commercial Software - Government Users Subject to
28Standard License Terms and Conditions.
29
30
31
32DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED
33CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY
34IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
35PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT
36TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY
37INVALID.
38
39_________________________________________________________________________
40Copyright 1999 Sun Microsystems, Inc.,
41901 San Antonio Road, Palo Alto, CA 94303, Etats-Unis.
42Tous droits re'serve's.
43
44
45Ce produit ou document est prote'ge' par un copyright et distribue' avec
46des licences qui en restreignent l'utilisation, la copie, la distribution,
47et la de'compilation. Aucune partie de ce produit ou de sa documentation
48associe'e ne peut e^tre reproduite sous aucune forme, par quelque moyen
49que ce soit, sans l'autorisation pre'alable et e'crite de Sun et de ses
50bailleurs de licence, s'il y en a.
51
52Le logiciel de'tenu par des tiers, et qui comprend la technologie
53relative aux polices de caracte`res, est prote'ge' par un copyright
54et licencie' par des fournisseurs de Sun.
55
56Sun, Sun Microsystems, le logo Sun, Solaris, Java, JavaServer Pages, Java
57Naming and Directory Interface, JDBC, JDK, JavaMail, et Enterprise JavaBeans,
58sont des marques de fabrique ou des marques de'pose'es de Sun
59Microsystems, Inc. aux Etats-Unis et dans d'autres pays.
60
61Toutes les marques SPARC sont utilise'es sous licence et sont
62des marques de fabrique ou des marques de'pose'es de SPARC
63International, Inc. aux Etats-Unis et dans
64d'autres pays. Les produits portant les marques SPARC sont
65base's sur une architecture de'veloppe'e par Sun Microsystems, Inc.
66
67Postcript est une marque enregistre'e d'Adobe Systems Inc.
68
69LA DOCUMENTATION EST FOURNIE "EN L'ETAT" ET TOUTES AUTRES CONDITIONS,
70DECLARATIONS ET GARANTIES EXPRESSES OU TACITES SONT FORMELLEMENT EXCLUES,
71DANS LA MESURE AUTORISEE PAR LA LOI APPLICABLE, Y COMPRIS NOTAMMENT
72TOUTE GARANTIE IMPLICITE RELATIVE A LA QUALITE MARCHANDE, A L'APTITUDE
73A UNE UTILISATION PARTICULIERE OU A L'ABSENCE DE CONTREFACON.
74-->
75
76<!--
77The application-client element is the root element of an application client
78deployment descriptor.
79The application client deployment descriptor describes the EJB components and
80external resources referenced by the application client.
81-->
82<!ELEMENT application-client (icon?, display-name, description?, env-entry*,
83ejb-ref*, resource-ref*)>
84
85<!--
86The description element is used to provide text describing the parent element.
87The description element should include any information that the
88application-client file producer wants to provide to the consumer of the
89application-client file (i.e., to the Deployer). Typically, the tools used by
90the application-client file consumer will display the description when
91processing the parent element that contains the description.
92-->
93<!ELEMENT description (#PCDATA)>
94
95<!--
96The display-name element contains a short name that is intended to be displayed
97by tools.
98-->
99<!ELEMENT display-name (#PCDATA)>
100
101<!--
102The ejb-link element is used in the ejb-ref element to specify that an EJB
103reference is linked to an enterprise bean in the encompassing J2EE Application
104package. The value of the ejb-link element must be the ejb-name of an enterprise
105bean in the same J2EE Application package. Used in: ejb-ref
106Example: <ejb-link>EmployeeRecord</ejb-link>
107-->
108<!ELEMENT ejb-link (#PCDATA)>
109
110<!--
111The ejb-ref element is used for the declaration of a reference to an enterprise
112bean's home. The declaration consists of an optional description; the EJB
113reference name used in the code of the referencing application client; the
114expected type of the referenced enterprise bean; the expected home and remote
115interfaces of the referenced enterprise bean; and an optional ejb-link
116information. The optional ejb-link element is used to specify the referenced
117enterprise bean.
118-->
119<!ELEMENT ejb-ref (description?, ejb-ref-name, ejb-ref-type, home, remote,
120ejb-link?)>
121
122<!--
123The ejb-ref-name element contains the name of an EJB reference. The EJB
124reference is an entry in the application client's environment. It is recommended
125that name is prefixed with "ejb/". Used in: ejb-ref
126Example: <ejb-ref-name>ejb/Payroll</ejb-ref-name>
127-->
128<!ELEMENT ejb-ref-name (#PCDATA)>
129
130<!--
131The ejb-ref-type element contains the expected type of the referenced enterprise
132bean. The ejb-ref-type element must be one of the following:
133<ejb-ref-type>Entity</ejb-ref-type>
134<ejb-ref-type>Session</ejb-ref-type>
135Used in: ejb-ref
136-->
137<!ELEMENT ejb-ref-type (#PCDATA)>
138
139<!--
140The env-entry element contains the declaration of an application client's
141environment entries. The declaration consists of an optional description, the
142name of the environment entry, and an optional value.
143-->
144<!ELEMENT env-entry (description?, env-entry-name, env-entry-type,
145env-entry-value?)>
146
147<!--
148The env-entry-name element contains the name of an application client's
149environment entry. Used in: env-entry
150Example: <env-entry-name>EmployeeAppDB</env-entry-name>
151-->
152<!ELEMENT env-entry-name (#PCDATA)>
153
154<!--
155The env-entry-type element contains the fully-qualified Java type of the
156environment entry value that is expected by the application client's code. The
157following are the legal values of env-entry-type: java.lang.Boolean,
158java.lang.String, java.lang.Integer, java.lang.Double, java.lang.Byte,
159java.lang.Short, java.lang.Long, and java.lang.Float.
160
161Used in: env-entry
162
163Example:
164<env-entry-type>java.lang.Boolean</env-entry-type>
165-->
166<!ELEMENT env-entry-type (#PCDATA)>
167
168<!--
169The env-entry-value element contains the value of an application client's
170environment entry. The value must be a String that is valid for the constructor
171of the specified type that takes a single String parameter.
172
173Used in: env-entry
174
175Example:
176<env-entry-value>/datasources/MyDatabase</env-entry-value>
177-->
178<!ELEMENT env-entry-value (#PCDATA)>
179
180<!--
181The home element contains the fully-qualified name of the enterprise bean's home
182interface.
183Used in: ejb-ref
184Example: <home>com.aardvark.payroll.PayrollHome</home>
185-->
186<!ELEMENT home (#PCDATA)>
187
188<!--
189The icon element contains a small-icon and large-icon element which specify the
190URIs for a small and a large GIF or JPEG icon image used to represent the
191application client in a GUI tool.
192-->
193<!ELEMENT icon (small-icon?, large-icon?)>
194
195<!--
196The large-icon element contains the name of a file containing a large (32 x 32)
197icon image. The file name is a relative path within the application-client jar
198file. The image must be either in the JPEG or GIF format, and the file name must
199end with the suffix ".jpg" or ".gif" respectively. The icon can be used by
200tools.
201Example:
202<large-icon>lib/images/employee-service-icon32x32.jpg</large-icon>
203-->
204<!ELEMENT large-icon (#PCDATA)>
205
206<!--
207The remote element contains the fully-qualified name of the enterprise bean's
208remote interface.
209Used in: ejb-ref
210Example:
211<remote>com.wombat.empl.EmployeeService</remote>
212-->
213<!ELEMENT remote (#PCDATA)>
214
215<!--
216The res-auth element specifies whether the enterprise bean code signs on
217programmatically to the resource manager, or whether the Container will sign on
218to the resource manager on behalf of the bean. In the latter case, the Container
219uses information that is supplied by the Deployer.
220The value of this element must be one of the two following:
221<res-auth>Application</res-auth>
222<res-auth>Container</res-auth>
223-->
224<!ELEMENT res-auth (#PCDATA)>
225
226<!--
227The res-ref-name element specifies the name of the resource factory reference
228name. The resource factory reference name is the name of the application
229client's environment entry whose value contains the JNDI name of the data
230source.
231Used in: resource-ref
232-->
233<!ELEMENT res-ref-name (#PCDATA)>
234
235<!--
236The res-type element specifies the type of the data source. The type is
237specified by the Java interface (or class) expected to be implemented by the
238data source.
239Used in: resource-ref
240-->
241<!ELEMENT res-type (#PCDATA)>
242
243<!--
244The resource-ref element contains a declaration of application clients's
245reference to an external resource. It consists of an optional description, the
246resource factory reference name, the indication of the resource factory type
247expected by the application client's code, and the type of authentication (bean
248or container).
249
250Example:
251<resource-ref>
252<res-ref-name>EmployeeAppDB</res-ref-name>
253<res-type>javax.sql.DataSource</res-type>
254<res-auth>Container</res-auth>
255</resource-ref>
256-->
257<!ELEMENT resource-ref (description?, res-ref-name, res-type, res-auth)>
258<!--
259The small-icon element contains the name of a file containing a small (16 x 16)
260icon image. The file name is a relative path within the application-client jar
261file. The image must be either in the JPEG or GIF format, and the file name must
262end with the suffix ".jpg" or ".gif" respectively. The icon can be used by
263tools.
264Example:
265<small-icon>lib/images/employee-service-icon16x16.jpg</small-icon>
266-->
267<!ELEMENT small-icon (#PCDATA)>
268
269<!--
270The ID mechanism is to allow tools to easily make tool-specific references to
271the elements of the deployment descriptor.
272 -->
273<!ATTLIST application-client id ID #IMPLIED>
274<!ATTLIST description id ID #IMPLIED>
275<!ATTLIST display-name id ID #IMPLIED>
276<!ATTLIST ejb-link id ID #IMPLIED>
277<!ATTLIST ejb-ref id ID #IMPLIED>
278<!ATTLIST ejb-ref-name id ID #IMPLIED>
279<!ATTLIST ejb-ref-type id ID #IMPLIED>
280<!ATTLIST env-entry id ID #IMPLIED>
281<!ATTLIST env-entry-name id ID #IMPLIED>
282<!ATTLIST env-entry-type id ID #IMPLIED>
283<!ATTLIST env-entry-value id ID #IMPLIED>
284<!ATTLIST home id ID #IMPLIED>
285<!ATTLIST icon id ID #IMPLIED>
286<!ATTLIST large-icon id ID #IMPLIED>
287<!ATTLIST remote id ID #IMPLIED>
288<!ATTLIST res-auth id ID #IMPLIED>
289<!ATTLIST res-ref-name id ID #IMPLIED>
290<!ATTLIST res-type id ID #IMPLIED>
291<!ATTLIST resource-ref id ID #IMPLIED>
292<!ATTLIST small-icon id ID #IMPLIED>