Copyright (c) 2009, 2020 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-client_9.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-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.
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.
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/".
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.
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.
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.
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.
The required value for the version is 9.
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.