alfresco:amp

Full name:

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

Description:

Builds an AMP archive of the current project's contents. The location of the AMP contents is ${project.build.directory}/${project.build.finalName}. Java resources (in src/main/java and src/main/resources) are packaged in a standard JAR file that is automatically bundled in the /lib folder of the AMP archive and it's treated as build artifact (i.e. distributed on Maven repositories during deploy). Maven transitive dependencies are by default added into the /lib folder of the AMP archive

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
ampBuildDirectory File 1.0 Target folder used to aggregate content then packaged into the AMP
Default value is: ${app.amp.output.folder}.
User property is: maven.alfresco.ampBuildDirectory.
ampFinalDir File 1.0 Directory of the final generated AMP
Default value is: ${project.build.directory}.
User property is: maven.alfresco.ampFinalDir.
includeDependencies boolean 1.0 Whether (runtime scoped) JAR dependencies (including transitive) should be added or not to the generated AMP /lib folder. By default it's true so all direct and transitive (runtime) dependencies will be added
Default value is: true.
User property is: maven.alfresco.includeDependencies.
includeWebResources boolean 1.0 Whether the AMP /web folder should be added or not to the generated AMP file. By default it's true so all web resources are package in the war. Can be disabled to enable quick loading of web resources from sources during development (e.g. in an IDE)
Default value is: true.
User property is: maven.alfresco.includeWebResources.

Optional Parameters

Name Type Since Description
archive MavenArchiveConfiguration 1.0 The archive configuration to use. See Maven Archiver Reference.
attachClasses boolean 1.0 Whether the JAR produced should be attached as a separate 'classes' artifact.
Default value is: false.
User property is: maven.alfresco.attachClasses.
attachConfig boolean 1.0 Whether a config artifact should be produced should be attached as a separate 'config' artifact.
Default value is: false.
User property is: maven.alfresco.attachConfig.
classifier String 1.0 Classifier to add to the artifact generated. If given, the artifact will be attached. If this is not given,it will merely be written to the output directory according to the finalName.
User property is: maven.alfresco.classifier.

Parameter Details

ampBuildDirectory:

Target folder used to aggregate content then packaged into the AMP
  • Type: java.io.File
  • Since: 1.0
  • Required: Yes
  • User Property: maven.alfresco.ampBuildDirectory
  • Default: ${app.amp.output.folder}

ampFinalDir:

Directory of the final generated AMP
  • Type: java.io.File
  • Since: 1.0
  • Required: Yes
  • User Property: maven.alfresco.ampFinalDir
  • Default: ${project.build.directory}

archive:

The archive configuration to use. See Maven Archiver Reference.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Since: 1.0
  • Required: No

attachClasses:

Whether the JAR produced should be attached as a separate 'classes' artifact.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: maven.alfresco.attachClasses
  • Default: false

attachConfig:

Whether a config artifact should be produced should be attached as a separate 'config' artifact.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: maven.alfresco.attachConfig
  • Default: false

classifier:

Classifier to add to the artifact generated. If given, the artifact will be attached. If this is not given,it will merely be written to the output directory according to the finalName.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: maven.alfresco.classifier

includeDependencies:

Whether (runtime scoped) JAR dependencies (including transitive) should be added or not to the generated AMP /lib folder. By default it's true so all direct and transitive (runtime) dependencies will be added
  • Type: boolean
  • Since: 1.0
  • Required: Yes
  • User Property: maven.alfresco.includeDependencies
  • Default: true

includeWebResources:

Whether the AMP /web folder should be added or not to the generated AMP file. By default it's true so all web resources are package in the war. Can be disabled to enable quick loading of web resources from sources during development (e.g. in an IDE)
  • Type: boolean
  • Since: 1.0
  • Required: Yes
  • User Property: maven.alfresco.includeWebResources
  • Default: true