Difference between revisions of "EclipseLink/Maven"

From Eclipsepedia

Jump to: navigation, search
(Basic Example POM)
Line 10: Line 10:
 
== Basic Example POM ==
 
== Basic Example POM ==
  
To help users diagnose Maven issues, we have created a basic POM that simply establishes EclipseLink dependencies (currenly using the 2.4.0 release). Executing it will verify your connection to the repository. Alternate Repository URLs are discussed. The POM can be found [[here|http://www.eclipse.org/downloads/download.php?file=/rt/eclipselink/pom.xml]].
+
To help users diagnose Maven issues, we have created a basic POM that simply establishes EclipseLink dependencies (currenly using the 2.4.0 release). Executing it will verify your connection to the repository. Alternate Repository URLs are discussed. The POM can be found [[http://www.eclipse.org/downloads/download.php?file=/rt/eclipselink/pom.xml|here]].
  
If you have any questions about using it, or experience problems, please let us know on our users mailing list or forum.  
+
If you have any questions about using it, or experience problems, please let us know on our users mailing list or forum.
  
 
== Proxying using Repository Managers (Nexus et al.) ==
 
== Proxying using Repository Managers (Nexus et al.) ==

Revision as of 11:30, 27 June 2012

Contents

Location

The use of the Eclipse mirrors for Maven repositories has been reported to cause varying issues from artifacts being reported as unavailable to local maven repository corruption. Therefore, instead of using the mirrored download URL:

it is recommended that you use the unmirrored URL to directly access the EclipseLink Maven repository on the Eclipse download site instead:

Note: because of the way these repositories are maintained at Eclipse, you will not be able to see into them by clicking on these links. If you have issues actually running a maven build, please report those issue via either the users mailing list or the forum. (If you are using Nexus, please see below before doing that)

Basic Example POM

To help users diagnose Maven issues, we have created a basic POM that simply establishes EclipseLink dependencies (currenly using the 2.4.0 release). Executing it will verify your connection to the repository. Alternate Repository URLs are discussed. The POM can be found [[1]].

If you have any questions about using it, or experience problems, please let us know on our users mailing list or forum.

Proxying using Repository Managers (Nexus et al.)

We appreciate your attempt to proxy the EclipseLink repository using a repository manager like Nexus and others. It reduces load from our servers and speeds up your local builds by reducing traffic over the web. There is work in progress to publish our releases of EclipseLink on the Eclipse Foundation's Nexus instance at http://maven.eclipse.org/nexus, but this is not finally done yet. Currently we only publish to a P2 instance directly, which is not trivial to proxy using a Maven repository manager due to technical differences, but it is possible with some helpful information:

Using Nexus Professional

Nexus Professional natively can proxy P2 repositories. Just provide the address "http://download.eclipse.org/rt/eclipselink/maven.repo/" and set the proxy type to P4. See http://www.sonatype.com/books/nexus-book/reference/p2-sect-intro.html for more details.

Using Nexus Open Source

Since Nexus Open Source cannot natively proxy P2 repositories, you have to take a bit more care:

You will be able to download artifacts using these seetings (which is what you primarily want), but note that you will neither be able to search nor browse artifacts that have not already been downloaded into the Nexus cache. The reason is that without native P2 support, Nexus read an index or list of artifacts found in the remote P2 repository. As this is only a secondary use of a repository manager, we hope you are not too disappointed. Remember, this will work as soon as we moved over to Eclipse's Nexus instance.

See http://www.sonatype.com/books/nexus-book/reference/config-sect-new-repo.html#id3046241 for more detail.

Identifiers

Group Id: org.eclipse.persistence

Artifact Id Description
javax.persistence EclipseLink version of the javax.persistence classes (OSGi enabled)
org.eclipse.persistence.equinox EclipseLink JPA - Equinox OSGi Fragment
org.eclipse.persistence.jpa.modelgen.processor EclipseLink JPA Modelgen Processor (non-OSGi) (Meta-data only)
org.eclipse.persistence.tools.oracleddl Oracle DB model - OSGi bundle
org.eclipse.persistence.weaving EclipseLink JPA - "Weaving for Equinox" OSGi Fragment
eclipselink The non-OSGI EclipseLink jar (includes the functionality below)
org.eclipse.persistence.antlr EclipseLink ANTLR OSGI bundle
org.eclipse.persistence.asm EclipseLink ASM OSGI bundle
org.eclipse.persistence.core EclipseLink Core OSGI bundle
org.eclipse.persistence.dbws EclipseLink DBWS OSGI bundle
org.eclipse.persistence.jpa EclipseLink JPA OSGI bundle
org.eclipse.persistence.jpa.modelgen EclipseLink Modelgen pre-processor (non-OSGI)
org.eclipse.persistence.moxy EclipseLink MOXY OSGI bundle
org.eclipse.persistence.oracle OSGI fragment bundle with Oracle-DB specific EclipseLink extensions
org.eclipse.persistence.osgi
org.eclipse.persistence.sdo EclipseLink SDO OSGI bundle

Runtime Dependencies (from Orbit)

Group Id Artifact Id Description
commonj.sdo commonj.sdo OSGI-enabled SDO API bundle
javax.activation javax.activation OSGI-enabled javax.activation API bundle
javax.mail javax.mail OSGI-enabled javax.mail bundle
javax.servlet javax.servlet OSGI-enabled javax.servlet bundle
javax.xml.bind javax.xml.bind OSGI-enabled javax.xml.bind bundle
javax.xml.stream javax.xml.stream OSGI-enabled javax.xml.stream bundle


What bundles should I get

The following lists what you should get based on your needs

Full functionality - non OSGI

This is the recommended way of getting EclipseLink unless you are using OSGi, or you want to explicitly exclude certain parts of EclipseLink

  • eclipselink
  • javax.persistence (optional - only needed if you are using JPA outside of a Java EE container)

JPA Only

  • JPA
  • Core (starting in 2.0.0 should be retrieved by maven dependency mechanism)
  • Antlr (starting in 2.0.0 should be retrieved by maven dependency mechanism)
  • Asm (starting in 2.0.0 should be retrieved by maven dependency mechanism)
  • javax.persistence
  • Oracle (optional - only needed to access Oracle DB specific functionality)

MOXy Only

  • MOXy
  • Core (starting in 2.0.0 should be retrieved by maven dependency mechanism)
  • Antlr (starting in 2.0.0 should be retrieved by maven dependency mechanism)
  • Asm (starting in 2.0.0 should be retrieved by maven dependency mechanism)

SDO Only

  • SDO
  • MOXy
  • Core (starting in 2.0.0 should be retrieved by maven dependency mechanism)
  • Antlr (starting in 2.0.0 should be retrieved by maven dependency mechanism)
  • Asm (starting in 2.0.0 should be retrieved by maven dependency mechanism)

Core Only

  • Core (starting in 2.0.0 should be retrieved by maven dependency mechanism)
  • Antlr (starting in 2.0.0 should be retrieved by maven dependency mechanism)
  • Asm (starting in 2.0.0 should be retrieved by maven dependency mechanism)
  • Oracle (optional - only needed to access Oracle DB specific functionality)

Versioning

Available Released Versions

  • 2.3.2
  • 2.3.1
  • 2.3.0
  • 2.2.1
  • 2.2.0
  • 2.1.3
  • 2.1.2
  • 2.1.1
  • 2.1.0
  • 2.0.2
  • 2.0.1
  • 2.0.0
    • JPA 2.0 Implementation release
  • 1.2.0
  • 1.1.4
    • final 1.1.x patchset
  • 1.1.3
  • 1.1.2
    • Eclipse Galileo Release
  • 1.1.1
  • 1.1.0
  • 1.0.2
  • 1.0.1
  • 1.0

NOTE: javax.persistence (JPA 2.0) has been released as version 2.0.0, 2.0.1, 2.0.2, and 2.0.3

Releases Under development

  • 2.4.0
  • 2.3.3
  • 2.2.2
  • 2.1.4
  • 2.0.3
  • 1.2.1

Under development releases have the following additional naming conventions

  • <releaseNumber>-SNAPSHOT (The most recent nightly build e.g. 2.1.0-SNAPSHOT)
  • <releaseNumber>-Mx (For milestones, replace x with the milestone number e.g. 2.0.0-M1)
  • <releaseNumber>-RCx (For release candidates, replace x with the release candidate number e.g. 2.0.0-RC1)

Sample pom.xml entries


<dependencies>
  <dependency>
    <groupId>org.eclipse.persistence</groupId>
    <artifactId>eclipselink</artifactId>
    <version>2.0.0</version>
    <scope>compile</scope>
       ...
  </dependency>
</dependencies>
      ...
<repositories>
  <repository>
     <id>EclipseLink Repo</id>
     <!-- note that ampersands in this URL are escaped because this is in an xml file -
            un-escape them to use in browser 
     -->
     <url>http://www.eclipse.org/downloads/download.php?r=1&amp;nf=1&amp;file=/rt/eclipselink/maven.repo</url>
     <!-- use this for javax.persistence
     <snapshots>
        <enabled>true</enabled>
     </snapshots> -->
  </repository>    
      ...
</repositories>