Corporate Info  |  News  |  Solutions  |  Products  |  Partners  |  Services  |  Events  |  Download  |  How To Buy
	http://www.oracle.com/technology/documentation/index.html   |   Site Map   |   Search   |   PDF Files   |   Contact   |   Glossary
WebLogic Enterprise Doc Home   |   Enterprise JavaBeans Topics   |   Previous Topic   |   Next Topic   |   Contents   |   Index

This topic describes the XML DTD for the EJB deployment descriptor, as defined in the Enterprise JavaBeans Specification 1.1 published by Sun Microsystems, Inc.

This topic includes the following sections:

• About Deployment Descriptors

• DOCTYPE Declaration

• Summary of Deployment Descriptor Elements

• Description of Deployment Descriptor Elements

In addition to the standard EJB deployment descriptor provided by Sun Microsystems, Inc., WebLogic Enterprise (WLE) provides the WebLogic Enterprise EJB Extensions, which are XML elements used to further customize EJBs for the WebLogic Enterprise environment. For more information, see WebLogic Enterprise EJB Extensions Reference. For more information about deploying EJBs in the WebLogic Enterprise environment, see "Developing WebLogic Enterprise EJB Applications" in Getting Started.

Note: Material in this topic was republished with permission from Sun Microsystems, Inc.

A deployment descriptor is a file that defines the following kinds of information:

• EJB structural information, such as the EJB name, class, home and remote interfaces, bean type (session or entity), environment entries, resource factory references, EJB references, security role references, as well as additional information based on the bean type.

• Application assembly information, such as EJB references, security roles, security role references, method permissions, and container transaction attributes. Specifying assembly descriptor information is an optional task that an Application Assembler performs.

For a complete discussion of the EJB deployment descriptor, see Chapter 16, "Deployment Descriptor," in the Enterprise JavaBeans Specification 1.1.

Specifying deployment descriptor information is a required task that a Bean Provider performs. The Bean Provider creates a standard EJB deployment descriptor file using the XML markup conventions in accordance with the syntax described in the Enterprise JavaBeans Specification 1.1. Multiple EJBs can be defined in a single deployment descriptor. For more information about creating deployment descriptors, see the following documents:

• "Developing WebLogic Enterprise EJB Applications" in Getting Started

• Using the WebLogic EJB Deployer

An Application Assembler or Deployer may subsequently modify only certain information (such as the EJB name, values of environment entries, and description entries) in the deployment descriptor. The Deployer may use the WebLogic EJB Deployer to update certain settings in the deployment descriptor.

Thereafter, the Application Assembler creates a deployable EJB JAR file using the ejbc command-line tool, specifying the -i parameter and passing this filename (ejb-jar.xml). For more information about the ejbc command-line tool, see the Commands, Systems Processes, and MIB Reference.

Deployment descriptors are stored in the EJB JAR file. The WebLogic EJB Deployer accepts standard, extended, and deployable EJB JAR files.

All valid EJB JAR deployment descriptors must contain the following DOCTYPE declaration:

<!DOCTYPE ejb-jar PUBLIC "-//Sun Microsystems, Inc.//DTD Enterprise
JavaBeans 1.1//EN" "http://java.sun.com/j2ee/dtds/ejb-jar_1_1.dtd">

Table 1-1 describes the standard deployment descriptor elements.

Table 1-1 List of Standard Deployment Descriptor Elements

Element	Description	EJB Role
assembly-descriptor	Contains application-assembly information.	Application Assembler
cmp-field	Describes a container-managed field.	Bean Provider
container-transaction	Specifies how the container must manage transaction scopes for the EJB's method invocations.	Application Assembler
description	Provides text describing the parent element.	Bean Provider or Application Assembler
display-name	Specifies a short name that is intended to be displayed by tools.	Bean Provider