Skip Headers
Oracle® Containers for J2EE Enterprise JavaBeans Developer's Guide
10g (

Part Number E13981-01
Go to Documentation Home
Go to Book List
Book List
Go to Table of Contents
Go to Index
Go to Feedback page
Contact Us

Go to previous page
Go to next page
View PDF

OC4J and the orion-ejb-jar.xml File

Whenever you deploy an application, OC4J automatically generates the OC4J-specific XML file with the default elements. If you want to change these defaults, you must copy the orion-ejb-jar.xml file to where your original ejb-jar.xml file is located and change it in this location. If you change the XML file within the deployed location, OC4J overwrites these changes when the application is deployed again. The changes only stay constant when changed in the development directories.

Oracle recommends that you add your OC4J-specific XML files within the recommended development structure, as Figure A-1 shows.

Figure A-1 Development Application Directory Structure

Description of Figure A-1 follows
Description of "Figure A-1 Development Application Directory Structure"

TopLink Persistence Support

Table A-2 describes all the attributes of the orion-ejb-jar.xml file <entity-deployment> element and indicates which options you configure in the orion-ejb-jar.xml file and which you configure using TopLink persistence API.

For example:

  • To configure <entity-deployment> attribute call-timeout, you must use the corresponding TopLink persistence API. If you set the call-timeout attribute in the orion-ejb-jar.xml file, OC4J will ignore it.

  • To configure <entity-deployment> attribute clustering-schema, you must use the orion-ejb-jar.xml file; there is no corresponding TopLink persistence API.

For EJB 3.0 applications, you access TopLink persistence API by augmenting orion-ejb-jar.xml configuration with TopLink-specific deployment descriptor files ejb3-toplink-sessions.xml and toplink-ejb-jar.xml. For more information, see "Customizing the JPA Persistence Provider".

For EJB 2.1 applications, you access TopLink persistence API using orion-ejb-jar.xml element pm-properties. For more information, see "Customizing the TopLink EJB 2.1 Persistence Manager".


To modify TopLink deployment descriptor files, use the TopLink Workbench.

For more information, see the following:

  • "Migrating OC4J Orion Persistence to OC4J TopLink Persistence" in the Oracle TopLink Developer's Guide

  • "Understanding TopLink Workbench" in the Oracle TopLink Developer's Guide

  • TopLink-specific deployment descriptor XML schema documents located at <OC4J_HOME>\toplink\config\xsds.


The OC4J-specific deployment descriptor contains extended deployment information for session beans, entity beans, message driven beans, and security for these enterprise beans. The major element structure within this deployment descriptor has the following structure:

<orion-ejb-jar deployment-time=... deployment-version=...> 
   <persistence-manager ...></persistence-manager>
   <session-deployment ...></session-deployment>
   <entity-deployment ...></entity-deployment>
   <message-driven-deployment ...></message-driven-deployment>
   <security-role-mapping ...></security-role-mapping>

Each section under the <orion-ejb-jar> main tag has its own purpose. These are described in the following sections:


The <enterprise-beans> section defines additional deployment information for all enterprise beans: session beans, entity beans, and message driven beans. There is a section for each type of EJB.

The following sections describe the elements within <enterprise-beans> element: