alfresco:install

Full name:

org.alfresco.maven.plugin:alfresco-maven-plugin:4.2.0-SNAPSHOT:install

Description:

Performs a AMP to WAR overlay invoking the Alfresco Repository ModuleManagementTool. It therefore wraps and emulates the same WAR overlay performed by Alfresco MMT.

This goal will install the AMP file(s) found in ${ampLocation} onto the WAR (or exploded WAR) found in ${warLocation}

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Since version: 1.0.

Optional Parameters

Name Type Since Description
ampLocation File 1.0 The location of the AMP file(s) to be installed. If this location is a folder all AMPs contained in the folder are installed, if it's a file it get directly installed on the ${warLocation}
Default value is: ${project.build.directory}/${project.build.finalName}.amp.
User property is: maven.alfresco.ampLocation.
backup boolean 1.0 Whether Alfresco MMT should produce backups while installing. Defaults to false to speed up development, set to true for Production AMP installations
Default value is: false.
User property is: maven.alfresco.backup.
force boolean 1.0 Whether Alfresco MMT should be force installation of AMPs
Default value is: true.
User property is: maven.alfresco.force.
skipAmpInstallation boolean 1.0 Whether or not to skip the attempt to install the AMP in the warLocation altogether
Default value is: false.
User property is: maven.alfresco.skipAmpInstallation.
skipWarManifestCheck boolean 1.0 Whether or not to skip the check for a manifest file in the warLocation
Default value is: false.
User property is: maven.alfresco.skipWarManifestCheck.
verbose boolean 1.0 Whether Alfresco MMT should be executed in verbose mode
Default value is: false.
User property is: maven.alfresco.verbose.
warLocation File 1.0 The WAR file or exploded dir to install the AMPs in. If specified Defaults to "${app.amp.client.war.folder}
Default value is: ${app.amp.client.war.folder}.
User property is: maven.alfresco.warLocation.

Parameter Details

ampLocation:

The location of the AMP file(s) to be installed. If this location is a folder all AMPs contained in the folder are installed, if it's a file it get directly installed on the ${warLocation}
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • User Property: maven.alfresco.ampLocation
  • Default: ${project.build.directory}/${project.build.finalName}.amp

backup:

Whether Alfresco MMT should produce backups while installing. Defaults to false to speed up development, set to true for Production AMP installations
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: maven.alfresco.backup
  • Default: false

force:

Whether Alfresco MMT should be force installation of AMPs
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: maven.alfresco.force
  • Default: true

skipAmpInstallation:

Whether or not to skip the attempt to install the AMP in the warLocation altogether
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: maven.alfresco.skipAmpInstallation
  • Default: false

skipWarManifestCheck:

Whether or not to skip the check for a manifest file in the warLocation
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: maven.alfresco.skipWarManifestCheck
  • Default: false

verbose:

Whether Alfresco MMT should be executed in verbose mode
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: maven.alfresco.verbose
  • Default: false

warLocation:

The WAR file or exploded dir to install the AMPs in. If specified Defaults to "${app.amp.client.war.folder}
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • User Property: maven.alfresco.warLocation
  • Default: ${app.amp.client.war.folder}