Fork me on GitHub

project-build:installEngine

Full name:

com.axonivy.ivy.ci:project-build-plugin:7.1.0:installEngine

Description:

Downloads an AXON.IVY Engine from the NET if it does not yet exists in the correct version.

Command line invocation is supported. E.g.

mvn com.axonivy.ivy.ci:project-build-plugin:6.2.0:installEngine
-Divy.engine.directory=c:/axonviy/engine
-Divy.engine.version=6.2.0
-Divy.engine.os.arch=Linux_x64

Attributes:

  • Since version: 6.0.0.

Required Parameters

Name Type Since Description
ivyVersion String 6.0.0 The ivy Engine version or version-range that must be used. Must be equal or higher than MINIMAL_COMPATIBLE_VERSION Examples:
  • "6.1.2" means ivyVersion = 6.1.2
  • "[6.1.0,7.0.0)" means 6.1.0 <= ivyVersion < 7.0.0
  • "(6.0.0,]" means ivyVersion > 6.0.0

Default value is: 7.1.0.
User property is: ivy.engine.version.

Optional Parameters

Name Type Since Description
autoInstallEngine boolean 6.0.0 Enables the automatic installation of an ivy Engine in the engineDirectory. If there is yet no engine installed, or the ivyVersion does not match, the engine will be downloaded from the engineDownloadUrl and unpacked into the engineDirectory.
Default value is: true.
User property is: ivy.engine.auto.install.
engineCacheDirectory File 6.0.0 Location where ivy engines in required version can be extracted to.

If the Engine does not yet exist, it can be automatically downloaded.


Default value is: ${settings.localRepository}/.cache/ivy.
User property is: ivy.engine.cache.directory.
engineDirectory File 6.0.0 Location where an unpacked (may pre-configured) ivy Engine in the required version exists.

If parameter is not set it will be a sub-directory of the engineCacheDirectory.

If the Engine does not yet exist, it can be automatically downloaded.


User property is: ivy.engine.directory.
engineDownloadUrl URL 6.0.0 URL where a packed ivy Engine can be downloaded. E.g. https://developer.axonivy.com/download/6.0.10/AxonIvyEngine6.0.10.55478_Windows_x64.zip
User property is: ivy.engine.download.url.
engineListPageUrl URL 6.0.0 URL where a link to the ivy Engine in the expected ivyVersion exists. The URL will be used to download the required engine if it does not yet exist. The URL should point to a site providing HTML content with a link to the engine
e.g. <a href="https://developer.axonivy.com/download/6.0.10/AxonIvyEngine6.0.10.55478_Windows_x64.zip"> the engine</a>
Default value is: https://developer.axonivy.com/download/maven.html.
User property is: ivy.engine.list.url.
osArchitecture String 6.0.0 Engine type that will be downloaded if autoInstallEngine is set and the engine must be retrieved from the engineListPageUrl. Possible values are:
  • All_x64
  • Windows_x64
All_x64 supports Linux and Windows.
Default value is: All_x64.
User property is: ivy.engine.os.arch.

Parameter Details

autoInstallEngine:

Enables the automatic installation of an ivy Engine in the engineDirectory. If there is yet no engine installed, or the ivyVersion does not match, the engine will be downloaded from the engineDownloadUrl and unpacked into the engineDirectory.
  • Type: boolean
  • Since: 6.0.0
  • Required: No
  • User Property: ivy.engine.auto.install
  • Default: true

engineCacheDirectory:

Location where ivy engines in required version can be extracted to.

If the Engine does not yet exist, it can be automatically downloaded.

  • Type: java.io.File
  • Since: 6.0.0
  • Required: No
  • User Property: ivy.engine.cache.directory
  • Default: ${settings.localRepository}/.cache/ivy

engineDirectory:

Location where an unpacked (may pre-configured) ivy Engine in the required version exists.

If parameter is not set it will be a sub-directory of the engineCacheDirectory.

If the Engine does not yet exist, it can be automatically downloaded.

  • Type: java.io.File
  • Since: 6.0.0
  • Required: No
  • User Property: ivy.engine.directory

engineDownloadUrl:

URL where a packed ivy Engine can be downloaded. E.g. https://developer.axonivy.com/download/6.0.10/AxonIvyEngine6.0.10.55478_Windows_x64.zip
  • Type: java.net.URL
  • Since: 6.0.0
  • Required: No
  • User Property: ivy.engine.download.url

engineListPageUrl:

URL where a link to the ivy Engine in the expected ivyVersion exists. The URL will be used to download the required engine if it does not yet exist. The URL should point to a site providing HTML content with a link to the engine
e.g. <a href="https://developer.axonivy.com/download/6.0.10/AxonIvyEngine6.0.10.55478_Windows_x64.zip"> the engine</a>
  • Type: java.net.URL
  • Since: 6.0.0
  • Required: No
  • User Property: ivy.engine.list.url
  • Default: https://developer.axonivy.com/download/maven.html

ivyVersion:

The ivy Engine version or version-range that must be used. Must be equal or higher than MINIMAL_COMPATIBLE_VERSION Examples:
  • "6.1.2" means ivyVersion = 6.1.2
  • "[6.1.0,7.0.0)" means 6.1.0 <= ivyVersion < 7.0.0
  • "(6.0.0,]" means ivyVersion > 6.0.0
  • Type: java.lang.String
  • Since: 6.0.0
  • Required: Yes
  • User Property: ivy.engine.version
  • Default: 7.1.0

osArchitecture:

Engine type that will be downloaded if autoInstallEngine is set and the engine must be retrieved from the engineListPageUrl. Possible values are:
  • All_x64
  • Windows_x64
All_x64 supports Linux and Windows.
  • Type: java.lang.String
  • Since: 6.0.0
  • Required: No
  • User Property: ivy.engine.os.arch
  • Default: All_x64