Adobe Content Package Maven Plugin

Use the Adobe Content Package Maven plugin to integrate package deployment and management tasks into your Maven projects.

The deployment of the constructed packages to AEM is performed by the Adobe Content Package Maven plugin and enables the automation of tasks normally performed using AEM Package Manager:

  • Create new packages from files in the file system.
  • Install and uninstall packages on AEM.
  • Build packages that are already defined on AEM.
  • Obtain a list of packages that are installed on AEM.
  • Remove a package from AEM.

This document details how to use the Maven to manage these tasks. However it is also important to understand how AEM projects and their packages are structured.

NOTE

Package creation is now owned by the Apache Jackrabbit FileVault Package Maven plugin. The deployment of the constructed packages to AEM is performed by the Adobe Content Package Maven plugin as described here.

Packages and the AEM Project Structure

AEM 6.5 adheres to the latest best practices for package management and project structure as implemented by the latest AEM Project Archetype for both on-premises and AMS implementations.

TIP

For further details, see the AEM Project Structure article in the AEM as a Cloud Service documentation as well as the AEM Project Archetype documentation. Both of which are fully-supported for AEM 6.5.

Obtaining the Content Package Maven Plugin

The plugin is available from the Maven Central Repository.

Content Package Maven Plugin Goals and Parameters

To use the Content Package Maven Plugin, add the following plugin element inside the build element of your POM file:

<plugin>
 <groupId>com.day.jcr.vault</groupId>
 <artifactId>content-package-maven-plugin</artifactId>
 <version>0.0.24</version>
 <configuration>
       <!-- parameters and values common to all goals, as required -->
 </configuration>
</plugin>

To enable Maven to download the plugin, use the profile provided in the Obtaining the Content Package Maven Plugin section on this page.

Goals of the Content Package Maven Plugin

The goals and goal parameters that the Content Package plugin provides are described in the sections that follow. Parameters that are described in the Common Parameters section can be used for most of the goals. Parameters that apply to one goal are described in the section for that goal.

Plugin Prefix

The plugin prefix is content-package. Use this prefix to execute a goal from the command line, as in the following example:

mvn content-package:build

Parameter Prefix

Unless otherwise noted, the plugin goals and parameters use the vault prefix, as in the following example:

mvn content-package:install -Dvault.targetURL="https://192.168.1.100:4502/crx/packmgr/service.jsp"

Proxies

Goals that use proxies for AEM use the first valid proxy configuration found in the Maven settings. If no proxy configuration is found, no proxy is used. See the useProxy parameter in the Common Parameters section.

Common Parameters

The parameters in the following table are common to all goals except when noted in the Goals column.

Name Type Required Default Value Description Goals
failOnError boolean No false A value of true causes the build to fail when an error occurs. A value of false causes the build to ignore the error. All goals except package
name String build: Yes, install: No, rm: Yes build: No default, install: The value of the artifactId property of the Maven project The name of the package to act on All goals except ls
password String Yes admin The password used for authentication with AEM All goals except package
serverId String No The server ID from which to retrieve the user name and password for authentication All goals except package
targetURL String Yes http://localhost:4502/crx/packmgr/service.jsp The URL of the HTTP service API of the AEM package manager All goals except package
timeout int No 5 The connection timeout for communicating with the package manager service, in seconds All goals except package
useProxy boolean No true A value of true causes Maven to use the first active proxy configuration found in order to proxy requests to the Package Manager. All goals except package
userId String Yes admin The user name to authenticate with AEM All goals except package
verbose boolean No false Enables or disables verbose logging All goals except package

build

Builds a content package that is already defined on an AEM instance.

NOTE

This goal does not need to be executed within a Maven project.

Parameters

All parameters for the build goal are described in the Common Parameters section.

install

Installs a package in the repository. Execution of this goal does not require a Maven project. The goal is bound to the install phase of the Maven build lifecycle.

Parameters

In addition to the following parameters, see the descriptions in the Common Parameters section.

Name Type Required Default Value Description
artifact String No The value of the artifactId property of the Maven project A string of the form groupId:artifactId:version[:packaging]
artifactId String No None The ID of the artifact to install
groupId String No None The groupId of the artifact to install
install boolean No true Determines whether to unpack the package automatically when it is uploaded
localRepository org.apache.maven.artifact.repository.ArtifactRepository No The value of the localRepository system variable The local Maven repository which cannot be configured using the plugin configuration as the system property is always used
packageFile java.io.File No The primary artifact that is defined for the Maven project The name of the package file to install
packaging String No zip The type of packaging of the artifact to install
pomRemoteRepositories java.util.List Yes The value of the remoteArtifactRepositories property that is defined for the Maven project This value cannot be configured using the plugin configuration and must be specified in the project.
project org.apache.maven.project.MavenProject Yes The project for which the plugin is configured The Maven project which is implicit because the project contains the plugin configuration
repositoryId (POM), repoID (command line) String No temp The ID of the repository from which the artifact is retrieved
repositoryUrl (POM), repoURL (command line) String No None The URL of the repository from which the artifact is retrieved
version String No None The version of the artifact to install

ls

Lists the packages that are deployed to Package Manager.

Parameters

All parameters of the ls goal are described in the Common Parameters section.

rm

Removes a package from Package Manager.

Parameters

All parameters of the rm goal are described in the Common Parameters section.

uninstall

Uninstalls a package. The package remains on the server in the uninstalled state.

Parameters

All parameters of the uninstall goal are described in the Common Parameters section.

package

Creates a content package. The default configuration of the package goal includes the contents of the directory where compiled files are saved. The execution of the package goal requires that the compile build phase has completed. The package goal is bound to the package phase of the Maven build lifecycle.

Parameters

In addition to the following parameters, see the description of the name parameter in the Common Parameters section.

Name Type Required Default Value Description
archive org.apache.maven.archiver.MavenArchiveConfiguration No None The archive configuration to use
builtContentDirectory java.io.File Yes The value of the output directory of the Maven build The directory that contains the content to include in package
dependencies java.util.List No None
embeddedTarget java.lang.String No None
embeddeds java.util.List No None
failOnMissingEmbed boolean Yes false A value of true causes the build to fail when an embedded artifact is not found in the project dependencies. A value of false causes the build to ignore such errors.
filterSource java.io.File No None This parameter defines a file that specifies the source of the workspace filter. The filters specified in the configuration and injected via emebeds or subpackages are merged with the file content.
filters com.day.jcr.vault.maven.pack.impl.DefaultWorkspaceFilter No None This parameter contains filter elements that define the package content. When executed, the filters are included in the filter.xml file. See the Using Filters section below.
finalName java.lang.String Yes The finalName defined in the Maven project (build phase) The name of the generated package ZIP file, without the .zip file extension
group java.lang.String Yes The groupID defined in the Maven project The groupId of the generated content package which is part of the target installation path for the content package
outputDirectory java.io.File Yes The build directory defined in the Maven project The local directory where the content package is saved
prefix java.lang.String No None
project org.apache.maven.project.MavenProject Yes None The Maven project
properties java.util.Map No None These parameters define additional properties that you can set in the properties.xml file. These properties cannot overwrite the following predefined properties: group (use group parameter to set), name (use name parameter to set), version (use version parameter to set), description (set from the project description), groupId (groupId of the Maven project descriptor), artifactId (artifactId of the Maven project descriptor), dependencies (use dependencies parameter to set), createdBy (the value of the user.name system property), created (the current system time), requiresRoot (use requiresRoot parameter to set), packagePath (automatically generated from the group and package name)
requiresRoot boolean Yes false Defines whether the package requires root. This will become the requiresRoot property of the properties.xml file.
subPackages java.util.List No None
version java.lang.String Yes The version defined in the Maven project The version of the content package
workDirectory java.io.File Yes The directory defined in the Maven project (build phase) The directory that contains the content to include in the package

Using filters

Use the filters element to define the package content. The filters are added to the workspaceFilter element in the META-INF/vault/filter.xml file of the package.

The following filter example shows the XML structure to use:

<filter>
   <root>/apps/myapp</root>
   <mode>merge</mode>
       <includes>
              <include>/apps/myapp/install/</include>
              <include>/apps/myapp/components</include>
       </includes>
       <excludes>
              <exclude>/apps/myapp/config/*</exclude>
       </excludes>
</filter>
Import Mode

The mode element defines how content is the repository is affected when the package is imported. The following values can be used:

  • Merge: Content in the package that is not already in the repository is added. Content that is in both the package and the repository is unchanged. No content is removed from the repository.
  • Replace: Content in the package that is not in the repository is added to the repository. Content in the repository is replaced with matching content in the package. Content is removed from the repository when it does not exist in the package.
  • Update: Content in the package that is not in the repository is added to the repository. Content in the repository is replaced with matching content in the package. Existing content gets removed from the repository.

When the filter contains no mode element, the default value of replace is used.

help

Parameters

Name Type Required Default Value Description
detail boolean No false Determines whether to display all settable properties for each goal
goal String No None This parameters defines the name of the goal for which to show help. If no value is specified, help for all goals is displayed.
indentSize int No 2 The number of spaces to use for the indentation of each level (must be positive if defined)
lineLength int No 80 The maximum length of a display line (must be positive if defined)

Including a Thumbnail Image or Properties File in the Package

Replace the default package configuration files to customize the package properties. For example, include a thumbnail image to distinguish the package in Package Manager and Package Share.

The source files can be located anywhere in your file system. In the POM file, define build resources to copy the source files to the target/vault-work/META-INF for inclusion in the package.

The following POM code adds the files in the META-INF folder of the project source to the package:

<build>
    <resources>
        <!-- vault META-INF resources (thumbnail etc.) -->
        <resource>
            <directory>${basedir}/src/main/content/META-INF</directory>
            <targetPath>../vault-work/META-INF</targetPath>
        </resource>
    </resources>
</build>

The following POM code adds only a thumbnail image to the package. The thumbnail image must be named thumbnail.png, and must be located in the META-INF/vault/definition folder of the package. In this example, the source file is located in the /src/main/content/META-INF/vault/definition folder of the project:

<build>
    <resources>
        <!-- thumbnail only -->
        <resource>
            <directory>${basedir}/src/main/content/META-INF/vault/definition</directory>
            <targetPath>../vault-work/META-INF/vault/definition</targetPath>
        </resource>
    </resources>
</build>

Using the AEM Project Archetype to Generate AEM Projects

The latest AEM Project Archetype implements the best-practice package structure for both on-premises and AMS implementations and is recommended for all AEM projects.

TIP

For further details, see the AEM Project Structure article in the AEM as a Cloud Service documentation as well as the AEM Project Archetype documentation. Both of which are fully-supported for AEM 6.5.

On this page