Packaging an OracleAS TopLink Application

Packaging the Java Application

You deploy Java applications simply by placing them on the classpath. To follow the standard OracleAS TopLink approach of encapsulating applications in an archive, deploy the application in a JAR file, as follows:

1. Place the sessions.xml and project.xml files in the root of the JAR.

2. Include all mapped classes and any required helper classes in the JAR.

3. Place the completed JAR on the classpath.

Deploying the Application to a Client

Build the JAR and place it on the classpath. Include the following Java code in your client application to access the OracleAS TopLink application from a client:

Session mysession = SessionManager.getManager().getSession("[SESSION-NAME]");

Packaging Applications with JSPs and Servlets

When you build an application to deploy to the Web, package the application components in separate archives based on function. You can then assemble the separate archive files in a single deployment archive file.

The final deployment archive is an EAR file. If your client application includes application XML files, store those files in the \meta-inf\ directory of the EAR. In addition, the EAR contains the following archive files:

Manifest-Version: 1.0
Created-By: 1.3.1 (Sun Microsystems Inc.)
// Add the following line
Class-Path: [Domain-Archive-Name].jar
// Two carriage returns to complete the file
[CR]
[CR]

Deploying the Application to a Client

After you build the WAR and JAR files, build them into an EAR file for deployment. To deploy the EAR to your JSP servlet server, copy the EAR to a well-known directory. You may also need to use server-specific deployment tools. For more information, see the server documentation.

Include the following Java code in your client application to access the OracleAS TopLink application from a client:

Session s = SessionManager.getManager().getSession("[SESSION-NAME]",[classloader]);

In most cases, [classloader] represents the class loader from the current thread context, specified as follows:

    Thread.current().getContextClassLoader()

However, if your J2EE container does not support using this class loader, you can substitute the class loader from the current class, as follows:

    this.getClass().getLoader()

Packaging Applications with Session Beans

When you build an application to deploy to the Web, package the application components in separate archives based on function. You can then assemble the separate archive files in a single deployment archive file.

The final deployment archive is an EAR file. If your client application includes application XML files, store those files in the \meta-inf\ directory of the EAR. In addition, the EAR contains the following archive files.

Deploying the Application to a Client

After you build the WAR and JAR files, build them into an EAR file for deployment. To deploy the EAR to your J2EE server, copy the EAR to a well-known directory. You may also need to use server-specific deployment tools. For more information, see the server documentation.

Include the following Java code in your client application to access the OracleAS TopLink application from a client:

Sessions = SessionManager.getManager().getSession("[SESSION-NAME]",[classloader]);

In most cases, [classloader] represents the class loader from the current thread context, specified as follows:

    Thread.current().getContextClassLoader()

However, if your J2EE container does not support using this class loader, you can substitute the class loader from the current class, as follows:

    this.getClass().getLoader()

An EJB JAR file

The EJB JAR file specifically services the EJB entity beans in the application. It includes:

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

• All mapped non-EJB classes from OracleAS TopLink Mapping Workbench project

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

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

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

• ejb-jar.xml file

• [VENDOR-SPECIFIC]-ejb-jar.xml file

• toplink-ejb-jar.xml file

• project.xml file

  
  

  Note: If you do not use XML files for deployment, you do not have a project.xml file to include in the \meta-inf\ directory. Instead, include the compiled project.class file in the appropriate directory structure in the EJB JAR.

  
  

A WAR File

The WAR file contains the Web application files, including:

• JSPs and Servlets that provide the dynamic content for the client application

• Static HTML content for the client application

• Additional client application resources, such as images

General Deployment

After you build the WAR and JAR files, build them into an EAR file for deployment. To deploy the EAR to your J2EE server, copy the EAR to a well-known directory. You may also need to use server-specific deployment tools. For more information, see the server documentation.

Deploying the Application to BEA WebLogic Server

OracleAS TopLink CMP support includes integration for BEA WebLogic Server. To enable OracleAS TopLink CMP for WebLogic entity beans, use the WebLogic EJB Compiler (ejbc) to compile the EJB JAR, as follows:

• Run ejbc from the command line. Include the EJB JAR file as a command line argument. ejbc creates an EJB JAR that contains the original classes, as well as all required generated classes and files.

When you run ejbc:

• It performs a partial EJB conformance check on the beans and their associated interfaces.

• It builds the internal BEA WebLogic classes that manage security and transactions, as well as the RMI stubs and skeletons that enable client access to the beans.

• OracleAS TopLink builds concrete bean subclasses and EJB finder method implementations.

For more information about running ejbc, see the BEA WebLogic documentation.

Deploying the Application to IBM WebSphere 4.x Server

OracleAS TopLink CMP support includes an integration for IBM WebSphere 4.x Server. Use the following procedure to deploy your application to WebSphere:

1. Use the OracleAS TopLink Deploy Tool for WebSphere to compile the EJB JAR file.

   For more information, see "Deploy Tool for WebSphere Server".

2. Start the WebSphere Administration Server.

3. Start the Administrator Console and deploy the compiled JAR.

   For more information about deploying the JAR, see the IBM WebSphere documentation.

   
   

   Note: When you deploy an application that contains an entity bean, set up a datasource and associate it with the bean. For more information about how to create and associate datasources, see the IBM WebSphere documentation.

   
   

It is not necessary to deploy the EJB JAR in WSAD, because deployment is carried out using the Deploy Tool (see "Deploy Tool for WebSphere Server").

An EJB JAR file

The EJB JAR file specifically services the EJB entity beans in the application. It includes:

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

• All mapped non-EJB classes from OracleAS TopLink Mapping Workbench project

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

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

Store the following XML files as follows:

• The ejb-jar.xml file in the \meta-inf\ directory

• The sessions.xml and the project.xml files in the root directory

  
  

  Note: If you do not use XML files for deployment, you do not have a project.xml file to include in the \meta-inf\ directory. Instead, include the compiled project.class file in the appropriate directory structure in the EJB JAR.

  
  

A WAR File

The WAR file contains the Web application files, including:

• JSPs and Servlets that provide the dynamic content for the client application

• Static HTML content for the client application

• Additional client application resources, such as images

Deploying the Application

After you build the WAR and JAR files, build them into an EAR file for deployment. To deploy the EAR to your J2EE server, copy the EAR to a well-known directory. You may also need to use server-specific deployment tools. For more information, see the server documentation.