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
</xsd:documentation>
</xsd:annotation>
<xsd:annotation>
<xsd:documentation>
The following definitions that appear in the common
shareable schema(s) of Jakarta EE deployment descriptors should be
interpreted with respect to the context they are included:
Deployment Component may indicate one of the following:
Jakarta EE application;
application client;
web application;
enterprise bean;
resource adapter;
Deployment File may indicate one of the following:
ear file;
war file;
jar file;
rar file;
This group collects elements that are common to all the
JNDI resource elements. It does not include the lookup-name element, that is only applicable to some resource elements.
A product specific name that this resource should be
mapped to. The name of this resource, as defined by the
resource's name element or defaulted, is a name that is
local to the application component using the resource.
(It's a name in the JNDI java:comp/env namespace.) Many
application servers provide a way to map these local
names to names of resources known to the application
server. This mapped name is often a global JNDI name,
but may be a name of any form.
Application servers are not required to support any
particular form or type of mapped name, nor the ability
to use mapped names. The mapped name is
product-dependent and often installation-dependent. No
use of a mapped name is portable.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="url" type="jakartaee:jdbc-urlType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
A JDBC URL. If the <code>url</code> property is specified
along with other standard <code>DataSource</code> properties
such as <code>serverName</code>, <code>databaseName</code>
and <code>portNumber</code>, the more specific properties will
take precedence and <code>url</code> will be ignored.
The description type is used by a description element to
provide text describing the parent element. The elements
that use this type should include any information that the
Deployment Component's Deployment File file producer wants
to provide to the consumer of the Deployment Component's
Deployment File (i.e., to the Deployer). Typically, the
tools used by such a Deployment File consumer will display
the description when processing the parent element that
contains the description.
The lang attribute defines the language that the
description is provided in. The default value is "en" (English).
<xsd:complexType name="display-nameType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The display-name type contains a short name that is intended
to be displayed by tools. It is used by display-name
elements. The display name need not be unique.
Example:
...
<display-name xml:lang="en">
Employee Self Service
</display-name>
The value of the xml:lang attribute is "en" (English) by default.
<xsd:complexType name="ejb-linkType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The ejb-linkType is used by ejb-link
elements in the ejb-ref or ejb-local-ref elements to specify
that an enterprise bean reference is linked to enterprise bean.
The value of the ejb-link element must be the ejb-name of an
enterprise bean in the same ejb-jar file or in another ejb-jar
file in the same Jakarta EE application unit.
Alternatively, the name in the ejb-link element may be
composed of a path name specifying the ejb-jar containing the
referenced enterprise bean with the ejb-name of the target
bean appended and separated from the path name by "#". The
path name is relative to the Deployment File containing
Deployment Component that is referencing the enterprise
bean. This allows multiple enterprise beans with the same
ejb-name to be uniquely identified.
The ejb-local-refType is used by ejb-local-ref elements for
the declaration of a reference to an enterprise bean's local
home or to the local business interface of a 3.0 bean.
The declaration consists of:
- an optional description
- the enterprise bean's reference name used in the code of the
Deployment Component that's referencing the enterprise bean.
- the optional expected type of the referenced enterprise bean
- the optional expected local interface of the referenced
enterprise bean or the local business interface of the
referenced enterprise bean.
- the optional expected local home interface of the referenced
enterprise bean. Not applicable if this ejb-local-ref refers
to the local business interface of a 3.0 bean.
- optional ejb-link information, used to specify the
referenced enterprise bean
- optional elements to define injection of the named enterprise
bean into a component field or property.
<xsd:complexType name="ejb-ref-nameType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The ejb-ref-name element contains the name of an enterprise bean reference.
The enterprise bean reference is an entry in the Deployment Component's
environment and is relative to the java:comp/env context. The name must
be unique within the Deployment Component.
It is recommended that name is prefixed with "ejb/".
The ejb-refType is used by ejb-ref elements for the
declaration of a reference to an enterprise bean's home or
to the remote business interface of a 3.0 bean.
The declaration consists of:
- an optional description
- the enterprise bean's reference name used in the code of
the Deployment Component that's referencing the enterprise
bean.
- the optional expected type of the referenced enterprise bean
- the optional remote interface of the referenced enterprise bean
or the remote business interface of the referenced enterprise
bean
- the optional expected home interface of the referenced
enterprise bean. Not applicable if this ejb-ref
refers to the remote business interface of a 3.0 bean.
- optional ejb-link information, used to specify the
referenced enterprise bean
- optional elements to define injection of the named enterprise
bean into a component field or property
The env-entryType is used to declare an application's
environment entry. The declaration consists of an optional
description, the name of the environment entry, a type
(optional if the value is injected, otherwise required), and
an optional value.
It also includes optional elements to define injection of
the named resource into fields or JavaBeans properties.
If a value is not specified and injection is requested,
no injection will occur and no entry of the specified name
will be created. This allows an initial value to be
specified in the source code without being incorrectly
changed when no override has been specified.
If a value is not specified and no injection is requested,
a value must be supplied during deployment.
This type is used by env-entry elements.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description" type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="env-entry-name" type="jakartaee:jndi-nameType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The env-entry-name element contains the name of a
Deployment Component's environment entry. The name
is a JNDI name relative to the java:comp/env
context. The name must be unique within a
Deployment Component. The uniqueness
constraints must be defined within the declared
context.
Example:
<env-entry-name>minAmount</env-entry-name>
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="env-entry-type" type="jakartaee:env-entry-type-valuesType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The env-entry-type element contains the Java language type of the environment entry. If an injection target
is specified for the environment entry, the type may
be omitted, or must match the type of the injection
target. If no injection target is specified, the type
is required.
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="env-entry-value" type="jakartaee:xsdStringType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The env-entry-value designates the value of a
Deployment Component's environment entry. The value
must be a String that is valid for the
constructor of the specified type that takes a
single String parameter, or for java.lang.Character,
a single character.
<xsd:complexType name="env-entry-type-valuesType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
This type contains the fully-qualified Java type of the
environment entry value that is expected by the
application's code.
The following are the legal values of env-entry-type-valuesType:
java.lang.Boolean
java.lang.Byte
java.lang.Character
java.lang.String
java.lang.Short
java.lang.Integer
java.lang.Long
java.lang.Float
java.lang.Double
java.lang.Class
any enumerationtype (i.e. a subclass of java.lang.Enum)
The elements that use this type designate the name of a
Java class or interface. The name is in the form of a "binary name", as defined in the JLS. This is the form
of name used in Class.forName(). Tools that need the
canonical name (the name used in source code) will need
to convert this binary name to the canonical name.
The icon type contains small-icon and large-icon elements
that specify the file names for small and large GIF, JPEG,
or PNG icon images used to represent the parent element in a
GUI tool.
The xml:lang attribute defines the language that the
icon file names are provided in. Its value is "en" (English)
by default.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="small-icon" type="jakartaee:pathType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The small-icon element contains the name of a file
containing a small (16 x 16) icon image. The file
name is a relative path within the Deployment
Component's Deployment File.
The image may be in the GIF, JPEG, or PNG format.
The icon can be used by tools.
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="large-icon" type="jakartaee:pathType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The large-icon element contains the name of a file
containing a large
(32 x 32) icon image. The file name is a relative
path within the Deployment Component's Deployment
File.
The image may be in the GIF, JPEG, or PNG format.
The icon can be used by tools.
An injection target specifies a class and a name within
that class into which a resource should be injected.
The injection target class specifies the fully qualified
class name that is the target of the injection. The
Jakarta EE specifications describe which classes can be an
injection target.
The injection target name specifies the target within
the specified class. The target is first looked for as a
JavaBeans property name. If not found, the target is
looked for as a field name.
The specified resource will be injected into the target
during initialization of the class by either calling the
set method for the target property or by setting a value
into the named field.
The following transaction isolation levels are allowed
(see documentation for the java.sql.Connection interface):
TRANSACTION_READ_UNCOMMITTED
TRANSACTION_READ_COMMITTED
TRANSACTION_REPEATABLE_READ
TRANSACTION_SERIALIZABLE
The java-identifierType defines a Java identifier.
The users of this type should further verify that
the content does not contain Java reserved keywords.
<xsd:complexType name="jdbc-urlType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The jdbc-urlType contains the url pattern of the mapping.
It must follow the rules specified in Section 9.3 of the
JDBC Specification where the format is:
Fully-qualified name of the messaging connection factory
interface. Permitted values are jakarta.jms.ConnectionFactory,
jakarta.jms.QueueConnectionFactory, or
jakarta.jms.TopicConnectionFactory. If not specified,
jakarta.jms.ConnectionFactory will be used.
Resource adapter name. If not specified, the application
server will define the default behavior, which may or may
not involve the use of a resource adapter.
Fully-qualified name of the messaging destination implementation
class. Ignored if a resource adapter is used unless the
resource adapter defines more than one destination implementation
class for the specified interface.
Resource adapter name. If not specified, the application
server will define the default behavior, which may or may
not involve the use of a resource adapter.
The jndi-nameType type designates a JNDI name in the
Deployment Component's environment and is relative to the
java:comp/env context. A JNDI name must be unique within the
Deployment Component.
<xsd:complexType name="homeType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The homeType defines the fully-qualified name of
an enterprise bean's home interface.
The lifecycle-callback type specifies a method on a
class to be called when a lifecycle event occurs.
Note that each class may have only one lifecycle callback
method for any given event and that the method may not
be overloaded.
If the lifefycle-callback-class element is missing then
the class defining the callback is assumed to be the
component class in scope at the place in the descriptor
in which the callback definition appears.
The listener-class element declares a class in the
application must be registered as a web
application listener bean. The value is the fully
qualified classname of the listener class.
The elements that use this type designate either a relative
path or an absolute path starting with a "/".
In elements that specify a pathname to a file within the
same Deployment File, relative filenames (i.e., those not
starting with "/") are considered relative to the root of
the Deployment File's namespace. Absolute filenames (i.e.,
those starting with "/") also specify names in the root of
the Deployment 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:complexType name="persistence-context-refType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The persistence-context-ref element contains a declaration
of Deployment Component's reference to a persistence context
associated within a Deployment Component's
environment. It consists of:
- an optional description
- the persistence context reference name
- an optional persistence unit name. If not specified,
the default persistence unit is assumed.
- an optional specification as to whether
the persistence context type is Transaction or
Extended. If not specified, Transaction is assumed.
- an optional specification as to whether
the persistence context synchronization with the current transaction is Synchronized or Unsynchronized. If not
specified, Synchronized is assumed.
- an optional list of persistence properties
- optional injection targets
The persistence-context-ref-name element specifies
the name of a persistence context reference; its
value is the environment entry name used in
Deployment Component code. The name is a JNDI name
relative to the java:comp/env context.
The Application Assembler(or BeanProvider) may use the
following syntax to avoid the need to rename persistence
units to have unique names within a Jakarta EE application.
The Application Assembler specifies the pathname of the
root of the persistence.xml file for the referenced
persistence unit and appends the name of the persistence
unit separated from the pathname by #. The pathname is
relative to the referencing application component jar file.
In this manner, multiple persistence units with the same
persistence unit name may be uniquely identified when the
Application Assembler cannot change persistence unit names.
Used to specify properties for the container or persistence
provider. Vendor-specific properties may be included in
the set of properties. Properties that are not recognized
by a vendor must be ignored. Entries that make use of the
namespace jakarta.persistence and its subnamespaces must not
be used for vendor-specific properties. The namespace
jakarta.persistence is reserved for use by the specification.
¤ Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.0.42Bemerkung:
Wie Sie bei der Firma Beratungs- und Dienstleistungen beauftragen können
¤
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.