sanspie/web-2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
master
web-2/wildfly/docs/schema/ejb-jar_4_0.xsd

3352 lines
122 KiB
XML
Raw Permalink Blame History

<?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="4.0">
<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 Enterprise Beans 4.0 deployment descriptor.
All Enterprise Beans deployment descriptors must indicate
the schema by using the Jakarta EE namespace:
https://jakarta.ee/xml/ns/jakartaee
and by indicating the version of the schema by
using the version element as shown below:
<ejb-jar 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/ejb-jar_4_0.xsd"
version="4.0">
...
</ejb-jar>
The instance documents may indicate the published version of
the schema using the xsi:schemaLocation attribute for the
Jakarta EE namespace with the following location:
https://jakarta.ee/xml/ns/jakartaee/ejb-jar_4_0.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_9.xsd"/>
<!-- **************************************************** -->
<xsd:element name="ejb-jar"
type="jakartaee:ejb-jarType">
<xsd:annotation>
<xsd:documentation>
This is the root of the ejb-jar deployment descriptor.
</xsd:documentation>
</xsd:annotation>
<xsd:key name="ejb-name-key">
<xsd:annotation>
<xsd:documentation>
The ejb-name element contains the name of an enterprise
bean. The name must be unique within the ejb-jar file or
.war file.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:enterprise-beans/*"/>
<xsd:field xpath="jakartaee:ejb-name"/>
</xsd:key>
<xsd:keyref name="ejb-name-references"
refer="jakartaee:ejb-name-key">
<xsd:annotation>
<xsd:documentation>
The keyref indicates the references from
relationship-role-source must be to a specific ejb-name
defined within the scope of enterprise-beans element.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath=".//jakartaee:ejb-relationship-role/jakartaee:relationship-role-source"/>
<xsd:field xpath="jakartaee:ejb-name"/>
</xsd:keyref>
<xsd:key name="role-name-key">
<xsd:annotation>
<xsd:documentation>
A role-name-key is specified to allow the references
from the security-role-refs.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:assembly-descriptor/jakartaee:security-role"/>
<xsd:field xpath="jakartaee:role-name"/>
</xsd:key>
<xsd:keyref name="role-name-references"
refer="jakartaee:role-name-key">
<xsd:annotation>
<xsd:documentation>
The keyref indicates the references from
security-role-ref to a specified role-name.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:enterprise-beans/*/jakartaee:security-role-ref"/>
<xsd:field xpath="jakartaee:role-link"/>
</xsd:keyref>
</xsd:element>
<!-- **************************************************** -->
<xsd:complexType name="access-timeoutType">
<xsd:annotation>
<xsd:documentation>
The access-timeoutType represents the maximum amount of
time (in a given time unit) that the container should wait for
a concurrency lock before throwing a timeout exception to the
client.
A timeout value of 0 means concurrent access is not permitted.
A timeout value of -1 means wait indefinitely to acquire a lock.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="timeout"
type="jakartaee:xsdIntegerType"/>
<xsd:element name="unit"
type="jakartaee:time-unit-typeType"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="async-methodType">
<xsd:annotation>
<xsd:documentation>
The async-methodType element specifies that a session
bean method has asynchronous invocation semantics.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="method-name"
type="jakartaee:string"/>
<xsd:element name="method-params"
type="jakartaee:method-paramsType"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="activation-configType">
<xsd:annotation>
<xsd:documentation>
The activation-configType defines information about the
expected configuration properties of the message-driven bean
in its operational environment. This may include information
about message acknowledgement, message selector, expected
destination type, destination or connection factory lookup
string, subscription name, etc.
The configuration information is expressed in terms of
name/value configuration properties.
The properties that are recognized for a particular
message-driven bean are determined by the messaging type.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="activation-config-property"
type="jakartaee:activation-config-propertyType"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="activation-config-propertyType">
<xsd:annotation>
<xsd:documentation>
The activation-config-propertyType contains a name/value
configuration property pair for a message-driven bean.
The properties that are recognized for a particular
message-driven bean are determined by the messaging type.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="activation-config-property-name"
type="jakartaee:xsdStringType">
<xsd:annotation>
<xsd:documentation>
The activation-config-property-name element contains
the name for an activation configuration property of
a message-driven bean.
For Jakarta Messaging message-driven beans, the following property
names are recognized: acknowledgeMode,
messageSelector, destinationType, subscriptionDurability,
destinationLookup, connectionFactoryLookup, subscriptionName,
and clientId.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="activation-config-property-value"
type="jakartaee:xsdStringType">
<xsd:annotation>
<xsd:documentation>
The activation-config-property-value element
contains the value for an activation configuration
property of a message-driven bean.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="around-invokeType">
<xsd:annotation>
<xsd:documentation>
The around-invoke type specifies a method on a
class to be called during the around invoke portion of an
ejb invocation. Note that each class may have only one
around invoke method and that the method may not be
overloaded.
If the class element is missing then
the class defining the callback is assumed to be the
interceptor class or component class in scope at the
location in the descriptor in which the around invoke
definition appears.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="class"
type="jakartaee:fully-qualified-classType"
minOccurs="0"/>
<xsd:element name="method-name"
type="jakartaee:java-identifierType"/>
</xsd:sequence>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="around-timeoutType">
<xsd:annotation>
<xsd:documentation>
The around-timeout type specifies a method on a
class to be called during the around-timeout portion of
a timer timeout callback. Note that each class may have
only one around-timeout method and that the method may not
be overloaded.
If the class element is missing then
the class defining the callback is assumed to be the
interceptor class or component class in scope at the
location in the descriptor in which the around-timeout
definition appears.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="class"
type="jakartaee:fully-qualified-classType"
minOccurs="0"/>
<xsd:element name="method-name"
type="jakartaee:java-identifierType"/>
</xsd:sequence>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="assembly-descriptorType">
<xsd:annotation>
<xsd:documentation>
The assembly-descriptorType defines
application-assembly information.
The application-assembly information consists of the
following parts: the definition of security roles, the
definition of method permissions, the definition of
transaction attributes for enterprise beans with
container-managed transaction demarcation, the definition
of interceptor bindings, a list of
methods to be excluded from being invoked, and a list of
exception types that should be treated as application exceptions.
All the parts are optional in the sense that they are
omitted if the lists represented by them are empty.
Providing an assembly-descriptor in the deployment
descriptor is optional for the ejb-jar file or .war file producer.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="security-role"
type="jakartaee:security-roleType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="method-permission"
type="jakartaee:method-permissionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="container-transaction"
type="jakartaee:container-transactionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="interceptor-binding"
type="jakartaee:interceptor-bindingType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="message-destination"
type="jakartaee:message-destinationType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="exclude-list"
type="jakartaee:exclude-listType"
minOccurs="0"/>
<xsd:element name="application-exception"
type="jakartaee:application-exceptionType"
minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="cmp-fieldType">
<xsd:annotation>
<xsd:documentation>
The cmp-fieldType describes a container-managed field. The
cmp-fieldType contains an optional description of the field,
and the name of the field.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="field-name"
type="jakartaee:java-identifierType">
<xsd:annotation>
<xsd:documentation>
The field-name element specifies the name of a
container managed field.
The name of the cmp-field of an entity bean with
cmp-version 2.x must begin with a lowercase
letter. This field is accessed by methods whose
names consists of the name of the field specified by
field-name in which the first letter is uppercased,
prefixed by "get" or "set".
The name of the cmp-field of an entity bean with
cmp-version 1.x must denote a public field of the
enterprise bean class or one of its superclasses.
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="cmp-versionType">
<xsd:annotation>
<xsd:documentation>
The cmp-versionType specifies the version of an entity bean
with container-managed persistence. It is used by
cmp-version elements.
The value must be one of the two following:
1.x
2.x
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="1.x"/>
<xsd:enumeration value="2.x"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="cmr-fieldType">
<xsd:annotation>
<xsd:documentation>
The cmr-fieldType describes the Bean Provider's view of
a relationship. It consists of an optional description, and
the name and the class type of a field in the source of a
role of a relationship. The cmr-field-name element
corresponds to the name used for the get and set accessor
methods for the relationship. The cmr-field-type element is
used only for collection-valued cmr-fields. It specifies the
type of the collection that is used.
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="cmr-field-name"
type="jakartaee:string">
<xsd:annotation>
<xsd:documentation>
The cmr-field-name element specifies the name of a
logical relationship field in the entity bean
class. The name of the cmr-field must begin with a
lowercase letter. This field is accessed by methods
whose names consist of the name of the field
specified by cmr-field-name in which the first
letter is uppercased, prefixed by "get" or "set".
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="cmr-field-type"
type="jakartaee:cmr-field-typeType"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="cmr-field-typeType">
<xsd:annotation>
<xsd:documentation>
The cmr-field-type element specifies the class of a
collection-valued logical relationship field in the entity
bean class. The value of an element using cmr-field-typeType
must be either: java.util.Collection or java.util.Set.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="java.util.Collection"/>
<xsd:enumeration value="java.util.Set"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="concurrency-management-typeType">
<xsd:annotation>
<xsd:documentation>
The concurrency-management-typeType specifies the way concurrency
is managed for a singleton or stateful session bean.
The concurrency management type must be one of the following:
Bean
Container
Bean managed concurrency can only be specified for a singleton bean.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="Bean"/>
<xsd:enumeration value="Container"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="concurrent-lock-typeType">
<xsd:annotation>
<xsd:documentation>
The concurrent-lock-typeType specifies how the container must
manage concurrent access to a method of a Singleton bean
with container-managed concurrency.
The container managed concurrency lock type must be one
of the following :
Read
Write
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="Read"/>
<xsd:enumeration value="Write"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="concurrent-methodType">
<xsd:annotation>
<xsd:documentation>
The concurrent-methodType specifies information about a method
of a bean with container managed concurrency.
The optional lock element specifies the kind of concurrency
lock asssociated with the method.
The optional access-timeout element specifies the amount of
time (in a given time unit) the container should wait for a
concurrency lock before throwing an exception to the client.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="method"
type="jakartaee:named-methodType"/>
<xsd:element name="lock"
type="jakartaee:concurrent-lock-typeType"
minOccurs="0"/>
<xsd:element name="access-timeout"
type="jakartaee:access-timeoutType"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="container-transactionType">
<xsd:annotation>
<xsd:documentation>
The container-transactionType specifies how the container
must manage transaction scopes for the enterprise bean's
method invocations. It defines an optional description, a
list of method elements, and a transaction attribute. The
transaction attribute is to be applied to all the specified
methods.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="method"
type="jakartaee:methodType"
maxOccurs="unbounded"/>
<xsd:element name="trans-attribute"
type="jakartaee:trans-attributeType"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="depends-onType">
<xsd:annotation>
<xsd:documentation>
The depends-onType is used to express initialization
ordering dependencies between Singleton components.
The depends-onType specifies the names of one or more
Singleton beans in the same application as the referring
Singleton, each of which must be initialized before
the referring bean.
Each dependent bean is expressed using ejb-link syntax.
The order in which dependent beans are initialized at
runtime is not guaranteed to match the order in which
they are listed.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="ejb-name"
type="jakartaee:ejb-linkType"
minOccurs="1"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="ejb-classType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The ejb-classType contains the fully-qualified name of the
enterprise bean's class. It is used by ejb-class elements.
Example:
<ejb-class>com.wombat.empl.EmployeeServiceBean</ejb-class>
]]>
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:fully-qualified-classType"/>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="ejb-jarType">
<xsd:annotation>
<xsd:documentation>
The ejb-jarType defines the root element of the Enterprise Beans
deployment descriptor. It contains
- an optional description of the ejb-jar file
- an optional display name
- an optional icon that contains a small and a large
icon file name
- an optional module name. Only applicable to
stand-alone ejb-jars or ejb-jars packaged in an ear.
Ignored if specified for an ejb-jar.xml within a .war file.
In that case, standard .war file module-name rules apply.
- structural information about all included
enterprise beans that is not specified through
annotations
- structural information about interceptor classes
- a descriptor for container managed relationships,
if any.
- an optional application-assembly descriptor
- an optional name of an ejb-client-jar file for the
ejb-jar.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="module-name"
type="jakartaee:string"
minOccurs="0"/>
<xsd:group ref="jakartaee:descriptionGroup"/>
<xsd:element name="enterprise-beans"
type="jakartaee:enterprise-beansType"
minOccurs="0"/>
<xsd:element name="interceptors"
type="jakartaee:interceptorsType"
minOccurs="0"/>
<xsd:element name="relationships"
type="jakartaee:relationshipsType"
minOccurs="0">
<xsd:unique name="relationship-name-uniqueness">
<xsd:annotation>
<xsd:documentation>
The ejb-relation-name contains the name of a
relation. The name must be unique within
relationships.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:ejb-relation"/>
<xsd:field xpath="jakartaee:ejb-relation-name"/>
</xsd:unique>
</xsd:element>
<xsd:element name="assembly-descriptor"
type="jakartaee:assembly-descriptorType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Providing an assembly-descriptor in the deployment
descriptor is optional for the ejb-jar file or .war file
producer.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ejb-client-jar"
type="jakartaee:pathType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The optional ejb-client-jar element specifies a JAR
file that contains the class files necessary for a
client program to access the
enterprise beans in the ejb-jar file.
Example:
<ejb-client-jar>employee_service_client.jar
</ejb-client-jar>
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="version"
type="jakartaee:dewey-versionType"
fixed="4.0"
use="required">
<xsd:annotation>
<xsd:documentation>
The version specifies the version of the
Enterprise Beans specification that the instance document must
comply with. This information enables deployment tools
to validate a particular Enterprise Beans Deployment
Descriptor with respect to a specific version of the Enterprise Beans
schema.
</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:complexType name="ejb-nameType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The ejb-nameType specifies an enterprise bean's name. It is
used by ejb-name elements. This name is assigned by the
file producer to name the enterprise bean in the
ejb-jar file or .war file's deployment descriptor. The name must be
unique among the names of the enterprise beans in the same
ejb-jar file or .war file.
There is no architected relationship between the used
ejb-name in the deployment descriptor and the JNDI name that
the Deployer will assign to the enterprise bean's home.
The name for an entity bean must conform to the lexical
rules for an NMTOKEN.
Example:
<ejb-name>EmployeeService</ejb-name>
]]>
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:xsdNMTOKENType"/>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="ejb-relationType">
<xsd:annotation>
<xsd:documentation>
The ejb-relationType describes a relationship between two
entity beans with container-managed persistence. It is used
by ejb-relation elements. It contains a description; an
optional ejb-relation-name element; and exactly two
relationship role declarations, defined by the
ejb-relationship-role elements. The name of the
relationship, if specified, is unique within the ejb-jar
file.
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="ejb-relation-name"
type="jakartaee:string"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The ejb-relation-name element provides a unique name
within the ejb-jar file for a relationship.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ejb-relationship-role"
type="jakartaee:ejb-relationship-roleType"
minOccurs="2"
maxOccurs="2"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="ejb-relationship-roleType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The ejb-relationship-roleType describes a role within a
relationship. There are two roles in each relationship.
The ejb-relationship-roleType contains an optional
description; an optional name for the relationship role; a
specification of the multiplicity of the role; an optional
specification of cascade-delete functionality for the role;
the role source; and a declaration of the cmr-field, if any,
by means of which the other side of the relationship is
accessed from the perspective of the role source.
The multiplicity and role-source element are mandatory.
The relationship-role-source element designates an entity
bean by means of an ejb-name element. For bidirectional
relationships, both roles of a relationship must declare a
relationship-role-source element that specifies a cmr-field
in terms of which the relationship is accessed. The lack of
a cmr-field element in an ejb-relationship-role specifies
that the relationship is unidirectional in navigability and
the entity bean that participates in the relationship is
"not aware" of the relationship.
Example:
<ejb-relation>
<ejb-relation-name>Product-LineItem</ejb-relation-name>
<ejb-relationship-role>
<ejb-relationship-role-name>product-has-lineitems
</ejb-relationship-role-name>
<multiplicity>One</multiplicity>
<relationship-role-source>
<ejb-name>ProductEJB</ejb-name>
</relationship-role-source>
</ejb-relationship-role>
</ejb-relation>
Support for entity beans is optional as of Enterprise Beans 3.2.
]]>
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="ejb-relationship-role-name"
type="jakartaee:string"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The ejb-relationship-role-name element defines a
name for a role that is unique within an
ejb-relation. Different relationships can use the
same name for a role.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="multiplicity"
type="jakartaee:multiplicityType"/>
<xsd:element name="cascade-delete"
type="jakartaee:emptyType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The cascade-delete element specifies that, within a
particular relationship, the lifetime of one or more
entity beans is dependent upon the lifetime of
another entity bean. The cascade-delete element can
only be specified for an ejb-relationship-role
element contained in an ejb-relation element in
which the other ejb-relationship-role
element specifies a multiplicity of One.
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="relationship-role-source"
type="jakartaee:relationship-role-sourceType"/>
<xsd:element name="cmr-field"
type="jakartaee:cmr-fieldType"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="enterprise-beansType">
<xsd:annotation>
<xsd:documentation>
The enterprise-beansType declares one or more enterprise
beans. Each bean can be a session, entity or message-driven
bean.
</xsd:documentation>
</xsd:annotation>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="session"
type="jakartaee:session-beanType">
<xsd:unique name="session-ejb-local-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 component's environment and is relative to the
java:comp/env context. The name must be unique within
the component.
It is recommended that name be prefixed with "ejb/".
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:ejb-local-ref"/>
<xsd:field xpath="jakartaee:ejb-ref-name"/>
</xsd:unique>
<xsd:unique name="session-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
component's environment and is relative to the
java:comp/env context. The name must be unique
within the component.
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="session-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 component
code. The name is a JNDI name relative to the
java:comp/env context and must be unique within an
component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:resource-env-ref"/>
<xsd:field xpath="jakartaee:resource-env-ref-name"/>
</xsd:unique>
<xsd:unique name="session-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 component
code. The name is a JNDI name relative to the
java:comp/env context and must be unique within an
component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:message-destination-ref"/>
<xsd:field xpath="jakartaee:message-destination-ref-name"/>
</xsd:unique>
<xsd:unique name="session-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 component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:resource-ref"/>
<xsd:field xpath="jakartaee:res-ref-name"/>
</xsd:unique>
<xsd:unique name="session-env-entry-name-uniqueness">
<xsd:annotation>
<xsd:documentation>
The env-entry-name element contains the name of a
component's environment entry. The name is a JNDI
name relative to the java:comp/env context. The
name must be unique within an component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:env-entry"/>
<xsd:field xpath="jakartaee:env-entry-name"/>
</xsd:unique>
</xsd:element>
<xsd:element name="entity"
type="jakartaee:entity-beanType">
<xsd:unique name="entity-ejb-local-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 component's environment and is relative to the
java:comp/env context. The name must be unique within
the component.
It is recommended that name be prefixed with "ejb/".
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:ejb-local-ref"/>
<xsd:field xpath="jakartaee:ejb-ref-name"/>
</xsd:unique>
<xsd:unique name="entity-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
component's environment and is relative to the
java:comp/env context. The name must be unique
within the component.
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="entity-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 component
code. The name is a JNDI name relative to the
java:comp/env context and must be unique within an
component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:resource-env-ref"/>
<xsd:field xpath="jakartaee:resource-env-ref-name"/>
</xsd:unique>
<xsd:unique name="entity-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 component
code. The name is a JNDI name relative to the
java:comp/env context and must be unique within an
component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:message-destination-ref"/>
<xsd:field xpath="jakartaee:message-destination-ref-name"/>
</xsd:unique>
<xsd:unique name="entity-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 component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:resource-ref"/>
<xsd:field xpath="jakartaee:res-ref-name"/>
</xsd:unique>
<xsd:unique name="entity-env-entry-name-uniqueness">
<xsd:annotation>
<xsd:documentation>
The env-entry-name element contains the name of a
component's environment entry. The name is a JNDI
name relative to the java:comp/env context. The
name must be unique within an component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:env-entry"/>
<xsd:field xpath="jakartaee:env-entry-name"/>
</xsd:unique>
</xsd:element>
<xsd:element name="message-driven"
type="jakartaee:message-driven-beanType">
<xsd:unique name="messaged-ejb-local-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 component's environment and is relative to the
java:comp/env context. The name must be unique within
the component.
It is recommended that name be prefixed with "ejb/".
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:ejb-local-ref"/>
<xsd:field xpath="jakartaee:ejb-ref-name"/>
</xsd:unique>
<xsd:unique name="messaged-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
component's environment and is relative to the
java:comp/env context. The name must be unique
within the component.
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="messaged-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 component
code. The name is a JNDI name relative to the
java:comp/env context and must be unique within an
component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:resource-env-ref"/>
<xsd:field xpath="jakartaee:resource-env-ref-name"/>
</xsd:unique>
<xsd:unique name="messaged-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 component
code. The name is a JNDI name relative to the
java:comp/env context and must be unique within an
component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:message-destination-ref"/>
<xsd:field xpath="jakartaee:message-destination-ref-name"/>
</xsd:unique>
<xsd:unique name="messaged-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 component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:resource-ref"/>
<xsd:field xpath="jakartaee:res-ref-name"/>
</xsd:unique>
<xsd:unique name="messaged-env-entry-name-uniqueness">
<xsd:annotation>
<xsd:documentation>
The env-entry-name element contains the name of a
component's environment entry. The name is a JNDI
name relative to the java:comp/env context. The
name must be unique within an component.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath="jakartaee:env-entry"/>
<xsd:field xpath="jakartaee:env-entry-name"/>
</xsd:unique>
</xsd:element>
</xsd:choice>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="entity-beanType">
<xsd:annotation>
<xsd:documentation>
Support for entity beans is optional as of Enterprise Beans 3.2.
The entity-beanType declares an entity bean. The declaration
consists of:
- an optional description
- an optional display name
- an optional icon element that contains a small and a large
icon file name
- a unique name assigned to the enterprise bean
in the deployment descriptor
- an optional mapped-name element that can be used to provide
vendor-specific deployment information such as the physical
jndi-name of the entity bean's remote home interface. This
element is not required to be supported by all implementations.
Any use of this element is non-portable.
- the names of the entity bean's remote home
and remote interfaces, if any
- the names of the entity bean's local home and local
interfaces, if any
- the entity bean's implementation class
- the optional entity bean's persistence management type. If
this element is not specified it is defaulted to Container.
- the entity bean's primary key class name
- an indication of the entity bean's reentrancy
- an optional specification of the
entity bean's cmp-version
- an optional specification of the entity bean's
abstract schema name
- an optional list of container-managed fields
- an optional specification of the primary key
field
- an optional declaration of the bean's environment
entries
- an optional declaration of the bean's enterprise bean
references
- an optional declaration of the bean's local enterprise bean
references
- an optional declaration of the bean's web
service references
- an optional declaration of the security role
references
- an optional declaration of the security identity
to be used for the execution of the bean's methods
- an optional declaration of the bean's
resource manager connection factory references
- an optional declaration of the bean's
resource environment references
- an optional declaration of the bean's message
destination references
- an optional set of query declarations
for finder and select methods for an entity
bean with cmp-version 2.x.
The optional abstract-schema-name element must be specified
for an entity bean with container-managed persistence and
cmp-version 2.x.
The optional primkey-field may be present in the descriptor
if the entity's persistence-type is Container.
The optional cmp-version element may be present in the
descriptor if the entity's persistence-type is Container. If
the persistence-type is Container and the cmp-version
element is not specified, its value defaults to 2.x.
The optional home and remote elements must be specified if
the entity bean cmp-version is 1.x.
The optional home and remote elements must be specified if
the entity bean has a remote home and remote interface.
The optional local-home and local elements must be specified
if the entity bean has a local home and local interface.
Either both the local-home and the local elements or both
the home and the remote elements must be specified.
The optional query elements must be present if the
persistence-type is Container and the cmp-version is 2.x and
query methods other than findByPrimaryKey have been defined
for the entity bean.
The other elements that are optional are "optional" in the
sense that they are omitted if the lists represented by them
are empty.
At least one cmp-field element must be present in the
descriptor if the entity's persistence-type is Container and
the cmp-version is 1.x, and none must not be present if the
entity's persistence-type is Bean.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:group ref="jakartaee:descriptionGroup"/>
<xsd:element name="ejb-name"
type="jakartaee:ejb-nameType"/>
<xsd:element name="mapped-name"
type="jakartaee:xsdStringType"
minOccurs="0"/>
<xsd:element name="home"
type="jakartaee:homeType"
minOccurs="0"/>
<xsd:element name="remote"
type="jakartaee:remoteType"
minOccurs="0"/>
<xsd:element name="local-home"
type="jakartaee:local-homeType"
minOccurs="0"/>
<xsd:element name="local"
type="jakartaee:localType"
minOccurs="0"/>
<xsd:element name="ejb-class"
type="jakartaee:ejb-classType"/>
<xsd:element name="persistence-type"
type="jakartaee:persistence-typeType"/>
<xsd:element name="prim-key-class"
type="jakartaee:fully-qualified-classType">
<xsd:annotation>
<xsd:documentation>
The prim-key-class element contains the
fully-qualified name of an
entity bean's primary key class.
If the definition of the primary key class is
deferred to deployment time, the prim-key-class
element should specify java.lang.Object.
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="reentrant"
type="jakartaee:true-falseType">
<xsd:annotation>
<xsd:documentation>
The reentrant element specifies whether an entity
bean is reentrant or not.
The reentrant element must be one of the two
following: true or false
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="cmp-version"
type="jakartaee:cmp-versionType"
minOccurs="0"/>
<xsd:element name="abstract-schema-name"
type="jakartaee:java-identifierType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The abstract-schema-name element specifies the name
of the abstract schema type of an entity bean with
cmp-version 2.x. It is used in Enterprise Beans QL queries.
For example, the abstract-schema-name for an entity
bean whose local interface is
com.acme.commerce.Order might be Order.
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="cmp-field"
type="jakartaee:cmp-fieldType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="primkey-field"
type="jakartaee:string"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The primkey-field element is used to specify the
name of the primary key field for an entity with
container-managed persistence.
The primkey-field must be one of the fields declared
in the cmp-field element, and the type of the field
must be the same as the primary key type.
The primkey-field element is not used if the primary
key maps to multiple container-managed fields
(i.e. the key is a compound key). In this case, the
fields of the primary key class must be public, and
their names must correspond to the field names of
the entity bean class that comprise the key.
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:group ref="jakartaee:jndiEnvironmentRefsGroup"/>
<xsd:element name="security-role-ref"
type="jakartaee:security-role-refType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="security-identity"
type="jakartaee:security-identityType"
minOccurs="0"/>
<xsd:element name="query"
type="jakartaee:queryType"
minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="exclude-listType">
<xsd:annotation>
<xsd:documentation>
The exclude-listType specifies one or more methods which
the Assembler marks to be uncallable.
If the method permission relation contains methods that are
in the exclude list, the Deployer should consider those
methods to be uncallable.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="method"
type="jakartaee:methodType"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="application-exceptionType">
<xsd:annotation>
<xsd:documentation>
The application-exceptionType declares an application
exception. The declaration consists of:
- the exception class. When the container receives
an exception of this type, it is required to
forward this exception as an applcation exception
to the client regardless of whether it is a checked
or unchecked exception.
- an optional rollback element. If this element is
set to true, the container must rollback the current
transaction before forwarding the exception to the
client. If not specified, it defaults to false.
- an optional inherited element. If this element is
set to true, subclasses of the exception class type
are also automatically considered application
exceptions (unless overriden at a lower level).
If set to false, only the exception class type is
considered an application-exception, not its
exception subclasses. If not specified, this
value defaults to true.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="exception-class"
type="jakartaee:fully-qualified-classType"/>
<xsd:element name="rollback"
type="jakartaee:true-falseType"
minOccurs="0"/>
<xsd:element name="inherited"
type="jakartaee:true-falseType"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="interceptorsType">
<xsd:annotation>
<xsd:documentation>
The interceptorsType element declares one or more interceptor
classes used by components within this ejb-jar file or .war file. The declaration
consists of :
- An optional description.
- One or more interceptor elements.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="interceptor"
type="jakartaee:interceptorType"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="interceptorType">
<xsd:annotation>
<xsd:documentation>
The interceptorType element declares information about a single
interceptor class. It consists of :
- An optional description.
- The fully-qualified name of the interceptor class.
- An optional list of around invoke methods declared on the
interceptor class and/or its super-classes.
- An optional list of around timeout methods declared on the
interceptor class and/or its super-classes.
- An optional list environment dependencies for the interceptor
class and/or its super-classes.
- An optional list of post-activate methods declared on the
interceptor class and/or its super-classes.
- An optional list of pre-passivate methods declared on the
interceptor class and/or its super-classes.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="interceptor-class"
type="jakartaee:fully-qualified-classType"/>
<xsd:element name="around-invoke"
type="jakartaee:around-invokeType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="around-timeout"
type="jakartaee:around-timeoutType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="around-construct"
type="jakartaee:lifecycle-callbackType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:group ref="jakartaee:jndiEnvironmentRefsGroup"/>
<xsd:element name="post-activate"
type="jakartaee:lifecycle-callbackType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="pre-passivate"
type="jakartaee:lifecycle-callbackType"
minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="interceptor-bindingType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The interceptor-bindingType element describes the binding of
interceptor classes to beans within the ejb-jar file or .war file.
It consists of :
- An optional description.
- The name of an ejb within the module or the wildcard value "*",
which is used to define interceptors that are bound to all
beans in the ejb-jar file or .war file.
- A list of interceptor classes that are bound to the contents of
the ejb-name element or a specification of the total ordering
over the interceptors defined for the given level and above.
- An optional exclude-default-interceptors element. If set to true,
specifies that default interceptors are not to be applied to
a bean-class and/or business method.
- An optional exclude-class-interceptors element. If set to true,
specifies that class interceptors are not to be applied to
a business method.
- An optional set of method elements for describing the name/params
of a method-level interceptor.
Interceptors bound to all classes using the wildcard syntax
"*" are default interceptors for the components in the ejb-jar file or .war file.
In addition, interceptors may be bound at the level of the bean
class (class-level interceptors) or business methods (method-level
interceptors ).
The binding of interceptors to classes is additive. If interceptors
are bound at the class-level and/or default-level as well as the
method-level, both class-level and/or default-level as well as
method-level will apply.
The method-name element may be used to bind a constructor-level
interceptor using the unqualified name of the bean class as the value;
the optional method-params elements identify the constructor if a bean
class has a constructor annotated with the Inject annotation in addition
to a no-arg constructor.
There are four possible styles of the interceptor element syntax :
1.
<interceptor-binding>
<ejb-name>*</ejb-name>
<interceptor-class>INTERCEPTOR</interceptor-class>
</interceptor-binding>
Specifying the ejb-name as the wildcard value "*" designates
default interceptors (interceptors that apply to all session and
message-driven beans contained in the ejb-jar file or .war file).
2.
<interceptor-binding>
<ejb-name>EJBNAME</ejb-name>
<interceptor-class>INTERCEPTOR</interceptor-class>
</interceptor-binding>
This style is used to refer to interceptors associated with the
specified enterprise bean(class-level interceptors).
3.
<interceptor-binding>
<ejb-name>EJBNAME</ejb-name>
<interceptor-class>INTERCEPTOR</interceptor-class>
<method>
<method-name>METHOD</method-name>
</method>
</interceptor-binding>
This style is used to associate a method-level interceptor with
the specified enterprise bean. If there are multiple methods
with the same overloaded name, the element of this style refers
to all the methods with the overloaded name. Method-level
interceptors can only be associated with business methods of the
bean class. Note that the wildcard value "*" cannot be used
to specify method-level interceptors.
4.
<interceptor-binding>
<ejb-name>EJBNAME</ejb-name>
<interceptor-class>INTERCEPTOR</interceptor-class>
<method>
<method-name>METHOD</method-name>
<method-params>
<method-param>PARAM-1</method-param>
<method-param>PARAM-2</method-param>
...
<method-param>PARAM-N</method-param>
</method-params>
</method>
</interceptor-binding>
This style is used to associate a method-level interceptor with
the specified method of the specified enterprise bean. This
style is used to refer to a single method within a set of methods
with an overloaded name. The values PARAM-1 through PARAM-N
are the fully-qualified Java types of the method's input parameters
(if the method has no input arguments, the method-params element
contains no method-param elements). Arrays are specified by the
array element's type, followed by one or more pair of square
brackets (e.g. int[][]).
]]>
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="ejb-name"
type="jakartaee:string"/>
<xsd:choice>
<xsd:element name="interceptor-class"
type="jakartaee:fully-qualified-classType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="interceptor-order"
type="jakartaee:interceptor-orderType"
minOccurs="1"/>
</xsd:choice>
<xsd:element name="exclude-default-interceptors"
type="jakartaee:true-falseType"
minOccurs="0"/>
<xsd:element name="exclude-class-interceptors"
type="jakartaee:true-falseType"
minOccurs="0"/>
<xsd:element name="method"
type="jakartaee:named-methodType"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="interceptor-orderType">
<xsd:annotation>
<xsd:documentation>
The interceptor-orderType element describes a total ordering
of interceptor classes.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="interceptor-class"
type="jakartaee:fully-qualified-classType"
minOccurs="1"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="named-methodType">
<xsd:sequence>
<xsd:element name="method-name"
type="jakartaee:string"/>
<xsd:element name="method-params"
type="jakartaee:method-paramsType"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="init-methodType">
<xsd:sequence>
<xsd:element name="create-method"
type="jakartaee:named-methodType"/>
<xsd:element name="bean-method"
type="jakartaee:named-methodType"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="remove-methodType">
<xsd:sequence>
<xsd:element name="bean-method"
type="jakartaee:named-methodType"/>
<xsd:element name="retain-if-exception"
type="jakartaee:true-falseType"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="message-driven-beanType">
<xsd:annotation>
<xsd:documentation>
The message-driven element declares a message-driven
bean. The declaration consists of:
- an optional description
- an optional display name
- an optional icon element that contains a small and a large
icon file name.
- a name assigned to the enterprise bean in
the deployment descriptor
- an optional mapped-name element that can be used to provide
vendor-specific deployment information such as the physical
jndi-name of destination from which this message-driven bean
should consume. This element is not required to be supported
by all implementations. Any use of this element is non-portable.
- the message-driven bean's implementation class
- an optional declaration of the bean's messaging
type
- an optional declaration of the bean's timeout method for
handling programmatically created timers
- an optional declaration of timers to be automatically created at
deployment time
- the optional message-driven bean's transaction management
type. If it is not defined, it is defaulted to Container.
- an optional declaration of the bean's
message-destination-type
- an optional declaration of the bean's
message-destination-link
- an optional declaration of the message-driven bean's
activation configuration properties
- an optional list of the message-driven bean class and/or
superclass around-invoke methods.
- an optional list of the message-driven bean class and/or
superclass around-timeout methods.
- an optional declaration of the bean's environment
entries
- an optional declaration of the bean's enterprise bean references
- an optional declaration of the bean's local enterprise bean
references
- an optional declaration of the bean's web service
references
- an optional declaration of the security role
references
- an optional declaration of the security
identity to be used for the execution of the bean's
methods
- an optional declaration of the bean's
resource manager connection factory
references
- an optional declaration of the bean's resource
environment references.
- an optional declaration of the bean's message
destination references
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:group ref="jakartaee:descriptionGroup"/>
<xsd:element name="ejb-name"
type="jakartaee:ejb-nameType"/>
<xsd:element name="mapped-name"
type="jakartaee:xsdStringType"
minOccurs="0"/>
<xsd:element name="ejb-class"
type="jakartaee:ejb-classType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The ejb-class element specifies the fully qualified name
of the bean class for this ejb. It is required unless
there is a component-defining annotation for the same
ejb-name.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="messaging-type"
type="jakartaee:fully-qualified-classType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The messaging-type element specifies the message
listener interface of the message-driven bean.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="timeout-method"
type="jakartaee:named-methodType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The timeout-method element specifies the method that
will receive callbacks for programmatically
created timers.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="timer"
type="jakartaee:timerType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="transaction-type"
type="jakartaee:transaction-typeType"
minOccurs="0"/>
<xsd:element name="message-destination-type"
type="jakartaee:message-destination-typeType"
minOccurs="0"/>
<xsd:element name="message-destination-link"
type="jakartaee:message-destination-linkType"
minOccurs="0"/>
<xsd:element name="activation-config"
type="jakartaee:activation-configType"
minOccurs="0"/>
<xsd:element name="around-invoke"
type="jakartaee:around-invokeType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="around-timeout"
type="jakartaee:around-timeoutType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:group ref="jakartaee:jndiEnvironmentRefsGroup"/>
<xsd:element name="security-role-ref"
type="jakartaee:security-role-refType"
minOccurs="0"
maxOccurs="unbounded">
</xsd:element>
<xsd:element name="security-identity"
type="jakartaee:security-identityType"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="methodType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The methodType is used to denote a method of an enterprise
bean. The method may be any of the following or a set of
any of the following methods may be designated:
business interface method
home interface method
component interface method
web service endpoint interface method
no-interface view method
singleton session bean lifecycle callback method
stateful session bean lifecycle callback method (see
limitations)
timeout callback method
message-driven bean message listener method
The ejb-name element must be the name of one of the enterprise
beans declared in the deployment descriptor.
The optional method-intf element allows distinguishing between a
method with the same signature that is multiply defined
across any of the above.
The method-name element specifies the method name.
The optional method-params elements identify a single method
among multiple methods with an overloaded method name.
There are three possible styles of using methodType element
within a method element:
1.
<method>
<ejb-name>EJBNAME</ejb-name>
<method-name>*</method-name>
</method>
This style is used to refer to all of the following methods
of the specified enterprise bean:
business interface methods
home interface methods
component interface methods
web service endpoint interface methods
no-interface view methods
singleton session bean lifecycle callback methods
timeout callback methods
message-driven bean message listener method
This style may also be used in combination with the
method-intf element that contains LifecycleCallback as
the value to specify transaction attributes of a stateful
session bean PostConstruct, PreDestroy, PrePassivate,
and PostActivate lifecycle callback methods or to override
transaction attributes of a singleton session bean
PostConstruct and PreDestroy lifecycle callback methods.
2.
<method>
<ejb-name>EJBNAME</ejb-name>
<method-name>METHOD</method-name>
</method>
This style is used to refer to the specified method of
the specified enterprise bean. If there are multiple
methods with the same overloaded name, the element of
this style refers to all the methods with the overloaded
name.
This style may be used to refer to stateful session bean
PostConstruct, PreDestroy, PrePassivate, and PostActivate
lifecycle callback methods to specify their transaction
attributes if any of the following is true:
there is only one method with this name in the specified
enterprise bean
all overloaded methods with this name in the specified
enterprise bean are lifecycle callback methods
method-intf element is specified and it contains
LifecycleCallback as the value
3.
<method>
<ejb-name>EJBNAME</ejb-name>
<method-name>METHOD</method-name>
<method-params>
<method-param>PARAM-1</method-param>
<method-param>PARAM-2</method-param>
...
<method-param>PARAM-n</method-param>
</method-params>
</method>
This style is used to refer to a single method within a
set of methods with an overloaded name. PARAM-1 through
PARAM-n are the fully-qualified Java types of the
method's input parameters (if the method has no input
arguments, the method-params element contains no
method-param elements). Arrays are specified by the
array element's type, followed by one or more pair of
square brackets (e.g. int[][]).
If a method with the same name and signature is defined
on more than one interface of an enterprise bean, this
style refers to all those methods.
Examples:
Style 1: The following method element refers to all of the
following methods of the EmployeeService bean:
no interface view methods
business interface methods
home interface methods
component business interface methods
singleton session bean lifecycle callback methods, if any
timeout callback methods
web service endpoint interface methods
message-driven bean message listener methods (if the bean
a message-driven bean)
<method>
<ejb-name>EmployeeService</ejb-name>
<method-name>*</method-name>
</method>
Style 2: The following method element refers to all the
create methods of the EmployeeService bean's home
interface(s).
<method>
<ejb-name>EmployeeService</ejb-name>
<method-name>create</method-name>
</method>
Style 3: The following method element refers to the
create(String firstName, String LastName) method of the
EmployeeService bean's home interface(s).
<method>
<ejb-name>EmployeeService</ejb-name>
<method-name>create</method-name>
<method-params>
<method-param>java.lang.String</method-param>
<method-param>java.lang.String</method-param>
</method-params>
</method>
The following example illustrates a Style 3 element with
more complex parameter types. The method
foobar(char s, int i, int[] iar, mypackage.MyClass mycl,
mypackage.MyClass[][] myclaar) would be specified as:
<method>
<ejb-name>EmployeeService</ejb-name>
<method-name>foobar</method-name>
<method-params>
<method-param>char</method-param>
<method-param>int</method-param>
<method-param>int[]</method-param>
<method-param>mypackage.MyClass</method-param>
<method-param>mypackage.MyClass[][]</method-param>
</method-params>
</method>
The optional method-intf element can be used when it becomes
necessary to differentiate between a method that is defined
multiple times with the same name and signature across any
of the following methods of an enterprise bean:
business interface methods
home interface methods
component interface methods
web service endpoint methods
no-interface view methods
singleton or stateful session bean lifecycle callback methods
timeout callback methods
message-driven bean message listener methods
However, if the same method is a method of both the local
business interface, and the local component interface,
the same attribute applies to the method for both interfaces.
Likewise, if the same method is a method of both the remote
business interface and the remote component interface, the same
attribute applies to the method for both interfaces.
For example, the method element
<method>
<ejb-name>EmployeeService</ejb-name>
<method-intf>Remote</method-intf>
<method-name>create</method-name>
<method-params>
<method-param>java.lang.String</method-param>
<method-param>java.lang.String</method-param>
</method-params>
</method>
can be used to differentiate the create(String, String)
method defined in the remote interface from the
create(String, String) method defined in the remote home
interface, which would be defined as
<method>
<ejb-name>EmployeeService</ejb-name>
<method-intf>Home</method-intf>
<method-name>create</method-name>
<method-params>
<method-param>java.lang.String</method-param>
<method-param>java.lang.String</method-param>
</method-params>
</method>
and the create method that is defined in the local home
interface which would be defined as
<method>
<ejb-name>EmployeeService</ejb-name>
<method-intf>LocalHome</method-intf>
<method-name>create</method-name>
<method-params>
<method-param>java.lang.String</method-param>
<method-param>java.lang.String</method-param>
</method-params>
</method>
The method-intf element can be used with all three Styles
of the method element usage. For example, the following
method element example could be used to refer to all the
methods of the EmployeeService bean's remote home interface
and the remote business interface.
<method>
<ejb-name>EmployeeService</ejb-name>
<method-intf>Home</method-intf>
<method-name>*</method-name>
</method>
]]>
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="ejb-name"
type="jakartaee:ejb-nameType"/>
<xsd:element name="method-intf"
type="jakartaee:method-intfType"
minOccurs="0">
</xsd:element>
<xsd:element name="method-name"
type="jakartaee:method-nameType"/>
<xsd:element name="method-params"
type="jakartaee:method-paramsType"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="method-intfType">
<xsd:annotation>
<xsd:documentation>
The method-intf element allows a method element to
differentiate between the methods with the same name and
signature that are multiply defined across the home and
component interfaces (e.g, in both an enterprise bean's
remote and local interfaces or in both an enterprise bean's
home and remote interfaces, etc.); the component and web
service endpoint interfaces, and so on.
Local applies to the local component interface, local business
interfaces, and the no-interface view.
Remote applies to both remote component interface and the remote
business interfaces.
ServiceEndpoint refers to methods exposed through a web service
endpoint.
Timer refers to the bean's timeout callback methods.
MessageEndpoint refers to the methods of a message-driven bean's
message-listener interface.
LifecycleCallback refers to the PostConstruct and PreDestroy
lifecycle callback methods of a singleton session bean and
to the PostConstruct, PreDestroy, PrePassivate, and PostActivate
lifecycle callback methods of a stateful session bean.
The method-intf element must be one of the following:
Home
Remote
LocalHome
Local
ServiceEndpoint
Timer
MessageEndpoint
LifecycleCallback
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="Home"/>
<xsd:enumeration value="Remote"/>
<xsd:enumeration value="LocalHome"/>
<xsd:enumeration value="Local"/>
<xsd:enumeration value="ServiceEndpoint"/>
<xsd:enumeration value="Timer"/>
<xsd:enumeration value="MessageEndpoint"/>
<xsd:enumeration value="LifecycleCallback"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="method-nameType">
<xsd:annotation>
<xsd:documentation>
The method-nameType contains a name of an enterprise
bean method or the asterisk (*) character. The asterisk is
used when the element denotes all the methods of an
enterprise bean's client view interfaces.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string"/>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="method-paramsType">
<xsd:annotation>
<xsd:documentation>
The method-paramsType defines a list of the
fully-qualified Java type names of the method parameters.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="method-param"
type="jakartaee:java-typeType"
minOccurs="0"
maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
The method-param element contains a primitive
or a fully-qualified Java type name of a method
parameter.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="method-permissionType">
<xsd:annotation>
<xsd:documentation>
The method-permissionType specifies that one or more
security roles are allowed to invoke one or more enterprise
bean methods. The method-permissionType consists of an
optional description, a list of security role names or an
indicator to state that the method is unchecked for
authorization, and a list of method elements.
Except as noted below the security roles used in the
method-permissionType must be defined in the security-role
elements of the deployment descriptor, and the methods
must be methods defined in the enterprise bean's no-interface
view, business, home, component and/or web service endpoint
interfaces.
If the role name "**" is included in the list of allowed
roles, and the application has not defined in its deployment
descriptor an application security role with this name,
then the list of allowed roles includes every and any
authenticated user.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:choice>
<xsd:element name="role-name"
type="jakartaee:role-nameType"
maxOccurs="unbounded"/>
<xsd:element name="unchecked"
type="jakartaee:emptyType">
<xsd:annotation>
<xsd:documentation>
The unchecked element specifies that a method is
not checked for authorization by the container
prior to invocation of the method.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:choice>
<xsd:element name="method"
type="jakartaee:methodType"
maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="multiplicityType">
<xsd:annotation>
<xsd:documentation>
The multiplicityType describes the multiplicity of the
role that participates in a relation.
The value must be one of the two following:
One
Many
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="One"/>
<xsd:enumeration value="Many"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="persistence-typeType">
<xsd:annotation>
<xsd:documentation>
The persistence-typeType specifies an entity bean's persistence
management type.
The persistence-type element must be one of the two following:
Bean
Container
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="Bean"/>
<xsd:enumeration value="Container"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="queryType">
<xsd:annotation>
<xsd:documentation>
The queryType defines a finder or select
query. It contains
- an optional description of the query
- the specification of the finder or select
method it is used by
- an optional specification of the result type
mapping, if the query is for a select method
and entity objects are returned.
- the Enterprise Beans QL query string that defines the query.
Queries that are expressible in Enterprise Beans QL must use the ejb-ql
element to specify the query. If a query is not expressible
in Enterprise Beans QL, the description element should be used to
describe the semantics of the query and the ejb-ql element
should be empty.
The result-type-mapping is an optional element. It can only
be present if the query-method specifies a select method
that returns entity objects. The default value for the
result-type-mapping element is "Local".
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"/>
<xsd:element name="query-method"
type="jakartaee:query-methodType"/>
<xsd:element name="result-type-mapping"
type="jakartaee:result-type-mappingType"
minOccurs="0"/>
<xsd:element name="ejb-ql"
type="jakartaee:xsdStringType"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="query-methodType">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
The query-method specifies the method for a finder or select
query.
The method-name element specifies the name of a finder or select
method in the entity bean's implementation class.
Each method-param must be defined for a query-method using the
method-params element.
It is used by the query-method element.
Example:
<query>
<description>Method finds large orders</description>
<query-method>
<method-name>findLargeOrders</method-name>
<method-params></method-params>
</query-method>
<ejb-ql>
SELECT OBJECT(o) FROM Order o
WHERE o.amount &gt; 1000
</ejb-ql>
</query>
Support for entity beans is optional as of Enterprise Beans 3.2.
]]>
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="method-name"
type="jakartaee:method-nameType"/>
<xsd:element name="method-params"
type="jakartaee:method-paramsType"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="relationship-role-sourceType">
<xsd:annotation>
<xsd:documentation>
The relationship-role-sourceType designates the source of a
role that participates in a relationship. A
relationship-role-sourceType is used by
relationship-role-source elements to uniquely identify an
entity bean.
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="ejb-name"
type="jakartaee:ejb-nameType"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="relationshipsType">
<xsd:annotation>
<xsd:documentation>
The relationshipsType describes the relationships in
which entity beans with container-managed persistence
participate. The relationshipsType contains an optional
description; and a list of ejb-relation elements, which
specify the container managed relationships.
Support for entity beans is optional as of Enterprise Beans 3.2.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="ejb-relation"
type="jakartaee:ejb-relationType"
maxOccurs="unbounded">
<xsd:unique name="role-name-uniqueness">
<xsd:annotation>
<xsd:documentation>
The ejb-relationship-role-name contains the name of a
relationship role. The name must be unique within
a relationship, but can be reused in different
relationships.
</xsd:documentation>
</xsd:annotation>
<xsd:selector xpath=".//jakartaee:ejb-relationship-role-name"/>
<xsd:field xpath="."/>
</xsd:unique>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="result-type-mappingType">
<xsd:annotation>
<xsd:documentation>
The result-type-mappingType is used in the query element to
specify whether an abstract schema type returned by a query
for a select method is to be mapped to an EJBLocalObject or
EJBObject type.
The value must be one of the following:
Local
Remote
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="Local"/>
<xsd:enumeration value="Remote"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="security-identityType">
<xsd:annotation>
<xsd:documentation>
The security-identityType specifies whether the caller's
security identity is to be used for the execution of the
methods of the enterprise bean or whether a specific run-as
identity is to be used. It contains an optional description
and a specification of the security identity to be used.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:choice>
<xsd:element name="use-caller-identity"
type="jakartaee:emptyType">
<xsd:annotation>
<xsd:documentation>
The use-caller-identity element specifies that
the caller's security identity be used as the
security identity for the execution of the
enterprise bean's methods.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="run-as"
type="jakartaee:run-asType"/>
</xsd:choice>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="session-beanType">
<xsd:annotation>
<xsd:documentation>
The session-beanType declares an session bean. The
declaration consists of:
- an optional description
- an optional display name
- an optional icon element that contains a small and a large
icon file name
- a name assigned to the enterprise bean
in the deployment description
- an optional mapped-name element that can be used to provide
vendor-specific deployment information such as the physical
jndi-name of the session bean's remote home/business interface.
This element is not required to be supported by all
implementations. Any use of this element is non-portable.
- the names of all the remote or local business interfaces,
if any
- the names of the session bean's remote home and
remote interfaces, if any
- the names of the session bean's local home and
local interfaces, if any
- an optional declaration that this bean exposes a
no-interface view
- the name of the session bean's web service endpoint
interface, if any
- the session bean's implementation class
- the session bean's state management type
- an optional declaration of a stateful session bean's timeout value
- an optional declaration of the session bean's timeout method for
handling programmatically created timers
- an optional declaration of timers to be automatically created at
deployment time
- an optional declaration that a Singleton bean has eager
initialization
- an optional declaration of a Singleton/Stateful bean's concurrency
management type
- an optional declaration of the method locking metadata
for a Singleton with container managed concurrency
- an optional declaration of the other Singleton beans in the
application that must be initialized before this bean
- an optional declaration of the session bean's asynchronous
methods
- the optional session bean's transaction management type.
If it is not present, it is defaulted to Container.
- an optional declaration of a stateful session bean's
afterBegin, beforeCompletion, and/or afterCompletion methods
- an optional list of the session bean class and/or
superclass around-invoke methods.
- an optional list of the session bean class and/or
superclass around-timeout methods.
- an optional declaration of the bean's
environment entries
- an optional declaration of the bean's enterprise bean references
- an optional declaration of the bean's local enterprise bean
references
- an optional declaration of the bean's web
service references
- an optional declaration of the security role
references
- an optional declaration of the security identity
to be used for the execution of the bean's methods
- an optional declaration of the bean's resource
manager connection factory references
- an optional declaration of the bean's resource
environment references.
- an optional declaration of the bean's message
destination references
- an optional specification as to whether the stateful
session bean is passivation capable or not. If not
specified, the bean is assumed to be passivation capable
The elements that are optional are "optional" in the sense
that they are omitted when if lists represented by them are
empty.
The service-endpoint element may only be specified if the
bean is a stateless session bean.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:group ref="jakartaee:descriptionGroup"/>
<xsd:element name="ejb-name"
type="jakartaee:ejb-nameType"/>
<xsd:element name="mapped-name"
type="jakartaee:xsdStringType"
minOccurs="0"/>
<xsd:element name="home"
type="jakartaee:homeType"
minOccurs="0"/>
<xsd:element name="remote"
type="jakartaee:remoteType"
minOccurs="0"/>
<xsd:element name="local-home"
type="jakartaee:local-homeType"
minOccurs="0"/>
<xsd:element name="local"
type="jakartaee:localType"
minOccurs="0"/>
<xsd:element name="business-local"
type="jakartaee:fully-qualified-classType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="business-remote"
type="jakartaee:fully-qualified-classType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="local-bean"
type="jakartaee:emptyType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The local-bean element declares that this
session bean exposes a no-interface Local client view.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="service-endpoint"
type="jakartaee:fully-qualified-classType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The service-endpoint element contains the
fully-qualified name of the enterprise bean's web
service endpoint interface. The service-endpoint
element may only be specified for a stateless
session bean. The specified interface must be a
valid Jakarta XML RPC service endpoint interface.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ejb-class"
type="jakartaee:ejb-classType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The ejb-class element specifies the fully qualified name
of the bean class for this ejb. It is required unless
there is a component-defining annotation for the same
ejb-name.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="session-type"
type="jakartaee:session-typeType"
minOccurs="0"/>
<xsd:element name="stateful-timeout"
type="jakartaee:stateful-timeoutType"
minOccurs="0"/>
<xsd:element name="timeout-method"
type="jakartaee:named-methodType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The timeout-method element specifies the method that
will receive callbacks for programmatically
created timers.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="timer"
type="jakartaee:timerType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="init-on-startup"
type="jakartaee:true-falseType"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The init-on-startup element specifies that a Singleton
bean has eager initialization.
This element can only be specified for singleton session
beans.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="concurrency-management-type"
type="jakartaee:concurrency-management-typeType"
minOccurs="0"/>
<xsd:element name="concurrent-method"
type="jakartaee:concurrent-methodType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="depends-on"
type="jakartaee:depends-onType"
minOccurs="0"/>
<xsd:element name="init-method"
type="jakartaee:init-methodType"
minOccurs="0"
maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
The init-method element specifies the mappings for
Enterprise Beans 2.x style create methods for an Enterprise Beans 3.x bean.
This element can only be specified for stateful
session beans.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="remove-method"
type="jakartaee:remove-methodType"
minOccurs="0"
maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
The remove-method element specifies the mappings for
Enterprise Beans 2.x style remove methods for an Enterprise Beans 3.x bean.
This element can only be specified for stateful
session beans.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="async-method"
type="jakartaee:async-methodType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="transaction-type"
type="jakartaee:transaction-typeType"
minOccurs="0"/>
<xsd:element name="after-begin-method"
type="jakartaee:named-methodType"
minOccurs="0"/>
<xsd:element name="before-completion-method"
type="jakartaee:named-methodType"
minOccurs="0"/>
<xsd:element name="after-completion-method"
type="jakartaee:named-methodType"
minOccurs="0"/>
<xsd:element name="around-invoke"
type="jakartaee:around-invokeType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="around-timeout"
type="jakartaee:around-timeoutType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:group ref="jakartaee:jndiEnvironmentRefsGroup"/>
<xsd:element name="post-activate"
type="jakartaee:lifecycle-callbackType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="pre-passivate"
type="jakartaee:lifecycle-callbackType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="security-role-ref"
type="jakartaee:security-role-refType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="security-identity"
type="jakartaee:security-identityType"
minOccurs="0"/>
<xsd:element name="passivation-capable"
type="xsd:boolean"
default="true"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>
The passivation-capable element specifies whether the
stateful session bean is passivation capable or not.
If not specified, the bean is assumed to be passivation
capable.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="session-typeType">
<xsd:annotation>
<xsd:documentation>
The session-typeType describes whether the session bean is a
singleton, stateful or stateless session. It is used by
session-type elements.
The value must be one of the three following:
Singleton
Stateful
Stateless
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="Singleton"/>
<xsd:enumeration value="Stateful"/>
<xsd:enumeration value="Stateless"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="stateful-timeoutType">
<xsd:annotation>
<xsd:documentation>
The stateful-timeoutType represents the amount of time
a stateful session bean can be idle(not receive any client
invocations) before it is eligible for removal by the container.
A timeout value of 0 means the bean is immediately eligible for removal.
A timeout value of -1 means the bean will never be removed due to timeout.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="timeout"
type="jakartaee:xsdIntegerType"/>
<xsd:element name="unit"
type="jakartaee:time-unit-typeType"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="time-unit-typeType">
<xsd:annotation>
<xsd:documentation>
The time-unit-typeType represents a time duration at a given
unit of granularity.
The time unit type must be one of the following :
Days
Hours
Minutes
Seconds
Milliseconds
Microseconds
Nanoseconds
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="Days"/>
<xsd:enumeration value="Hours"/>
<xsd:enumeration value="Minutes"/>
<xsd:enumeration value="Seconds"/>
<xsd:enumeration value="Milliseconds"/>
<xsd:enumeration value="Microseconds"/>
<xsd:enumeration value="Nanoseconds"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="timer-scheduleType">
<xsd:sequence>
<xsd:element name="second"
type="jakartaee:string"
minOccurs="0"/>
<xsd:element name="minute"
type="jakartaee:string"
minOccurs="0"/>
<xsd:element name="hour"
type="jakartaee:string"
minOccurs="0"/>
<xsd:element name="day-of-month"
type="jakartaee:string"
minOccurs="0"/>
<xsd:element name="month"
type="jakartaee:string"
minOccurs="0"/>
<xsd:element name="day-of-week"
type="jakartaee:string"
minOccurs="0"/>
<xsd:element name="year"
type="jakartaee:string"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="timerType">
<xsd:annotation>
<xsd:documentation>
The timerType specifies an enterprise bean timer. Each
timer is automatically created by the container upon
deployment. Timer callbacks occur based on the
schedule attributes. All callbacks are made to the
timeout-method associated with the timer.
A timer can have an optional start and/or end date. If
a start date is specified, it takes precedence over the
associated timer schedule such that any matching
expirations prior to the start time will not occur.
Likewise, no matching expirations will occur after any
end date. Start/End dates are specified using the
XML Schema dateTime type, which follows the ISO-8601
standard for date(and optional time-within-the-day)
representation.
An optional flag can be used to control whether
this timer has persistent(true) delivery semantics or
non-persistent(false) delivery semantics. If not specified,
the value defaults to persistent(true).
A time zone can optionally be associated with a timer.
If specified, the timer's schedule is evaluated in the context
of that time zone, regardless of the default time zone in which
the container is executing. Time zones are specified as an
ID string. The set of required time zone IDs is defined by
the Zone Name(TZ) column of the public domain zoneinfo database.
An optional info string can be assigned to the timer and
retrieved at runtime through the Timer.getInfo() method.
The timerType can only be specified on stateless session
beans, singleton session beans, and message-driven beans.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="description"
type="jakartaee:descriptionType"
minOccurs="0"
maxOccurs="unbounded"/>
<xsd:element name="schedule"
type="jakartaee:timer-scheduleType"/>
<xsd:element name="start"
type="xsd:dateTime"
minOccurs="0"/>
<xsd:element name="end"
type="xsd:dateTime"
minOccurs="0"/>
<xsd:element name="timeout-method"
type="jakartaee:named-methodType"/>
<xsd:element name="persistent"
type="jakartaee:true-falseType"
minOccurs="0"/>
<xsd:element name="timezone"
type="jakartaee:string"
minOccurs="0"/>
<xsd:element name="info"
type="jakartaee:string"
minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id"
type="xsd:ID"/>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="trans-attributeType">
<xsd:annotation>
<xsd:documentation>
The trans-attributeType specifies how the container must
manage the transaction boundaries when delegating a method
invocation to an enterprise bean's business method.
The value must be one of the following:
NotSupported
Supports
Required
RequiresNew
Mandatory
Never
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="NotSupported"/>
<xsd:enumeration value="Supports"/>
<xsd:enumeration value="Required"/>
<xsd:enumeration value="RequiresNew"/>
<xsd:enumeration value="Mandatory"/>
<xsd:enumeration value="Never"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
<!-- **************************************************** -->
<xsd:complexType name="transaction-typeType">
<xsd:annotation>
<xsd:documentation>
The transaction-typeType specifies an enterprise bean's
transaction management type.
The transaction-type must be one of the two following:
Bean
Container
</xsd:documentation>
</xsd:annotation>
<xsd:simpleContent>
<xsd:restriction base="jakartaee:string">
<xsd:enumeration value="Bean"/>
<xsd:enumeration value="Container"/>
</xsd:restriction>
</xsd:simpleContent>
</xsd:complexType>
</xsd:schema>
Reference in New Issue View Git Blame Copy Permalink