2 Installing Oracle TopLink

This chapter tells how to install Oracle TopLink.

The instructions below tell how to install TopLink using the quick installer jar file available from the download site. A zip file is also available. If you choose to download and install using the zip file, instead of the quick installer, follow the instructions in the readme file included with the zip file.

This chapter contains the following sections:

2.1 Introduction

TopLink is integrated with several Oracle products, including Oracle WebLogic Server, Glassfish Server, Oracle JDeveloper, and Oracle Coherence. You can also download the standalone distribution of TopLink to integrate with other application servers and use as the persistence provider in your applications. This chapter describes how to install the standalone distribution.

2.2 Task 1: Prerequisites

The complete product requirements list and the latest certification information for the current version of TopLink are available at:


TopLink requires a Java Virtual Machine (JVM) compatible with JDK 1.6 (or higher). TopLink also requires internet access to use URL-based schemas and hosted documentation.

2.3 Task 2: Download TopLink

To download a TopLink distribution that is not part of another Oracle download,

  1. Go to the TopLink download page at http://www.oracle.com/technetwork/middleware/toplink/downloads/index.html.

  2. Select Accept License Agreement to accept the license agreement.

  3. Find the version of TopLink you want, and download it to your computer.

    Starting with TopLink 12c Release 1 (12.1.2), TopLink is available as a Java quick installer named toplink_quick_121200.jar. These instructions explain how to install using that quick installer.

    You can download it to any directory.

2.4 Task 3: Run the Installer

You can install TopLink into any directory. To run the quick installer,

  1. Create a directory where you want to install TopLink, for example C:\toplink. The directory must be completely empty.

  2. Open a command window in the new directory.

  3. Run the command to unarchive the jar file, as described below.

    • If a valid JRE or JDK is in the path, run the following:

      java -jar path\toplink_quick_121200.jar

      where path\ is the path to the directory where you downloaded the JAR file.

      For example, if you created a new, empty C:\toplink directory and downloaded the JAR file to c:\downloads, run the following:

      C:\toplink>java -jar c:\downloads\toplink_quick_121200.jar

    • If a valid JRE or JDK is not in the path, or if you want to use a specific one, run the following:

      JAVA_HOME\java -jar path\toplink_quick_121200.jar

      where JAVA_HOME is the directory containing the Java runtime. For example, if the runtime is located in C:\java\jdk1.6.0_33\bin\, run the following:

      C:\toplink>c:\java\jdk1.6.0_33\bin\java -jar c:\downloads\toplink_quick_121200.jar

    In the directory structure created from the installation, the TopLink libraries, schemas, utilities, and documentation are in TOPLINK_HOME\oracle_common\modules\oracle.toplink_version_no and in TOPLINK_HOME\toplink.

2.5 Additional Resources

See the following for more information about the technologies and tools used to implement the solutions in this chapter: