10 Packaging a TopLink Application

10.2.1 How to Create the TopLink Domain JAR

The domain JAR contains the TopLink files and domain objects required by the application, including the following:

• sessions.xml (see Section 9.1.2, "sessions.xml File");

• project.xml (see Section 9.1.1, "project.xml File") (or the compiled Project class file, if you are not using XML files for deployment);

• The mapped classes required by the application, in a fully resolved directory structure.

When you create the JAR file, the JAR building utility automatically creates a directory structure within the JAR. Ensure that the sessions.xml file and the project.xml file (or project.class file) appear at the root of the JAR file. Also ensure that the class directory structure starts at the root of the JAR.

If you do not store the project.xml or sessions.xml files at the root of the JAR file, see Section 10.8, "Packaging with TopLink Metadata File Resource Paths".

10.3.1 How to Package an EJB 1.n and 2.n Session Bean Application

For Java EE applications with session beans, it is common to package the application in an Enterprise Archive (EAR) file made up of various Java EE application component archives, as Example 10-3 shows.

appname.ear
    META-INF
        application.xml
        orion-application.xml
    ejb_module_X.jar
        EJB classes - session and non-entity beans
        META-INF
            ejb-jar.xml
            orion-ejb-jar.xml - no persistence-manager subentries
    domain_module.jar
        Java classes that represent the object mapped
        project.xml
        session.xml
        META-INF
            Manifest.mf
    web_module.war
        html pages, JSP's, etc.
        META-INF
            web.xml
            orion-web.xml
        classes
            servlet classes
        lib
    client_module.jar
        Client classes
        META-INF
            application-client.xml
            orion-application-client.xml

The component archives with TopLink dependencies include the following:

• TopLink domain JAR (see Section 10.2.1, "How to Create the TopLink Domain JAR");

• EJB JAR (see Section 10.3.4, "How to Create the EJB JAR").

10.3.2 How to Package an EJB 3.0 Session Bean Application

For information on how to package an EJB 3.0 session bean application, see "Packaging an EclipseLink JPA Application" section of EclipseLink Developer's Guide at http://wiki.eclipse.org/Packaging_and_Deploying_EclipseLink_JPA_Applications_%28ELUG%29#Packaging_an_EclipseLink_JPA_Application.

10.3.3 How to Create the TopLink Domain JAR

The domain JAR contains the TopLink files and domain objects required by the application, including the following:

• sessions.xml (see Section 9.1.2, "sessions.xml File");

• project.xml (see Section 9.1.1, "project.xml File") (or the compiled Project.class file if you are not using XML files for deployment);

• The mapped classes required by the application, in a fully-resolved directory structure.

When you create the JAR file, the JAR building utility automatically creates a directory structure within the JAR. Ensure that the sessions.xml file and the project.xml file (or project.class file) appear at the root of the JAR file. Also ensure that the class directory structure starts at the root of the JAR.

If you do not store the project.xml or sessions.xml files at the root of the JAR file, see Section 10.8, "Packaging with TopLink Metadata File Resource Paths".

10.3.4 How to Create the EJB JAR

In this type of application, the EJB JAR contains session beans. Consequently, its orion-ejb-jar.xml file does not contain persistence-manager or pm-properties entries. These entries apply only to CMP applications.

10.6.1 How to Create the EJB JAR

In this type of application, the EJB JAR file specifically service both non-entity and entity EJB. It includes the following:

• The home and remote, and all implementation code for all mapped beans in the application.

• All mapped non-EJB classes from the Oracle JDeveloper or TopLink Workbench project

• The home and remote, and all implementation code for any session beans included in the application.

• Helper classes that contain TopLink amendment methods, and any other classes the application requires.

  For example, an instance of oracle.toplink.ejb.cmp.DeploymentCustomization (for more information, see customization-class in Table 9-3 in Section 9.9.1, "How to Configure persistence-manager Entries").

Store the following XML files in the EJB JAR \meta-inf directory:

• ejb-jar.xml (see ejb-jar.xml File)

• JAVA-EE-COMTAINER-ejb-jar.xml (see JAVA-EE-CONTAINER-ejb-jar.xml File)

• toplink-ejb-jar.xml (see toplink-ejb-jar.xml File)

You must persist all of the entity beans to the same data source. For a CMP application, TopLink does not support the session broker functionality (see Section 87.7, "Session Broker and Client Sessions").

10.7.1 How to Create the TopLink Domain JAR

The domain JAR contains the TopLink files and domain objects required by the application, including the following:

• sessions.xml (see Section 9.1.2, "sessions.xml File");

• project.xml (see Section 9.1.1, "project.xml File") (or the compiled Project.class file if you are not using XML files for deployment);

• The mapped classes required by the application, in a fully resolved directory structure.

When you create the JAR file, the JAR building utility automatically creates a directory structure within the JAR. Ensure that the sessions.xml file and the project.xml file (or project.class file) appear at the root of the JAR file. Also ensure that the class directory structure starts at the root of the JAR.

If you do not store the project.xml or sessions.xml files at the root of the JAR file, see Section 10.8, "Packaging with TopLink Metadata File Resource Paths".

10.7.2 How to Create EJB JAR File

In this type of application, the EJB JAR file specifically services both session and entity beans. It includes the following:

• The home and remote, and all implementation code for all mapped beans in the application.

• All mapped non-EJB classes from the Oracle JDeveloper or TopLink Workbench project.

• The home and remote, and all implementation code for any session beans included in the application.

• Helper classes that contain TopLink amendment methods, and any other classes the application requires.

Store the following XML files in the EJB JAR \meta-inf directory:

• ejb-jar.xml (see ejb-jar.xml File)

• JAVA-EE-COMTAINER-ejb-jar.xml (see JAVA-EE-CONTAINER-ejb-jar.xml File)

Because the EJB JAR does not contain entity beans with container-managed persistence, its orion-ejb-jar.xml file must not contain persistence-manager or pm-properties entries.

For more information, see Section 9.9.1, "How to Configure persistence-manager Entries".