308 lines
12 KiB
XML
308 lines
12 KiB
XML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<xsd:schema xmlns="http://www.w3.org/2001/XMLSchema"
|
||
|
|
targetNamespace="https://jakarta.ee/xml/ns/jakartaee"
|
||
|
|
xmlns:jakartaee="https://jakarta.ee/xml/ns/jakartaee"
|
||
|
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||
|
|
elementFormDefault="qualified"
|
||
|
|
attributeFormDefault="unqualified"
|
||
|
|
version="10">
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
Copyright (c) 2009, 2021 Oracle and/or its affiliates. All rights reserved.
|
||
|
|
|
||
|
|
This program and the accompanying materials are made available under the
|
||
|
|
terms of the Eclipse Public License v. 2.0, which is available at
|
||
|
|
http://www.eclipse.org/legal/epl-2.0.
|
||
|
|
|
||
|
|
This Source Code may also be made available under the following Secondary
|
||
|
|
Licenses when the conditions for such availability set forth in the
|
||
|
|
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
|
||
|
|
version 2 with the GNU Classpath Exception, which is available at
|
||
|
|
https://www.gnu.org/software/classpath/license.html.
|
||
|
|
|
||
|
|
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
<![CDATA[
|
||
|
|
This is the XML Schema for the application client 10
|
||
|
|
deployment descriptor. The deployment descriptor must
|
||
|
|
be named "META-INF/application-client.xml" in the
|
||
|
|
application client's jar file. All application client
|
||
|
|
deployment descriptors must indicate the application
|
||
|
|
client schema by using the Jakarta EE namespace:
|
||
|
|
|
||
|
|
https://jakarta.ee/xml/ns/jakartaee
|
||
|
|
|
||
|
|
and indicate the version of the schema by
|
||
|
|
using the version element as shown below:
|
||
|
|
|
||
|
|
<application-client xmlns="https://jakarta.ee/xml/ns/jakartaee"
|
||
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||
|
|
xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee
|
||
|
|
https://jakarta.ee/xml/ns/jakartaee/application-client_10.xsd"
|
||
|
|
version="10">
|
||
|
|
...
|
||
|
|
</application-client>
|
||
|
|
|
||
|
|
The instance documents may indicate the published version of
|
||
|
|
the schema using the xsi:schemaLocation attribute for Jakarta EE
|
||
|
|
namespace with the following location:
|
||
|
|
|
||
|
|
https://jakarta.ee/xml/ns/jakartaee/application-client_10.xsd
|
||
|
|
|
||
|
|
]]>
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
The following conventions apply to all Jakarta EE
|
||
|
|
deployment descriptor elements unless indicated otherwise.
|
||
|
|
|
||
|
|
- In elements that specify a pathname to a file within the
|
||
|
|
same JAR file, relative filenames (i.e., those not
|
||
|
|
starting with "/") are considered relative to the root of
|
||
|
|
the JAR file's namespace. Absolute filenames (i.e., those
|
||
|
|
starting with "/") also specify names in the root of the
|
||
|
|
JAR file's namespace. In general, relative names are
|
||
|
|
preferred. The exception is .war files where absolute
|
||
|
|
names are preferred for consistency with the Servlet API.
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
|
||
|
|
<xsd:include schemaLocation="jakartaee_10.xsd"/>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- **************************************************** -->
|
||
|
|
|
||
|
|
<xsd:element name="application-client"
|
||
|
|
type="jakartaee:application-clientType">
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
The application-client element is the root element of an
|
||
|
|
application client deployment descriptor. The application
|
||
|
|
client deployment descriptor describes the enterprise bean
|
||
|
|
components and external resources referenced by the
|
||
|
|
application client.
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
<xsd:unique name="env-entry-name-uniqueness">
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
The env-entry-name element contains the name of an
|
||
|
|
application client's environment entry. The name is a JNDI
|
||
|
|
name relative to the java:comp/env context. The name must
|
||
|
|
be unique within an application client.
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
<xsd:selector xpath="jakartaee:env-entry"/>
|
||
|
|
<xsd:field xpath="jakartaee:env-entry-name"/>
|
||
|
|
</xsd:unique>
|
||
|
|
<xsd:unique name="ejb-ref-name-uniqueness">
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
The ejb-ref-name element contains the name of an enterprise bean
|
||
|
|
reference. The enterprise bean reference is an entry
|
||
|
|
in the application client's environment and is relative to the
|
||
|
|
java:comp/env context. The name must be unique within the
|
||
|
|
application client.
|
||
|
|
|
||
|
|
It is recommended that name is prefixed with "ejb/".
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
<xsd:selector xpath="jakartaee:ejb-ref"/>
|
||
|
|
<xsd:field xpath="jakartaee:ejb-ref-name"/>
|
||
|
|
</xsd:unique>
|
||
|
|
<xsd:unique name="res-ref-name-uniqueness">
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
The res-ref-name element specifies the name of a
|
||
|
|
resource manager connection factory reference.The name
|
||
|
|
is a JNDI name relative to the java:comp/env context.
|
||
|
|
The name must be unique within an application client.
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
<xsd:selector xpath="jakartaee:resource-ref"/>
|
||
|
|
<xsd:field xpath="jakartaee:res-ref-name"/>
|
||
|
|
</xsd:unique>
|
||
|
|
<xsd:unique name="resource-env-ref-uniqueness">
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
The resource-env-ref-name element specifies the name of
|
||
|
|
a resource environment reference; its value is the
|
||
|
|
environment entry name used in the application client
|
||
|
|
code. The name is a JNDI name relative to the
|
||
|
|
java:comp/env context and must be unique within an
|
||
|
|
application client.
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
<xsd:selector xpath="jakartaee:resource-env-ref"/>
|
||
|
|
<xsd:field xpath="jakartaee:resource-env-ref-name"/>
|
||
|
|
</xsd:unique>
|
||
|
|
<xsd:unique name="message-destination-ref-uniqueness">
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
The message-destination-ref-name element specifies the
|
||
|
|
name of a message destination reference; its value is
|
||
|
|
the message destination reference name used in the
|
||
|
|
application client code. The name is a JNDI name
|
||
|
|
relative to the java:comp/env context and must be unique
|
||
|
|
within an application client.
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
<xsd:selector xpath="jakartaee:message-destination-ref"/>
|
||
|
|
<xsd:field xpath="jakartaee:message-destination-ref-name"/>
|
||
|
|
</xsd:unique>
|
||
|
|
</xsd:element>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- **************************************************** -->
|
||
|
|
|
||
|
|
<xsd:complexType name="application-clientType">
|
||
|
|
<xsd:sequence>
|
||
|
|
<xsd:element name="module-name"
|
||
|
|
type="jakartaee:string"
|
||
|
|
minOccurs="0"/>
|
||
|
|
<xsd:group ref="jakartaee:descriptionGroup"/>
|
||
|
|
<xsd:element name="env-entry"
|
||
|
|
type="jakartaee:env-entryType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="ejb-ref"
|
||
|
|
type="jakartaee:ejb-refType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:group ref="jakartaee:service-refGroup"/>
|
||
|
|
<xsd:element name="resource-ref"
|
||
|
|
type="jakartaee:resource-refType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="resource-env-ref"
|
||
|
|
type="jakartaee:resource-env-refType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="message-destination-ref"
|
||
|
|
type="jakartaee:message-destination-refType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="persistence-unit-ref"
|
||
|
|
type="jakartaee:persistence-unit-refType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="post-construct"
|
||
|
|
type="jakartaee:lifecycle-callbackType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="pre-destroy"
|
||
|
|
type="jakartaee:lifecycle-callbackType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="callback-handler"
|
||
|
|
type="jakartaee:fully-qualified-classType"
|
||
|
|
minOccurs="0">
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
The callback-handler element names a class provided by
|
||
|
|
the application. The class must have a no args
|
||
|
|
constructor and must implement the
|
||
|
|
jakarta.security.auth.callback.CallbackHandler
|
||
|
|
interface. The class will be instantiated by the
|
||
|
|
application client container and used by the container
|
||
|
|
to collect authentication information from the user.
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
</xsd:element>
|
||
|
|
<xsd:element name="message-destination"
|
||
|
|
type="jakartaee:message-destinationType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="data-source"
|
||
|
|
type="jakartaee:data-sourceType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="jms-connection-factory"
|
||
|
|
type="jakartaee:jms-connection-factoryType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="jms-destination"
|
||
|
|
type="jakartaee:jms-destinationType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="mail-session"
|
||
|
|
type="jakartaee:mail-sessionType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="connection-factory"
|
||
|
|
type="jakartaee:connection-factory-resourceType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
<xsd:element name="administered-object"
|
||
|
|
type="jakartaee:administered-objectType"
|
||
|
|
minOccurs="0"
|
||
|
|
maxOccurs="unbounded"/>
|
||
|
|
</xsd:sequence>
|
||
|
|
<xsd:attribute name="version"
|
||
|
|
type="jakartaee:dewey-versionType"
|
||
|
|
fixed="10"
|
||
|
|
use="required">
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
The required value for the version is 10.
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
</xsd:attribute>
|
||
|
|
<xsd:attribute name="metadata-complete"
|
||
|
|
type="xsd:boolean">
|
||
|
|
<xsd:annotation>
|
||
|
|
<xsd:documentation>
|
||
|
|
|
||
|
|
The metadata-complete attribute defines whether this
|
||
|
|
deployment descriptor and other related deployment
|
||
|
|
descriptors for this module (e.g., web service
|
||
|
|
descriptors) are complete, or whether the class
|
||
|
|
files available to this module and packaged with
|
||
|
|
this application should be examined for annotations
|
||
|
|
that specify deployment information.
|
||
|
|
|
||
|
|
If metadata-complete is set to "true", the deployment
|
||
|
|
tool must ignore any annotations that specify deployment
|
||
|
|
information, which might be present in the class files
|
||
|
|
of the application.
|
||
|
|
|
||
|
|
If metadata-complete is not specified or is set to
|
||
|
|
"false", the deployment tool must examine the class
|
||
|
|
files of the application for annotations, as
|
||
|
|
specified by the specifications.
|
||
|
|
|
||
|
|
</xsd:documentation>
|
||
|
|
</xsd:annotation>
|
||
|
|
</xsd:attribute>
|
||
|
|
<xsd:attribute name="id"
|
||
|
|
type="xsd:ID"/>
|
||
|
|
</xsd:complexType>
|
||
|
|
|
||
|
|
</xsd:schema>
|