Fork me on GitHub

filevault-package:package

Full name:

org.apache.jackrabbit:filevault-package-maven-plugin:1.0.1-SNAPSHOT:package

Description:

Build a content package.

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.
Default value is: false.
User property is: vault.allowIndexDefinitions.
classesDirectory File - The directory containing the compiled classes to use to import analysis.
Default value is: ${project.build.outputDirectory}.
excludes String[] - The file name patterns to exclude in addition to the ones listed in AbstractScanner.DEFAULTEXCLUDES. The format of each pattern is described in DirectoryScanner.
Default value is: **/.vlt,**/.vltignore,**/.DS_Store.
User property is: vault.excludes.
failOnDependencyErrors boolean - Controls if errors during dependency validation should fail the build.
Default value is: true.
User property is: vault.failOnDependencyErrors.
failOnEmptyFilter boolean - Controls if empty workspace filter fails the build.
Default value is: true.
User property is: vault.failOnEmptyFilter.
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 groupId used for the generated content package. This will be part of the target installation path of the content package.
Default value is: ${project.groupId}.
User property is: vault.group.
jcrRootSourceDirectory File[] - The directory that contains the jcr_root of the content. Multiple directories can be specified as a comma separated list, which will act as a search path and cause the plugin to look for the first existing directory.
Default value is: ${project.basedir}/jcr_root,${project.basedir}/src/main/jcr_root,${project.basedir}/src/main/content/jcr_root,${project.basedir}/src/content/jcr_root,${project.build.outputDirectory}.
User property is: vault.jcrRootSourceDirectory.
name String - The name of the content package
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 content package.
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
archive MavenArchiveConfiguration - The archive configuration to use. See the documentation for Maven Archiver.
builtContentDirectory File - The directory containing the content to be packaged up into the content package. This property is deprecated; use jcrRootSourceDirectory instead.
dependencies Dependency[] - 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 Embedded[] - 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 emebedds or subpackages are merged into it.
filters DefaultWorkspaceFilter - Defines the content of the filter.xml file
generatedImportPackage File - File to store the generated manifest snippet.
Default value is: ${project.build.directory}/vault-generated-import.txt.
User property is: vault.generatedImportPackage.
importPackage String - Defines additional bundle dependency via the osgi import-package entry in the manifest.
Default value is: -org.apache.sling.scripting.sightly.compiler.expression.nodes,-org.apache.sling.scripting.sightly.java.compiler,-org.apache.sling.scripting.sightly.render.
User property is: vault.importPackage.
packageType PackageType - Defines the content package type. this is either 'application', 'content', 'container' or 'mixed'. If omitted, it is calculated automatically based on filter definitions. certain package types imply restrictions, for example, 'application' and 'content' packages are not allowed to contain sub packages or embedded bundles.
User property is: vault.packageType.
prefix String - Adds a path prefix to all resources useful for shallower source trees.
User property is: vault.prefix.
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
packageType Set via the package type parameter

repositoryStructurePackages Dependency[] - Defines the packages that define the repository structure
subPackages SubPackage[] - Defines the list of sub packages.

Parameter Details

allowIndexDefinitions:

Defines whether the package is allowed to contain index definitions. This will become the allowIndexDefinitions property of the properties.xml file.
  • 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. This property is deprecated; use jcrRootSourceDirectory instead.
  • Type: java.io.File
  • Required: No

classesDirectory:

The directory containing the compiled classes to use to import analysis.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.outputDirectory}

dependencies:

Defines the list of dependencies
  • Type: org.apache.jackrabbit.filevault.maven.packaging.Dependency[]
  • 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: org.apache.jackrabbit.filevault.maven.packaging.Embedded[]
  • Required: No

excludes:

The file name patterns to exclude in addition to the ones listed in AbstractScanner.DEFAULTEXCLUDES. The format of each pattern is described in DirectoryScanner.
  • Type: java.lang.String[]
  • Required: Yes
  • User Property: vault.excludes
  • Default: **/.vlt,**/.vltignore,**/.DS_Store

failOnDependencyErrors:

Controls if errors during dependency validation should fail the build.
  • Type: boolean
  • Required: Yes
  • User Property: vault.failOnDependencyErrors
  • Default: true

failOnEmptyFilter:

Controls if empty workspace filter fails the build.
  • Type: boolean
  • Required: Yes
  • User Property: vault.failOnEmptyFilter
  • Default: true

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 emebedds or subpackages are merged into it.
  • Type: java.io.File
  • Required: No

filters:

Defines the content of the filter.xml file
  • Type: org.apache.jackrabbit.filevault.maven.packaging.impl.DefaultWorkspaceFilter
  • 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}

generatedImportPackage:

File to store the generated manifest snippet.
  • Type: java.io.File
  • Required: No
  • User Property: vault.generatedImportPackage
  • Default: ${project.build.directory}/vault-generated-import.txt

group:

The groupId used for the generated content package. This will be part of the target installation path of the content package.
  • Type: java.lang.String
  • Required: Yes
  • User Property: vault.group
  • Default: ${project.groupId}

importPackage:

Defines additional bundle dependency via the osgi import-package entry in the manifest.
  • Type: java.lang.String
  • Required: No
  • User Property: vault.importPackage
  • Default: -org.apache.sling.scripting.sightly.compiler.expression.nodes,-org.apache.sling.scripting.sightly.java.compiler,-org.apache.sling.scripting.sightly.render

jcrRootSourceDirectory:

The directory that contains the jcr_root of the content. Multiple directories can be specified as a comma separated list, which will act as a search path and cause the plugin to look for the first existing directory.
  • Type: java.io.File[]
  • Required: Yes
  • User Property: vault.jcrRootSourceDirectory
  • Default: ${project.basedir}/jcr_root,${project.basedir}/src/main/jcr_root,${project.basedir}/src/main/content/jcr_root,${project.basedir}/src/content/jcr_root,${project.build.outputDirectory}

name:

The name of the content package
  • 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}

packageType:

Defines the content package type. this is either 'application', 'content', 'container' or 'mixed'. If omitted, it is calculated automatically based on filter definitions. certain package types imply restrictions, for example, 'application' and 'content' packages are not allowed to contain sub packages or embedded bundles.
  • Type: org.apache.jackrabbit.filevault.maven.packaging.impl.PackageType
  • Required: No
  • User Property: vault.packageType

prefix:

Adds a path prefix to all resources useful for shallower source trees.
  • Type: java.lang.String
  • Required: No
  • User Property: vault.prefix

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
packageType Set via the package type parameter
  • Type: java.util.Properties
  • Required: No

repositoryStructurePackages:

Defines the packages that define the repository structure
  • Type: org.apache.jackrabbit.filevault.maven.packaging.Dependency[]
  • 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 sub packages.
  • Type: org.apache.jackrabbit.filevault.maven.packaging.SubPackage[]
  • Required: No

version:

The version of the content package.
  • 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