Full name:

io.wcm.devops.conga.plugins:conga-aem-maven-plugin:1.9.1-SNAPSHOT:package-install

Description:

Installs all AEM content packages to AEM which are referenced in a model.yaml generated by CONGA for a node.

Attributes:

Required Parameters

Name Type Since Description
<nodeDirectory> File - Directory with the generated CONGA configuration containing the model.yaml.
User property is: conga.nodeDirectory.
<password> String - The password to authenticate against the remote CRX system.
Default value is: admin.
User property is: vault.password.
<serviceURL> String -

The URL of the HTTP service API of the CRX package manager.

See CRX HTTP service Interface for details on this interface.


Default value is: http://localhost:4502/crx/packmgr/service.
User property is: vault.serviceURL.
<userId> String - The user name to authenticate as against the remote CRX system.
Default value is: admin.
User property is: vault.userId.

Optional Parameters

Name Type Since Description
<bundleStatusBlacklistBundleNames> String[] - Patterns for symbolic names of bundles that are expected to be not present in bundle list. If any of these bundles are found in the bundle list, this system is assumed as not ready for installing further packages because a previous installation (e.g. of AEM service pack) is still in progress.
Default value is: ^updater\.aem.*$.
User property is: vault.bundleStatusBlacklistBundleNames.
<bundleStatusURL> String -

Bundle status JSON URL. If an URL is configured the activation status of all bundles in the system is checked before it is tried to upload and install a new package and after each upload.

If not all packages are installed the upload is delayed up to 10 minutes, every 5 seconds the activation status is checked anew.

Expected is an URL like: http://localhost:4502/system/console/bundles/.json

If the URL is not set it is derived from serviceURL. Set to "-" to explicitly disable the status check.


User property is: vault.bundleStatusURL.
<bundleStatusWaitLimit> int - Number of seconds to wait as maximum for a positive bundle status check. If this limit is reached and the bundle status is still not positive the install of the package proceeds anyway.
Default value is: 360.
User property is: vault.bundleStatusWaitLimit.
<bundleStatusWhitelistBundleNames> String[] - Patterns for symbolic names of bundles that are ignored in bundle list. The state of these bundles has no effect on the bundle status check.
Default value is: ^com\.day\.crx\.crxde-support$,^com\.adobe\.granite\.crx-explorer$,^com\.adobe\.granite\.crxde-lite$.
User property is: vault.bundleStatusWhitelistBundleNames.
<delayAfterInstallSec> Integer - Delay further steps after package installation by this amount of seconds
User property is: vault.delayAfterInstallSec.
<force> Boolean - Force upload and install of content package. If set to:
  • true: Package is always installed, even if it was already uploaded before.
  • false: Package is only installed if it was not already uploade before.
  • nothing (default): Force is applied to packages with the string "-SNAPSHOT" in it's filename.

User property is: vault.force.
<httpConnectTimeoutSec> int - HTTP connection timeout (in seconds).
Default value is: 10.
User property is: vault.httpConnectTimeoutSec.
<httpSocketTimeout> int - HTTP socket timeout (in seconds).
Default value is: 60.
User property is: vault.httpSocketTimeoutSec.
<install> boolean - Whether to install (unpack) the uploaded package automatically or not.
Default value is: true.
User property is: vault.install.
<recursive> boolean - If set to true nested packages get installed as well.
Default value is: true.
User property is: vault.recursive.
<relaxedSSLCheck> boolean - If set to true also self-signed certificates are accepted.
Default value is: false.
User property is: vault.relaxedSSLCheck.
<retryCount> int - Number of times to retry upload and install via CRX HTTP interface if it fails.
Default value is: 24.
User property is: vault.retryCount.
<retryDelay> int - Number of seconds between retry attempts.
Default value is: 5.
User property is: vault.retryDelay.
<skip> boolean - Set this to "true" to skip installing packages to CRX although configured in the POM.
Default value is: false.
User property is: vault.skip.

Parameter Details

<bundleStatusBlacklistBundleNames>

Patterns for symbolic names of bundles that are expected to be not present in bundle list. If any of these bundles are found in the bundle list, this system is assumed as not ready for installing further packages because a previous installation (e.g. of AEM service pack) is still in progress.
  • Type: java.lang.String[]
  • Required: No
  • User Property: vault.bundleStatusBlacklistBundleNames
  • Default: ^updater\.aem.*$

<bundleStatusURL>

Bundle status JSON URL. If an URL is configured the activation status of all bundles in the system is checked before it is tried to upload and install a new package and after each upload.

If not all packages are installed the upload is delayed up to 10 minutes, every 5 seconds the activation status is checked anew.

Expected is an URL like: http://localhost:4502/system/console/bundles/.json

If the URL is not set it is derived from serviceURL. Set to "-" to explicitly disable the status check.

  • Type: java.lang.String
  • Required: No
  • User Property: vault.bundleStatusURL

<bundleStatusWaitLimit>

Number of seconds to wait as maximum for a positive bundle status check. If this limit is reached and the bundle status is still not positive the install of the package proceeds anyway.
  • Type: int
  • Required: No
  • User Property: vault.bundleStatusWaitLimit
  • Default: 360

<bundleStatusWhitelistBundleNames>

Patterns for symbolic names of bundles that are ignored in bundle list. The state of these bundles has no effect on the bundle status check.
  • Type: java.lang.String[]
  • Required: No
  • User Property: vault.bundleStatusWhitelistBundleNames
  • Default: ^com\.day\.crx\.crxde-support$,^com\.adobe\.granite\.crx-explorer$,^com\.adobe\.granite\.crxde-lite$

<delayAfterInstallSec>

Delay further steps after package installation by this amount of seconds
  • Type: java.lang.Integer
  • Required: No
  • User Property: vault.delayAfterInstallSec

<force>

Force upload and install of content package. If set to:
  • true: Package is always installed, even if it was already uploaded before.
  • false: Package is only installed if it was not already uploade before.
  • nothing (default): Force is applied to packages with the string "-SNAPSHOT" in it's filename.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: vault.force

<httpConnectTimeoutSec>

HTTP connection timeout (in seconds).
  • Type: int
  • Required: No
  • User Property: vault.httpConnectTimeoutSec
  • Default: 10

<httpSocketTimeout>

HTTP socket timeout (in seconds).
  • Type: int
  • Required: No
  • User Property: vault.httpSocketTimeoutSec
  • Default: 60

<install>

Whether to install (unpack) the uploaded package automatically or not.
  • Type: boolean
  • Required: No
  • User Property: vault.install
  • Default: true

<nodeDirectory>

Directory with the generated CONGA configuration containing the model.yaml.
  • Type: java.io.File
  • Required: Yes
  • User Property: conga.nodeDirectory

<password>

The password to authenticate against the remote CRX system.
  • Type: java.lang.String
  • Required: Yes
  • User Property: vault.password
  • Default: admin

<recursive>

If set to true nested packages get installed as well.
  • Type: boolean
  • Required: No
  • User Property: vault.recursive
  • Default: true

<relaxedSSLCheck>

If set to true also self-signed certificates are accepted.
  • Type: boolean
  • Required: No
  • User Property: vault.relaxedSSLCheck
  • Default: false

<retryCount>

Number of times to retry upload and install via CRX HTTP interface if it fails.
  • Type: int
  • Required: No
  • User Property: vault.retryCount
  • Default: 24

<retryDelay>

Number of seconds between retry attempts.
  • Type: int
  • Required: No
  • User Property: vault.retryDelay
  • Default: 5

<serviceURL>

The URL of the HTTP service API of the CRX package manager.

See CRX HTTP service Interface for details on this interface.

  • Type: java.lang.String
  • Required: Yes
  • User Property: vault.serviceURL
  • Default: http://localhost:4502/crx/packmgr/service

<skip>

Set this to "true" to skip installing packages to CRX although configured in the POM.
  • Type: boolean
  • Required: No
  • User Property: vault.skip
  • Default: false

<userId>

The user name to authenticate as against the remote CRX system.
  • Type: java.lang.String
  • Required: Yes
  • User Property: vault.userId
  • Default: admin

Back to top

Version: 1.9.1-SNAPSHOT. Last Published: 2019-08-20.