Maven Repository

To make it easy for you to configure Maven to work with Artifactory, Artifactory can automatically generate a settings.xmlfile which you can save under your Maven home directory.

The definitions in the generated settings.xml file override the default central and snapshot repositories of Maven.

Once you have created your Maven repository, go to Application | Artifactory | Artifacts, select your Maven repository and click Set Me Up.

In the Set Me Up dialog, click Generate Maven Settings.

You can now specify the repositories you want to configure for Maven.

Once you have configured the settings for Maven, click Generate Settings to generate and save the settings.xml file.

You can deploy and provision a dynamic settings template for your users.

Once downloaded, settings are generated according to your own logic and can automatically include user authentication information.

For more details, please refer to the Provisioning Build Tool Settings under Filtered Resources.

To override the built-in central and snapshot repositories of Maven, you need to ensure that Artifactory is correctly configured so that no request is ever sent directly to them.

To do so, you need to insert the following into your parent POM or settings.xml (under an active profile):

<repositories>
    <repository>
        <id>central</id>
        <url>http://[host]:[port]/artifactory/libs-release</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>snapshots</id>
        <url>http://[host]:[port]/artifactory/libs-snapshot</url>
        <releases>
            <enabled>false</enabled>
        </releases>
    </repository>
</repositories>
<pluginRepositories>
    <pluginRepository>
        <id>central</id>
        <url>http://[host]:[port]/artifactory/plugins-release</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </pluginRepository>
    <pluginRepository>
        <id>snapshots</id>
        <url>http://[host]:[port]/artifactory/plugins-snapshot</url>
        <releases>
            <enabled>false</enabled>
        </releases>
    </pluginRepository>
</pluginRepositories>

In addition to overriding built-in Maven repositories, you can use the Mirror Any setting to redirect all requests to a Maven repository through Artifactory, including those defined inside POMs of plug-ins and third party dependencies. (While it does not adhere to best practices, it is not uncommon for POMs to reference Maven repositories directly). This ensures no unexpected requests directly to Maven are introduced by such POMs.

You can either check Mirror Any in the Maven Settings screen when generating your settings.xml file, or you can manually insert the following:

<mirrors>
    <mirror>
      <id>artifactory</id>
      <mirrorOf>*</mirrorOf>
      <url>http://[host]:[port]/artifactory/[virtual repository]</url>
      <name>Artifactory</name>
    </mirror>
</mirrors>

Artifactory requires user authentication in three cases:

Authentication is configured in Maven using <server> elements in the settings.xml file.

Each <repository> and <mirror> element specified in the file must have a corresponding <server> element with a matching <id> that specifies the username and password.

The sample snippet below emphasizes that the <repository> element with id=central has a corresponding <server> element with id=central.

Similarly, the <repository> element with id=snapshots has a corresponding <server> element with id=snapshots.

The same would hold for <mirror> elements that require authentication.

In both cases the username is admin and the password is encrypted.

Forcing Authentication on Virtual Maven Repositories

Artifactory supports Maven repositories with Allow Anonymous Access enabled by default and will not query the Maven client for authentication parameters.

If you want to enforce authentication you need to explicitly instruct Artifactory to request authentication parameters.

In the New or Edit Repository dialog of the Maven virtual repositories, select the Force Authentication check box.

Note

When Force Authentication is selected, Artifactory will request authentication parameters from the Maven client before trying to access this repository.

To deploy build artifacts through Artifactory you must add a deployment element with the URL of a target local repository to which you want to deploy your artifacts.

To make this easier, Artifactory displays a code snippet that you can use as your deployment element. In the Artifact Repository Browser, click Tree and select the repository you want to deploy to and click Set Me Up. The code snippet is displayed under Deploy.

When deploying your Maven builds through Artifactory, you must ensure that any <repository> element in your distribution settings has a corresponding <server> element in the settings.xml file with a valid username and password as described in Configuring Authentication above. For the example displayed above, the Maven client expects to find a <server> element in the settings.xml with <id>artifactory</id> specified.