Required Parameters

Name	Type	Since	Description
outputDirectory	File	-	Represent the directory where the file should be downloaded. Default value is: ${project.build.directory}. User property is: download.outputDirectory.
url	String	-	Represent the URL to fetch information from. User property is: download.url.

Optional Parameters

Name	Type	Since	Description
cacheDirectory	File	-	The directory to use as a cache. Default is ${local-repo}/.cache/maven-download-plugin User property is: download.cache.directory.
checkSignature	boolean	-	Whether to check the signature of existing files Default value is: false. User property is: checkSignature.
failOnError	boolean	-	Flag to determine whether to fail on an unsuccessful download. Default value is: true.
md5	String	-	The md5 of the file. If set, file signature will be compared to this signature and plugin will fail.
outputFileName	String	-	Represent the file name to use as output value. If not set, will use last segment of "url" User property is: download.outputFileName.
overwrite	boolean	-	Flag to overwrite the file by redownloading it User property is: download.overwrite.
password	String	-	Custom password for the download
readTimeOut	int	-	Read timeout for a download in milliseconds Default value is: 0.
retries	int	-	How many retries for a download Default value is: 2.
session	MavenSession	-	(no description) User property is: session.
sha1	String	-	The sha1 of the file. If set, file signature will be compared to this signature and plugin will fail.
sha512	String	-	The sha512 of the file. If set, file signature will be compared to this signature and plugin will fail.
skip	boolean	-	Whether to skip execution of Mojo Default value is: false. User property is: download.plugin.skip.
skipCache	boolean	-	Download file without polling cache Default value is: false.
unpack	boolean	-	Whether to unpack the file in case it is an archive (.zip) Default value is: false.
username	String	-	Custom username for the download

Parameter Details

cacheDirectory:

• Type: java.io.File
• Required: No
• User Property: download.cache.directory

---

checkSignature:

• Type: boolean
• Required: No
• User Property: checkSignature
• Default: false

---

failOnError:

• Type: boolean
• Required: No
• Default: true

---

md5:

• Type: java.lang.String
• Required: No

---

outputDirectory:

• Type: java.io.File
• Required: Yes
• User Property: download.outputDirectory
• Default: ${project.build.directory}

---

outputFileName:

• Type: java.lang.String
• Required: No
• User Property: download.outputFileName

---

overwrite:

• Type: boolean
• Required: No
• User Property: download.overwrite

---

password:

• Type: java.lang.String
• Required: No

---

readTimeOut:

• Type: int
• Required: No
• Default: 0

---

retries:

• Type: int
• Required: No
• Default: 2

---

session:

• Type: org.apache.maven.execution.MavenSession
• Required: No
• User Property: session

---

sha1:

• Type: java.lang.String
• Required: No

---

sha512:

• Type: java.lang.String
• Required: No

---

skip:

• Type: boolean
• Required: No
• User Property: download.plugin.skip
• Default: false

---

skipCache:

• Type: boolean
• Required: No
• Default: false

---

unpack:

• Type: boolean
• Required: No
• Default: false

---

url:

• Type: java.lang.String
• Required: Yes
• User Property: download.url

---

username:

• Type: java.lang.String
• Required: No