Difference between revisions of "EclipseLink/Maven"

From Eclipsepedia

Jump to: navigation, search
(Identifiers)
(48 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
__TOC__  
 
__TOC__  
 
</div> </div>
 
</div> </div>
The EclipseLink project currently produces a maven repository for its releases
+
As of the 2.5.0 release, EclipseLink is available on [http://search.maven.org/#search|ga|1|org.eclipse.persistence Maven Central]. In addition, the EclipseLink project hosts its nightly, milestone, and release builds on [https://oss.sonatype.org/index.html#nexus-search;gav~org.eclipse.persistence Sonatype]
 
+
<div align="center">'''http://download.eclipse.org/rt/eclipselink/maven.repo'''</div>
+
  
 
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.  
 
 
== Configuring your pom.xml  ==
 
== Configuring your 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]].  
+
To help users diagnose Maven issues, we have created a basic POM that simply establishes EclipseLink dependencies (currenly using the 2.5.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]].  
 +
 
 +
=== Repositories ===
 +
 
 +
Prior to the 2.5.0 release, you will need to specify the EclipseLink repository (in a <repositories> block) wthin your pom.xml. In addition, SNAPSHOT and Milestone builds would need a repository entry.
 +
 
 +
==== oss.sonatype.org: 2.4.2 and Later ====
  
=== <repository> ===
+
The EclipseLink project has switched to publishing its builds through oss.sonatype org during the 2.4.2/2.5.0 development. The staging repo will provide access to SNAPSHOT and named milestone and release candidate builds. To access these use:
  
Within your pom.xml you will need to specify the EclipseLink repository using:
 
 
<source lang="xml">
 
<source lang="xml">
 
<repository>
 
<repository>
   <id>EclipseLink Repo</id>
+
<id>oss.sonatype.org</id>
 +
<name>OSS Sonatype Staging</name>
 +
<url>https://oss.sonatype.org/content/groups/staging</url>
 +
</repository>
 +
</source>
 +
 
 +
When the 2.4.2 and above releases are finalized they will be published to [http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.eclipse.persistence%22 Maven Central] where no additional  repository configuration will be required.
 +
 
 +
==== Custom Repo: 2.4 and Earlier ====
 +
 
 +
Builds prior to EclipseLink 2.4.2 are available at:
 +
 
 +
<source lang="xml">
 +
<repository>
 +
   <id>EclipseLink</id>
 
   <url>http://download.eclipse.org/rt/eclipselink/maven.repo</url>
 
   <url>http://download.eclipse.org/rt/eclipselink/maven.repo</url>
 
</repository>
 
</repository>
Line 23: Line 39:
  
 
== <dependencies> ==
 
== <dependencies> ==
 +
 +
The artifacts can then be added to you pom as follows.
 +
 +
<source lang="xml">
 +
<dependency>
 +
  <groupId>org.eclipse.persistence</groupId>
 +
  <artifactId>{artifact}</artifactId>
 +
  <version>{version}</version>
 +
  <scope>compile</scope>
 +
</dependency>
 +
</source>
 +
 +
The following are the primary artifacts though artifacts do vary by release. 2.4.2 and newer artifacts can be browsed from the Maven Central or Sonatype OSS links above. While predominantly the same, artifacts in older releases and their descriptions are listed below.
 +
  
 
{|{{BMTableStyle}}
 
{|{{BMTableStyle}}
Line 30: Line 60:
 
|-
 
|-
 
| eclipselink  
 
| eclipselink  
| The non-OSGI EclipseLink jar (includes the functionality below)
+
| The full eclipselink.jar (non-OSGi) including the full capabilities of all of the following artifact bundles and fragments.
|-
+
| 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  
 
| org.eclipse.persistence.jpa  
| EclipseLink JPA OSGI bundle
+
| EclipseLink JPA (OSGi bundle): Use this artifact if you only want EclipseLink's JPA capabilities for relational databases. If accessing an Oracle database then you will also want the '''org.eclipse.persistence.oracle''' artifact.
|-
+
| org.eclipse.persistence.jpa.modelgen
+
| EclipseLink Modelgen pre-processor (non-OSGI)
+
 
|-
 
|-
 
| org.eclipse.persistence.moxy  
 
| org.eclipse.persistence.moxy  
| EclipseLink MOXY OSGI bundle
+
| EclipseLink MOXy (OSGi bundle): Use this artifact if you only want EclipseLink's Object-XML binding and JAXB implementation. This also includes JSON binding support.
 
|-
 
|-
 
| org.eclipse.persistence.nosql  
 
| org.eclipse.persistence.nosql  
| OSGI fragment of Core bundle for NoSQL support (including MongoDB)
+
| EclipseLink NoSQL (OSGi fragment): Provides NoSQL support extending org.eclipse.persistence.core.
 
|-
 
|-
 
| org.eclipse.persistence.oracle  
 
| org.eclipse.persistence.oracle  
| OSGI fragment of Core bundle with Oracle-DB specific EclipseLink extensions
+
| EclipseLink JPA for Oracle (OSGi fragment): Extended Oracle database capabilities extending the core bundle with specific Oracle JDBC dependencies.
 
|-
 
|-
 
| org.eclipse.persistence.oracle.nosql  
 
| org.eclipse.persistence.oracle.nosql  
| OSGI fragment of Core bundle for Oracle specific NoSQL support
+
| EclipseLink NoSQL for Oracle (OSGI fragment): Oracle specific NoSQL support extending core bundle.
 +
|-
 +
| org.eclipse.persistence.dbws
 +
| EclipseLink DBWS OSGI bundle
 +
|-
 +
| org.eclipse.persistence.jpa.modelgen
 +
| EclipseLink Modelgen pre-processor (non-OSGI) (pre-2.5.0)
 
|-
 
|-
 
| org.eclipse.persistence.osgi  
 
| org.eclipse.persistence.osgi  
| <br>
+
| (pre-2.5.0 only)
 
|-
 
|-
 
| org.eclipse.persistence.sdo  
 
| org.eclipse.persistence.sdo  
 
| EclipseLink SDO OSGI bundle
 
| EclipseLink SDO OSGI bundle
|-
 
| javax.persistence
 
| EclipseLink version of the javax.persistence classes (OSGi enabled)
 
 
|-
 
|-
 
| org.eclipse.persistence.equinox  
 
| org.eclipse.persistence.equinox  
| EclipseLink JPA Equinox OSGi Fragment
+
| EclipseLink JPA Equinox OSGi Fragment (pre-2.5.0 only)
 
|-
 
|-
 
| org.eclipse.persistence.jpa.modelgen.processor  
 
| org.eclipse.persistence.jpa.modelgen.processor  
| EclipseLink JPA Modelgen Processor (non-OSGi) (Meta-data only)
+
| EclipseLink JPA Modelgen Processor (non-OSGi) (pre-2.5.0: Meta-data only. 2.5.0+: single jar contains both classes and meta-data)
 
|-
 
|-
| org.eclipse.persistence.tools.oracleddl
+
| org.eclipse.persistence.oracleddlparser
 
| Oracle DB model - OSGi bundle
 
| Oracle DB model - OSGi bundle
 
|-
 
|-
 
| org.eclipse.persistence.weaving  
 
| org.eclipse.persistence.weaving  
| EclipseLink JPA - "Weaving for Equinox" OSGi Fragment
+
| EclipseLink JPA - "Weaving for Equinox" OSGi Fragment (pre-2.5.0 only)
 
|}
 
|}
  
== What bundles should I get ==
+
== Versions ==
  
The following lists what you should get based on your needs
+
For the available EclipseLink release versions please refer to [http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.eclipse.persistence%22 Maven Central] or [https://oss.sonatype.org/index.html#nexus-search;quick~org.eclipse.persistence Sonatype OSS]. For access to nightly or milestone builds please see [https://oss.sonatype.org/index.html#nexus-search;quick~org.eclipse.persistence Sonatype OSS].
  
==== Full functionality - non OSGI ====
+
== Sample pom.xml (Staging) ==
  
This is the recommended way of getting EclipseLink unless you are using OSGi, or you want to explicitly exclude certain parts of EclipseLink  
+
The following pom.xml illustrates access the EclipseLink 2.5.0-RC1 from our staging repository.
  
*eclipselink
+
<source lang="xml">
*javax.persistence (optional - only needed if you are using JPA outside of a Java EE container)
+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 
+
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
==== JPA ====
+
<modelVersion>4.0.0</modelVersion>
 
+
<groupId>eclipselink.example.jpa</groupId>
*JPA
+
<artifactId>simple</artifactId>
*Core (starting in 2.0.0 should be retrieved by maven dependency mechanism)
+
<version>2.5.0-SNAPSHOT</version>
*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)
+
<repositories>
*javax.persistence
+
<repository>
*Oracle (optional - only needed to access Oracle DB specific functionality)
+
<id>oss.sonatype.org</id>
 
+
<name>OSS Sonatype Staging</name>
==== MOXy ====
+
<url>https://oss.sonatype.org/content/groups/staging</url>
 
+
</repository>
*MOXy
+
</repositories>
*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)
+
<dependencies>
*Asm (starting in 2.0.0 should be retrieved by maven dependency mechanism)
+
<dependency>
 
+
<groupId>org.eclipse.persistence</groupId>
===== SDO =====
+
<artifactId>eclipselink</artifactId>
 
+
<version>2.5.0-RC1</version>
*SDO
+
<exclusions>
*MOXy
+
<exclusion>
*Core (starting in 2.0.0 should be retrieved by maven dependency mechanism)
+
<groupId>org.eclipse.persistence</groupId>
*Antlr (starting in 2.0.0 should be retrieved by maven dependency mechanism)
+
<artifactId>commonj.sdo</artifactId>
*Asm (starting in 2.0.0 should be retrieved by maven dependency mechanism)
+
</exclusion>
 
+
</exclusions>
== Versioning  ==
+
</dependency>
 
+
</dependencies>
=== Available Released Versions ===
+
</project>
 
+
</source>
*2.4.0  
+
*2.3.3
+
*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.5.0
+
*2.4.1
+
*2.3.4
+
 
+
''Under development releases have the following additional naming conventions''
+
 
+
*&lt;releaseNumber&gt;-SNAPSHOT (The most recent nightly build e.g. 2.1.0-SNAPSHOT)
+
*&lt;releaseNumber&gt;-Mx (For milestones, replace x with the milestone number e.g. 2.0.0-M1)
+
*&lt;releaseNumber&gt;-RCx (For release candidates, replace x with the release candidate number e.g. 2.0.0-RC1)
+
 
+
== Sample pom.xml entries ==
+
<pre>&lt;dependencies&gt;
+
  &lt;dependency&gt;
+
    &lt;groupId&gt;org.eclipse.persistence&lt;/groupId&gt;
+
    &lt;artifactId&gt;eclipselink&lt;/artifactId&gt;
+
    &lt;version&gt;2.0.0&lt;/version&gt;
+
    &lt;scope&gt;compile&lt;/scope&gt;
+
      ...
+
  &lt;/dependency&gt;
+
&lt;/dependencies&gt;
+
      ...
+
&lt;repositories&gt;
+
  &lt;repository&gt;
+
    &lt;id&gt;EclipseLink Repo&lt;/id&gt;
+
    &lt;!-- note that ampersands in this URL are escaped because this is in an xml file -
+
            un-escape them to use in browser
+
    --&gt;
+
    &lt;url&gt;http://www.eclipse.org/downloads/download.php?r=1&amp;amp;nf=1&amp;amp;file=/rt/eclipselink/maven.repo&lt;/url&gt;
+
    &lt;!-- use this for javax.persistence
+
    &lt;snapshots&gt;
+
        &lt;enabled&gt;true&lt;/enabled&gt;
+
    &lt;/snapshots&gt; --&gt;
+
  &lt;/repository&gt;   
+
      ...
+
&lt;/repositories&gt;
+
 
+
</pre>  
+
[[Category:EclipseLink|Maven]]
+

Revision as of 13:59, 28 May 2013

As of the 2.5.0 release, EclipseLink is available on Maven Central. In addition, the EclipseLink project hosts its nightly, milestone, and release builds on Sonatype

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

Configuring your pom.xml

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

Repositories

Prior to the 2.5.0 release, you will need to specify the EclipseLink repository (in a <repositories> block) wthin your pom.xml. In addition, SNAPSHOT and Milestone builds would need a repository entry.

oss.sonatype.org: 2.4.2 and Later

The EclipseLink project has switched to publishing its builds through oss.sonatype org during the 2.4.2/2.5.0 development. The staging repo will provide access to SNAPSHOT and named milestone and release candidate builds. To access these use:

<repository>
	<id>oss.sonatype.org</id>
	<name>OSS Sonatype Staging</name>
	<url>https://oss.sonatype.org/content/groups/staging</url>
</repository>

When the 2.4.2 and above releases are finalized they will be published to Maven Central where no additional repository configuration will be required.

Custom Repo: 2.4 and Earlier

Builds prior to EclipseLink 2.4.2 are available at:

<repository>
   <id>EclipseLink</id>
   <url>http://download.eclipse.org/rt/eclipselink/maven.repo</url>
</repository>

<dependencies>

The artifacts can then be added to you pom as follows.

<dependency>
   <groupId>org.eclipse.persistence</groupId>
   <artifactId>{artifact}</artifactId>
   <version>{version}</version>
   <scope>compile</scope>
</dependency>

The following are the primary artifacts though artifacts do vary by release. 2.4.2 and newer artifacts can be browsed from the Maven Central or Sonatype OSS links above. While predominantly the same, artifacts in older releases and their descriptions are listed below.


Artifact Id Description
eclipselink The full eclipselink.jar (non-OSGi) including the full capabilities of all of the following artifact bundles and fragments.
org.eclipse.persistence.jpa EclipseLink JPA (OSGi bundle): Use this artifact if you only want EclipseLink's JPA capabilities for relational databases. If accessing an Oracle database then you will also want the org.eclipse.persistence.oracle artifact.
org.eclipse.persistence.moxy EclipseLink MOXy (OSGi bundle): Use this artifact if you only want EclipseLink's Object-XML binding and JAXB implementation. This also includes JSON binding support.
org.eclipse.persistence.nosql EclipseLink NoSQL (OSGi fragment): Provides NoSQL support extending org.eclipse.persistence.core.
org.eclipse.persistence.oracle EclipseLink JPA for Oracle (OSGi fragment): Extended Oracle database capabilities extending the core bundle with specific Oracle JDBC dependencies.
org.eclipse.persistence.oracle.nosql EclipseLink NoSQL for Oracle (OSGI fragment): Oracle specific NoSQL support extending core bundle.
org.eclipse.persistence.dbws EclipseLink DBWS OSGI bundle
org.eclipse.persistence.jpa.modelgen EclipseLink Modelgen pre-processor (non-OSGI) (pre-2.5.0)
org.eclipse.persistence.osgi (pre-2.5.0 only)
org.eclipse.persistence.sdo EclipseLink SDO OSGI bundle
org.eclipse.persistence.equinox EclipseLink JPA Equinox OSGi Fragment (pre-2.5.0 only)
org.eclipse.persistence.jpa.modelgen.processor EclipseLink JPA Modelgen Processor (non-OSGi) (pre-2.5.0: Meta-data only. 2.5.0+: single jar contains both classes and meta-data)
org.eclipse.persistence.oracleddlparser Oracle DB model - OSGi bundle
org.eclipse.persistence.weaving EclipseLink JPA - "Weaving for Equinox" OSGi Fragment (pre-2.5.0 only)

Versions

For the available EclipseLink release versions please refer to Maven Central or Sonatype OSS. For access to nightly or milestone builds please see Sonatype OSS.

Sample pom.xml (Staging)

The following pom.xml illustrates access the EclipseLink 2.5.0-RC1 from our staging repository.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>eclipselink.example.jpa</groupId>
	<artifactId>simple</artifactId>
	<version>2.5.0-SNAPSHOT</version>
 
	<repositories>
		<repository>
			<id>oss.sonatype.org</id>
			<name>OSS Sonatype Staging</name>
			<url>https://oss.sonatype.org/content/groups/staging</url>
		</repository>
	</repositories>
 
	<dependencies>
		<dependency>
			<groupId>org.eclipse.persistence</groupId>
			<artifactId>eclipselink</artifactId>
			<version>2.5.0-RC1</version>
			<exclusions>
				<exclusion>
					<groupId>org.eclipse.persistence</groupId>
					<artifactId>commonj.sdo</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
	</dependencies>
</project>