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

Difference between revisions of "EclipseLink/Maven"

(double-escape ampersand, so it displays correctly for a copy'n'paste)
(128 intermediate revisions by 13 users not shown)
Line 1: Line 1:
== Location ==
+
<div style="float:right;width:300px"><div align="center" style="background:#ffffff;width:275px">
 +
__TOC__
 +
</div> </div>
 +
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]. As of the 2.5.1 patch set (September 2013), builds will no longer be published to the download.eclipse.org Maven repository.
  
* http://www.eclipse.org/downloads/download.php?r=1&amp;nf=1&amp;file=/rt/eclipselink/maven.repo
+
If you have any questions about using it, or experience problems, please let us know on our users mailing list or forum.  
* Group Id: org.eclipse.persistence
+
== Configuring your pom.xml ==
* Artifact Ids:
+
** eclipselink
+
*** The non OSGI EclipseLink jar
+
** org.eclipse.peristence.core
+
*** OSGI-enabled EclipseLink core bundle
+
** org.eclipse.peristence.jpa
+
*** OSGI-enabled EclipseLink JPA bundle
+
** org.eclipse.peristence.moxy
+
*** OSGI-enabled EclipseLink MOXY bundle
+
** org.eclipse.peristence.sdo
+
***  OSGI-enabled EclipseLink SDO bundle
+
** org.eclipse.peristence.asm
+
***  OSGI-enabled EclipseLink ASM bundle
+
** org.eclipse.peristence.antlr
+
*** OSGI-enabled EclipseLink ANTLR bundle
+
* Versioning
+
** Release: 1.0
+
** Nightly/Snapshot: 1.0-SNAPSHOT
+
** Milestone bulids: 1.0Mx (x is the number of the milestone)
+
*** e.g. 1.0M5
+
*** Note: Milestone builds will be available starting with 1.0M5
+
  
== Sample pom.xml entires ==
+
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]].
  
<pre>
+
=== Repositories ===
  
<dependencies>
+
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.
  <dependency>
+
    <groupId>org.eclipse.persistence</groupId>
+
    <artifactId>eclipselink</artifactId>
+
    <version>1.0-SNAPSHOT</version>
+
    <scope>compile</scope>
+
      ...
+
  </dependency>
+
<dependencies>
+
      ...
+
<repositories>
+
  <repository>
+
    <id>EclipseLink Repo</id>
+
    <url>http://www.eclipse.org/downloads/download.php?r=1&amp;amp;nf=1&amp;amp;file=/rt/eclipselink/maven.repo</url>
+
  </repository>   
+
      ...
+
</repositories>
+
  
</pre>
+
==== 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:
 +
 
 +
<source lang="xml">
 +
<repository>
 +
<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>
 +
</repository>
 +
</source>
 +
 
 +
== <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}}
 +
|-{{BMTHStyle}}
 +
! 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 [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].
 +
 
 +
== Sample pom.xml  (Staging) ==
 +
 
 +
The following pom.xml illustrates access the EclipseLink 2.5.0-RC1 from our staging repository.
 +
 
 +
<source lang="xml">
 +
<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>
 +
</source>

Revision as of 14:00, 27 September 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. As of the 2.5.1 patch set (September 2013), builds will no longer be published to the download.eclipse.org Maven repository.

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>

Back to the top