Skip to main content
Jump to: navigation, search

EclipseLink/Installing and Configuring EclipseLink

Installing and Configuring EclipseLink

This document include the installation and configuration instructions for:

Installing EclipseLink (Java SE & EE)

Use the following procedures to install EclipseLink for Java SE and EE development. Installation instructions for OSGi development are provided in another section. Before you proceed with the install, it is recommended that you must back up all existing project data.

Setting System Environment Variables

You must set the following system environment variables before installing EclipseLink:

  1. JAVA_HOME - Set JAVA_HOME to where you installed your Java SDK home directory. For example:
    • Windows example: JAVA_HOME = C:\JDK
    • UNIX example: JAVA_HOME = ...:/usr/java/jdk
  2. PATH - Set PATH to include JDK/bin directory. For example:
    • Windows example: PATH = C:\JDK\bin
    • UNIX example: PATH = ...:/usr/java/jdk/bin

Note: Ensure that a Java Virtual Machine (JVM) compatible with JDK 1.5 (or higher) is also installed on your machine


  1. Download the EclipseLink install archive zip file from the EclipseLink downloads page here. The zip file also includes EclipseLink Workbench, a graphical interface that allows you to configure descriptors and map your projects. It is a powerful tool if you are migrating from Oracle TopLink with classic or native ORM/OXM/EIS usage.
  2. Unpack the downloaded zip file in the desired installation directory. When you unzip the file, you’ll find an eclipselink subdirectory, with multiple subdirectories. This directory is your new ECLIPSELINK_HOME directory. For example:
    • Windows example: ECLIPSELINK_HOME = <INSTALL_DIR>/eclipselink
    • UNIX example: ECLIPSELINK_HOME = ...:/usr/el/<INSTALL_DIR>/eclipselink
  3. When unzipped, additional steps are required to run EclipseLink Workbench. For more information, see Configuring the Workbench Environment.

Installing EclipseLink NoSQL (2.4 and Later)

Support for NoSQL databases is supported in EclipseLink by downloading and installing a seperate zip file found on the EclipseLink downloads page. Please use this bundle in conjunction with EclipseLink.jar, or the EclipseLink jpa bundles.

Installing EclipseLink OSGi

EclipseLink OSGi bundles are made available both as a zip and via an Eclipse P2 update site.

Installing with P2

You can install EclipseLink binary and source bundles into your target platform or Eclipse IDE install using P2. See Installing EclipseLink OSGi in PDE for a walk through of the procedure.

Download Zip of Bundles

As an alternative to P2 you can download the EclipseLink bundles and install them in your development environment manually.

  • Download the EclipseLink OSGi bundles zip from the EclipseLink downloads page.
  • Unpack the downloaded zip file in the desired installation directory.
    • You can add the installation directory to a target platform, or
    • If developing in Eclipse with PDE you can place the downloaded bundles into your <ECLIPSE_HOME>\dropins folder (see better approach for PDE above).

EclipseLink OSGi Bundles

The following tables list the bundles included with EclipseLink OSGi:

NOTE: The specific names of the bundles will be suffixed with a release and build number. Those numbers will vary depending upon what release you download.

EclipseLink Core Functionality

Bundle Description
org.eclipse.persistence.core This bundle provides EclipseLink's core library. All other EclipseLink bundles (JPA, MOXy, SDO) are dependent on this bundle.
org.eclipse.persistence.asm This bundle provides EclipseLink's version of the ASM library used for byte-code weaving in the core, JPA, SDO and MOXy bundles. It is required when using any of those bundles.
org.eclipse.persistence.antlr This bundle provides EclipseLink's version of the ANTLR library used for JPQL parsing in the JPA and core bundles. It is required when using JPA. This bundle provides support for extended Oracle database features (Timestamp extensions, Spatial types, Oracle XML Parser, XDB, Advanced Queueing, XDK, Oracle LOBs).


These bundles contain classes from Java specification. They have been converted to bundle format so they can be used in OSGi. Depending on the OSGi environment whether the running OSGi Environment EclipseLink contains those versions of the libraries listed, these bundles may or may not be necessary.

EclipseLink JPA

Bundle Description
javax.persistence This bundle contains versions of the javax.persistence and javax.persistence.spi classes that have been updated to be OSGi friendly. OSGi users must use this bundle for performing OSGi-based JPA.
org.eclipse.persistence.jpa This bundle supports JPA functionality along with Extended JPA support using EclipseLink's annotations, PU properties, and query hints. The bundle also supports partial and complete EclipseLink-ORM.XML extensions of JPA.
org.eclipse.persistence.jpa.osgi This bundle provides support for using JPA in OSGi


These bundles implement byte code weaving support when running on Equinox.

EclipseLink Moxy

Bundle Description
org.eclipse.persistence.moxy This bundle supports JAXB 2.0 using annotations and XML mapping file.
javax.xml.bind This bundle contains the specification classes and interfaces augmented with support for discovering JAXB provider services.

EclipseLink SDO

Bundle Description
org.eclipse.persistence.sdo This bundle supports Eclipse persistence SDO 2.1 classes.
commonj.sdo This bundle provides common SDO 2.1 classes.

Back to the top