How to configure Maven setting.xml and pom.xml to access a Nexus private repository

PREREQUISITES

    Before you begin, you must have done the following:

  • Requested and received confirmation that a private Nexus repository has been created.

    When you receive confirmaiton that the private repository has been created, you will given the following information:

    repository name\\
repository group name\\
Team ID\\
Team list name\\
    You will need the above information to configure your Maven project so that it can access the private repository.

These instuctions assume the following:

  • The name of the Nexus Repository server is maven.mit.edu.  The actual server name may be different.

Overview

Configuring a Maven project to access a private repository requires setting up a name/password pair in the settings.xml file and associating the name/password with a specific repository which is defined in the project's pom.xml.

Items 1 and 2 below give the syntax of the entries for both the settings.xml and pom.xml files.  It is important to note the following:

  1. The <id> element that is used in both the setting.xml (found in the <server> element) and the pom.xml (found in the <repository> element) is what associates the name/password pair with the private repository.  The <id> element in both places must be identical.  It can be anything you want it to be, the only restriction is that they must be identical.

  2. In the settings.xml, the <password> element must be the Team list name that was given to you when you received your repository confirmation.  Refer to the PREREQUISITES section above.

  3. In the settings.xml, the <username> element must be build#string.


The private repositories can be accessed by using either http or https.  If you want to use https, then you must enable Maven for SSL operations.  Click here for instructions on how to use SSL with Maven.  Using https is highly recommended when using private repositories.

1. the setting.xml <server> element configuration

<servers>
    <server>
        <id>myPrivateRepo</id>
        <username>build#string</username>
        <password>myTeamListName</password>
    </server>
</servers>


where myTeamListName has the form dvtl<Team ID>.

Example: if your Team ID is uadev, then the <password> element would be <password>dvtluadev</password>.


2. the Maven pom.xml <repository> element configuration

  • A private repository can be accessed directly by using the <repository> element below:

    <repositories>
    ...
    <repository>
        <id>myPrivateRepo</id>
        <name>This is my private repository</name>
        <url>https://maven.mit.edu/nexus/content/repositories/privateRepo</url>
    </repository>
    ...
</repositories>
    note: In the above <url> tag, privateRepo must be replaced with the name of your private repository.

  • If there is a private repository group, then the private repository group can be accessed by using the <repository> element below:

    <repositories>
    ...
    <repository>
        <id>myPrivateRepo</id>
        <name>This is my private repository group</name>
        <url>https://maven.mit.edu/nexus/content/groups/privateRepoGroup</url>
    </repository>
    ...
<repositories>
    note: In the above <url> tag, privateRepoGroup must be replaced with the name of your private repository group.