@(#)ejb-jar_2_1.xsds 1.23 08/01/03 Copyright 2003 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, California 94303, U.S.A. All rights reserved. Sun Microsystems, Inc. has intellectual property rights relating to technology described in this document. In particular, and without limitation, these intellectual property rights may include one or more of the U.S. patents listed at http://www.sun.com/patents and one or more additional patents or pending patent applications in the U.S. and other countries. This document and the technology which it describes are distributed under licenses restricting their use, copying, distribution, and decompilation. No part of this document may be reproduced in any form by any means without prior written authorization of Sun and its licensors, if any. Third-party software, including font technology, is copyrighted and licensed from Sun suppliers. Sun, Sun Microsystems, the Sun logo, Solaris, Java, J2EE, JavaServer Pages, Enterprise JavaBeans and the Java Coffee Cup logo are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. Federal Acquisitions: Commercial Software - Government Users Subject to Standard License Terms and Conditions. ... The instance documents may indicate the published version of the schema using the xsi:schemaLocation attribute for the J2EE namespace with the following location: http://java.sun.com/xml/ns/j2ee/ejb-jar_2_1.xsd ]]> The following conventions apply to all J2EE 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. This is the root of the ejb-jar deployment descriptor. The ejb-name element contains the name of an enterprise bean. The name must be unique within the ejb-jar file. The keyref indicates the references from relationship-role-source must be to a specific ejb-name defined within the scope of enterprise-beans element. A role-name-key is specified to allow the references from the security-role-refs. The keyref indicates the references from security-role-ref to a specified role-name. 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. The activation-config-property-name element contains the name for an activation configuration property of a message-driven bean. For JMS message-driven beans, the following property names are recognized: acknowledgeMode, messageSelector, destinationType, subscriptionDurability The activation-config-property-value element contains the value for an activation configuration property of a message-driven bean. 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, 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. 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 and a list of methods to be excluded from being invoked. 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 producer. The cmp-fieldType describes a container-managed field. The cmp-fieldType contains an optional description of the field, and the name of the field. 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. 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 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. 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. 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". 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. com.wombat.empl.EmployeeServiceBean ]]> The ejb-jarType defines the root element of the EJB 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 - mandatory structural information about all included enterprise beans - 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. The ejb-relation-name contains the name of a relation. The name must be unique within relationships. Providing an assembly-descriptor in the deployment descriptor is optional for the ejb-jar file producer. employee_service_client.jar ]]> The version specifies the version of the EJB specification that the instance document must comply with. This information enables deployment tools to validate a particular EJB Deployment Descriptor with respect to a specific version of the EJB schema. EmployeeService ]]> 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. The ejb-relation-name element provides a unique name within the ejb-jar file for a relationship. Product-LineItem product-has-lineitems One ProductEJB ]]> 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. 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. The enterprise-beansType declares one or more enterprise beans. Each bean can be a session, entity or message-driven bean. The ejb-ref-name element contains the name of an EJB reference. The EJB 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/". The ejb-ref-name element contains the name of an EJB reference. The EJB 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/". 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. 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. 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. 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. The ejb-ref-name element contains the name of an EJB reference. The EJB 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/". The ejb-ref-name element contains the name of an EJB reference. The EJB 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/". 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. 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. 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. 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. The ejb-ref-name element contains the name of an EJB reference. The EJB 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/". The ejb-ref-name element contains the name of an EJB reference. The EJB 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/". 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. 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. 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. 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. 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 - 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 entity bean's persistence management type - 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 EJB references - an optional declaration of the bean's local EJB 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. 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. 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 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 EJB QL queries. For example, the abstract-schema-name for an entity bean whose local interface is com.acme.commerce.Order might be Order. 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. 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. 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 - the message-driven bean's implementation class - an optional declaration of the bean's messaging type - the message-driven bean's transaction management type - 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 declaration of the bean's environment entries - an optional declaration of the bean's EJB references - an optional declaration of the bean's local EJB references - an optional declaration of the bean's web service 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 The messaging-type element specifies the message listener interface of the message-driven bean. If the messaging-type element is not specified, it is assumed to be javax.jms.MessageListener. 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. The method-intf element must be one of the following: Home Remote LocalHome Local ServiceEndpoint 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. The method-paramsType defines a list of the fully-qualified Java type names of the method parameters. The method-param element contains a primitive or a fully-qualified Java type name of a method parameter. 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. 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 home, component and/or web service endpoint interfaces. The unchecked element specifies that a method is not checked for authorization by the container prior to invocation of the method. EJBNAME * This style is used to refer to all the methods of the specified enterprise bean's home, component, and/or web service endpoint interfaces. 2. EJBNAME 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. 3. EJBNAME METHOD PARAM-1 PARAM-2 ... PARAM-n 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 there are multiple methods with the same overloaded name, this style refers to all of the overloaded methods. Examples: Style 1: The following method element refers to all the methods of the EmployeeService bean's home, component, and/or web service endpoint interfaces: EmployeeService * Style 2: The following method element refers to all the create methods of the EmployeeService bean's home interface(s). EmployeeService create Style 3: The following method element refers to the create(String firstName, String LastName) method of the EmployeeService bean's home interface(s). EmployeeService create java.lang.String java.lang.String 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: EmployeeService foobar char int int[] mypackage.MyClass mypackage.MyClass[][] The optional method-intf element can be used when it becomes necessary to differentiate between a method that is multiply defined across the enterprise bean's home, component, and/or web service endpoint interfaces with the same name and signature. For example, the method element EmployeeService Remote create java.lang.String java.lang.String 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 EmployeeService Home create java.lang.String java.lang.String and the create method that is defined in the local home interface which would be defined as EmployeeService LocalHome create java.lang.String java.lang.String The method-intf element can be used with all th ree 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. EmployeeService Home * ]]> The multiplicityType describes the multiplicity of the role that participates in a relation. The value must be one of the two following: One Many The persistence-typeType specifies an entity bean's persistence management type. The persistence-type element must be one of the two following: Bean Container Method finds large orders findLargeOrders SELECT OBJECT(o) FROM Order o WHERE o.amount > 1000 ]]> 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 EJB QL query string that defines the query. Queries that are expressible in EJB QL must use the ejb-ql element to specify the query. If a query is not expressible in EJB 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". 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. 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. 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. 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 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. 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. 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 - 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 - 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 - the session bean's transaction management type - an optional declaration of the bean's environment entries - an optional declaration of the bean's EJB references - an optional declaration of the bean's local EJB 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 The elements that are optional are "optional" in the sense that they are omitted when if lists represented by them are empty. Either both the local-home and the local elements or both the home and the remote elements must be specified for the session bean. The service-endpoint element may only be specified if the bean is a stateless session bean. 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 JAX-RPC service endpoint interface. The session-typeType describes whether the session bean is a stateful session or stateless session. It is used by session-type elements. The value must be one of the two following: Stateful Stateless 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 The transaction-typeType specifies an enterprise bean's transaction management type. The transaction-type must be one of the two following: Bean Container