aem:deploy

Full name:

com.unic.maven.plugins:aem-maven-plugin:2.0.17-SNAPSHOT:deploy

Description:

Deploys a CRX package from either local files (e.g. residing within the build directory) or from configured maven artifacts.

Attributes:

Optional Parameters

Name Type Since Description
<adminPassword> String - The password of the "admin" user.
Default value is: admin.
User property is: password.
<aemType> AemMojo$AemType - The instance type, e.g. "author" or "publish".
Default value is: author.
User property is: aem.type.
<baseUrl> String - The schema + hostname of the AEM instance, e.g. "http://localhost".
Default value is: http://localhost.
User property is: base.url.
<contextPath> String - The context path of the AEM instance.
User property is: context.path.
<debugEnabled> boolean - Whether remote debugging shall be available for the started instance via the configured port.
Default value is: true.
User property is: debug.enabled.
<debugPort> int - Use this debug port for remote debugging on the instance.
Default value is: 30303.
User property is: debug.port.
<deployArtifacts> String[] - The artifacts to deploy, in format <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>
User property is: deploy.artifacts.
<deployFiles> File[] - The packages to deploy directly from the file system.
User property is: deploy.files.
<deployRetries> int - The number of times an file upload may be re-tried
Default value is: 3.
User property is: deploy.retries.
<deploySaveThreshold> int - The number of nodes after which an intermediate save is triggered during deployment.
Default value is: 4096.
User property is: deploy.saveThreshold.
<deploySubpackages> boolean - Whether to extract subpackages.
Default value is: true.
User property is: deploy.subPackages.
<httpPort> int - The AEM HTTP port. Defaults to 4502 for an author and 4503 for a publish AEM type.
Default value is: -1.
User property is: http.port.
<javaHome> String - Use this JRE to start the AEM instance.
Default value is: ${java.home}.
User property is: java.home.
<pauseJcrInstaller> boolean - Enable the "Pause/resume JCR Installer" feature. By default it is disabled. This feature is only available for AEM 6.1+. See also: https://issues.apache.org/jira/browse/SLING-3747
User property is: pause.jcrInstaller.
<useControlPort> boolean - If true the AEM Control Port feature is enabled and used for stopping the instance. If false the system console HTTP API is used to stop the AEM instance.
Default value is: true.
User property is: use.controlport.

Parameter Details

<adminPassword>

The password of the "admin" user.
  • Type: java.lang.String
  • Required: No
  • User Property: password
  • Default: admin

<aemType>

The instance type, e.g. "author" or "publish".
  • Type: com.unic.maven.plugins.aem.mojos.AemMojo$AemType
  • Required: No
  • User Property: aem.type
  • Default: author

<baseUrl>

The schema + hostname of the AEM instance, e.g. "http://localhost".
  • Type: java.lang.String
  • Required: No
  • User Property: base.url
  • Default: http://localhost

<contextPath>

The context path of the AEM instance.
  • Type: java.lang.String
  • Required: No
  • User Property: context.path

<debugEnabled>

Whether remote debugging shall be available for the started instance via the configured port.
  • Type: boolean
  • Required: No
  • User Property: debug.enabled
  • Default: true

<debugPort>

Use this debug port for remote debugging on the instance.
  • Type: int
  • Required: No
  • User Property: debug.port
  • Default: 30303

<deployArtifacts>

The artifacts to deploy, in format <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>
  • Type: java.lang.String[]
  • Required: No
  • User Property: deploy.artifacts

<deployFiles>

The packages to deploy directly from the file system.
  • Type: java.io.File[]
  • Required: No
  • User Property: deploy.files

<deployRetries>

The number of times an file upload may be re-tried
  • Type: int
  • Required: No
  • User Property: deploy.retries
  • Default: 3

<deploySaveThreshold>

The number of nodes after which an intermediate save is triggered during deployment.
  • Type: int
  • Required: No
  • User Property: deploy.saveThreshold
  • Default: 4096

<deploySubpackages>

Whether to extract subpackages.
  • Type: boolean
  • Required: No
  • User Property: deploy.subPackages
  • Default: true

<httpPort>

The AEM HTTP port. Defaults to 4502 for an author and 4503 for a publish AEM type.
  • Type: int
  • Required: No
  • User Property: http.port
  • Default: -1

<javaHome>

Use this JRE to start the AEM instance.
  • Type: java.lang.String
  • Required: No
  • User Property: java.home
  • Default: ${java.home}

<pauseJcrInstaller>

Enable the "Pause/resume JCR Installer" feature. By default it is disabled. This feature is only available for AEM 6.1+. See also: https://issues.apache.org/jira/browse/SLING-3747
  • Type: boolean
  • Required: No
  • User Property: pause.jcrInstaller

<useControlPort>

If true the AEM Control Port feature is enabled and used for stopping the instance. If false the system console HTTP API is used to stop the AEM instance.
  • Type: boolean
  • Required: No
  • User Property: use.controlport
  • Default: true