Fork me on GitHub
Built by Maven

wagon:download

Full name:

org.codehaus.mojo:wagon-maven-plugin:3.2.0:download

Description:

Transfers a set of files from a remote URL to a specified local directory.

Attributes:

  • The goal is not marked as thread-safe and thus does not support parallel builds.

Required Parameters

Name Type Since Description
<url> String - URL to upload to or download from or list. Must exist and point to a directory.
User Property: wagon.url

Optional Parameters

Name Type Since Description
<caseSensitive> boolean - Whether to consider remote path case sensitivity during scan.
Default: true
User Property: wagon.caseSensitive
<excludes> String - Comma separated list of Ant's excludes to scan for remote files.
User Property: wagon.excludes
<fromDir> String - Directory path relative to Wagon's URL
User Property: wagon.fromDir
<includes> String - Comma separated list of Ant's includes to scan for remote files.

The download goal does not scan the remote file system when every include is an exact path relative to fromDir, such as 1.1/a.jar,1.1/a.pom: it fetches those files directly, which also works over plain HTTP, where a directory cannot be listed. An exact path has no * or ? and does not end with a slash. excludes still apply, and a file that does not exist is skipped with a warning, as a scan would not have reported it. The list goal always scans.


Default: *
User Property: wagon.includes
<serverId> String - settings.xml's server id for the URL. This is used when wagon needs extra authentication information.
Default: serverId
User Property: wagon.serverId
<skip> boolean 2.0.0 When true, skip the execution.
User Property: wagon.skip
<toDir> File - Local directory to download the remote resource ( tree ) to.
Default: ${project.build.directory}/wagon-plugin
User Property: wagon.toDir

Parameter Details

<caseSensitive>

Whether to consider remote path case sensitivity during scan.
  • Type: boolean
  • Required: No
  • User Property: wagon.caseSensitive
  • Default: true

<excludes>

Comma separated list of Ant's excludes to scan for remote files.
  • Type: java.lang.String
  • Required: No
  • User Property: wagon.excludes

<fromDir>

Directory path relative to Wagon's URL
  • Type: java.lang.String
  • Required: No
  • User Property: wagon.fromDir

<includes>

Comma separated list of Ant's includes to scan for remote files.

The download goal does not scan the remote file system when every include is an exact path relative to fromDir, such as 1.1/a.jar,1.1/a.pom: it fetches those files directly, which also works over plain HTTP, where a directory cannot be listed. An exact path has no * or ? and does not end with a slash. excludes still apply, and a file that does not exist is skipped with a warning, as a scan would not have reported it. The list goal always scans.

  • Type: java.lang.String
  • Required: No
  • User Property: wagon.includes
  • Default: *

<serverId>

settings.xml's server id for the URL. This is used when wagon needs extra authentication information.
  • Type: java.lang.String
  • Required: No
  • User Property: wagon.serverId
  • Default: serverId

<skip>

When true, skip the execution.
  • Type: boolean
  • Since: 2.0.0
  • Required: No
  • User Property: wagon.skip

<toDir>

Local directory to download the remote resource ( tree ) to.
  • Type: java.io.File
  • Required: No
  • User Property: wagon.toDir
  • Default: ${project.build.directory}/wagon-plugin

<url>

URL to upload to or download from or list. Must exist and point to a directory.
  • Type: java.lang.String
  • Required: Yes
  • User Property: wagon.url