Apache Maven Remote Resources Plugin

This plugin is used to retrieve JARs of resources from remote repositories, process those resources, and incorporate them into JARs you build with Maven.

A very common use-case is the need to package certain resources in a consistent way across your organization. For example at Apache, it is required that every JAR produced contains a copy of the Apache license and a notice file that references all used software in a given project: see Apache Resource Bundles.

Goals Overview

  • remote-resources:bundle creates the resource bundle manifest required by the remote resource bundle processing. The manifest file, ${basedir}/target/classes/META-INF/maven/remote-resources.xml, is created from the contents of the src/main/resources directory.
  • remote-resources:process retrieves the specified remote resource bundles, processes them and makes them available to the process-resources phase.
  • remote-resources:aggregate retrieves the specified remote resource bundles, processes them and makes them available to the process-resources phase in aggregate mode.

Usage

General instructions on how to use the Remote Resources Plugin can be found on the usage page. Some more specific use cases are described in the examples given below.

If you need help using some of the more advanced features of the plugin, check out the advanced help pages:

In case you still have questions regarding the plugin's usage, please have a look at the FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.

If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the guide to helping with Maven.

Examples

To provide you with better understanding of some usages of the Remote Resources Plugin, you can take a look at the following examples: