Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

EclipseLink/Building

SVN Structure

At the moment, all code can be found in the org.eclipse.persistence/trunk directory on the technology SVN server.

Runtime

The below is a description of the content of the directories. Note: All projects are Eclipse PDE projects and therefore classpath dependencies are defined in the manifest rather than the project metadata.

Plugins

The plugins directory contains all the common dependencies needed by all the projects. You can make use of them by either importing the Eclipse projects for all the depenencies or by copying the bundle jars (all the jars) in this directory in your Eclipse installation's plugin's directory. Note: The org.eclipse.persistence.asm and org.eclipse.persistence.antlr jars are not checked in and must be either be built by running the EclipseLink build or imported as projects.

Foundation

  • org.eclipse.persistence.core - All other EclipseLink components depend on this bundle. You will need to import this project to work on other EclipseLink components. All other components can be imported separately.
  • org.eclipse.persistence.oracle - extensions that require Oracle-specific libraries for compilation. If you do not have the required oracle libraries, you can get the compiled classes since they are checked in. This bundle is only used for advanced Oracle-specific functionality and not required unless you are using that functionality.

JPA

  • org.eclipse.persistence.jpa - EclipseLink's JPA support
  • plugins - The additional dependencies for JPA support
  • org.eclipse.persistence.equinox - fragment for OSGi weaving on Equinox that plugs into org.eclispe.persistence.jpa. Only required for people doing weaving on Equinox
  • org.eclipse.persistence.equinox.weaving - fragment for OSGi weaving on Equinox that plugs into Equinox itself. Only required for people doing weaving on Equinox

MOXY

  • org.eclipse.persistence.moxy - EclipseLink's Object-XML support
  • plugins - The additional dependencies for Object-XML support

SDO

  • org.eclipse.persistence.sdo - EclipseLink's SDO support
  • plugins - The additional dependencies for SDO support

DBWS

  • org.eclipse.persistence.dbws - EclipseLink's Database Webservice support
  • plugins - The additional dependencies for DBWS support


Testing

Note: Before testing in Eclipse using the Testing Browser - you will need to a full root build of EclipseLink in 'trunk>ant' so that the test jars eclipse*model.jar get created and placed on the root of jpa/eclipselink.jpa.test. Please refresh your eclipselink.jpa.test project to pick these up before running the Testing Browser eclipse launch target.

  • foundation/eclipselink.core.test - the core testing for EclipseLink
  • foundation/eclipselink.extension.oracle.test - the testing for EclipseLink's Oracle-specific functionality. Like the extension.oracle directory, this will only build after some licensing issues have been sorted out.
  • jpa/eclipselink.jpa.test - the JPA tests for EclipseLink

Projects and Dependencies

When using the Eclipse IDE - an EE version is required. See the following locations for a install binary.

Eclipse Projects are available for eclipselink.core, eclipselink.core.lib, eclipselink.core.test jpa, jpa.test, sdo, sdo.test, moxy and moxy.test. These projects should allow you to use most of the core EclipseLink functionality.

Until our dependencies have been checked in, you should be able to build use the following dependencies to build.

  1. org.eclipse.persistence.core depends on the following:
    1. moxy/plugins/javax.xml.bind
    2. plugins/javax.activation
    3. plugins/javax.ejb
    4. plugins/javax.jms
    5. plugins/javax.persistence
    6. plugins/javax.resource
    7. plugins/javax.transaction
    8. plugins/javax.xml.rpc
    9. plugins/javax.xml.soap
    10. plugins/javax.xml.stream
    11. plugins/org.eclipse.persistence.antlr
    12. plugins/org.eclipse.persistence.asm
  1. org.eclipse.persistence.jpa depends on the following:
    1. org.eclipse.persistence.core - The Eclipse project defined in this folder
  2. eclipselink.core.test should have all its dependencies already set but provides an ant build that sets up some xml files to run
  3. eclipselink.jpa.test should have all its dependencies already set but provides an ant build to build persistence units for testing
  4. eclipselink.extension.oracle depends on a selection of jars from Oracle products. In order to build this project you will need to obtain all these jars. As a result the class files from this project are checked in so they can be used by people that do not have those jars
    1. Jars:
      1. aqapi.jar - Oracle Advanced Queue
      2. sdoapi.jar - Oracle Spatial API
      3. An oracle JDBC driver
      4. xdb.jar - XDB
      5. xml.jar - Oracle XML support
      6. xmlparserv2.jar - Oracle XML parser
    2. Projects
      1. eclipselink.core depends on the same jars as foundation/extension.oracle and as a result, it has also had class files checked in
  5. eclipselink.extension.oracle.test depends on
    1. eclipselink.extension.oracle
    2. eclipselink.core.test
    3. org.eclipse.persistence.jpa
  6. org.eclipse.persistence.moxy depends on the following:
    1. org.eclipse.persistence.core
  7. eclipselink.moxy.test depends on the following:
    1. org.eclipse.persistence.moxy
    2. org.eclipse.persistence.core
    3. Eclipse Library JUnit 3 - this is already configured, but there have been issues with Eclipse version 3.2 where the library needs to be reselected in order for JUnit to be picked up properly.
  8. eclipselink.sdo depends on the following:
    1. org.eclipse.persistence.core
  9. eclipselink.sdo.test depends on the following:
    1. org.eclipse.persistence.sdo
    2. org.eclipse.persistence.core
    3. TOOLS_LIB variable has been mapped to your JDK tools.jar for a runtime dependency
    4. Eclipse Library JUnit 3 - this is already configured, but there have been issues with Eclipse version 3.2 where the library needs to be reselected in order for JUnit to be picked up properly.

Migrating Eclipse Projects to PDE as of 20080430

There is a new PDE structure being finalized that will require a rebuild of all existing EclipseLink projects in Eclipse. See [EclipseLink/Development/EclipseLinkPDEConversionPlan http://wiki.eclipse.org/EclipseLink/Development/EclipseLinkPDEConversionPlan]

These notes will be incorporated into the main doc and formalized when this process is complete.

  • Migrating Eclipse Projects to PDE #2 as of 20080508 - currently editing
  • This section is for developers that did the initial PDE refresh after 20080430.
    • Remove existing lib projects and reimport as plugin projects (delete project but not workspace contents)
      • All javax.*, org.apache.*, org.*antlr, org.*.asm
    • Perform actions below

Note: If you are getting compilation errors that are due to a missing plugin like javax.resource or javax.jms - and you have these projects in your workspace. The fix seems to be to delete these projects (not the filesystem) and reimport the project with the problem as well as the plugin that it is complaining it cannot find - together in a single import (from the <root>).

  1. Prerequisites
    1. Eclipse 3.3+ EE version required - you will need the EE version of eclipse
      1. Internal: eclipse-jee-europa-winter-win32, eclipse-jee-europa-fall2-win32 or eclipse-jee-ganymede-M6-win32
    2. Remove any existing eclipselink.* projects (delete project but not workspace contents)
    3. Note: eclipselink.*.test projects are not migrated yet, these can be retained
    4. Keep existing classpath variables
  2. Update SVN at the <trunk> root
  3. Importing Projects
    1. Import | General | Existing projects into Workspace
      1. root directory = <trunk>/plugins
      2. Leave "Copy projects into workspace" unselected
      3. select all of javax.* and org.*
    2. Import jpa/plugins/javax.persistence
    3. Import foundation projects in the same way
    4. Import jpa projects in the same way
    5. Import moxy/plugins projects so jpa test project compiles
    6. Import sdo/plugins
    7. Refresh/Rebuild
      1. If automatic build is not checked - check it and clean all projects
    8. core dependency on jpa lib project
      1. see javax.persistence;bundle-version="1.99.0";visibility:=reexport in the core project
      2. If you get a compile error on javax.persistence it is because we are referencing the 1.99 version instead of 1.0 in the manifest of org.eclipse.persistence.core - make sure the jpa project javax.persistence.1.99 is loaded in your workspace.
  4. Building
    1. Run ant at the <trunk> root so that all the test project jars are updated and built
    2. BUILD SUCCESSFUL Total time: 8 minutes 4 seconds
  5. Running
    1. Test the build by running test.jpa
    2. <trunk>/ant test-jpa
    3. Note: if db.platform is not set in your <user-home>/test.properties then you may get a "ClassNotFoundException: ${db.platform}" - set this variable as follows (using your own platform)
      1. db.platform=org.eclipse.persistence.platform.database.oracle.Oracle11Platform
      2. Normally we do not set a dependecy on the platform though - this will be fixed shortly in our script.
      3. [junit] Tests run: 911, Failures: 0, Errors: 1, Time elapsed: 583.35 sec Total time: 10 minutes 4 Seconds
  6. See the following (I get 1 error locally that can be ignored)
    1. C:\view_w34\jpa\eclipselink.jpa.test\reports\junit-noframes.html
  7. Refresh eclipse workspace to optionally run the testing browser targets
  8. Pending:
  9. Launch Targets

Port TODO List

List of task, items, issues, refactorig left to due from the initial port.

  • Get all tests passing. - JPA JUnit tests and legacy LRG model currently pass
  • Move left-over internal classes to internal packages.
  • Internationalization.
  • Server tests.
  • Sun Corba and RMI-IIOP - are these elements still required in EclipseLink. If so, make sure tests work. Else, remove.
  • Make all server platforms work. i.e. address the fact that they all need to be reflective to compile

How To

Retrieved from "https://wiki.eclipse.org/index.php?title=EclipseLink/Building&oldid=112188"

Back to the top