wcm.io

wcmio-content-package:package

Full name:

io.wcm.maven.plugins:wcmio-content-package-maven-plugin:1.8.5-SNAPSHOT:package

This plugin goal has been deprecated:

Description:

Creates a JCR Content Package with embedded Bundles and Packages.

Attributes:

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

Required Parameters

Name Type Since Description
<allowIndexDefinitions> boolean - Defines whether the package is allowed to contain index definitions. This will become the allowIndexDefinitions property of the properties.xml file. As of now there is no check if any files contain index definitions if this is set to false
Default value is: false.
User property is: vault.allowIndexDefinitions.
<builtContentDirectory> File - The directory containing the content to be packaged up into the content package. For now any content here is disregarded. Please copy the content into the workDirectory.
Default value is: ${project.build.outputDirectory}.
<failOnMissingEmbed> boolean - Defines whether to fail the build when an embedded artifact is not found in the project's dependencies
Default value is: false.
User property is: vault.failOnMissingEmbed.
<finalName> String - The name of the generated package ZIP file without the ".zip" file extension.
Default value is: ${project.build.finalName}.
User property is: vault.finalName.
<group> String - The group of the package (location where the package is installed)
Default value is: ${project.groupId}.
User property is: vault.group.
<name> String - The name of the deployed package on the target server
Default value is: ${project.artifactId}.
User property is: vault.name.
<outputDirectory> File - Directory in which the built content package will be output.
Default value is: ${project.build.directory}.
<requiresRoot> boolean - Defines whether the package requires root. This will become the requiresRoot property of the properties.xml file.
Default value is: false.
User property is: vault.requiresRoot.
<version> String - The version of the artifact to install.
Default value is: ${project.version}.
User property is: vault.version.
<workDirectory> File - The directory containing the content to be packaged up into the content package.
Default value is: ${project.build.directory}/vault-work.

Optional Parameters

Name Type Since Description
<acHandling> String - Defines the AC Handling (see vault properties.xml file). It must be a String representation of the AccessControlHandling enum otherwise the packaging will fail.

Possible values

  • ignore: Ignores the packaged access control and leaves the target unchanged.
  • overwrite: Applies the access control provided with the package to the target. this also removes existing access control.
  • merge: Merge access control provided with the package with the one in the content by replacing the access control entries of corresponding principals (i.e. package first). It never alters access control entries of principals not present in the package.
  • merge_preserve: Merge access control in the content with the one provided with the package by adding the access control entries of principals not present in the content (i.e. content first). It never alters access control entries already existing in the content.
  • clear: Clears all access control on the target system.

Default value is: ignore.
User property is: vault.acHandling.
<archive> MavenArchiveConfiguration - The archive configuration to use. See the documentation for Maven Archiver.
<dependencies> List - Defines the list of dependencies
<embeddedTarget> String - Defines the path under which the embedded bundles are placed. defaults to '/apps/bundles/install'
User property is: vault.embeddedTarget.
<embeddeds> List - list of embedded bundles
<filterSource> File - Optional file that specifies the source of the workspace filter. The filters specified in the configuration and injected via embeddeds or subpackages are merged into it.
Default value is: src/main/package-definition/filter.xml.
<filters> Filters - Defines the content of the filter.xml file
<properties> Properties - Specifies additional properties to be 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
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
allowIndexDefinitions Use allowIndexDefinitions parameter to set
packagePath Automatically generated from the group and package name
acHandling Use acHandling parameter to set it

<subPackages> List - Defines the list of nested packages.
<thumbnailImage> File - Optional reference to PNG image that should be used as thumbnail for the content package.
Default value is: src/main/package-definition/thumbnail.png.

Parameter Details

<acHandling>

Defines the AC Handling (see vault properties.xml file). It must be a String representation of the AccessControlHandling enum otherwise the packaging will fail.

Possible values

  • ignore: Ignores the packaged access control and leaves the target unchanged.
  • overwrite: Applies the access control provided with the package to the target. this also removes existing access control.
  • merge: Merge access control provided with the package with the one in the content by replacing the access control entries of corresponding principals (i.e. package first). It never alters access control entries of principals not present in the package.
  • merge_preserve: Merge access control in the content with the one provided with the package by adding the access control entries of principals not present in the content (i.e. content first). It never alters access control entries already existing in the content.
  • clear: Clears all access control on the target system.
  • Type: java.lang.String
  • Required: No
  • User Property: vault.acHandling
  • Default: ignore

<allowIndexDefinitions>

Defines whether the package is allowed to contain index definitions. This will become the allowIndexDefinitions property of the properties.xml file. As of now there is no check if any files contain index definitions if this is set to false
  • Type: boolean
  • Required: Yes
  • User Property: vault.allowIndexDefinitions
  • Default: false

<archive>

The archive configuration to use. See the documentation for Maven Archiver.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

<builtContentDirectory>

The directory containing the content to be packaged up into the content package. For now any content here is disregarded. Please copy the content into the workDirectory.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.outputDirectory}

<dependencies>

Defines the list of dependencies
  • Type: java.util.List
  • Required: No

<embeddedTarget>

Defines the path under which the embedded bundles are placed. defaults to '/apps/bundles/install'
  • Type: java.lang.String
  • Required: No
  • User Property: vault.embeddedTarget

<embeddeds>

list of embedded bundles
  • Type: java.util.List
  • Required: No

<failOnMissingEmbed>

Defines whether to fail the build when an embedded artifact is not found in the project's dependencies
  • Type: boolean
  • Required: Yes
  • User Property: vault.failOnMissingEmbed
  • Default: false

<filterSource>

Optional file that specifies the source of the workspace filter. The filters specified in the configuration and injected via embeddeds or subpackages are merged into it.
  • Type: java.io.File
  • Required: No
  • Default: src/main/package-definition/filter.xml

<filters>

Defines the content of the filter.xml file
  • Type: io.wcm.maven.plugins.contentpackage.pack.Filters
  • Required: No

<finalName>

The name of the generated package ZIP file without the ".zip" file extension.
  • Type: java.lang.String
  • Required: Yes
  • User Property: vault.finalName
  • Default: ${project.build.finalName}

<group>

The group of the package (location where the package is installed)
  • Type: java.lang.String
  • Required: Yes
  • User Property: vault.group
  • Default: ${project.groupId}

<name>

The name of the deployed package on the target server
  • Type: java.lang.String
  • Required: Yes
  • User Property: vault.name
  • Default: ${project.artifactId}

<outputDirectory>

Directory in which the built content package will be output.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}

<properties>

Specifies additional properties to be 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
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
allowIndexDefinitions Use allowIndexDefinitions parameter to set
packagePath Automatically generated from the group and package name
acHandling Use acHandling parameter to set it
  • Type: java.util.Properties
  • Required: No

<requiresRoot>

Defines whether the package requires root. This will become the requiresRoot property of the properties.xml file.
  • Type: boolean
  • Required: Yes
  • User Property: vault.requiresRoot
  • Default: false

<subPackages>

Defines the list of nested packages.
  • Type: java.util.List
  • Required: No

<thumbnailImage>

Optional reference to PNG image that should be used as thumbnail for the content package.
  • Type: java.io.File
  • Required: No
  • Default: src/main/package-definition/thumbnail.png

<version>

The version of the artifact to install.
  • Type: java.lang.String
  • Required: Yes
  • User Property: vault.version
  • Default: ${project.version}

<workDirectory>

The directory containing the content to be packaged up into the content package.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/vault-work

Back to top

Copyright ©2014-2021 wcm.io. All Rights Reserved.

Version: 1.8.5-SNAPSHOT. Last Published: 2021-12-07.