Maven 2 Artifact Repository Server Configuration

Description:

Java programmers often choose Maven as a build tool because of its ability to pull together Jar file (and other artifact) dependencies from a Maven.org server on the internet. The specific version of the Java Jar file can be specified and easily upgraded. This dependency management helps reduce the practice of holding Jar file dependencies in a CM system (ie Git, Subversion, CVS) which is best used to manage changes in text files and not binary files.

Multiple options are available to host your own maven network repository server:

Server	Description	Web management interface
Standard Maven	Use the Apache httpd server to front-end a Maven repository.	No
Artifactory	A Tomcat based web app with web based support tools.	Yes
Archiva	The Apache Archiva project is a Tomcat based front-end a generic artifact repository capable of operating as a Maven repository.	Yes
Dead Simple Maven Proxy (DSMP)	A repository server which also acts as a filter when Maven accesses the internet.	No

This tutorial describes how to configure a "Standard Maven" repository server using an Apache http server.

Server Configuration

Configure the web server to be able to index and traverse the file system. The location can be any where you choose on the file system. For this example we chose /srv/maven2/

Configure Apache httpd:

File: /etc/httpd/conf.d/maven2.conf

01Alias /maven2 /srv/maven2
02<Directory /srv/maven2>
03    Options Indexes FollowSymLinks
04    AllowOverride AuthConfig
05    Order allow,deny
06    Allow from all
07    ReadmeName README.html
08    HeaderName HEADER.html
09    IndexIgnore HEADER* README*
10    IndexOptions Charset=UTF-8
11    IndexOptions FancyIndexing VersionSort NameWidth=* HTMLTable
12    AddDescription "XML data files" *.xml
13    AddDescription "Java jar files" *.jar
14    AddDescription "Zip compressed files" *.zip
15    AddDescription "Gzip compressed tar ball files" *.tar.gz
16 
17#    AuthType Basic
18#    AuthName "Megacorp directory services login"
19#    AuthBasicProvider ldap
20#    AuthzLDAPAuthoritative on
21#    AuthLDAPURL "ldap://ldap.megacorp.com:389/ou=person,o=megacorp.com,c=us?uid?sub"
22#    Include authorized-users.txt
23</Directory>

Generate the Maven 2 directory structure:

Here we populate the repository by copying Apache commons-lang3 from the maven.org repository into our repository:

Generate the directory structure, the Maven metadata and support files:

cd /srv/maven2/

mkdir -p org/apache/commons/commons-lang3

cd org/apache/commons/commons-lang3

wget http://repo1.maven.org/maven2/org/apache/commons/commons-lang3/maven-metadata.xml

md5sum maven-metadata.xml > maven-metadata.xml.md5

sha1sum maven-metadata.xml > maven-metadata.xml.sha1

Edit maven-metadata.xml to reflect the proposed archive in your repository. In this case we intend to only store release version 3.1 and no others:

01<?xml version="1.0" encoding="UTF-8"?>
02<metadata>
03  <groupId>org.apache.commons</groupId>
04  <artifactId>commons-lang3</artifactId>
05  <versioning>
06    <latest>3.1</latest>
07    <release>3.1</release>
08    <versions>
09      <version>3.1</version>
10    </versions>
11    <lastUpdated>20170612113459</lastUpdated>
12  </versioning>
13</metadata>

Populate the repository with the artifacts (JAR files):

mkdir 3.1

cd 3.1

wget -e robots=off --user-agent=Mozilla/5.0 --reject="index.html*" -nd -r --no-parent http://repo1.maven.org/maven2/org/apache/commons/commons-lang3/3.1/

cd /srv/maven2/

chown -R apache.apache *

chmod ugo+r -R *

Wget is used to copy the artifact contents from the maven.org repo. Note that ownership and permissions are modified so that the Apache httpd webs server can read the files.

Using the Maven Command to Load the Repository:

Specify the JAR file, version number and repository location to generate the repository directory tree and locate contents.

$ ls
myJarLib.jar
$ mvn install:install-file -DgroupId=com.megacorp.projectx -DartifactId=myJarLib -Dpackaging=jar -Dversion=0.9.0-SNAPSHOT -Dfile=myJarLib.jar -DlocalRepositoryPath=/srv/maven2/

This will generate:

/src/maven2/com/corp/pkga/myJarLib/0.9.0-SNAPSHOT/maven-metadata-local.xml - rename this to maven-metadata.xml

view source print ?
01 <?xml version="1.0" encoding="UTF-8"?>
02 <metadata>
03   <groupId>com.megacorp.projectx</groupId>
04   <artifactId>myJarLib</artifactId>
05   <versioning>
06     <versions>
07       <version>0.9.0-SNAPSHOT</version>
08     </versions>
09     <lastUpdated>20170705233506</lastUpdated>
10   </versioning>
11 </metadata>
/src/maven2/com/megacorp/projectx/myJarLib/0.9.0-SNAPSHOT/myJarLib-0.9.0-SNAPSHOT.jar - copies and renames the file
/src/maven2/com/megacorp/projectx/myJarLib/0.9.0-SNAPSHOT/myJarLib-0.9.0-SNAPSHOT.pom

view source print ?
1 <?xml version="1.0" encoding="UTF-8"?>
2 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
3     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
4   <modelVersion>4.0.0</modelVersion>
5   <groupId>com.megacorp.projectx</groupId>
6   <artifactId>myJarLib</artifactId>
7   <version>0.9.0-SNAPSHOT</version>
8   <description>POM was created from install:install-file</description>
9 </project>
/src/maven2/com/megacorp/projectx/myJarLib/0.9.0-SNAPSHOT/maven-metadata-local.xml - rename this to maven-metadata.xml

view source print ?
01 <?xml version="1.0" encoding="UTF-8"?>
02 <metadata modelVersion="1.1.0">
03   <groupId>com.megacorp.projecx</groupId>
04   <artifactId>myJarLib</artifactId>
05   <version>0.9.0-SNAPSHOT</version>
06   <versioning>
07     <snapshot>
08       <localCopy>true</localCopy>
09     </snapshot>
10     <lastUpdated>20170705233506</lastUpdated>
11     <snapshotVersions>
12       <snapshotVersion>
13         <extension>jar</extension>
14         <value>0.9.0-SNAPSHOT</value>
15         <updated>20170705233506</updated>
16       </snapshotVersion>
17       <snapshotVersion>
18         <extension>pom</extension>
19         <value>0.9.0-SNAPSHOT</value>
20         <updated>20170705233506</updated>
21       </snapshotVersio>n
22     </snapshotVersions>
23   </versioning>
24 </metadata>

Using your Maven repository:

Specify the Maven2 repository server in your $HOME/.m2/settings.xml Maven configuration file:

01<profiles>
02      <profile>
03            <id>dev</id>
04            <repositories>
05                  <repository>
06                        <id>central</id>
07                        <name>Megacorp Repository</name>
08                        <url>http://maven2.megacorp.com/maven2</url>
09                        <layout>default</layout>
10                        <snapshots>
11                              <enabled>true</enabled>
12                              <updatePolicy>always</updatePolicy>
13                              <checksumPolicy>fail</checksumPolicy>
14                        </snapshots>
15                  </repository>
16                  <repository>
17                        <id>snapshots</id>
18                        <name>Megacorp Repository</name>
19                        <url>http://maven2.megacorp.com/maven2</url>
20                        <layout>default</layout>
21                        <releases>
22                              <enabled>true</enabled>
23                              <updatePolicy>always</updatePolicy>
24                              <checksumPolicy>fail</checksumPolicy>
25                        </releases>
26                  </repository>
27            </repositories>
28      </profile>
29</profiles>

Specify the dependency in your pom.xml Maven file. Repositories can also be listed:

01<project xmlns="http://maven.apache.org/POM/4.0.0"
02    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
03    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
04    http://maven.apache.org/maven-v4_0_0.xsd">
05  <modelVersion>4.0.0</modelVersion>
06  <groupId>test</groupId>
07  <artifactId>test</artifactId>
08  <packaging>jar</packaging>
09  <version>1.0-SNAPSHOT</version>
10  <name>test</name>
11  <url>http://maven.apache.org</url>
12            <repositories>
13                  <repository>
14                        <id>central</id>
15                        <url>http://maven2.megacorp.com/maven2</url>
16                        <layout>default</layout>
17                        <snapshots>
18                              <enabled>true</enabled>
19                              <updatePolicy>always</updatePolicy>
20                              <checksumPolicy>fail</checksumPolicy>
21                        </snapshots>
22                  </repository>
23                  <repository>
24                        <id>snapshots</id>
25                        <url>http://maven2.megacorp.com/maven2</url>
26                        <layout>default</layout>
27                        <releases>
28                              <enabled>true</enabled>
29                              <updatePolicy>always</updatePolicy>
30                              <checksumPolicy>fail</checksumPolicy>
31                        </releases>
32                  </repository>
33            </repositories>
34  <dependencies>
35    <dependency>
36    <groupId>org.apache.commons</groupId>
37    <artifactId>commons-lang3</artifactId>
38    <version>3.1</version>
39    </dependency>
40  </dependencies>
41</project>

Books:

"Maven Essentials"
by Prabath Siriwardena
ISBN # 178398676X, Packt Publishing

For Java developers

Maven 2 Artifact Repository Server Configuration:

Using the Maven Command to Load the Repository: