wcm.io

wcmio-content-package:download

Full name:

io.wcm.maven.plugins:wcmio-content-package-maven-plugin:2.1.7-SNAPSHOT:download

Description:

Builds and downloads a content package defined on a remote CRX or AEM system.

Attributes:

  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: install.

Required Parameters

Name Type Since Description
<outputFile> String - The output file to save.
Default value is: ${project.build.directory}/${project.build.finalName}.zip.
User property is: vault.outputFile.
<password> String - The password to authenticate against the remote CRX system (package manager).
Default value is: admin.
User property is: vault.password.
<serviceURL> String -

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

See Package Manager HTTP API 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 (package manager).
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 bundles are activated the upload is delayed up to bundleStatusWaitLimit seconds, 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. If set to "-" the status check is disabled.


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$,^org\.apache\.sling\.jcr\.webdav$,^org\.apache\.sling\.jcr\.davex$.
User property is: vault.bundleStatusWhitelistBundleNames.
<consoleOauth2AccessToken> String - OAuth 2 access token to authenticate against the remote CRX system (Felix console). If this is configured, username and password are ignored. Defaults to value from authenticationBearerToken.
User property is: console.consoleOauth2AccessToken.
<consolePassword> String - The password to authenticate against the remote CRX system (Felix console). Defaults to the value from password.
User property is: console.password.
<consoleUserId> String - The user name to authenticate as against the remote CRX system (Felix console). Defaults to the value from userId.
User property is: console.userId.
<contentPackagePath> String - Path of the content package to download. The path is detected automatically when uploadPackageDefinition is set to true (which is default). If set to false, the path of the content package needs to be specified explicitly.

Example path: /etc/packages/mygroup/mypackage-1.0.0-SNAPSHOT.zip


User property is: vault.download.contentPackagePath.
<dateLastReplicated> String - Sets a fixed date to be used for the "lastReplicated" property when setting replication status to "activated". If not set the current date is used.

Use ISO8601 format. Example: 2020-01-01T00:00:00.000+02:00.
<excludeFiles> String[] - List of regular patterns matching relative path of extracted content package. All files matching these patterns are excluded when unpacking the content package.
<excludeMixins> String[] - List of regular patterns matching mixin names inside a .content.xml file. All mixins matching theses patterns are removed from the .content.xml when unpacking the content package.
<excludeNodes> String[] - List of regular patterns matching node paths in the whole content package. All nodes matching theses patterns are removed from the .content.xml when unpacking the content package.
<excludeProperties> String[] - List of regular patterns matching property names inside a .content.xml file. All properties matching theses patterns are removed from the .content.xml when unpacking the content package.
<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.
<markReplicationActivated> boolean - Set replication status to "activated" for all cq:Page and cq:Template nodes.
<markReplicationActivatedIncludeNodes> String[] - List of regular patterns matching node paths in the whole content package. If markReplicationActivated is activated it affects only nodes matched by any of these patterns.
<oauth2AccessToken> String - OAuth 2 access token to authenticate against the remote CRX system (package manager). If this is configured, username and password are ignored.
User property is: vault.oauth2AccessToken.
<packageFile> File - The name of the content package file to install on the target system. If not set, the primary artifact of the project is considered the content package to be installed.
Default value is: ${project.build.directory}/${project.build.finalName}.zip.
User property is: vault.file.
<packageManagerInstallStatusURL> String -

Package Manager install status JSON URL. If an URL is configured the installation status of packages and embedded packages 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 packageManagerInstallStatusWaitLimit seconds, every 5 seconds the installation status is checked anew.

Expected is an URL like: http://localhost:4502/crx/packmgr/installstatus.jsp

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


User property is: vault.packageManagerInstallStatusURL.
<packageManagerInstallStatusWaitLimit> int - Number of seconds to wait as maximum for a positive package manager install status check. If this limit is reached and the package manager status is still not positive the install of the package proceeds anyway.
Default value is: 360.
User property is: vault.packageManagerInstallStatusWaitLimit.
<packageManagerOutputLogLevel> String - Log level to be used to log responses from package manager (which may get huge for large packages). Possible values are INFO (default) or DEBUG.
Default value is: INFO.
User property is: vault.packageManagerOutputLogLevel.
<rebuildPackage> boolean - Whether to rebuild the package within the CRX package manager before downloading it to include the latest content from repository.
Default value is: true.
User property is: vault.download.rebuildPackage.
<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.
<unpack> boolean - If set to true the package is unpacked to the directory specified by unpackDirectory .
Default value is: false.
User property is: vault.unpack.
<unpackDeleteDirectories> String[] - If unpack=true: delete existing content from the named directories (relative to unpackDirectory root) before unpacking the package content, to make sure only the content from the downloaded package remains.
<unpackDirectory> File - Directory to unpack the content of the package to.
Default value is: ${basedir}.
User property is: vault.unpackDirectory.
<uploadPackageDefinition> boolean - Whether to upload the local package definition first to CRX package manager before actually downloading the package. For this, the local package has to been build locally already.
Default value is: true.
User property is: vault.download.uploadPackageDefinition.

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 bundles are activated the upload is delayed up to bundleStatusWaitLimit seconds, 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. If set to "-" the status check is disabled.

  • 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$,^org\.apache\.sling\.jcr\.webdav$,^org\.apache\.sling\.jcr\.davex$

<consoleOauth2AccessToken>

OAuth 2 access token to authenticate against the remote CRX system (Felix console). If this is configured, username and password are ignored. Defaults to value from authenticationBearerToken.
  • Type: java.lang.String
  • Required: No
  • User Property: console.consoleOauth2AccessToken

<consolePassword>

The password to authenticate against the remote CRX system (Felix console). Defaults to the value from password.
  • Type: java.lang.String
  • Required: No
  • User Property: console.password

<consoleUserId>

The user name to authenticate as against the remote CRX system (Felix console). Defaults to the value from userId.
  • Type: java.lang.String
  • Required: No
  • User Property: console.userId

<contentPackagePath>

Path of the content package to download. The path is detected automatically when uploadPackageDefinition is set to true (which is default). If set to false, the path of the content package needs to be specified explicitly.

Example path: /etc/packages/mygroup/mypackage-1.0.0-SNAPSHOT.zip

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

<dateLastReplicated>

Sets a fixed date to be used for the "lastReplicated" property when setting replication status to "activated". If not set the current date is used.

Use ISO8601 format. Example: 2020-01-01T00:00:00.000+02:00.

  • Type: java.lang.String
  • Required: No

<excludeFiles>

List of regular patterns matching relative path of extracted content package. All files matching these patterns are excluded when unpacking the content package.
  • Type: java.lang.String[]
  • Required: No

<excludeMixins>

List of regular patterns matching mixin names inside a .content.xml file. All mixins matching theses patterns are removed from the .content.xml when unpacking the content package.
  • Type: java.lang.String[]
  • Required: No

<excludeNodes>

List of regular patterns matching node paths in the whole content package. All nodes matching theses patterns are removed from the .content.xml when unpacking the content package.
  • Type: java.lang.String[]
  • Required: No

<excludeProperties>

List of regular patterns matching property names inside a .content.xml file. All properties matching theses patterns are removed from the .content.xml when unpacking the content package.
  • Type: java.lang.String[]
  • Required: No

<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

<markReplicationActivated>

Set replication status to "activated" for all cq:Page and cq:Template nodes.
  • Type: boolean
  • Required: No

<markReplicationActivatedIncludeNodes>

List of regular patterns matching node paths in the whole content package. If markReplicationActivated is activated it affects only nodes matched by any of these patterns.
  • Type: java.lang.String[]
  • Required: No

<oauth2AccessToken>

OAuth 2 access token to authenticate against the remote CRX system (package manager). If this is configured, username and password are ignored.
  • Type: java.lang.String
  • Required: No
  • User Property: vault.oauth2AccessToken

<outputFile>

The output file to save.
  • Type: java.lang.String
  • Required: Yes
  • User Property: vault.outputFile
  • Default: ${project.build.directory}/${project.build.finalName}.zip

<packageFile>

The name of the content package file to install on the target system. If not set, the primary artifact of the project is considered the content package to be installed.
  • Type: java.io.File
  • Required: No
  • User Property: vault.file
  • Default: ${project.build.directory}/${project.build.finalName}.zip

<packageManagerInstallStatusURL>

Package Manager install status JSON URL. If an URL is configured the installation status of packages and embedded packages 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 packageManagerInstallStatusWaitLimit seconds, every 5 seconds the installation status is checked anew.

Expected is an URL like: http://localhost:4502/crx/packmgr/installstatus.jsp

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

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

<packageManagerInstallStatusWaitLimit>

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

<packageManagerOutputLogLevel>

Log level to be used to log responses from package manager (which may get huge for large packages). Possible values are INFO (default) or DEBUG.
  • Type: java.lang.String
  • Required: No
  • User Property: vault.packageManagerOutputLogLevel
  • Default: INFO

<password>

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

<rebuildPackage>

Whether to rebuild the package within the CRX package manager before downloading it to include the latest content from repository.
  • Type: boolean
  • Required: No
  • User Property: vault.download.rebuildPackage
  • 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 Package Manager HTTP API 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

<unpack>

If set to true the package is unpacked to the directory specified by unpackDirectory .
  • Type: boolean
  • Required: No
  • User Property: vault.unpack
  • Default: false

<unpackDeleteDirectories>

If unpack=true: delete existing content from the named directories (relative to unpackDirectory root) before unpacking the package content, to make sure only the content from the downloaded package remains.
  • Type: java.lang.String[]
  • Required: No

<unpackDirectory>

Directory to unpack the content of the package to.
  • Type: java.io.File
  • Required: No
  • User Property: vault.unpackDirectory
  • Default: ${basedir}

<uploadPackageDefinition>

Whether to upload the local package definition first to CRX package manager before actually downloading the package. For this, the local package has to been build locally already.
  • Type: boolean
  • Required: No
  • User Property: vault.download.uploadPackageDefinition
  • Default: true

<userId>

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

Back to top

Copyright ©2014-2023 wcm.io. All Rights Reserved.

Version: 2.1.7-SNAPSHOT. Last Published: 2023-10-17.