Attaching a snapshot of a 3rd party JAR to maven as local repo with a maven based project - an example with Java-Websocket

README.md

Just an example for others and a note for myself in case I need to reference this procedure again in the future. Note that I'm not a maven expert, so I googled for answers and hacked this up. It could be improved. Feedback appreciated.

Setting up local repo for your maven based project to use to fetch/manage dependency of a 3rd party library

Steps:

Add the following type of snippet to your maven project POM

<repositories>
  <repository>
    <id>third-party-jars</id>
    <releases>
      <enabled>false</enabled>
      <checksumPolicy>ignore</checksumPolicy>
    </releases>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
    <url>file://${project.basedir}/third-party-jars</url>
  </repository>
</repositories>

Add/edit the maven dependency for that JAR, set to use SNAPSHOT version as needed, as opposed to a version in maven central

<dependency>
  <groupId>org.java-websocket</groupId>
  <artifactId>Java-WebSocket</artifactId>
  <version>1.3.1-SNAPSHOT</version>
</dependency>

1. create the matching local directory in your maven based project e.g. third-party-jars under project root.
2. copy over the (compiled) JAR into directory of step 3, following Java package convention, e.g. under third-party-jars/org/java-websocket/Java-Websocket/1.3.1-SNAPSHOT/.
3. copy over the matching POM file for that compiled JAR to same location (this is not the same POM as in the 3rd party JARs project source? or am I mistaken?). If it doesn't exist, you will have to generate one, this gist has a sample.
4. copy over the matching maven-metadata.xml that is generated with the 3rd party JAR's maven project, when you compiled the JAR, etc. If it doesn't exist, you have to generate one, this gist has a sample. Destination to copy to is one level up from the JAR as this is not version specific.
5. Run maven commands to update dependency for your maven project from the local repo you just set up from previous steps. If you use Eclipse like I did, that would be mvn eclipse:eclipse with optional mvn eclipse:clean beforehand.

Compiling a 3rd party library via it's maven project setup as needed

This is just notes for doing this for https://github.com/TooTallNate/Java-WebSocket since at time of this gist, v1.3.0 JAR in maven central and what's available for download is outdated. And for v1.3.1 (snapshot), you'll need to compile from source.

I just ran mvn package, although on the 1st run, it failed 2 tests. I suppose maybe a rerun would be ok, but I didn't know at the time, so I ran it without the test step: mvn -Dmaven.test.skip=true package. When I reran with tests after this, the tests passed, some quirk there. The output JAR was under the target directory. I did not find/notice a matching maven-metadata.xml file, and there was no *.pom. So I manually constructed these based on samples of other packages that did have them. Samples attached with this gist.

Handling newer maven versions with external dependency fetch restrictions

Can run maven with patched maven settings (part of this gist) to permit the locally hosted dependency fetch

mvn package -gs maven-default-settings-patched.xml

Java-WebSocket-1.3.1-SNAPSHOT.pom

<?xml version="1.0" encoding="UTF-8"?>
<!-- note that this is somefile.pom not pom.xml, and may not be the same data as in pom.xml -->
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.java-websocket</groupId>
  <artifactId>Java-WebSocket</artifactId>
  <packaging>jar</packaging>
  <name>Java WebSocket</name>
  <version>1.3.1-SNAPSHOT</version>
  <description>A barebones WebSocket client and server implementation written in 100% Java</description>
  <url>http://java-websocket.org/</url>
  <licenses>
    <license>
      <name>MIT License</name>
      <url>http://github.com/TooTallNate/Java-WebSocket/blob/master/LICENSE</url>
      <distribution>repo</distribution>
    </license>
  </licenses>
  <scm>
    <url>https://github.com/TooTallNate/Java-WebSocket</url>
  </scm>
  <developers>
        <developer>
            <id>TooTallNate</id>
            <name>Nathan Rajlich</name>
            <email>[email protected]</email>
            <url>https://github.com/TooTallNate</url>
            <roles>
                <role>founder</role>
            </roles>
        </developer>
        <developer>
            <id>Davidiusdadi</id>
            <name>David Rohmer</name>
            <email>[email protected]</email>
            <url>https://github.com/Davidiusdadi</url>
            <roles>
                <role>maintainer</role>
            </roles>
        </developer>
    </developers>
</project>

maven-default-settings-patched.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

<!--
 | This is the configuration file for Maven. It can be specified at two levels:
 |
 |  1. User Level. This settings.xml file provides configuration for a single user,
 |                 and is normally provided in ${user.home}/.m2/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -s /path/to/user/settings.xml
 |
 |  2. Global Level. This settings.xml file provides configuration for all Maven
 |                 users on a machine (assuming they're all using the same Maven
 |                 installation). It's normally provided in
 |                 ${maven.conf}/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -gs /path/to/global/settings.xml
 |
 | The sections in this sample file are intended to give you a running start at
 | getting the most out of your Maven installation. Where appropriate, the default
 | values (values used when the setting is not specified) are provided.
 |
 |-->
<settings xmlns="http://maven.apache.org/SETTINGS/1.2.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.2.0 https://maven.apache.org/xsd/settings-1.2.0.xsd">
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ${user.home}/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->

  <!-- interactiveMode
   | This will determine whether maven prompts you when it needs input. If set to false,
   | maven will use a sensible default value, perhaps based on some other setting, for
   | the parameter in question.
   |
   | Default: true
  <interactiveMode>true</interactiveMode>
  -->

  <!-- offline
   | Determines whether maven should attempt to connect to the network when executing a build.
   | This will have an effect on artifact downloads, artifact deployment, and others.
   |
   | Default: false
  <offline>false</offline>
  -->

  <!-- pluginGroups
   | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e.
   | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers
   | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list.
   |-->
  <pluginGroups>
    <!-- pluginGroup
     | Specifies a further group identifier to use for plugin lookup.
    <pluginGroup>com.your.plugins</pluginGroup>
    -->
  </pluginGroups>

  <!-- proxies
   | This is a list of proxies which can be used on this machine to connect to the network.
   | Unless otherwise specified (by system property or command-line switch), the first proxy
   | specification in this list marked as active will be used.
   |-->
  <proxies>
    <!-- proxy
     | Specification for one proxy, to be used in connecting to the network.
     |
    <proxy>
      <id>optional</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>proxyuser</username>
      <password>proxypass</password>
      <host>proxy.host.net</host>
      <port>80</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
    </proxy>
    -->
  </proxies>

  <!-- servers
   | This is a list of authentication profiles, keyed by the server-id used within the system.
   | Authentication profiles can be used whenever maven must make a connection to a remote server.
   |-->
  <servers>
    <!-- server
     | Specifies the authentication information to use when connecting to a particular server, identified by
     | a unique name within the system (referred to by the 'id' attribute below).
     |
     | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are
     |       used together.
     |
    <server>
      <id>deploymentRepo</id>
      <username>repouser</username>
      <password>repopwd</password>
    </server>
    -->

    <!-- Another sample, using keys to authenticate.
    <server>
      <id>siteServer</id>
      <privateKey>/path/to/private/key</privateKey>
      <passphrase>optional; leave empty if not used.</passphrase>
    </server>
    -->
  </servers>

  <!-- mirrors
   | This is a list of mirrors to be used in downloading artifacts from remote repositories.
   |
   | It works like this: a POM may declare a repository to use in resolving certain artifacts.
   | However, this repository may have problems with heavy traffic at times, so people have mirrored
   | it to several places.
   |
   | That repository definition will have a unique id, so we can create a mirror reference for that
   | repository, to be used as an alternate download site. The mirror site will be the preferred
   | server for that repository.
   |-->
  <mirrors>
    <!-- mirror
     | Specifies a repository mirror site to use instead of a given repository. The repository that
     | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used
     | for inheritance and direct lookup purposes, and must be unique across the set of mirrors.
     |
    <mirror>
      <id>mirrorId</id>
      <mirrorOf>repositoryId</mirrorOf>
      <name>Human Readable Name for this Mirror.</name>
      <url>http://my.repository.com/repo/path</url>
    </mirror>

     | below default in settings.xml commented out to allow compiling with custom websocket JAR
     | dependency that is locally hosted in this repo via "file://" URL scheme to access it
    <mirror>
      <id>maven-default-http-blocker</id>
      <mirrorOf>external:http:*</mirrorOf>
      <name>Pseudo repository to mirror external repositories initially using HTTP.</name>
      <url>http://0.0.0.0/</url>
      <blocked>true</blocked>
    </mirror>
     -->
  </mirrors>

  <!-- profiles
   | This is a list of profiles which can be activated in a variety of ways, and which can modify
   | the build process. Profiles provided in the settings.xml are intended to provide local machine-
   | specific paths and repository locations which allow the build to work in the local environment.
   |
   | For example, if you have an integration testing plugin - like cactus - that needs to know where
   | your Tomcat instance is installed, you can provide a variable here such that the variable is
   | dereferenced during the build process to configure the cactus plugin.
   |
   | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles
   | section of this document (settings.xml) - will be discussed later. Another way essentially
   | relies on the detection of a system property, either matching a particular value for the property,
   | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a
   | value of '1.4' might activate a profile when the build is executed on a JDK version of '1.4.2_07'.
   | Finally, the list of active profiles can be specified directly from the command line.
   |
   | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact
   |       repositories, plugin repositories, and free-form properties to be used as configuration
   |       variables for plugins in the POM.
   |
   |-->
  <profiles>
    <!-- profile
     | Specifies a set of introductions to the build process, to be activated using one or more of the
     | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/>
     | or the command line, profiles have to have an ID that is unique.
     |
     | An encouraged best practice for profile identification is to use a consistent naming convention
     | for profiles, such as 'env-dev', 'env-test', 'env-production', 'user-jdcasey', 'user-brett', etc.
     | This will make it more intuitive to understand what the set of introduced profiles is attempting
     | to accomplish, particularly when you only have a list of profile id's for debug.
     |
     | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo.
    <profile>
      <id>jdk-1.4</id>

      <activation>
        <jdk>1.4</jdk>
      </activation>

      <repositories>
        <repository>
          <id>jdk14</id>
          <name>Repository for JDK 1.4 builds</name>
          <url>http://www.myhost.com/maven/jdk14</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
    -->

    <!--
     | Here is another profile, activated by the system property 'target-env' with a value of 'dev',
     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
     | might hypothetically look like:
     |
     | ...
     | <plugin>
     |   <groupId>org.myco.myplugins</groupId>
     |   <artifactId>myplugin</artifactId>
     |
     |   <configuration>
     |     <tomcatLocation>${tomcatPath}</tomcatLocation>
     |   </configuration>
     | </plugin>
     | ...
     |
     | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to
     |       anything, you could just leave off the <value/> inside the activation-property.
     |
    <profile>
      <id>env-dev</id>

      <activation>
        <property>
          <name>target-env</name>
          <value>dev</value>
        </property>
      </activation>

      <properties>
        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
      </properties>
    </profile>
    -->
  </profiles>

  <!-- activeProfiles
   | List of profiles that are active for all builds.
   |
  <activeProfiles>
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>
  -->
</settings>

maven-metadata.xml

<?xml version="1.0"?>
<metadata>
	<groupId>org.java-websocket</groupId>
	<artifactId>Java-WebSocket</artifactId>
	<version>1.3.1-SNAPSHOT</version>
	<versioning>
		<release>1.3.1-SNAPSHOT</release>
		<versions>
 			<version>1.3.1-SNAPSHOT</version>
		</versions>
		<!-- I fudged the date here, it was roughly the last modified date of the JAR -->
		<lastUpdated>20151203143539</lastUpdated>
	</versioning>
</metadata>