vltpack:vault-inf

Full name:

net.adamcin:vltpack-maven-plugin:1.3.0:vault-inf

Description:

Generates package meta information under META-INF/vault, including config.xml, properties.xml, filter.xml and the package definition

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 0.6.0.
  • Binds by default to the lifecycle phase: prepare-package.

Optional Parameters

Name Type Since Description
createDefinition boolean 0.6.0
Set to true to generate the JCR Package Definition. This is necessary if thumbnails, screenshots, or definition properties need to be set within the package. Package creation may take significantly more time than normal if this is set because a Jackrabbit TransientRepository will need to be started
definitionProperties Map 0.6.0
Properties to be added to the JCR Package Definition node. These will NOT be added to the properties.xml file. (requires createDefinition to be set to true)
localRepositoryPath File 1.0.4
Specify the local repository path for resolved artifacts Refer to maven-install-plugin:install-file

User property is: vltpack.localRepositoryPath.
packageDependencies List 0.6.0
List of artifactIds matching dependencies that are valid vault packages
properties Map 0.6.0
Package properties that will be set in the properties.xml file
screenshots List 0.6.0
Specify a list of PNG files that will be included as package screenshots in the CRX Package Manager (requires createDefinition to be set to true)
thumbnail File 0.6.0
Specify a PNG file that will be used as the thumbnail for the package in the CRX Package Manager (requires createDefinition to be set to true)
user String 0.6.0
Specify the CQ username associated with package creation and installation

Default value is: admin.
User property is: vltpack.user.
vaultSource File 0.6.0
Source folder for existing meta info files, such as are created and managed by the VLT working copy

Default value is: ${project.build.outputDirectory}/META-INF/vault.

Parameter Details

createDefinition:

Set to true to generate the JCR Package Definition. This is necessary if thumbnails, screenshots, or definition properties need to be set within the package. Package creation may take significantly more time than normal if this is set because a Jackrabbit TransientRepository will need to be started
  • Type: boolean
  • Since: 0.6.0
  • Required: No

definitionProperties:

Properties to be added to the JCR Package Definition node. These will NOT be added to the properties.xml file. (requires createDefinition to be set to true)
  • Type: java.util.Map
  • Since: 0.6.0
  • Required: No

localRepositoryPath:

Specify the local repository path for resolved artifacts Refer to maven-install-plugin:install-file
  • Type: java.io.File
  • Since: 1.0.4
  • Required: No
  • User Property: vltpack.localRepositoryPath

packageDependencies:

List of artifactIds matching dependencies that are valid vault packages
  • Type: java.util.List
  • Since: 0.6.0
  • Required: No

properties:

Package properties that will be set in the properties.xml file
  • Type: java.util.Map
  • Since: 0.6.0
  • Required: No

screenshots:

Specify a list of PNG files that will be included as package screenshots in the CRX Package Manager (requires createDefinition to be set to true)
  • Type: java.util.List
  • Since: 0.6.0
  • Required: No

thumbnail:

Specify a PNG file that will be used as the thumbnail for the package in the CRX Package Manager (requires createDefinition to be set to true)
  • Type: java.io.File
  • Since: 0.6.0
  • Required: No

user:

Specify the CQ username associated with package creation and installation
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • User Property: vltpack.user
  • Default: admin

vaultSource:

Source folder for existing meta info files, such as are created and managed by the VLT working copy
  • Type: java.io.File
  • Since: 0.6.0
  • Required: No
  • Default: ${project.build.outputDirectory}/META-INF/vault