Full name:

com.isomorphic:isc-maven-plugin:1.4.6:download

Description:

Downloads and unpacks a given distribution, but does not actually do anything with the resulting Maven artifacts.

Attributes:

  • Executes by direct invocation only.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

Required Parameters

Name Type Since Description
<buildNumber> String 1.0.0 The Isomorphic version number of the specified product . e.g., 9.1d, 4.0p. Used to determine both remote and local file locations.
User Property: buildNumber
<license> License 1.0.0 Typically one of: LGPL, EVAL, PRO, POWER, ENTERPRISE. Although it is also valid to specify optional modules ANALYTICS_MODULE or MESSAGING_MODULE, generally prefer the includeAnalytics / includeMessaging properties, respectively, to cause the optional modules to be included with the base installation / deployment.
User Property: license

Optional Parameters

Name Type Since Description
<buildDate> String 1.0.0 The date on which the Isomorphic build was made publicly available at http://www.smartclient.com/builds /, in yyyy-MM-dd format. e.g., 2013-25-12. Used to determine both remote and local file locations.
Note that if no value is provided, and skipDownload is not true, an attempt is made to discover the date of the latest distribution currently published to the Isomorphic build server.
Default value is: The date of the most recent distribution (with caveats).
User Property: buildDate
<copyToLatestFolder> Boolean 1.4.0 If true, makes a copy of the given distribution in a 'latest' subdirectory. Can be useful for bookmarking documentation, etc. but adds additional install time and storage requirements.
Default: false
User Property: copyToLatestFolder
<includeAnalytics> Boolean 1.0.0 If true, the optional analytics module (bundled and distributed separately) has been licensed and should be downloaded with the distribution specified by license .
Default: false
User Property: includeAnalytics
<includeMessaging> Boolean 1.0.0 If true, the optional messaging module (bundled and distributed separately) has been licensed and should be downloaded with the distribution specified by license .
Default: false
User Property: includeMessaging
<overwrite> Boolean 1.0.0 If true, any file previously downloaded / unpacked will be overwritten with this execution. Useful in the case of an interrupted download. Note that this setting has no effect on unzip operations.
Default: false
User Property: overwrite
<product> Product 1.0.0 One of SMARTGWT, SMARTCLIENT.
Default: SMARTGWT
User Property: product
<serverId> String 1.0.0 The id of a server configuration containing authentication credentials for the smartclient.com website, used to download licensed products.

Not strictly necessary for unprotected (LGPL) distributions.


Default: smartclient-developer
User Property: serverId
<skins> String 1.4.6 Limits the skins installed with the runtime to the names in this comma-separated list. E.g., -Dskins=Tahoe,Stratus will remove all skins except Tahoe and Stratus. Note that these deleted resources cannot be recovered except by reinstalling the artifact(s) to your repository.
User Property: skins
<skipDownload> Boolean 1.0.0 If true, no attempt is made to download any remote distribution. Files will be loaded instead from a path constructed of the following parts (e.g., C:/downloads/SmartGWT/PowerEdition/4.1d/2013-12-25/zip):
  • workdir
  • product
  • license
  • buildNumber
  • buildDate
  • "zip"

Default: false
User Property: skipDownload
<skipExtraction> Boolean - If true, no attempt it made to extract the contents of any distribution. Only useful in the case where some manual intervention is required between download and another step. For example, it would be possible to first run the download goal, manipulate the version number of some dependency in some POM, and then run the install goal with skipExtraction=false to prevent the modified POM from being overwritten.

This is the kind of thing that should generally be avoided, however.


Default: false
User Property: skipExtraction
<snapshots> Boolean 1.0.0 If true, artifacts should be versioned with the 'SNAPSHOT' qualifier, in the case of development builds only. The setting has no effect on patch builds.

If false, each artifact's POM file is modified to remove the unwanted qualifier. This can be useful if you need to deploy a development build to a production environment.


Default: true
User Property: snapshots
<workdir> File 1.0.0 The path to some directory that is to be used for storing downloaded files, working copies, and so on.
Default: ${java.io.tmpdir}/${project.artifactId}
User Property: workdir

Parameter Details

<buildDate>

The date on which the Isomorphic build was made publicly available at http://www.smartclient.com/builds /, in yyyy-MM-dd format. e.g., 2013-25-12. Used to determine both remote and local file locations.
Note that if no value is provided, and skipDownload is not true, an attempt is made to discover the date of the latest distribution currently published to the Isomorphic build server.
Default value is: The date of the most recent distribution (with caveats).
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: buildDate

<buildNumber>

The Isomorphic version number of the specified product . e.g., 9.1d, 4.0p. Used to determine both remote and local file locations.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: Yes
  • User Property: buildNumber

<copyToLatestFolder>

If true, makes a copy of the given distribution in a 'latest' subdirectory. Can be useful for bookmarking documentation, etc. but adds additional install time and storage requirements.
  • Type: java.lang.Boolean
  • Since: 1.4.0
  • Required: No
  • User Property: copyToLatestFolder
  • Default: false

<includeAnalytics>

If true, the optional analytics module (bundled and distributed separately) has been licensed and should be downloaded with the distribution specified by license .
  • Type: java.lang.Boolean
  • Since: 1.0.0
  • Required: No
  • User Property: includeAnalytics
  • Default: false

<includeMessaging>

If true, the optional messaging module (bundled and distributed separately) has been licensed and should be downloaded with the distribution specified by license .
  • Type: java.lang.Boolean
  • Since: 1.0.0
  • Required: No
  • User Property: includeMessaging
  • Default: false

<license>

Typically one of: LGPL, EVAL, PRO, POWER, ENTERPRISE. Although it is also valid to specify optional modules ANALYTICS_MODULE or MESSAGING_MODULE, generally prefer the includeAnalytics / includeMessaging properties, respectively, to cause the optional modules to be included with the base installation / deployment.
  • Type: com.isomorphic.maven.packaging.License
  • Since: 1.0.0
  • Required: Yes
  • User Property: license

<overwrite>

If true, any file previously downloaded / unpacked will be overwritten with this execution. Useful in the case of an interrupted download. Note that this setting has no effect on unzip operations.
  • Type: java.lang.Boolean
  • Since: 1.0.0
  • Required: No
  • User Property: overwrite
  • Default: false

<product>

One of SMARTGWT, SMARTCLIENT.
  • Type: com.isomorphic.maven.packaging.Product
  • Since: 1.0.0
  • Required: No
  • User Property: product
  • Default: SMARTGWT

<serverId>

The id of a server configuration containing authentication credentials for the smartclient.com website, used to download licensed products.

Not strictly necessary for unprotected (LGPL) distributions.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: serverId
  • Default: smartclient-developer

<skins>

Limits the skins installed with the runtime to the names in this comma-separated list. E.g., -Dskins=Tahoe,Stratus will remove all skins except Tahoe and Stratus. Note that these deleted resources cannot be recovered except by reinstalling the artifact(s) to your repository.
  • Type: java.lang.String
  • Since: 1.4.6
  • Required: No
  • User Property: skins

<skipDownload>

If true, no attempt is made to download any remote distribution. Files will be loaded instead from a path constructed of the following parts (e.g., C:/downloads/SmartGWT/PowerEdition/4.1d/2013-12-25/zip):
  • workdir
  • product
  • license
  • buildNumber
  • buildDate
  • "zip"
  • Type: java.lang.Boolean
  • Since: 1.0.0
  • Required: No
  • User Property: skipDownload
  • Default: false

<skipExtraction>

If true, no attempt it made to extract the contents of any distribution. Only useful in the case where some manual intervention is required between download and another step. For example, it would be possible to first run the download goal, manipulate the version number of some dependency in some POM, and then run the install goal with skipExtraction=false to prevent the modified POM from being overwritten.

This is the kind of thing that should generally be avoided, however.

  • Type: java.lang.Boolean
  • Required: No
  • User Property: skipExtraction
  • Default: false

<snapshots>

If true, artifacts should be versioned with the 'SNAPSHOT' qualifier, in the case of development builds only. The setting has no effect on patch builds.

If false, each artifact's POM file is modified to remove the unwanted qualifier. This can be useful if you need to deploy a development build to a production environment.

  • Type: java.lang.Boolean
  • Since: 1.0.0
  • Required: No
  • User Property: snapshots
  • Default: true

<workdir>

The path to some directory that is to be used for storing downloaded files, working copies, and so on.
  • Type: java.io.File
  • Since: 1.0.0
  • Required: No
  • User Property: workdir
  • Default: ${java.io.tmpdir}/${project.artifactId}

Back to top

Reflow Maven skin by Andrius Velykis.