Built by Maven

toolbox:http-get

Full name:

eu.maveniverse.maven.plugins:toolbox:0.16.0:http-get

Description:

Downloads a file from remote using Maven settings.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<output> File - The output file (or directory, when unpack) to store the resource.
Default: ${project.build.directory}/http-get
User Property: output
<remoteResource> String - The HTTP URL of the remote resource to download. It can be:
  • URL
  • serverId::URL
In latter case, it will pick up auth and all Maven specific config for given server ID.
User Property: remoteResource
<unpack> boolean - Should the downloaded (archive) file be unpacked?
Default: false
User Property: unpack
<useRoot> boolean - When unpacking, should the archive root entry be used or skipped?
Default: true
User Property: useRoot

Optional Parameters

Name Type Since Description
<checksums> Map<String,String> - Optionally, to enforce Resolver supported checksums on resource (the origin, in case unpack=true).
User Property: checksums
<dryRun> boolean - Option to run potentially destructive commands without performing any IO.
Default: false
User Property: dryRun
<extraRepositories> String - Appends extra repositories to context.
User Property: extraRepositories
<failOnLogicalFailure> boolean - Makes command fail on "logical" failure.
Default: true
User Property: failOnLogicalFailure
<forceStdout> boolean - No description.
User Property: forceStdout
<forceUpdates> boolean - Force updates.
User Property: update
<repositoryVendor> String - The repository vendor to use for Search RR backend ("central", "nx2" or any other extractor). If empty, heuristics will be applied to figure out.
User Property: toolbox.search.backend.type
<verbosity> Output$Verbosity - No description.
Default: NORMAL
User Property: verbosity

Parameter Details

<checksums>

Optionally, to enforce Resolver supported checksums on resource (the origin, in case unpack=true).
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No
  • User Property: checksums

<dryRun>

Option to run potentially destructive commands without performing any IO.
  • Type: boolean
  • Required: No
  • User Property: dryRun
  • Default: false

<extraRepositories>

Appends extra repositories to context.
  • Type: java.lang.String
  • Required: No
  • User Property: extraRepositories

<failOnLogicalFailure>

Makes command fail on "logical" failure.
  • Type: boolean
  • Required: No
  • User Property: failOnLogicalFailure
  • Default: true

<forceStdout>

No description.
  • Type: boolean
  • Required: No
  • User Property: forceStdout

<forceUpdates>

Force updates.
  • Type: boolean
  • Required: No
  • User Property: update

<output>

The output file (or directory, when unpack) to store the resource.
  • Type: java.io.File
  • Required: Yes
  • User Property: output
  • Default: ${project.build.directory}/http-get

<remoteResource>

The HTTP URL of the remote resource to download. It can be:
  • URL
  • serverId::URL
In latter case, it will pick up auth and all Maven specific config for given server ID.
  • Type: java.lang.String
  • Required: Yes
  • User Property: remoteResource

<repositoryVendor>

The repository vendor to use for Search RR backend ("central", "nx2" or any other extractor). If empty, heuristics will be applied to figure out.
  • Type: java.lang.String
  • Required: No
  • User Property: toolbox.search.backend.type

<unpack>

Should the downloaded (archive) file be unpacked?
  • Type: boolean
  • Required: Yes
  • User Property: unpack
  • Default: false

<useRoot>

When unpacking, should the archive root entry be used or skipped?
  • Type: boolean
  • Required: Yes
  • User Property: useRoot
  • Default: true

<verbosity>

No description.
  • Type: eu.maveniverse.maven.toolbox.shared.output.Output$Verbosity
  • Required: No
  • User Property: verbosity
  • Default: NORMAL