Creating OracleAS TopLink Deployment Files

session

The session element contains settings for the entire project. The toplink-ejb-jar.xml file must include a session section, which includes the following XML elements:

• name: A session name (unique among all deployed JARs) that is used as a key for the deployed OracleAS TopLink project (or the JAR that contains the project).

• project-xml: Specifies the name of the XML file that contains the OracleAS TopLink project metadata. Specify the fully qualified file name, including the .xml extension.

• The project deployment XML file can be stored either in the deployable JAR file at the root directory or on the file system.

  
  

  Note: If you wish, use a project-class element rather than a project-xml tag. With the project-class element, specify the fully-qualified name of the OracleAS TopLink project class. Include this class in the deployable JAR file. You can generate the project class either with OracleAS TopLink Mapping Workbench or write it manually.

  
  

• session-type: The session type must always be set to server-session.

• platform-class: The platform class controls the format of the SQL generated and other database specific behavior.

• uses-external-connection-pool and uses-external-transaction-controller: For OracleAS TopLink to participate in WebSphere JTS transactions, set both of these to TRUE.

• external-transaction-controller-class: This is the OracleAS TopLink server-specific JTS controller class required when using external transaction control. For WebSphere 4.0, use oracle.toplink.jts.was.JTSExternalTransactionController_4_0.

• enable-logging: When set to TRUE, OracleAS TopLink prints logging information for several of its operations. This is useful for debugging.

• logging-options: Options for different levels of OracleAS TopLink logging.

For more information about the toplink-was-ejb-jar_904.dtd, see <ORACLE_HOME>\toplink\config\dtds.

session

The session element contains settings for the entire project. The toplink-ejb-jar.xml file must include a session section, which may include the following XML elements:

• name: Specifies the name of the session. Assign a unique session name to all projects deployed in a given server. This tag is mandatory.

• project-class: Specifies the name of the class that contains the OracleAS TopLink project metadata. Specify the fully qualified Java class name, but do not include the .class or .java extension.

  Use this tag (and not the project-xml tag) if you deploy your projects using exported and compiled Java code.

• project-xml: Specifies the name of the XML file that contains the OracleAS TopLink project metadata. Specify the fully qualified file name, including the .xml extension.

  Use this tag (and not the project-class tag) if you deploy your project using an exported XML file.

• login: Specifies the login parameters for the session. This element includes the sub elements listed in Table 9-1.

• cache-synchronization (optional): This element indicates that changes made to one OracleAS TopLink cache in a cluster are automatically propagated to all other server caches. You can also include the optional sub elements listed in Table 9-2.

• use-remote-relationships (optional): OracleAS TopLink enables you to define relationships between beans in terms of their remote interfaces. This is especially useful when you port EJB 1.1 applications to EJB 2.0. When you enable this option, OracleAS TopLink defines all relationships in the JAR file using remote interfaces. Valid values are TRUE or FALSE. Default is FALSE.

  
  

  Note: If you enable this option, then your application no longer strictly complies with EJB 2.0, and your container may require some custom configuration. For example, when you deploy, run the weblogic.ejbc tool with the -nocompliance flag set.

  
  

• customization-class (optional): Specifies the fully qualified name of a DeploymentCustomization class.

Configuring the [J2EE-Container]-ejb-jar.xml File for BEA WebLogic

To deploy to a BEA WebLogic Server, modify the webLogic-ejb-jar.xml file. Within that file, each bean must have a persistence-descriptor entry with subentries, as follows:

• Configure the persistence-descriptor entry with subentries that indicate OracleAS TopLink is available and should be used:

  • If you deploy to WebLogic 6.1 (Service Pack 5). Include a persistence-type element and a persistence-use element. Both elements require a type-identifier and a type-version tag. Table 9-3 lists the options for the type-identifier tag, and Table 9-4 contains the options for the type-version tag.

  • If you deploy to WebLogic 7.0 or 8.1. Include a persistence-use element with a type-identifier and a type-version tag. Table 9-3 lists the options for the type-identifier tag, and Table 9-4 contains the options for the type-version tag.

• If you use WebLogic 6.1, add the element type-storage to the persistence-type element, and set it to META-INF\toplink-ejb-jar.xml.

• If you use WebLogic 7.0 or 8.1, add the element type-storage to the persistence-use element, and set it to META-INF\toplink-ejb-jar.xml.

• Set the enable-call-by-reference element to TRUE to enable Call by Reference:

  <weblogic-enterprise-bean>
      <ejb-name>AccountBean</ejb-name>
      ...
          <enable-call-by-reference>True</enable-call-by-reference>
      ...
  </weblogic-enterprise-bean>
  
  

<type-identifier>TopLink_CMP_1_1</type-identifier>

<type-identifier>TopLink_CMP_2_0</type-identifier>

<type-version>4.0</type-version>

<type-version>4.5</type-version>

<type-version>9.0.4</type-version>

Unsupported weblogic-ejb-jar.xml File Tags

The weblogic-ejb-jar.xml file includes the following tags that OracleAS TopLink either does not support or does not require:

• concurrency-strategy: This tag specifies how WebLogic manages concurrent users for a given bean. Because OracleAS TopLink manages concurrent access internally, it does not require this element.

  For more information about OracleAS TopLink concurrency strategy, see "Locking Policy".

• db-is-shared: Because OracleAS TopLink does not make any assumptions about the exclusivity of database access, OracleAS TopLink does not require this tag. OracleAS TopLink addresses multi-user access issues through various locking and refreshing policies.

• delay-updates-until-end-of-tx: OracleAS TopLink always delays updates until the end of a transaction and does not require this tag.

• finders-load-bean: OracleAS TopLink always loads the bean upon execution of the finder and does not require this tag.

• pool: OracleAS TopLink does not use a pooling strategy for entity beans. This avoids object-identity problems that can occur due to pooling.

• lifecycle: This element manages beans that follow a pooling strategy. Because OracleAS TopLink does not use a pooling strategy, OracleAS TopLink ignores this tag.

• is-modified-method-name: OracleAS TopLink does not require a bean developer-defined method to detect changes in object state.

• isolation-level: Because isolation level settings for the cache or database transactions are specified in the OracleAS TopLink project, OracleAS TopLink ignores this tag.

• cache: Because you define OracleAS TopLink cache properties in OracleAS TopLink Mapping Workbench, this tag is not necessary.