amp:amp

Full name:

org.alfresco.maven.plugin:maven-amp-plugin:2.0.1:amp

Description:

Build a amp/webapp.

Note this is a modification of Emmanuel Venisse's (evenisse@apache.org) WAR Mojo and has been adapted to build an Alfresco AMP.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
mAmpConfigDirectory File - Single directory for extra files to include in the AMP.
mAmpDirectory File - The directory where the webapp is built.
mAmpName String - The name of the generated AMP.
mAmpWebDirectory File - Single directory for extra files to include in the AMP.
mCacheFile File 2.1 The file containing the webapp structure cache.
mOutputDirectory String - The directory for the generated AMP.
mWorkDirectory File - Directory to unpack dependent AMPs into if needed

Optional Parameters

Name Type Since Description
archive MavenArchiveConfiguration - The maven archive configuration to use.
dependentAmpExcludes String - The comma separated list of tokens to exclude when doing a AMP overlay.
dependentAmpIncludes String - The comma separated list of tokens to include when doing a AMP overlay. Default is '**'
filters List - Filters (property files) to include during the interpolation of the pom.xml.
mAmpJarExcludes String - The comma separated list of tokens to exclude from the AMP created JAR file. By default module configuration is left outside jars. Default value is: alfresco/module/**.
mAmpJarIncludes String - The comma separated list of tokens to include in the AMP internal JAR. Default **. Default is '**'.
mAmpResources Resource[] - The list of webResources we want to transfer.
mAmpWebExcludes String - The comma separated list of tokens to exclude from the AMP created JAR file. By default module configuration is left outside jars.
mAmpWebIncludes String - The comma separated list of tokens to include in the AMP internal JAR. Default **. Default is '**'. Default value is: **.
mClassifier String - Classifier to add to the artifact generated. If given, the artifact will be an attachment instead.
mModuleProperties File - The path to the web.xml file to use. Default value is: ${project.basedir}/module.properties.
mOutputFileNameMapping String 2.0.3 The file name mapping to use to copy libraries and tlds. If no file mapping is set (default) the file is copied with its standard name.
mOverlays List 2.1 The overlays to apply.
mPrimaryArtifact boolean - Whether this is the main artifact being built. Set to false if you don't want to install or deploy it to the local repository instead of the default one in an execution. Default value is: true.
mUseCache boolean 2.1 Whether the cache should be used to save the status of the webapp accross multiple runs. Default value is: true.

Parameter Details

archive :

The maven archive configuration to use.

  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

dependentAmpExcludes :

The comma separated list of tokens to exclude when doing a AMP overlay.

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

dependentAmpIncludes :

The comma separated list of tokens to include when doing a AMP overlay. Default is '**'

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

filters :

Filters (property files) to include during the interpolation of the pom.xml.

  • Type: java.util.List
  • Required: No
  • Expression: ${project.build.filters}

mAmpConfigDirectory :

Single directory for extra files to include in the AMP.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.outputDirectory}

mAmpDirectory :

The directory where the webapp is built.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/${project.build.finalName}

mAmpJarExcludes :

The comma separated list of tokens to exclude from the AMP created JAR file. By default module configuration is left outside jars.

  • Type: java.lang.String
  • Required: No
  • Default: alfresco/module/**

mAmpJarIncludes :

The comma separated list of tokens to include in the AMP internal JAR. Default **. Default is '**'.

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

mAmpName :

The name of the generated AMP.

  • Type: java.lang.String
  • Required: Yes
  • Expression: ${project.build.finalName}

mAmpResources :

The list of webResources we want to transfer.

  • Type: org.apache.maven.model.Resource[]
  • Required: No

mAmpWebDirectory :

Single directory for extra files to include in the AMP.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/main/webapp

mAmpWebExcludes :

The comma separated list of tokens to exclude from the AMP created JAR file. By default module configuration is left outside jars.

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

mAmpWebIncludes :

The comma separated list of tokens to include in the AMP internal JAR. Default **. Default is '**'.

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

mCacheFile :

The file containing the webapp structure cache.

  • Type: java.io.File
  • Since: 2.1
  • Required: Yes
  • Expression: ${project.build.directory}/amp/work/amp-cache.xml

mClassifier :

Classifier to add to the artifact generated. If given, the artifact will be an attachment instead.

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

mModuleProperties :

The path to the web.xml file to use.

  • Type: java.io.File
  • Required: No
  • Expression: ${maven.amp.moduleProperties}
  • Default: ${project.basedir}/module.properties

mOutputDirectory :

The directory for the generated AMP.

  • Type: java.lang.String
  • Required: Yes
  • Expression: ${project.build.directory}

mOutputFileNameMapping :

The file name mapping to use to copy libraries and tlds. If no file mapping is set (default) the file is copied with its standard name.

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

mOverlays :

The overlays to apply.

  • Type: java.util.List
  • Since: 2.1
  • Required: No

mPrimaryArtifact :

Whether this is the main artifact being built. Set to false if you don't want to install or deploy it to the local repository instead of the default one in an execution.

  • Type: boolean
  • Required: No
  • Expression: ${primaryArtifact}
  • Default: true

mUseCache :

Whether the cache should be used to save the status of the webapp accross multiple runs.

  • Type: boolean
  • Since: 2.1
  • Required: No
  • Expression: ${useCache}
  • Default: true

mWorkDirectory :

Directory to unpack dependent AMPs into if needed

  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/amp/work