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
...
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_10.xsd
]]>
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.
The application element is the root element of a Jakarta EE
application deployment descriptor.
The context-root element content must be unique
in the ear.
The security-role-name element content
must be unique in the ear.
The applicationType defines the structure of the
application.
If initialize-in-order is true, modules must be initialized
in the order they're listed in this deployment descriptor,
with the exception of application client modules, which can
be initialized in any order.
If initialize-in-order is not set or set to false, the order
of initialization is unspecified and may be product-dependent.
The application deployment descriptor must have one
module element for each Jakarta EE module in the
application package. A module element is defined
by moduleType definition.
The library-directory element specifies the pathname
of a directory within the application package, relative
to the top level of the application package. All files
named "*.jar" in this directory must be made available
in the class path of all components included in this
application package. If this element isn't specified,
the directory named "lib" is searched. An empty element
may be used to disable searching.
The required value for the version is 10.
The moduleType defines a single Jakarta EE module and contains a
connector, ejb, java, or web element, which indicates the
module type and contains a path to the module file, and an
optional alt-dd element, which specifies an optional URI to
the post-assembly version of the deployment descriptor.
The connector element specifies the URI of a
resource adapter archive file, relative to the
top level of the application package.
The ejb element specifies the URI of an ejb-jar,
relative to the top level of the application
package.
The java element specifies the URI of a java
application client module, relative to the top
level of the application package.
The alt-dd element specifies an optional URI to the
post-assembly version of the deployment descriptor
file for a particular Jakarta EE module. The URI must
specify the full pathname of the deployment
descriptor file relative to the application's root
directory. If alt-dd is not specified, the deployer
must read the deployment descriptor from the default
location and file name required by the respective
component specification.
The webType defines the web-uri and context-root of
a web application module.
The web-uri element specifies the URI of a web
application file, relative to the top level of the
application package.
The context-root element specifies the context root
of a web application.