Download Plugin for Maven

This is a plugin meant to help maven user to download different files on different protocol in part of maven build. The plugin caches downloaded files in maven cache directory, which saves network trafic and speedup build.

Project Status

Functional but not under active development. We accept pull requests, and generally get them merged within a week or 2 depending on the complexity.

Enable

This Maven plugin should be available on Maven Central. But in case you can't find it on Central for some reason, here is the repository to add to your pom:

<pluginRepository>
	<id>sonatype-public-repository</id>
	<url>https://oss.sonatype.org/content/groups/public</url>
	<snapshots>
		<enabled>true</enabled>
	</snapshots>
	<releases>
		<enabled>true</enabled>
	</releases>
</pluginRepository>

You can use some alternative repositories. See https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide#SonatypeOSSMavenRepositoryUsageGuide-4.MavenRepositories for details.

Basic Usage

"Artifact" goal

Meant to be used from anywhere on the system to download an artifact at a specific location. Does not need a pom file to be run and can be used directly from the command line. Can be an alternative to maven-dependency-plugin:get or maven-dependency-plugin:unpack mojoes.

mvn com.googlecode.maven-download-plugin:download-maven-plugin:1.6.8:artifact -DgroupId=com.googlecode -DartifactId=maven-download-plugin -Dversion=0.1 -DoutputDirectory=temp

"WGet" goal

This is meant to provide the necessary tooling for downloading anything in your Maven build without having to use Ant scripts. It provides caching and checksum verification.

<plugin>
	<groupId>com.googlecode.maven-download-plugin</groupId>
	<artifactId>download-maven-plugin</artifactId>
	<version>1.6.8</version>
	<executions>
		<execution>
			<id>install-jbpm</id>
			<phase>pre-integration-test</phase>
			<goals>
				<goal>wget</goal>
			</goals>
		</execution>
	</executions>
	<configuration>
		<url>http://downloads.sourceforge.net/project/jbpm/jBPM%203/jbpm-3.1.4/jbpm-3.1.4.zip</url>
		<unpack>true</unpack>
		<outputDirectory>${project.build.directory}/jbpm-3.1.4</outputDirectory>
		<md5>df65b5642f33676313ebe4d5b69a3fff</md5>
	</configuration>
</plugin>

Requirements

Starting from version 1.6.9, the plugin requires Maven version 3 or above.

Known issues and workarounds

IO Error: No such archiver

Happens when the plugin is instructed to unarchive file but the file has unsupported extension

Solution: Specify outputFilename parameter with proper file extension

WARNING about artifactId

Until version 1.1, the plugin artifactId used to be maven-download-plugin, however Maven conventions makes that this name is not allowed for a plugin which is not part of the Apache Maven project. So starting from version 1.2-SNAPSHOT, the plugin artifactId is download-maven-plugin. The following documentation will get updated when releasing download-maven-plugin:1.2.

Help

Maven help

To get basic plugin help, type in the command :

mvn com.googlecode.maven-download-plugin:download-maven-plugin:help

To get a more detailed help, type command :

mvn com.googlecode.maven-download-plugin:download-maven-plugin:help -Ddetail

Generated documentation

See also generated documentation pages for 1.6.8 and for snapshot.

Mailing-list

See https://groups.google.com/forum/?fromgroups#!forum/maven-download-plugin

Issue Tracker and wikis...

Are maintained at GitHub (links above).

Contribute

This project support GitHub PR, but enforce some rules for decent tracking: 1 Change Request == 1 PR == 1 commit, if a change can be made by iterations, then use a specific PR for each iteration. Ideally, every bugfix should be supplied with a unit or integration test.

Other links

Former project page at Google Code: http://code.google.com/p/maven-download-plugin/