EJB Deployment Descriptor Example

• an optional description of the ejb-jar file
• an optional display name
• an optional small icon file name
• an optional 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.

Example:

<display-name>Employee Self Service</display-name>

The file name is a relative path within the the application’s ear file.

Example:

<small-icon>employee-service-icon16x16.jpg</small-icon>

The file name is a relative path within the the application’s ear file.

Example:

<large-icon>employee-service-icon32x32.jpg</large-icon>

The session element declares an session bean. The declaration consists of:

• an optional description
• an optional display name
• an optional small icon file name
• an optional 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 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 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.

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.

Example:

<display-name>Employee Self Service</display-name>

The file name is a relative path within the the application’s ear file.

Example:

<small-icon>employee-service-icon16x16.jpg</small-icon>

The file name is a relative path within the the application’s ear file.

Example:

<large-icon>employee-service-icon32x32.jpg</large-icon>

There is no architected relationship between the 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 with cmp-version 2.x must conform to the lexical rules for an NMTOKEN. The name for an entity bean with cmp-version 2.x must not be a reserved literal in EJB QL.

Example:

<ejb-name>EmployeeService</ejb-name>

Example:

<home>com.aardvark.payroll.PayrollHome</home>

Example:

<remote>com.wombat.empl.EmployeeService</remote>

<ejb-class>com.wombat.empl.EmployeeServiceBean</ejb-class>

The session-type element must be one of the two following:

<session-type>Stateful</session-type>
<session-type>Stateless</session-type>

The transaction-type element must be one of the two following:

<transaction-type>Bean</transaction-type>
<transaction-type>Container</transaction-type>

Example:

<env-entry-name>minAmount</env-entry-name>

The following are the legal values of env-entry-type:

java.lang.Boolean
java.lang.Byte
java.lang.Character
java.lang.String
java.lang.Short
java.lang.Integer
java.lang.Long
java.lang.Float
java.lang.Double

Example:

<env-entry-type>java.lang.Boolean</env-entry-type>

Example:

<env-entry-value>100.00</env-entry-value>

• an optional description
• the EJB reference name used in the code of the enterprise bean that’s referencing the enterprise bean
• the expected type of the referenced enterprise bean
• the expected home and remote interfaces of the referenced enterprise bean
• optional ejb-link information, used to specify the referenced enterprise bean

It is recommended that name is prefixed with “ejb/”.

Example:

<ejb-ref-name>ejb/Payroll</ejb-ref-name>

The ejb-ref-type element must be one of the following:

<ejb-ref-type>Entity</ejb-ref-type> <ejb-ref-type>Session</ejb-ref-type>

Example:

<home>com.aardvark.payroll.PayrollHome</home>

Example:

<remote>com.wombat.empl.EmployeeService</remote>

The value of the ejb-link element must be the ejb-name of an enterprise bean in the same ejb-jar file or in another ejb-jar file in the same J2EE application unit.

Alternatively, the name in the ejb-link element may be composed of a path name specifying the ejb-jar containing the referenced enterprise bean with the ejb-name of the target bean appended and separated from the path name by “#”. The path name is relative to the ejb-jar file containing the enterprise bean that is referencing the enterprise bean. This allows multiple enterprise beans with the same ejb-name to be uniquely identified.

Examples:

<ejb-link>EmployeeRecord</ejb-link>
<ejb-link>../products/product.jar#ProductEJB</ejb-link>

• an optional description
• the EJB reference name used in the code of the enterprise bean that’s referencing the enterprise bean
• the expected type of the referenced enterprise bean
• the expected local home and local interfaces of the referenced enterprise bean
• optional ejb-link information, used to specify the referenced enterprise bean

It is recommended that name is prefixed with “ejb/”.

Example:

<ejb-ref-name>ejb/Payroll</ejb-ref-name>

The ejb-ref-type element must be one of the following:

<ejb-ref-type>Entity</ejb-ref-type> <ejb-ref-type>Session</ejb-ref-type>

The value of the ejb-link element must be the ejb-name of an enterprise bean in the same ejb-jar file or in another ejb-jar file in the same J2EE application unit.

Alternatively, the name in the ejb-link element may be composed of a path name specifying the ejb-jar containing the referenced enterprise bean with the ejb-name of the target bean appended and separated from the path name by “#”. The path name is relative to the ejb-jar file containing the enterprise bean that is referencing the enterprise bean. This allows multiple enterprise beans with the same ejb-name to be uniquely identified.

Examples:

<ejb-link>EmployeeRecord</ejb-link>
<ejb-link>../products/product.jar#ProductEJB</ejb-link>

The value of the role-name element must be the String used as the parameter to the EJBContext.isCallerInRole(String roleName) method or the HttpServletRequest.isUserInRole(String role) method.

The name must conform to the lexical rules for an NMTOKEN.

The description element is used to provide text describing the parent element. The description element should include any information that the enterprise bean ejb-jar file producer wants to provide to the consumer of the enterprise bean ejb-jar file (i.e., to the Deployer). Typically, the tools used by the enterprise bean ejb-jar file consumer will display the description when processing the parent element that contains the description.

The role-name element contains the name of a security role. The name must conform to the lexical rules for an NMTOKEN.

Example:

<resource-ref>
<res-ref-name>jdbc/EmployeeAppDB</res-ref-name>
<res-type>javax.sql.DataSource</res-type>
<res-auth>Container</res-auth>
<res-sharing-scope>Shareable</res-sharing-scope>
</resource-ref>

The value of this element must be one of the two following:

<res-auth>Application</res-auth>
<res-auth>Container</res-auth>

<res-sharing-scope>Shareable</res-sharing-scope>
<res-sharing-scope>Unshareable</res-sharing-scope>

The default value is Shareable.

Example:

<resource-env-ref>
<resource-env-ref-name>jms/StockQueue</resource-env-ref-name>
<resource-env-ref-type>javax.jms.Queue</resource-env-ref-type>
</resource-env-ref>

The entity element declares an entity bean. The declaration consists of:

• an optional description
• an optional display name
• an optional small icon file name
• an optional 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 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 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.

Example:

<display-name>Employee Self Service</display-name>

The file name is a relative path within the the application’s ear file.

Example:

<small-icon>employee-service-icon16x16.jpg</small-icon>

The file name is a relative path within the the application’s ear file.

Example:

<large-icon>employee-service-icon32x32.jpg</large-icon>

There is no architected relationship between the 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 with cmp-version 2.x must conform to the lexical rules for an NMTOKEN. The name for an entity bean with cmp-version 2.x must not be a reserved literal in EJB QL.

Example:

<ejb-name>EmployeeService</ejb-name>

Example:

<home>com.aardvark.payroll.PayrollHome</home>

Example:

<remote>com.wombat.empl.EmployeeService</remote>

<ejb-class>com.wombat.empl.EmployeeServiceBean</ejb-class>

The persistence-type element must be one of the two following:

<persistence-type>Bean</persistence-type>
<persistence-type>Container</persistence-type>

If the definition of the primary key class is deferred to deployment time, the prim-key-class element should specify java.lang.Object.

Examples:

<prim-key-class>java.lang.String</prim-key-class>
<prim-key-class>com.wombat.empl.EmployeeID</prim-key-class>
<prim-key-class>java.lang.Object</prim-key-class>

The reentrant element must be one of the two following:

<reentrant>True</reentrant>
<reentrant>False</reentrant>

The cmp-version element must be one of the two following:

<cmp-version>1.x</cmp-version>
<cmp-version>2.x</cmp-version>

The default value of the cmp-version element is 2.x.

For example, the abstract-schema-name for an entity bean whose local interface is com.acme.commerce.Order might be Order.

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.

Example:

<field-name>firstName</field-Name>

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.

Example:

<primkey-field>EmployeeId</primkey-field>

Example:

<env-entry-name>minAmount</env-entry-name>

The following are the legal values of env-entry-type:

java.lang.Boolean
java.lang.Byte
java.lang.Character
java.lang.String
java.lang.Short
java.lang.Integer
java.lang.Long
java.lang.Float
java.lang.Double

Example:

<env-entry-type>java.lang.Boolean</env-entry-type>

Example:

<env-entry-value>100.00</env-entry-value>

• an optional description
• the EJB reference name used in the code of the enterprise bean that’s referencing the enterprise bean
• the expected type of the referenced enterprise bean
• the expected home and remote interfaces of the referenced enterprise bean
• optional ejb-link information, used to specify the referenced enterprise bean

It is recommended that name is prefixed with “ejb/”.

Example:

<ejb-ref-name>ejb/Payroll</ejb-ref-name>

The ejb-ref-type element must be one of the following:

<ejb-ref-type>Entity</ejb-ref-type> <ejb-ref-type>Session</ejb-ref-type>

Example:

<home>com.aardvark.payroll.PayrollHome</home>

Example:

<remote>com.wombat.empl.EmployeeService</remote>

The value of the ejb-link element must be the ejb-name of an enterprise bean in the same ejb-jar file or in another ejb-jar file in the same J2EE application unit.

Alternatively, the name in the ejb-link element may be composed of a path name specifying the ejb-jar containing the referenced enterprise bean with the ejb-name of the target bean appended and separated from the path name by “#”. The path name is relative to the ejb-jar file containing the enterprise bean that is referencing the enterprise bean. This allows multiple enterprise beans with the same ejb-name to be uniquely identified.

Examples:

<ejb-link>EmployeeRecord</ejb-link>
<ejb-link>../products/product.jar#ProductEJB</ejb-link>

• an optional description
• the EJB reference name used in the code of the enterprise bean that’s referencing the enterprise bean
• the expected type of the referenced enterprise bean
• the expected local home and local interfaces of the referenced enterprise bean
• optional ejb-link information, used to specify the referenced enterprise bean

It is recommended that name is prefixed with “ejb/”.

Example:

<ejb-ref-name>ejb/Payroll</ejb-ref-name>

The ejb-ref-type element must be one of the following:

<ejb-ref-type>Entity</ejb-ref-type> <ejb-ref-type>Session</ejb-ref-type>

The value of the ejb-link element must be the ejb-name of an enterprise bean in the same ejb-jar file or in another ejb-jar file in the same J2EE application unit.

Alternatively, the name in the ejb-link element may be composed of a path name specifying the ejb-jar containing the referenced enterprise bean with the ejb-name of the target bean appended and separated from the path name by “#”. The path name is relative to the ejb-jar file containing the enterprise bean that is referencing the enterprise bean. This allows multiple enterprise beans with the same ejb-name to be uniquely identified.

Examples:

<ejb-link>EmployeeRecord</ejb-link>
<ejb-link>../products/product.jar#ProductEJB</ejb-link>

The value of the role-name element must be the String used as the parameter to the EJBContext.isCallerInRole(String roleName) method or the HttpServletRequest.isUserInRole(String role) method.

The name must conform to the lexical rules for an NMTOKEN.

The description element is used to provide text describing the parent element. The description element should include any information that the enterprise bean ejb-jar file producer wants to provide to the consumer of the enterprise bean ejb-jar file (i.e., to the Deployer). Typically, the tools used by the enterprise bean ejb-jar file consumer will display the description when processing the parent element that contains the description.

The role-name element contains the name of a security role. The name must conform to the lexical rules for an NMTOKEN.

Example:

<resource-ref>
<res-ref-name>jdbc/EmployeeAppDB</res-ref-name>
<res-type>javax.sql.DataSource</res-type>
<res-auth>Container</res-auth>
<res-sharing-scope>Shareable</res-sharing-scope>
</resource-ref>

The value of this element must be one of the two following:

<res-auth>Application</res-auth>
<res-auth>Container</res-auth>

<res-sharing-scope>Shareable</res-sharing-scope>
<res-sharing-scope>Unshareable</res-sharing-scope>

The default value is Shareable.

Example:

<resource-env-ref>
<resource-env-ref-name>jms/StockQueue</resource-env-ref-name>
<resource-env-ref-type>javax.jms.Queue</resource-env-ref-type>
</resource-env-ref>

• 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 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.

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 > 1000</ejb-ql>
</query>

The result-type-mapping element must be one of the following:

<result-type-mapping>Local</result-type-mapping>
<result-type-mapping>Remote</result-type-mapping>

The ejb-ql element must be specified for all queries that are expressible in EJB QL.

Example:

<query>
<query-method>
<method-name>ejbSelectPendingLineitems</method-name>
<method-params/>
</query-method>
<ejb-ql>SELECT OBJECT(l) FROM LineItems l WHERE l.shipped <> TRUE
</ejb-ql>
</query>

The message-driven element declares a message-driven bean. The declaration consists of:

• an optional description
• an optional display name
• an optional small icon file name
• an optional large icon file name
• a name assigned to the enterprise bean in the deployment descriptor
• the message-driven bean’s implementation class
• the message-driven bean’s transaction management type
• an optional declaration of the message-driven bean’s message selector
• an optional declaration of the acknowledgment mode for the message-driven bean if bean-managed transaction demarcation is used
• an optional declaration of the intended destination type of the message-driven bean
• 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 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.

Example:

<display-name>Employee Self Service</display-name>

The file name is a relative path within the the application’s ear file.

Example:

<small-icon>employee-service-icon16x16.jpg</small-icon>

The file name is a relative path within the the application’s ear file.

Example:

<large-icon>employee-service-icon32x32.jpg</large-icon>

There is no architected relationship between the 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 with cmp-version 2.x must conform to the lexical rules for an NMTOKEN. The name for an entity bean with cmp-version 2.x must not be a reserved literal in EJB QL.

Example:

<ejb-name>EmployeeService</ejb-name>

<ejb-class>com.wombat.empl.EmployeeServiceBean</ejb-class>

The transaction-type element must be one of the two following:

<transaction-type>Bean</transaction-type>
<transaction-type>Container</transaction-type>

Example:

<message-selector>JMSType = ‘car’ AND color = ‘blue’ AND weight > 2500 </message-selector>

The acknowledge-mode element must be one of the two following:

<acknowledge-mode>Auto-acknowledge</acknowledge-mode>
<acknowledge-mode>Dups-ok-acknowledge</acknowledgemode>

The destination-type element must be one of the two following:

<destination-type>javax.jms.Queue</destination-type>
<destination-type>javax.jms.Topic</destination-type>

The subscription-durability element must be one of the two following:

<subscription-durability>Durable</subscription-durability>
<subscription-durability>NonDurable</subscription-durability>

Example:

<env-entry-name>minAmount</env-entry-name>

The following are the legal values of env-entry-type:

java.lang.Boolean
java.lang.Byte
java.lang.Character
java.lang.String
java.lang.Short
java.lang.Integer
java.lang.Long
java.lang.Float
java.lang.Double

Example:

<env-entry-type>java.lang.Boolean</env-entry-type>

Example:

<env-entry-value>100.00</env-entry-value>

• an optional description
• the EJB reference name used in the code of the enterprise bean that’s referencing the enterprise bean
• the expected type of the referenced enterprise bean
• the expected home and remote interfaces of the referenced enterprise bean
• optional ejb-link information, used to specify the referenced enterprise bean

It is recommended that name is prefixed with “ejb/”.

Example:

<ejb-ref-name>ejb/Payroll</ejb-ref-name>

The ejb-ref-type element must be one of the following:

<ejb-ref-type>Entity</ejb-ref-type> <ejb-ref-type>Session</ejb-ref-type>

Example:

<home>com.aardvark.payroll.PayrollHome</home>

Example:

<remote>com.wombat.empl.EmployeeService</remote>

The value of the ejb-link element must be the ejb-name of an enterprise bean in the same ejb-jar file or in another ejb-jar file in the same J2EE application unit.

Alternatively, the name in the ejb-link element may be composed of a path name specifying the ejb-jar containing the referenced enterprise bean with the ejb-name of the target bean appended and separated from the path name by “#”. The path name is relative to the ejb-jar file containing the enterprise bean that is referencing the enterprise bean. This allows multiple enterprise beans with the same ejb-name to be uniquely identified.

Examples:

<ejb-link>EmployeeRecord</ejb-link>
<ejb-link>../products/product.jar#ProductEJB</ejb-link>

• an optional description
• the EJB reference name used in the code of the enterprise bean that’s referencing the enterprise bean
• the expected type of the referenced enterprise bean
• the expected local home and local interfaces of the referenced enterprise bean
• optional ejb-link information, used to specify the referenced enterprise bean

It is recommended that name is prefixed with “ejb/”.

Example:

<ejb-ref-name>ejb/Payroll</ejb-ref-name>

The ejb-ref-type element must be one of the following:

<ejb-ref-type>Entity</ejb-ref-type> <ejb-ref-type>Session</ejb-ref-type>

The value of the ejb-link element must be the ejb-name of an enterprise bean in the same ejb-jar file or in another ejb-jar file in the same J2EE application unit.

Alternatively, the name in the ejb-link element may be composed of a path name specifying the ejb-jar containing the referenced enterprise bean with the ejb-name of the target bean appended and separated from the path name by “#”. The path name is relative to the ejb-jar file containing the enterprise bean that is referencing the enterprise bean. This allows multiple enterprise beans with the same ejb-name to be uniquely identified.

Examples:

<ejb-link>EmployeeRecord</ejb-link>
<ejb-link>../products/product.jar#ProductEJB</ejb-link>

The description element is used to provide text describing the parent element. The description element should include any information that the enterprise bean ejb-jar file producer wants to provide to the consumer of the enterprise bean ejb-jar file (i.e., to the Deployer). Typically, the tools used by the enterprise bean ejb-jar file consumer will display the description when processing the parent element that contains the description.

The role-name element contains the name of a security role. The name must conform to the lexical rules for an NMTOKEN.

Example:

<resource-ref>
<res-ref-name>jdbc/EmployeeAppDB</res-ref-name>
<res-type>javax.sql.DataSource</res-type>
<res-auth>Container</res-auth>
<res-sharing-scope>Shareable</res-sharing-scope>
</resource-ref>

The value of this element must be one of the two following:

<res-auth>Application</res-auth>
<res-auth>Container</res-auth>

<res-sharing-scope>Shareable</res-sharing-scope>
<res-sharing-scope>Unshareable</res-sharing-scope>

The default value is Shareable.

Example:

<resource-env-ref>
<resource-env-ref-name>jms/StockQueue</resource-env-ref-name>
<resource-env-ref-type>javax.jms.Queue</resource-env-ref-type>
</resource-env-ref>

The ejb-relationship-role element 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>

The multiplicity element must be one of the two following:

<multiplicity>One</multiplicity>
<multiplicity>Many</multiplicity>

There is no architected relationship between the 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 with cmp-version 2.x must conform to the lexical rules for an NMTOKEN. The name for an entity bean with cmp-version 2.x must not be a reserved literal in EJB QL.

Example:

<ejb-name>EmployeeService</ejb-name>

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.

Example:

<security-role>
<description>
This role includes all employees who are authorized
to access the employee service application.
</description>
<role-name>employee</role-name>
</security-role>

The name must conform to the lexical rules for an NMTOKEN.

The security roles used in the method-permission element must be defined in the security-role elements of the deployment descriptor, and the methods must be methods defined in the enterprise bean’s component and/or home interfaces.

The unchecked element specifies that a method is not checked for authorization by the container prior to invocation of the method.

There are three possible styles of the method element syntax:

1.
<method>
<ejb-name>EJBNAME</ejb-name>
<method-name>*</method-name>
</method>

This style is used to refer to all the methods of the specified enterprise bean’s home and component interfaces.

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.

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 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 and component interfaces:

<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 multiply defined across the enterprise bean’s home and component interfaces with the same name and signature.

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.

<method>
<ejb-name>EmployeeService</ejb-name>
<method-intf>Home</method-intf>
<method-name>*</method-name>
</method>

There is no architected relationship between the 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 with cmp-version 2.x must conform to the lexical rules for an NMTOKEN. The name for an entity bean with cmp-version 2.x must not be a reserved literal in EJB QL.

Example:

<ejb-name>EmployeeService</ejb-name>

The method-intf element must be one of the following:

<method-intf>Home</method-intf>
<method-intf>Remote</method-intf>
<method-intf>LocalHome</method-intf>
<method-intf>Local</method-intf>

The value of trans-attribute must be one of the following:

<trans-attribute>NotSupported</trans-attribute>
<trans-attribute>Supports</trans-attribute>
<trans-attribute>Required</trans-attribute>
<trans-attribute>RequiresNew</trans-attribute>
<trans-attribute>Mandatory</trans-attribute>
<trans-attribute>Never</trans-attribute>

If the method permission relation contains methods that are in the exclude list, the Deployer should consider those methods to be uncallable.

<ejb-client-jar>employee_service_client.jar</ejb-client-jar>