1
<?xml version="1.0" encoding="UTF-8"?>
2
<xsd:schema xmlns="http://www.w3.org/2001/XMLSchema"
3
targetNamespace="http://java.sun.com/xml/ns/javaee"
4
xmlns:javaee="http://java.sun.com/xml/ns/javaee"
5
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
6
elementFormDefault="qualified"
7
attributeFormDefault="unqualified"
11
@(#)application-client_5.xsds 1.26 02/17/06
18
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
20
Copyright 2003-2007 Sun Microsystems, Inc. All rights reserved.
22
The contents of this file are subject to the terms of either the
23
GNU General Public License Version 2 only ("GPL") or the Common
24
Development and Distribution License("CDDL") (collectively, the
25
"License"). You may not use this file except in compliance with
26
the License. You can obtain a copy of the License at
27
https://glassfish.dev.java.net/public/CDDL+GPL.html or
28
glassfish/bootstrap/legal/LICENSE.txt. See the License for the
29
specific language governing permissions and limitations under the
32
When distributing the software, include this License Header
33
Notice in each file and include the License file at
34
glassfish/bootstrap/legal/LICENSE.txt. Sun designates this
35
particular file as subject to the "Classpath" exception as
36
provided by Sun in the GPL Version 2 section of the License file
37
that accompanied this code. If applicable, add the following
38
below the License Header, with the fields enclosed by brackets []
39
replaced by your own identifying information:
40
"Portions Copyrighted [year] [name of copyright owner]"
44
If you wish your version of this file to be governed by only the
45
CDDL or only the GPL Version 2, indicate your decision by adding
46
"[Contributor] elects to include this software in this
47
distribution under the [CDDL or GPL Version 2] license." If you
48
don't indicate a single choice of license, a recipient has the
49
option to distribute your version of this file under either the
50
CDDL, the GPL Version 2 or to extend the choice of license to its
51
licensees as provided above. However, if you add GPL Version 2
52
code and therefore, elected the GPL Version 2 license, then the
53
option applies only if the new code is made subject to such
54
option by the copyright holder.
63
This is the XML Schema for the application client 5
64
deployment descriptor. The deployment descriptor must
65
be named "META-INF/application-client.xml" in the
66
application client's jar file. All application client
67
deployment descriptors must indicate the application
68
client schema by using the Java EE namespace:
70
http://java.sun.com/xml/ns/javaee
72
and indicate the version of the schema by
73
using the version element as shown below:
75
<application-client xmlns="http://java.sun.com/xml/ns/javaee"
76
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
77
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
78
http://java.sun.com/xml/ns/javaee/application-client_5.xsd"
83
The instance documents may indicate the published version of
84
the schema using the xsi:schemaLocation attribute for Java EE
85
namespace with the following location:
87
http://java.sun.com/xml/ns/javaee/application-client_5.xsd
96
The following conventions apply to all Java EE
97
deployment descriptor elements unless indicated otherwise.
99
- In elements that specify a pathname to a file within the
100
same JAR file, relative filenames (i.e., those not
101
starting with "/") are considered relative to the root of
102
the JAR file's namespace. Absolute filenames (i.e., those
103
starting with "/") also specify names in the root of the
104
JAR file's namespace. In general, relative names are
105
preferred. The exception is .war files where absolute
106
names are preferred for consistency with the Servlet API.
111
<xsd:include schemaLocation="javaee_5.xsd"/>
114
<!-- **************************************************** -->
116
<xsd:element name="application-client" type="javaee:application-clientType">
120
The application-client element is the root element of an
121
application client deployment descriptor. The application
122
client deployment descriptor describes the EJB components
123
and external resources referenced by the application
129
<xsd:unique name="env-entry-name-uniqueness">
133
The env-entry-name element contains the name of an
134
application client's environment entry. The name is a JNDI
135
name relative to the java:comp/env context. The name must
136
be unique within an application client.
140
<xsd:selector xpath="javaee:env-entry"/>
141
<xsd:field xpath="javaee:env-entry-name"/>
144
<xsd:unique name="ejb-ref-name-uniqueness">
148
The ejb-ref-name element contains the name of an EJB
149
reference. The EJB reference is an entry in the application
150
client's environment and is relative to the
151
java:comp/env context. The name must be unique within the
154
It is recommended that name is prefixed with "ejb/".
158
<xsd:selector xpath="javaee:ejb-ref"/>
159
<xsd:field xpath="javaee:ejb-ref-name"/>
162
<xsd:unique name="res-ref-name-uniqueness">
166
The res-ref-name element specifies the name of a
167
resource manager connection factory reference.The name
168
is a JNDI name relative to the java:comp/env context.
169
The name must be unique within an application client.
173
<xsd:selector xpath="javaee:resource-ref"/>
174
<xsd:field xpath="javaee:res-ref-name"/>
177
<xsd:unique name="resource-env-ref-uniqueness">
181
The resource-env-ref-name element specifies the name of
182
a resource environment reference; its value is the
183
environment entry name used in the application client
184
code. The name is a JNDI name relative to the
185
java:comp/env context and must be unique within an
190
<xsd:selector xpath="javaee:resource-env-ref"/>
191
<xsd:field xpath="javaee:resource-env-ref-name"/>
194
<xsd:unique name="message-destination-ref-uniqueness">
198
The message-destination-ref-name element specifies the
199
name of a message destination reference; its value is
200
the message destination reference name used in the
201
application client code. The name is a JNDI name
202
relative to the java:comp/env context and must be unique
203
within an application client.
207
<xsd:selector xpath="javaee:message-destination-ref"/>
208
<xsd:field xpath="javaee:message-destination-ref-name"/>
212
<!-- **************************************************** -->
214
<xsd:complexType name="application-clientType">
216
<xsd:group ref="javaee:descriptionGroup"/>
217
<xsd:element name="env-entry"
218
type="javaee:env-entryType"
219
minOccurs="0" maxOccurs="unbounded"/>
220
<xsd:element name="ejb-ref"
221
type="javaee:ejb-refType"
222
minOccurs="0" maxOccurs="unbounded"/>
223
<xsd:group ref="javaee:service-refGroup"/>
224
<xsd:element name="resource-ref"
225
type="javaee:resource-refType"
226
minOccurs="0" maxOccurs="unbounded"/>
227
<xsd:element name="resource-env-ref"
228
type="javaee:resource-env-refType"
229
minOccurs="0" maxOccurs="unbounded"/>
230
<xsd:element name="message-destination-ref"
231
type="javaee:message-destination-refType"
232
minOccurs="0" maxOccurs="unbounded"/>
233
<xsd:element name="persistence-unit-ref"
234
type="javaee:persistence-unit-refType"
235
minOccurs="0" maxOccurs="unbounded"/>
236
<xsd:element name="post-construct"
237
type="javaee:lifecycle-callbackType"
238
minOccurs="0" maxOccurs="unbounded"/>
239
<xsd:element name="pre-destroy"
240
type="javaee:lifecycle-callbackType"
241
minOccurs="0" maxOccurs="unbounded"/>
242
<xsd:element name="callback-handler"
243
type="javaee:fully-qualified-classType"
248
The callback-handler element names a class provided by
249
the application. The class must have a no args
250
constructor and must implement the
251
javax.security.auth.callback.CallbackHandler
252
interface. The class will be instantiated by the
253
application client container and used by the container
254
to collect authentication information from the user.
259
<xsd:element name="message-destination"
260
type="javaee:message-destinationType"
262
maxOccurs="unbounded"/>
265
<xsd:attribute name="version"
266
type="javaee:dewey-versionType"
272
The required value for the version is 5.
279
<xsd:attribute name="metadata-complete" type="xsd:boolean">
283
The metadata-complete attribute defines whether this
284
deployment descriptor and other related deployment
285
descriptors for this module (e.g., web service
286
descriptors) are complete, or whether the class
287
files available to this module and packaged with
288
this application should be examined for annotations
289
that specify deployment information.
291
If metadata-complete is set to "true", the deployment
292
tool must ignore any annotations that specify deployment
293
information, which might be present in the class files
296
If metadata-complete is not specified or is set to
297
"false", the deployment tool must examine the class
298
files of the application for annotations, as
299
specified by the specifications.
306
<xsd:attribute name="id" type="xsd:ID"/>