How to add a 3rd party jar

This short document answers the question “So, how do I let everyone have a copy of a jar that my code depends on?”.


Before You Start

Please check the jar you are looking for may already be in a repository out there on the big bad internet:

Review a couple of the repository search websites:

  1. If you get a hit - confirm it is the jar you want:

  2. Navigate to the correct version and cut and paste the dependency information from the website into your modules pom.xml:

  3. Navigate to the root pom.xml for the project and go to the dependency management section.

    Cut and past paste the dependency information here as well:

  1. You can then adjust your pom.xml to not include the version number (as it will be retrieved from the dependency management section).:

      <!-- version retrieved from parent -->

It really is not available - how to upload?

Assuming the jar you want is not already hosted on one of these sites you need to upload it and add a dependency entry to your pom.xml file.

  • Upload with Maven (not by copy-and-paste)

    Uploading a jar file is not enough. A clean repository also needs the associated jar.md5, jar.sha1, pom, pom.md5, pom.sha1 files to be uploaded, and needs the various maven-metadata.xml files to be updated (as well as their associated md5 and sha1 files).

    This is very tedious, so don’t do that by hand! Maven 2 will do this automatically for you.

Deploying to Open Source Geospatial Foundation Maven 2 Repository:

  1. This is the GeoTools repository used for stable releases; as such it is the best place to host extra 3rd party dependencies. Use your OSGeo ID login credentials:

    Your OSGeo ID must be on this list to enable WebDAV access. Anyone on the list can add you:

  1. Create or update your ~/.m2/settings.xml file as below (~ is your home directory):

    <?xml version="1.0" encoding="ISO-8859-1"?>
          <username>your osgeo id</username>
          <password>your osgeo password</password>
  1. Now you can deploy your jar:

    mvn deploy:deploy-file -DgroupId=<group-id>         \
                           -DartifactId=<artifact-id>   \
                           -Dversion=<version>          \
                           -Dfile=<path-to-file>        \
                           -Dpackaging=jar              \
                           -DrepositoryId=osgeo   \
  2. Or if you have a pom file:

    mvn deploy:deploy-file -DpomFile=<path-to-pom>      \
                           -Dfile=<path-to-file>        \
                           -DrepositoryId=osgeo   \
  3. Elements in bracket (<foo>) need to be replaced by their actual values.

Deploying to OpenGeo Maven 2 Repository:

  1. This is the repository used for SNAPSHOT releases; you can ask on the email list for access.

  2. Although this really is more the target for a “mvn deploy” then something to upload to by hand.

Uploading to Ibiblio

  1. You can also upload your new jar to ibiblio - in case is hacked again.

  2. Unfortunately only a limited number of GeoTools developers have ibiblio access so unless you are one of the lucky few you will have to ask someone else to do that part for you.

  3. To do this create a JIRA task requesting that your jar be uploaded/

  4. In this task request include the following information:

    • Location where the jar can be obtained from

    • A version number for the jar (this should match what you specify in the pom.xml)

    • The license under which the jar can be re-distributed

Examples of Updating JTS Jar

  1. Change into one of the GeoTools directories (the geotools pom.xml has all the repository definitions so changing directories is easier than editing your settings.xml):

    C:\> cd java\geotools\trunk
  2. Here is an example of how to deploy the JTS binary jar:

    C:\java\geotools\trunk>mvn deploy:deploy-file -DgroupId=org.locationtech -DartifactId=jts-core -Dversion=1.13 -Dfile=C:\java\jts\lib\jts-1.13.jar -Dpackaging=jar -DrepositoryId=osgeo -Durl=dav:
  3. And the source code (you will need to zip this up first since JTS does not provide a source download):

    C:\java\geotools\trunk>mvn deploy:deploy-file -DgroupId=org.locationtech -DartifactId=jts -Dversion=1.13 -Dfile=C:\java\jts\ -Dpackaging=java-source -DrepositoryId=osgeo -Durl=dav: -DgeneratePom=false