Full name:

com.isomorphic:isc-maven-plugin:1.4.5:install

Description:

Installs a collection of Modules to the user's local repository. Functionally, pretty much just like the Install Plugin's install-file goal, except this one works on a collection.

Refer to http://maven.apache.org/plugins/maven-install-plugin/install-file-mojo.html

Attributes:

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 is: 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 is: 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, 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.
User property is: 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 value is: false.
User property is: 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 value is: false.
User property is: 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 value is: false.
User property is: 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 value is: false.
User property is: overwrite.
product Product 1.0.0 One of SMARTGWT, SMARTCLIENT, or SMARTGWT_MOBILE.
Default value is: SMARTGWT.
User property is: 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 value is: smartclient-developer.
User property is: serverId.
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 value is: false.
User property is: 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 value is: false.
User property is: 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 value is: true.
User property is: 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 value is: ${java.io.tmpdir}/${project.artifactId}.
User property is: 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, 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.
  • 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, or SMARTGWT_MOBILE.
  • 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

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.