isc:install-reify-onsite
Full name:
com.isomorphic:isc-maven-plugin:1.5.0:install-reify-onsite
Description:
Downloads and unpacks a Reify OnSite distribution and deploys it to targetDir
. Note that the current version of this goal only supports installing the SmartClient version of Reify OnSite. Isomorphic does also provide a version of Reify OnSite packaged as a SmartGWT application, but that is outside the scope of this plugin.
Note that Reify OnSite is NOT a Maven project, This goal installs the actual product in the target directory you specify; it does not install files to any Maven cache or repository.
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 com.isomorphic.maven.mojo.AbstractPackagerMojo.product
. e.g., 13.1p, 15.0d. Used to determine both remote and local file locations.User Property: buildNumber |
<targetDir> |
String |
1.5.0 |
Path to the directory where Reify OnSite should be installed. By default, this directory will be created if necessary - see createDir
. If the target directory already exists and is not empty, by default this goal will fail - see overwriteTarget
As described in the User Property: targetDir |
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., 2025-10-13. Used to determine both remote and local file locations. Note that if no value is provided, and com.isomorphic.maven.mojo.AbstractPackagerMojo.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 |
<createDir> |
Boolean |
1.5.0 |
If the targetDir
does not exist, should we create it automatically, including any parent directories necessary? Defaults to trueDefault: trueUser Property: createDir |
<license> |
License |
1.0.0 |
Technically the license should be "ENTERPRISE", but there is no need to specify it (and indeed it will be ignored if you do). ENTERPRISE is implied for the Reify OnSite goals, so we force it to that setting Default: ENTERPRISEUser Property: license |
<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: falseUser Property: overwrite |
<overwriteTarget> |
Boolean |
1.5.0 |
If the targetDir
already exists and is not empty, should we proceed anyway? By default, the goal will failDefault: falseUser Property: overwriteTarget |
<port> |
String |
1.5.0 |
The HTTP port that Reify OnSite should listen on, in standalone
mode. Defaults to "8080". Ignored if we are not installing in standalone modeDefault: 8080User Property: port |
<product> |
Product |
1.0.0 |
Technically the product should be "REIFY_ONSITE", but there is no need to specify it (and indeed it will be ignored if you do). REIFY_ONSITE is implied for the Reify OnSite goals, so we force it to that setting Default: REIFY_ONSITEUser 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-developerUser Property: serverId |
<skins> |
String |
1.5.0 |
Limits the skins installed with Reify OnSite to the names in this comma-separated list. E.g., -Dskins=Tahoe,Stratus will remove all skins except Tahoe and Stratus (plus a couple that are always installed because various parts of the system expect them to be present)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):
Default: falseUser Property: skipDownload |
<standalone> |
Boolean |
1.5.0 |
Reify OnSite bundles an embedded version of Tomcat which enables it to run standalone with a simple CLI command. It can also be installed as a regular webapp under an existing installation of Tomcat (or whatever other servlet engine you wish to use). By default we install for standalone use; if you do not intend to run standalone, set standalone=false and the plugin will not deploy the standalone elements (but also read the important proviso about restrictions on targetDir
when not running in standalone mode)Default: trueUser Property: standalone |
<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>
Note that if no value is provided, and
com.isomorphic.maven.mojo.AbstractPackagerMojo.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>
com.isomorphic.maven.mojo.AbstractPackagerMojo.product
. e.g., 13.1p, 15.0d. Used to determine both remote and local file locations.
- Type:
java.lang.String - Since:
1.0.0 - Required:
Yes - User Property:
buildNumber
<createDir>
targetDir
does not exist, should we create it automatically, including any parent directories necessary? Defaults to true
- Type:
java.lang.Boolean - Since:
1.5.0 - Required:
No - User Property:
createDir - Default:
true
<license>
- Type:
com.isomorphic.maven.packaging.License - Since:
1.0.0 - Required:
No - User Property:
license - Default:
ENTERPRISE
<overwrite>
- Type:
java.lang.Boolean - Since:
1.0.0 - Required:
No - User Property:
overwrite - Default:
false
<overwriteTarget>
targetDir
already exists and is not empty, should we proceed anyway? By default, the goal will fail
- Type:
java.lang.Boolean - Since:
1.5.0 - Required:
No - User Property:
overwriteTarget - Default:
false
<port>
standalone
mode. Defaults to "8080". Ignored if we are not installing in standalone mode
- Type:
java.lang.String - Since:
1.5.0 - Required:
No - User Property:
port - Default:
8080
<product>
- Type:
com.isomorphic.maven.packaging.Product - Since:
1.0.0 - Required:
No - User Property:
product - Default:
REIFY_ONSITE
<serverId>
Not strictly necessary for unprotected (LGPL) distributions.
- Type:
java.lang.String - Since:
1.0.0 - Required:
No - User Property:
serverId - Default:
smartclient-developer
<skins>
-Dskins=Tahoe,Stratus will remove all skins except Tahoe and Stratus (plus a couple that are always installed because various parts of the system expect them to be present)
- Type:
java.lang.String - Since:
1.5.0 - Required:
No - User Property:
skins
<skipDownload>
com.isomorphic.maven.mojo.AbstractPackagerMojo.workdircom.isomorphic.maven.mojo.AbstractPackagerMojo.productcom.isomorphic.maven.mojo.AbstractPackagerMojo.licensecom.isomorphic.maven.mojo.AbstractPackagerMojo.buildNumbercom.isomorphic.maven.mojo.AbstractPackagerMojo.buildDate- "zip"
- Type:
java.lang.Boolean - Since:
1.0.0 - Required:
No - User Property:
skipDownload - Default:
false
<standalone>
targetDir
when not running in standalone mode)
- Type:
java.lang.Boolean - Since:
1.5.0 - Required:
No - User Property:
standalone - Default:
true
<targetDir>
createDir
. If the target directory already exists and is not empty, by default this goal will fail - see
overwriteTarget
As described in the standalone
property docs, Reify OnSite can run standalone or as a regular webapp. If you are running standalone (the default), you can deploy to any target directory you like. If you are deploying as a regular webapp in an existing server, the targetDir MUST be the directory configured as the context root in your servlet container - for example, in Tomcat it should be "tomcat/webapps/ROOT", in other servlet engines you often configure it with a <context-root> tag or similar. This is because Reify OnSite is literally the exact same code running at https://create.reify.com, including the automatic redirecting we do for authentication, so it expects to be running in the context root and will fail if you try to run it elsewhere.
- Type:
java.lang.String - Since:
1.5.0 - Required:
Yes - User Property:
targetDir
<workdir>
- Type:
java.io.File - Since:
1.0.0 - Required:
No - User Property:
workdir - Default:
${java.io.tmpdir}/${project.artifactId}