| <?xml version="1.0" encoding="UTF-8"?> |
| |
| <!-- Generated by maven-plugin-tools 3.6 (enhanced XHTML version with additional attributes)--> |
| |
| <plugin> |
| <name>Apache Jackrabbit FileVault - Package Maven Plugin</name> |
| <description>Maven Plugin supporting creation of content packages.</description> |
| <groupId>org.apache.jackrabbit</groupId> |
| <artifactId>filevault-package-maven-plugin</artifactId> |
| <version>1.3.1-SNAPSHOT</version> |
| <goalPrefix>filevault-package</goalPrefix> |
| <isolatedRealm>false</isolatedRealm> |
| <inheritedByDefault>true</inheritedByDefault> |
| <mojos> |
| <mojo> |
| <goal>analyze-classes</goal> |
| <description>Analyzes the generated class files and generates a usage report. This report can be used by the <code>generate-metadata</code> goal to generate a manifest header out of it.</description> |
| <requiresDependencyResolution>compile</requiresDependencyResolution> |
| <requiresDirectInvocation>false</requiresDirectInvocation> |
| <requiresProject>true</requiresProject> |
| <requiresReports>false</requiresReports> |
| <aggregator>false</aggregator> |
| <requiresOnline>false</requiresOnline> |
| <inheritedByDefault>true</inheritedByDefault> |
| <phase>process-classes</phase> |
| <implementation>org.apache.jackrabbit.filevault.maven.packaging.mojo.AnalyzeClassesMojo</implementation> |
| <language>java</language> |
| <instantiationStrategy>per-lookup</instantiationStrategy> |
| <executionStrategy>once-per-session</executionStrategy> |
| <threadSafe>true</threadSafe> |
| <parameters> |
| <parameter> |
| <name>excludedLibraries</name> |
| <type>java.lang.String[]</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines a list of libraries in partial maven coordinates that are not used for analysis.</description> |
| </parameter> |
| <parameter> |
| <name>generatedImportPackage</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>File to store the generated manifest snippet.</description> |
| </parameter> |
| <parameter> |
| <name>importUnusedPackages</name> |
| <type>boolean</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines if unused packages should be included in the import-package entry if no classes exist in the project</description> |
| </parameter> |
| <parameter> |
| <name>project</name> |
| <type>org.apache.maven.project.MavenProject</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/project/MavenProject.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description>The Maven project.</description> |
| </parameter> |
| <parameter> |
| <name>showImportPackageReport</name> |
| <type>boolean</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Controls if the output should contain the package report.</description> |
| </parameter> |
| <parameter> |
| <name>sourceDirectory</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Location of class files</description> |
| </parameter> |
| </parameters> |
| <configuration> |
| <excludedLibraries implementation="java.lang.String[]">${vault.excludedLibraries}</excludedLibraries> |
| <generatedImportPackage implementation="java.io.File" default-value="${project.build.directory}/vault-generated-import.txt">${vault.generatedImportPackage}</generatedImportPackage> |
| <importUnusedPackages implementation="boolean">${vault.importUnusedPackages}</importUnusedPackages> |
| <project implementation="org.apache.maven.project.MavenProject">${project}</project> |
| <showImportPackageReport implementation="boolean" default-value="false">${vault.showPackageReport}</showImportPackageReport> |
| <sourceDirectory implementation="java.io.File" default-value="${project.build.outputDirectory}">${vault.classesDirectory}</sourceDirectory> |
| </configuration> |
| </mojo> |
| <mojo> |
| <goal>check-signature</goal> |
| <description>Checks the embedded libraries against a defined signature. Based on the <a href="https://www.mojohaus.org/animal-sniffer/">Animal Sniffer project</a>.</description> |
| <requiresDependencyResolution>compile</requiresDependencyResolution> |
| <requiresDirectInvocation>false</requiresDirectInvocation> |
| <requiresProject>true</requiresProject> |
| <requiresReports>false</requiresReports> |
| <aggregator>false</aggregator> |
| <requiresOnline>false</requiresOnline> |
| <inheritedByDefault>true</inheritedByDefault> |
| <phase>process-classes</phase> |
| <implementation>org.apache.jackrabbit.filevault.maven.packaging.mojo.CheckSignatureMojo</implementation> |
| <language>java</language> |
| <instantiationStrategy>per-lookup</instantiationStrategy> |
| <executionStrategy>once-per-session</executionStrategy> |
| <threadSafe>true</threadSafe> |
| <parameters> |
| <parameter> |
| <name>classpathElements</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description>Project classpath.</description> |
| </parameter> |
| <parameter> |
| <name>embeddeds</name> |
| <type>org.apache.jackrabbit.filevault.maven.packaging.Embedded[]</type> |
| <typeJavadocUrl>apidocs/org/apache/jackrabbit/filevault/maven/packaging/Embedded.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>list of embedded bundles to scan</description> |
| </parameter> |
| <parameter> |
| <name>failOnMissingEmbed</name> |
| <type>boolean</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Defines whether to fail the build when an embedded artifact is not found in the project's dependencies</description> |
| </parameter> |
| <parameter> |
| <name>ignores</name> |
| <type>java.lang.String[]</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Class names to ignore signatures for (wildcards accepted).</description> |
| </parameter> |
| <parameter> |
| <name>project</name> |
| <type>org.apache.maven.project.MavenProject</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/project/MavenProject.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description>The Maven project.</description> |
| </parameter> |
| <parameter> |
| <name>repoSession</name> |
| <type>org.eclipse.aether.RepositorySystemSession</type> |
| <typeJavadocUrl>apidocs/org/eclipse/aether/RepositorySystemSession.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>repositories</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>signature</name> |
| <type>org.codehaus.mojo.animal_sniffer.maven.Signature</type> |
| <typeJavadocUrl>apidocs/org/codehaus/mojo/animal_sniffer/maven/Signature.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Signature module to use. If not set the signature check will be skipped.</description> |
| </parameter> |
| <parameter> |
| <name>skipCheckSignature</name> |
| <type>boolean</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>If true, skip the signature check.</description> |
| </parameter> |
| </parameters> |
| <configuration> |
| <classpathElements implementation="java.util.List">${project.compileClasspathElements}</classpathElements> |
| <failOnMissingEmbed implementation="boolean" default-value="false">${vault.failOnMissingEmbed}</failOnMissingEmbed> |
| <project implementation="org.apache.maven.project.MavenProject">${project}</project> |
| <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/> |
| <repositories implementation="java.util.List" default-value="${project.remoteProjectRepositories}"/> |
| <skipCheckSignature implementation="boolean" default-value="false">${vault.checksignature.skip}</skipCheckSignature> |
| </configuration> |
| <requirements> |
| <requirement> |
| <role>org.eclipse.aether.RepositorySystem</role> |
| <field-name>repoSystem</field-name> |
| </requirement> |
| </requirements> |
| </mojo> |
| <mojo> |
| <goal>format-xml</goal> |
| <description>Either checks only the formatting of the Docview XML files to comply with the formatting rules from FileVault or also reformats those files.</description> |
| <requiresDirectInvocation>false</requiresDirectInvocation> |
| <requiresProject>true</requiresProject> |
| <requiresReports>false</requiresReports> |
| <aggregator>false</aggregator> |
| <requiresOnline>false</requiresOnline> |
| <inheritedByDefault>true</inheritedByDefault> |
| <phase>process-sources</phase> |
| <implementation>org.apache.jackrabbit.filevault.maven.packaging.mojo.FormatDocviewXmlMojo</implementation> |
| <language>java</language> |
| <instantiationStrategy>per-lookup</instantiationStrategy> |
| <executionStrategy>once-per-session</executionStrategy> |
| <threadSafe>true</threadSafe> |
| <parameters> |
| <parameter> |
| <name>enableForIncrementalBuild</name> |
| <type>boolean</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>If set to <code>true</code> will also run on incremental builds (i.e. within Eclipse with m2e). Otherwise this goal is skipped in incremental builds and only runs on full builds.</description> |
| </parameter> |
| <parameter> |
| <name>excludes</name> |
| <type>java.util.Set</type> |
| <typeJavadocUrl>apidocs/java/util/Set.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Exclude patterns for files to exclude. If not set defaults to []. |
| <p>Note: includes have precedences over excludes. Each pattern can either be an <a href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant-like pattern</a> or a regular expression if it is starting with <code>%regex[</code> and ending with <code>]</code>.</p></description> |
| </parameter> |
| <parameter> |
| <name>includes</name> |
| <type>java.util.Set</type> |
| <typeJavadocUrl>apidocs/java/util/Set.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Include patterns for files to include. If not set defaults to [**\/*.xml]. |
| <p>Note: includes have precedences over excludes. Each pattern can either be an <a href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant-like pattern</a> or a regular expression if it is starting with <code>%regex[</code> and ending with <code>]</code>.</p></description> |
| </parameter> |
| <parameter> |
| <name>jcrRootSourceDirectory</name> |
| <type>java.io.File[]</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>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.</description> |
| </parameter> |
| <parameter> |
| <name>validateOnly</name> |
| <type>boolean</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>If set to <code>true</code> then fails the build if it encounters XML files which don't follow the formatting rules for XML Docview files. If set to <code>false</code> will reformat all XML Docview files.</description> |
| </parameter> |
| </parameters> |
| <configuration> |
| <enableForIncrementalBuild implementation="boolean" default-value="false"/> |
| <jcrRootSourceDirectory implementation="java.io.File[]" default-value="${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}">${vault.jcrRootSourceDirectory}</jcrRootSourceDirectory> |
| <validateOnly implementation="boolean" default-value="false"/> |
| </configuration> |
| <requirements> |
| <requirement> |
| <role>org.sonatype.plexus.build.incremental.BuildContext</role> |
| <field-name>buildContext</field-name> |
| </requirement> |
| </requirements> |
| </mojo> |
| <mojo> |
| <goal>generate-cnd</goal> |
| <description>Generates a <a href="https://jackrabbit.apache.org/jcr/node-type-notation.html">CND file</a> containing all used node types and namespaces. It uses the <a href="https://s.apache.org/jcr-2.0-spec/3_Repository_Model.html#3.7.11%20Standard%20Application%20Node%20Types">default namespaces and node types</a> and in addition some provided ones as source node type and namespace registry. From those only the ones being really leveraged in the package end up in the generated CND. The generated CND will end up in the <a href="https://jackrabbit.apache.org/filevault/nodetypes.html">package metadata</a> and all contained namespaces and node types are automatically registered during installation (in case they are not yet registered).</description> |
| <requiresDependencyResolution>compile</requiresDependencyResolution> |
| <requiresDirectInvocation>false</requiresDirectInvocation> |
| <requiresProject>true</requiresProject> |
| <requiresReports>false</requiresReports> |
| <aggregator>false</aggregator> |
| <requiresOnline>false</requiresOnline> |
| <inheritedByDefault>true</inheritedByDefault> |
| <phase>generate-sources</phase> |
| <implementation>org.apache.jackrabbit.filevault.maven.packaging.mojo.GenerateCndMojo</implementation> |
| <language>java</language> |
| <instantiationStrategy>per-lookup</instantiationStrategy> |
| <executionStrategy>once-per-session</executionStrategy> |
| <since>1.3.0</since> |
| <threadSafe>true</threadSafe> |
| <parameters> |
| <parameter> |
| <name>addDefaultExcludes</name> |
| <type>boolean</type> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>By default certain metadata files are excluded which means they will not be copied into the package. If you need them for a particular reason you can do that by setting this parameter to <code>false</code>. This means all files matching the following <a href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant patterns</a> won't be copied by default. |
| <ul> |
| <li>Misc: **/*~, **/#*#, **/.#*, **/%*%, **/._*</li> |
| <li>CVS: **/CVS, **/CVS/**, **/.cvsignore</li> |
| <li>SVN: **/.svn, **/.svn/**</li> |
| <li>GNU: **/.arch-ids, **/.arch-ids/**</li> |
| <li>Bazaar: **/.bzr, **/.bzr/**</li> |
| <li>SurroundSCM: **/.MySCMServerInfo</li> |
| <li>Mac: **/.DS_Store</li> |
| <li>Serena Dimension: **/.metadata, **/.metadata/**</li> |
| <li>Mercurial: **/.hg, **/.hg/**</li> |
| <li>GIT: **/.git, **/.git/**</li> |
| <li>Bitkeeper: **/BitKeeper, **/BitKeeper/**, **/ChangeSet, **/ChangeSet/**</li> |
| <li>Darcs: **/_darcs, **/_darcs/**, **/.darcsrepo, **/.darcsrepo/****/-darcs-backup*, **/.darcs-temp-mail</li> |
| </ul><br /><strong>See also:</strong> org.codehaus.plexus.util.AbstractScanner.DEFAULTEXCLUDES<!-- this link does not have javadoc linked --></description> |
| </parameter> |
| <parameter> |
| <name>additionalInputCndUrls</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>List of URLs pointing to a <a href="https://jackrabbit.apache.org/jcr/node-type-notation.html">CND</a> which define the additional namespaces and node types potentially used in this package apart from the <a href="https://s.apache.org/jcr-2.0-spec/3_Repository_Model.html#3.7.11%20Standard%20Application%20Node%20Types">default ones defined in JCR 2.0</a>. If a URI is pointing to a JAR it will leverage all the node types being mentioned in the <a href="https://sling.apache.org/documentation/bundles/content-loading-jcr-contentloader.html#declared-node-type-registration"><code>Sling-Nodetypes</code> manifest header</a>. Apart from the <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html#URL-java.lang.String-java.lang.String-int-java.lang.String-">standard protocols</a> the scheme <code>tccl</code> can be used to reference names from the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html#getContextClassLoader--">Thread's context class loader</a>. In the Maven plugin context this is the <a href="http://maven.apache.org/guides/mini/guide-maven-classloading.html?ref=driverlayer.com/web#3-plugin-classloaders">plugin classloader</a>.</description> |
| </parameter> |
| <parameter> |
| <name>builtContentDirectory</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <deprecated>Use <a href="#jcrRootSourceDirectory"><code>jcrRootSourceDirectory</code></a> instead.</deprecated> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The directory containing the content to be packaged up into the content package.</description> |
| </parameter> |
| <parameter> |
| <name>classifier</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <since>1.1.4</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Optional classifier to add to the generated package. If given, the artifact will be attached as a supplemental artifact having this classifier. Also all generated metadata will be pushed to <code>&lt;workDirectory&gt;-&lt;classifier&gt;</code> and will preferably be looked up from there. In addition the embedded file names will be exchanged leveraging a classifier specific property.</description> |
| </parameter> |
| <parameter> |
| <name>excludes</name> |
| <type>java.util.Set</type> |
| <typeJavadocUrl>apidocs/java/util/Set.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The file name patterns to exclude (in addition to the default ones mentioned at <a href="#addDefaultExcludes"><code>addDefaultExcludes</code></a>. The format of each pattern is described in <code>org.codehaus.plexus.util.DirectoryScanner</code><!-- this link does not have javadoc linked -->. The comparison is against the path relative to the according filter root. Since this is hardly predictable it is recommended to use only filename/directory name patterns here but not take into account file system hierarchies! |
| <p>Each value is either a regex pattern if enclosed within <code>%regex[</code> and <code>]</code>, otherwise an <a href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant pattern</a>.</p></description> |
| </parameter> |
| <parameter> |
| <name>jcrRootSourceDirectory</name> |
| <type>java.io.File[]</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>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.</description> |
| </parameter> |
| <parameter> |
| <name>metaInfVaultDirectory</name> |
| <type>java.io.File[]</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The directory that contains the META-INF/vault. 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. |
| <p>This directory is added as fileset to the package archiver before the the <a href="#workDirectory"><code>workDirectory</code></a>. This means that files specified in this directory have precedence over the one present in the <a href="#workDirectory"><code>workDirectory</code></a>. For example, if this directory contains a <code>properties.xml</code> it will not be overwritten by the generated one. A special case is the <code>filter.xml</code> which will be merged with inline filters if present.</p></description> |
| </parameter> |
| <parameter> |
| <name>outputTimestamp</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ssXXX</code> or as an int representing seconds since the epoch (like <a href="https://reproducible-builds.org/docs/source-date-epoch/">SOURCE_DATE_EPOCH</a>).</description> |
| </parameter> |
| <parameter> |
| <name>prefix</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Adds a path prefix to all resources. Useful for shallower source trees. This does not apply to files in <a href="#workDirectory"><code>workDirectory</code></a> nor <a href="#metaInfVaultDirectory"><code>metaInfVaultDirectory</code></a> but e.g. is relevant for the default filter and for the jcr_root of the package. Must start with "/" if not empty. As separator only forward slashes are allowed. The trailing slash is automatically appended if not there.</description> |
| </parameter> |
| <parameter> |
| <name>project</name> |
| <type>org.apache.maven.project.MavenProject</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/project/MavenProject.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description>The Maven project.</description> |
| </parameter> |
| <parameter> |
| <name>workDirectory</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The output directory for goal "generate-metadata" and additional input directory containing the metadata to be packaged up into the content package for goal "package". The directory name is suffixed with <code>-&lt;classifier&gt;</code> in case a <a href="#classifier"><code>classifier</code></a> is used. In case of the "package" goal this falls back to the non-suffixed directory name in case the one with suffix does not exist.</description> |
| </parameter> |
| </parameters> |
| <configuration> |
| <addDefaultExcludes implementation="boolean" default-value="true"/> |
| <additionalInputCndUrls implementation="java.util.List">${vault.inputCndUrls}</additionalInputCndUrls> |
| <classifier implementation="java.lang.String">${vault.classifier}</classifier> |
| <excludes implementation="java.util.Set" default-value="**/.vlt,**/.vltignore,**/.gitignore">${vault.excludes}</excludes> |
| <jcrRootSourceDirectory implementation="java.io.File[]" default-value="${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}">${vault.jcrRootSourceDirectory}</jcrRootSourceDirectory> |
| <metaInfVaultDirectory implementation="java.io.File[]" default-value="${project.basedir}/META-INF/vault,${project.basedir}/src/main/META-INF/vault,${project.basedir}/src/main/content/META-INF/vault,${project.basedir}/src/content/META-INF/vault">${vault.metaInfVaultDirectory}</metaInfVaultDirectory> |
| <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/> |
| <prefix implementation="java.lang.String" default-value="">${vault.prefix}</prefix> |
| <project implementation="org.apache.maven.project.MavenProject">${project}</project> |
| <workDirectory implementation="java.io.File" default-value="${project.build.directory}/vault-work"/> |
| </configuration> |
| </mojo> |
| <mojo> |
| <goal>generate-metadata</goal> |
| <description>Generates the metadata ending up in the content package like <code>META-INF/MANIFEST.MF</code> as well as the files ending up in <code>META-INF/vault</code> like <code>filter.xml</code>, <code>properties.xml</code>, <code>config.xml</code> and <code>settings.xml</code>. Those files will be written to the directory given via parameter <a href="#workDirectory"><code>workDirectory</code></a>. In addition performs some validations. Also configures artifacts (like OSGi bundles or subpackages) to be embedded in the content package as those may affect metadata as well. The generated metadata is usually packaged in a content package in a subsequent goal <code>package</code>. |
| <p><i>This goal is executed/bound by default for Maven modules of type <code>content-package</code>.</i></p></description> |
| <requiresDependencyResolution>compile</requiresDependencyResolution> |
| <requiresDirectInvocation>false</requiresDirectInvocation> |
| <requiresProject>true</requiresProject> |
| <requiresReports>false</requiresReports> |
| <aggregator>false</aggregator> |
| <requiresOnline>false</requiresOnline> |
| <inheritedByDefault>true</inheritedByDefault> |
| <phase>generate-test-sources</phase> |
| <implementation>org.apache.jackrabbit.filevault.maven.packaging.mojo.GenerateMetadataMojo</implementation> |
| <language>java</language> |
| <instantiationStrategy>per-lookup</instantiationStrategy> |
| <executionStrategy>once-per-session</executionStrategy> |
| <since>1.0.3</since> |
| <threadSafe>true</threadSafe> |
| <parameters> |
| <parameter> |
| <name>accessControlHandling</name> |
| <alias>acHandling</alias> |
| <type>org.apache.jackrabbit.vault.fs.io.AccessControlHandling</type> |
| <typeJavadocUrl>apidocs/org/apache/jackrabbit/vault/fs/io/AccessControlHandling.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines the Access control handling. This will become the <code>acHandling</code> property of the properties.xml file.<br /> Possible values: |
| <ul> |
| <li><code>ignore</code>: Ignores the packaged access control and leaves the target unchanged.</li> |
| <li><code>overwrite</code>: Applies the access control provided with the package to the target. this also removes existing access control.</li> |
| <li><code>merge</code>: 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.</li> |
| <li><code>merge_preserve</code>: 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.</li> |
| <li><code>clear</code>: Clears all access control on the target system.</li> |
| </ul></description> |
| </parameter> |
| <parameter> |
| <name>allowIndexDefinitions</name> |
| <type>boolean</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Defines whether the package is allowed to contain index definitions. This will become the <code>allowIndexDefinitions</code> property of the properties.xml file.</description> |
| </parameter> |
| <parameter> |
| <name>archive</name> |
| <type>org.apache.maven.archiver.MavenArchiveConfiguration</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/archiver/MavenArchiveConfiguration.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The archive configuration to use. See <a href="http://maven.apache.org/shared/maven-archiver/index.html">the documentation for Maven Archiver</a>. All settings related to manifest are not relevant as this gets overwritten by the manifest in <a href="#workDirectory"><code>workDirectory</code></a></description> |
| </parameter> |
| <parameter> |
| <name>classifier</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <since>1.1.4</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Optional classifier to add to the generated package. If given, the artifact will be attached as a supplemental artifact having this classifier. Also all generated metadata will be pushed to <code>&lt;workDirectory&gt;-&lt;classifier&gt;</code> and will preferably be looked up from there. In addition the embedded file names will be exchanged leveraging a classifier specific property.</description> |
| </parameter> |
| <parameter> |
| <name>dependencies</name> |
| <type>java.util.Collection</type> |
| <typeJavadocUrl>apidocs/java/util/Collection.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines the list of dependencies A dependency is declared as a <code>&lt;dependency&gt;</code> element of a list style <code>&lt;dependencies&gt;</code> element: |
| <pre>&lt;dependency&gt; |
| &lt;group&gt;theGroup&lt;/group&gt; |
| &lt;name&gt;theName&lt;/name&gt; |
| &lt;version&gt;1.5&lt;/version&gt; |
| &lt;/dependency&gt; |
| </pre> |
| <p>The dependency can also reference a maven project dependency, this is preferred as it yields to more robust builds.</p> |
| <pre>&lt;dependency&gt; |
| &lt;groupId&gt;theGroup&lt;/groupId&gt; |
| &lt;artifactId&gt;theName&lt;/artifactId&gt; |
| &lt;/dependency&gt; |
| </pre> |
| <p>The <code>versionRange</code> may be indicated as a single version, in which case the version range has no upper bound and defines the minimal version accepted. Otherwise, the version range defines a lower and upper bound of accepted versions, where the bounds are either included using parentheses <code>()</code> or excluded using brackets <code>[]</code></p></description> |
| </parameter> |
| <parameter> |
| <name>embeddeds</name> |
| <type>org.apache.jackrabbit.filevault.maven.packaging.Embedded[]</type> |
| <typeJavadocUrl>apidocs/org/apache/jackrabbit/filevault/maven/packaging/Embedded.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>List of filters for artifacts to embed in the package. The <a href="apidocs/org/apache/jackrabbit/filevault/maven/packaging/Embedded.html"><code>org.apache.jackrabbit.filevault.maven.packaging.Embedded</code></a> class represents one or multiple embedded artifact dependencies from the project descriptor. Each <code>&lt;embedded&gt;</code> element may configure any of the following fields |
| <p></p> |
| <table> |
| <tbody> |
| <tr> |
| <td><code>groupId</code></td> |
| <td><code>String</code><!-- this link does not have javadoc linked --></td> |
| <td>Filter criterion against the group id of a project dependency. A pattern as described below.</td> |
| </tr> |
| <tr> |
| <td><code>artifactId</code></td> |
| <td><code>String</code><!-- this link does not have javadoc linked --></td> |
| <td>Filter criterion against the artifact id of a project dependency. A pattern as described below.</td> |
| </tr> |
| <tr> |
| <td><code>scope</code></td> |
| <td><code>org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter</code><!-- this link does not have javadoc linked --></td> |
| <td>Filter criterion against the <a href="https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Dependency_Scope">scope of a project dependency</a>. Possible values are |
| <ul> |
| <li><code>test</code>, which allows every scope</li> |
| <li><code>compile+runtime</code> which allows every scope except <code>test</code></li> |
| <li><code>runtime+system</code> which allows every scope except <code>test</code> and <code>provided</code></li> |
| <li><code>compile</code> which allows only scope <code>compile</code>, <code>provided</code> and <code>system</code></li> |
| <li><code>runtime</code> which only allows scope <code>runtime</code> and <code>compile</code>.</li> |
| </ul></td> |
| </tr> |
| <tr> |
| <td><code>type</code></td> |
| <td><code>String</code><!-- this link does not have javadoc linked --></td> |
| <td>Filter criterion against the type of a project dependency. A pattern as described below.</td> |
| </tr> |
| <tr> |
| <td><code>classifier</code></td> |
| <td><code>String</code><!-- this link does not have javadoc linked --></td> |
| <td>Filter criterion against the classifier of a project dependency. A pattern as described below.</td> |
| </tr> |
| <tr> |
| <td><code>filter</code></td> |
| <td><code>Boolean</code><!-- this link does not have javadoc linked --></td> |
| <td>If set to <code>true</code> adds the embedded artifact location to the package's filter. Default = <code>false</code>.</td> |
| </tr> |
| <tr> |
| <td><code>isAllVersionsFilter</code></td> |
| <td><code>Boolean</code><!-- this link does not have javadoc linked --></td> |
| <td>If <code>filter</code> is <code>true</code> and this is <code>true</code> as well, the filter entry will contain all versions of the same artifact (by creating an according filter pattern). Default = <code>false</code>.</td> |
| </tr> |
| <tr> |
| <td><code>excludeTransitive</code></td> |
| <td><code>Boolean</code><!-- this link does not have javadoc linked --></td> |
| <td>If <code>true</code> only filters on direct dependencies (not on transitive ones). Default = <code>false</code>.</td> |
| </tr> |
| <tr> |
| <td><code>target</code></td> |
| <td><code>String</code><!-- this link does not have javadoc linked --></td> |
| <td>The parent directory location in the package where to place the embedded artifact. Falls back to <a href="#embeddedTarget"><code>embeddedTarget</code></a> if not set.</td> |
| </tr> |
| </tbody> |
| </table> All fields are optional. All filter criteria is concatenated with AND logic (i.e. every criterion must match for a specific dependency to be embedded). <br /> All filter patterns follow the format <code>&lt;filter&gt;{,&lt;filter&gt;}</code>. Each <code>filter</code> is a string which is either an exclude (if it starts with a <code>~</code>) or an include otherwise. If the first <code>filter</code> is an include the pattern acts as whitelist, otherwise as blacklist. The last matching filter determines the outcome. Only matching dependencies are being considered for being embedded. <br /> <i>The difference between <a href="#embeddeds"><code>embeddeds</code></a> and <a href="#subPackages"><code>subPackages</code></a> is that for the former an explicit target is given while for the latter the target is being computed from the artifact's vault property file.</i></description> |
| </parameter> |
| <parameter> |
| <name>embeddedTarget</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines the path under which the embedded bundles are placed. defaults to '/apps/bundles/install'</description> |
| </parameter> |
| <parameter> |
| <name>failOnEmptyFilter</name> |
| <type>boolean</type> |
| <deprecated>This is no longer evaluated as every package is supposed to come with a non-empty filter</deprecated> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Controls if empty workspace filter fails the build.</description> |
| </parameter> |
| <parameter> |
| <name>failOnMissingEmbed</name> |
| <type>boolean</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Defines whether to fail the build when an embedded artifact is not found in the project's dependencies</description> |
| </parameter> |
| <parameter> |
| <name>filters</name> |
| <type>org.apache.jackrabbit.filevault.maven.packaging.Filters</type> |
| <typeJavadocUrl>apidocs/org/apache/jackrabbit/filevault/maven/packaging/Filters.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines the content of the filter.xml file. Each filter consists of the mandatory element <code>root</code> and the optional <code>mode</code> and <code>type</code> elements. All those elements are simple strings. In addition optionally a number of <code>include</code> and <code>exclude</code> elements are supported below <code>includes</code>/<code>excludes</code> respectively.</description> |
| </parameter> |
| <parameter> |
| <name>filterSource</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>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.</description> |
| </parameter> |
| <parameter> |
| <name>generatedImportPackage</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>File from which to read the generated manifest snippet generated by goal "analyze-classes". The contents of the file end up in the `import-package` entry in the manifest.</description> |
| </parameter> |
| <parameter> |
| <name>group</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The groupId used for the generated content package. This will be part of the target installation path of the content package.</description> |
| </parameter> |
| <parameter> |
| <name>importPackage</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines additional package dependencies via the `import-package` entry in the manifest. Is merged with the input from <a href="#generatedImportPackage"><code>generatedImportPackage</code></a>.</description> |
| </parameter> |
| <parameter> |
| <name>installHooks</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <since>1.1.8</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>A list of artifact coordinates in the format <code>&lt;groupId&gt;:&lt;artifactId&gt;[:&lt;extension&gt;[:&lt;classifier&gt;]]:&lt;version&gt;</code>. The resolved artifacts are embedded as <a href="http://jackrabbit.apache.org/filevault/installhooks.html">internal install hooks</a> in the resulting content package.</description> |
| </parameter> |
| <parameter> |
| <name>metaInfVaultDirectory</name> |
| <type>java.io.File[]</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The directory that contains the META-INF/vault. 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. |
| <p>This directory is added as fileset to the package archiver before the the <a href="#workDirectory"><code>workDirectory</code></a>. This means that files specified in this directory have precedence over the one present in the <a href="#workDirectory"><code>workDirectory</code></a>. For example, if this directory contains a <code>properties.xml</code> it will not be overwritten by the generated one. A special case is the <code>filter.xml</code> which will be merged with inline filters if present.</p></description> |
| </parameter> |
| <parameter> |
| <name>name</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The name of the content package</description> |
| </parameter> |
| <parameter> |
| <name>outputTimestamp</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ssXXX</code> or as an int representing seconds since the epoch (like <a href="https://reproducible-builds.org/docs/source-date-epoch/">SOURCE_DATE_EPOCH</a>).</description> |
| </parameter> |
| <parameter> |
| <name>packageDefinitionProperties</name> |
| <type>java.util.Map</type> |
| <typeJavadocUrl>apidocs/java/util/Map.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Specifies <a href="https://jackrabbit.apache.org/filevault/packagedefinition.html">JCR package definition properties</a> to be serialized into the <code>META-INF/vault/definition/.content.xml</code> file. Those are implementation-specific and not standardized by FileVault. Only non-namespaced string properties are allowed here. Properties canonically stored somewhere else (like package properties or filter rules) should not be set.</description> |
| </parameter> |
| <parameter> |
| <name>packageType</name> |
| <type>org.apache.jackrabbit.vault.packaging.PackageType</type> |
| <typeJavadocUrl>apidocs/org/apache/jackrabbit/vault/packaging/PackageType.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>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.<br /> Possible values: |
| <ul> |
| <li><code>application</code>: An application package consists purely of application content. It serializes entire subtrees with no inclusion or exclusion filters. it does not contain any subpackages nor OSGi configuration or bundles.</li> |
| <li><code>content</code>: A content package consists only of content and user defined configuration. It usually serializes entire subtrees but can contain inclusion or exclusion filters. it does not contain any subpackages nor OSGi configuration or bundles.</li> |
| <li><code>container</code>: A container package only contains sub packages and OSGi configuration and bundles. The container package is only used as container for deployment.</li> |
| <li><code>mixed</code>: Catch all type for a combination of the above.</li> |
| </ul></description> |
| </parameter> |
| <parameter> |
| <name>prefix</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Adds a path prefix to all resources. Useful for shallower source trees. This does not apply to files in <a href="#workDirectory"><code>workDirectory</code></a> nor <a href="#metaInfVaultDirectory"><code>metaInfVaultDirectory</code></a> but e.g. is relevant for the default filter and for the jcr_root of the package. Must start with "/" if not empty. As separator only forward slashes are allowed. The trailing slash is automatically appended if not there.</description> |
| </parameter> |
| <parameter> |
| <name>project</name> |
| <type>org.apache.maven.project.MavenProject</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/project/MavenProject.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description>The Maven project.</description> |
| </parameter> |
| <parameter> |
| <name>properties</name> |
| <type>java.util.Properties</type> |
| <typeJavadocUrl>apidocs/java/util/Properties.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Specifies additional <a href="https://jackrabbit.apache.org/filevault/properties.html">package properties</a> to be set in the properties.xml file. These properties cannot overwrite the following predefined properties: |
| <p></p> |
| <table> |
| <tbody> |
| <tr> |
| <td><code>group</code></td> |
| <td>Use <i>group</i> parameter to set</td> |
| </tr> |
| <tr> |
| <td><code>name</code></td> |
| <td>Use <i>name</i> parameter to set</td> |
| </tr> |
| <tr> |
| <td><code>version</code></td> |
| <td>Use <i>version</i> parameter to set</td> |
| </tr> |
| <tr> |
| <td><code>groupId</code></td> |
| <td><i>groupId</i> of the Maven project descriptor</td> |
| </tr> |
| <tr> |
| <td><code>artifactId</code></td> |
| <td><i>artifactId</i> of the Maven project descriptor</td> |
| </tr> |
| <tr> |
| <td><code>dependencies</code></td> |
| <td>Use <i>dependencies</i> parameter to set</td> |
| </tr> |
| <tr> |
| <td><code>createdBy</code></td> |
| <td>The value of the <i>user.name</i> system property</td> |
| </tr> |
| <tr> |
| <td><code>created</code></td> |
| <td>The current system time</td> |
| </tr> |
| <tr> |
| <td><code>requiresRoot</code></td> |
| <td>Use <i>requiresRoot</i> parameter to set</td> |
| </tr> |
| <tr> |
| <td><code>allowIndexDefinitions</code></td> |
| <td>Use <i>allowIndexDefinitions</i> parameter to set</td> |
| </tr> |
| <tr> |
| <td><code>packagePath</code></td> |
| <td>Automatically generated from the group and package name</td> |
| </tr> |
| <tr> |
| <td><code>packageType</code></td> |
| <td>Set via the package type parameter</td> |
| </tr> |
| <tr> |
| <td><code>acHandling</code></td> |
| <td>Use <i>accessControlHandling</i> parameter to set</td> |
| </tr> |
| <tr> |
| <td><code>subPackageHandling</code></td> |
| <td>Use <i>subPackageHandlingEntries</i> parameter to set</td> |
| </tr> |
| </tbody> |
| </table></description> |
| </parameter> |
| <parameter> |
| <name>repoSession</name> |
| <type>org.eclipse.aether.RepositorySystemSession</type> |
| <typeJavadocUrl>apidocs/org/eclipse/aether/RepositorySystemSession.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>repositories</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>requiresRoot</name> |
| <type>boolean</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Defines whether the package requires an admin/privileged session for installation. This will become the <code>requiresRoot</code> property of the properties.xml file.</description> |
| </parameter> |
| <parameter> |
| <name>session</name> |
| <type>org.apache.maven.execution.MavenSession</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/execution/MavenSession.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description>The Maven session.</description> |
| </parameter> |
| <parameter> |
| <name>subPackageHandlingEntries</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <since>1.1.10</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines a list of sub package handling entries, which affect how sub packages are installed. Each entry has the following elements: |
| <ul> |
| <li>option, mandatory, one of the values from <code>org.apache.jackrabbit.vault.packaging.SubPackageHandling.Option</code><!-- this link does not have javadoc linked --></li> |
| <li>groupName, optional, restricts the option to the given group name, if not set affects there is no package group restriction</li> |
| <li>packageName, optional, restricts the option to the given package name, if not set affects all package names</li> |
| </ul></description> |
| </parameter> |
| <parameter> |
| <name>subPackages</name> |
| <type>org.apache.jackrabbit.filevault.maven.packaging.SubPackage[]</type> |
| <typeJavadocUrl>apidocs/org/apache/jackrabbit/filevault/maven/packaging/SubPackage.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines the list of sub packages to be embedded in this package. The <code>SubPackage</code> class represents one or multiple subpackage artifact dependencies from the project descriptor. Each <code>&lt;subPackage&gt;</code> element may configure any of the following fields |
| <p></p> |
| <table> |
| <tbody> |
| <tr> |
| <td><code>groupId</code></td> |
| <td><code>String</code><!-- this link does not have javadoc linked --></td> |
| <td>Filter criterion against the group id of a project dependency. A pattern as described below.</td> |
| </tr> |
| <tr> |
| <td><code>artifactId</code></td> |
| <td><code>String</code><!-- this link does not have javadoc linked --></td> |
| <td>Filter criterion against the artifact id of a project dependency. A pattern as described below.</td> |
| </tr> |
| <tr> |
| <td><code>scope</code></td> |
| <td><code>org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter</code><!-- this link does not have javadoc linked --></td> |
| <td>Filter criterion against the <a href="https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Dependency_Scope">scope of a project dependency</a>. Possible values are |
| <ul> |
| <li><code>test</code>, which allows every scope</li> |
| <li><code>compile+runtime</code> which allows every scope except <code>test</code></li> |
| <li><code>runtime+system</code> which allows every scope except <code>test</code> and <code>provided</code></li> |
| <li><code>compile</code> which allows only scope <code>compile</code>, <code>provided</code> and <code>system</code></li> |
| <li><code>runtime</code> which only allows scope <code>runtime</code> and <code>compile</code>.</li> |
| </ul></td> |
| </tr> |
| <tr> |
| <td><code>type</code></td> |
| <td><code>String</code><!-- this link does not have javadoc linked --></td> |
| <td>Filter criterion against the type of a project dependency. A pattern as described below.</td> |
| </tr> |
| <tr> |
| <td><code>classifier</code></td> |
| <td><code>String</code><!-- this link does not have javadoc linked --></td> |
| <td>Filter criterion against the classifier of a project dependency. A pattern as described below.</td> |
| </tr> |
| <tr> |
| <td><code>filter</code></td> |
| <td><code>Boolean</code><!-- this link does not have javadoc linked --></td> |
| <td>If set to <code>true</code> adds the embedded artifact location to the package's filter. Default = <code>false</code>.</td> |
| </tr> |
| <tr> |
| <td><code>isAllVersionsFilter</code></td> |
| <td><code>Boolean</code><!-- this link does not have javadoc linked --></td> |
| <td>If <code>filter</code> is <code>true</code> and this is <code>true</code> as well, the filter entry will contain all versions of the same artifact (by creating an according filter pattern). Default = <code>false</code>.</td> |
| </tr> |
| <tr> |
| <td><code>excludeTransitive</code></td> |
| <td><code>Boolean</code><!-- this link does not have javadoc linked --></td> |
| <td>If <code>true</code> only filters on direct dependencies (not on transitive ones). Default = <code>false</code>.</td> |
| </tr> |
| </tbody> |
| </table> All fields are optional. All filter criteria is concatenated with AND logic (i.e. every criterion must match for a specific dependency to be embedded as a sub package). <br /> All filter patterns follow the format <code>&lt;filter&gt;{,&lt;filter&gt;}</code>. Each <code>filter</code> within a filter pattern is a string which is either an exclude (if it starts with a <code>~</code>) or an include otherwise. If the first <code>filter</code> is an include the pattern acts as whitelist, otherwise as blacklist. The last matching filter determines the outcome. Only matching dependencies are being considered for being embedded. <br /> <i>The difference between <a href="#embeddeds"><code>embeddeds</code></a> and <a href="#subPackages"><code>subPackages</code></a> is that for the former an explicit target is given while for the latter the target is being computed from the artifact's vault property file.</i></description> |
| </parameter> |
| <parameter> |
| <name>thumbnailImage</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <since>1.0.1</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Optional reference to PNG image that should be used as thumbnail for the content package. Should have a width of 64 pixels.</description> |
| </parameter> |
| <parameter> |
| <name>version</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The version of the content package.</description> |
| </parameter> |
| <parameter> |
| <name>workDirectory</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The output directory for goal "generate-metadata" and additional input directory containing the metadata to be packaged up into the content package for goal "package". The directory name is suffixed with <code>-&lt;classifier&gt;</code> in case a <a href="#classifier"><code>classifier</code></a> is used. In case of the "package" goal this falls back to the non-suffixed directory name in case the one with suffix does not exist.</description> |
| </parameter> |
| </parameters> |
| <configuration> |
| <accessControlHandling implementation="org.apache.jackrabbit.vault.fs.io.AccessControlHandling">${vault.acHandling}</accessControlHandling> |
| <allowIndexDefinitions implementation="boolean" default-value="false">${vault.allowIndexDefinitions}</allowIndexDefinitions> |
| <classifier implementation="java.lang.String">${vault.classifier}</classifier> |
| <dependencies implementation="java.util.Collection">${vault.dependencies}</dependencies> |
| <embeddedTarget implementation="java.lang.String">${vault.embeddedTarget}</embeddedTarget> |
| <failOnEmptyFilter implementation="boolean" default-value="true">${vault.failOnEmptyFilter}</failOnEmptyFilter> |
| <failOnMissingEmbed implementation="boolean" default-value="false">${vault.failOnMissingEmbed}</failOnMissingEmbed> |
| <generatedImportPackage implementation="java.io.File" default-value="${project.build.directory}/vault-generated-import.txt">${vault.generatedImportPackage}</generatedImportPackage> |
| <group implementation="java.lang.String" default-value="${project.groupId}">${vault.group}</group> |
| <importPackage implementation="java.lang.String" default-value="-org.apache.sling.scripting.sightly.compiler.expression.nodes,-org.apache.sling.scripting.sightly.java.compiler,-org.apache.sling.scripting.sightly.render">${vault.importPackage}</importPackage> |
| <metaInfVaultDirectory implementation="java.io.File[]" default-value="${project.basedir}/META-INF/vault,${project.basedir}/src/main/META-INF/vault,${project.basedir}/src/main/content/META-INF/vault,${project.basedir}/src/content/META-INF/vault">${vault.metaInfVaultDirectory}</metaInfVaultDirectory> |
| <name implementation="java.lang.String" default-value="${project.artifactId}">${vault.name}</name> |
| <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/> |
| <packageType implementation="org.apache.jackrabbit.vault.packaging.PackageType">${vault.packageType}</packageType> |
| <prefix implementation="java.lang.String" default-value="">${vault.prefix}</prefix> |
| <project implementation="org.apache.maven.project.MavenProject">${project}</project> |
| <repoSession implementation="org.eclipse.aether.RepositorySystemSession" default-value="${repositorySystemSession}"/> |
| <repositories implementation="java.util.List" default-value="${project.remoteProjectRepositories}"/> |
| <requiresRoot implementation="boolean" default-value="false">${vault.requiresRoot}</requiresRoot> |
| <session implementation="org.apache.maven.execution.MavenSession">${session}</session> |
| <version implementation="java.lang.String" default-value="${project.version}">${vault.version}</version> |
| <workDirectory implementation="java.io.File" default-value="${project.build.directory}/vault-work"/> |
| </configuration> |
| <requirements> |
| <requirement> |
| <role>org.sonatype.plexus.build.incremental.BuildContext</role> |
| <field-name>buildContext</field-name> |
| </requirement> |
| <requirement> |
| <role>org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout</role> |
| <role-hint>default</role-hint> |
| <field-name>embedArtifactLayout</field-name> |
| </requirement> |
| <requirement> |
| <role>org.eclipse.aether.RepositorySystem</role> |
| <field-name>repoSystem</field-name> |
| </requirement> |
| </requirements> |
| </mojo> |
| <mojo> |
| <goal>help</goal> |
| <description>Display help information on filevault-package-maven-plugin.<br /> Call <code>mvn filevault-package:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</description> |
| <requiresDirectInvocation>false</requiresDirectInvocation> |
| <requiresProject>false</requiresProject> |
| <requiresReports>false</requiresReports> |
| <aggregator>false</aggregator> |
| <requiresOnline>false</requiresOnline> |
| <inheritedByDefault>true</inheritedByDefault> |
| <implementation>org.apache.jackrabbit.filevault_package_maven_plugin.HelpMojo</implementation> |
| <language>java</language> |
| <instantiationStrategy>per-lookup</instantiationStrategy> |
| <executionStrategy>once-per-session</executionStrategy> |
| <threadSafe>true</threadSafe> |
| <parameters> |
| <parameter> |
| <name>detail</name> |
| <type>boolean</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>If <code>true</code>, display all settable properties for each goal.</description> |
| </parameter> |
| <parameter> |
| <name>goal</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The name of the goal for which to show help. If unspecified, all goals will be displayed.</description> |
| </parameter> |
| <parameter> |
| <name>indentSize</name> |
| <type>int</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The number of spaces per indentation level, should be positive.</description> |
| </parameter> |
| <parameter> |
| <name>lineLength</name> |
| <type>int</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The maximum length of a display line, should be positive.</description> |
| </parameter> |
| </parameters> |
| <configuration> |
| <detail implementation="boolean" default-value="false">${detail}</detail> |
| <goal implementation="java.lang.String">${goal}</goal> |
| <indentSize implementation="int" default-value="2">${indentSize}</indentSize> |
| <lineLength implementation="int" default-value="80">${lineLength}</lineLength> |
| </configuration> |
| </mojo> |
| <mojo> |
| <goal>package</goal> |
| <description>Builds a content package. Uses the metadata generated by and embedded artifacts (like subpackages or OSGi bundles) configured in a preceding execution of goal <code>generate-metadata</code>. |
| <p><i>This goal is executed/bound by default for Maven modules of type <code>content-package</code>.</i></p></description> |
| <requiresDependencyResolution>compile</requiresDependencyResolution> |
| <requiresDirectInvocation>false</requiresDirectInvocation> |
| <requiresProject>true</requiresProject> |
| <requiresReports>false</requiresReports> |
| <aggregator>false</aggregator> |
| <requiresOnline>false</requiresOnline> |
| <inheritedByDefault>true</inheritedByDefault> |
| <phase>package</phase> |
| <implementation>org.apache.jackrabbit.filevault.maven.packaging.mojo.VaultMojo</implementation> |
| <language>java</language> |
| <instantiationStrategy>per-lookup</instantiationStrategy> |
| <executionStrategy>once-per-session</executionStrategy> |
| <threadSafe>true</threadSafe> |
| <parameters> |
| <parameter> |
| <name>addDefaultExcludes</name> |
| <type>boolean</type> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>By default certain metadata files are excluded which means they will not be copied into the package. If you need them for a particular reason you can do that by setting this parameter to <code>false</code>. This means all files matching the following <a href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant patterns</a> won't be copied by default. |
| <ul> |
| <li>Misc: **/*~, **/#*#, **/.#*, **/%*%, **/._*</li> |
| <li>CVS: **/CVS, **/CVS/**, **/.cvsignore</li> |
| <li>SVN: **/.svn, **/.svn/**</li> |
| <li>GNU: **/.arch-ids, **/.arch-ids/**</li> |
| <li>Bazaar: **/.bzr, **/.bzr/**</li> |
| <li>SurroundSCM: **/.MySCMServerInfo</li> |
| <li>Mac: **/.DS_Store</li> |
| <li>Serena Dimension: **/.metadata, **/.metadata/**</li> |
| <li>Mercurial: **/.hg, **/.hg/**</li> |
| <li>GIT: **/.git, **/.git/**</li> |
| <li>Bitkeeper: **/BitKeeper, **/BitKeeper/**, **/ChangeSet, **/ChangeSet/**</li> |
| <li>Darcs: **/_darcs, **/_darcs/**, **/.darcsrepo, **/.darcsrepo/****/-darcs-backup*, **/.darcs-temp-mail</li> |
| </ul><br /><strong>See also:</strong> org.codehaus.plexus.util.AbstractScanner.DEFAULTEXCLUDES<!-- this link does not have javadoc linked --></description> |
| </parameter> |
| <parameter> |
| <name>archive</name> |
| <type>org.apache.maven.archiver.MavenArchiveConfiguration</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/archiver/MavenArchiveConfiguration.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The archive configuration to use. See <a href="http://maven.apache.org/shared/maven-archiver/index.html">the documentation for Maven Archiver</a>. All settings related to manifest are not relevant as this gets overwritten by the manifest in <a href="#workDirectory"><code>workDirectory</code></a></description> |
| </parameter> |
| <parameter> |
| <name>builtContentDirectory</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <deprecated>Use <a href="#jcrRootSourceDirectory"><code>jcrRootSourceDirectory</code></a> instead.</deprecated> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The directory containing the content to be packaged up into the content package.</description> |
| </parameter> |
| <parameter> |
| <name>classifier</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <since>1.1.4</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Optional classifier to add to the generated package. If given, the artifact will be attached as a supplemental artifact having this classifier. Also all generated metadata will be pushed to <code>&lt;workDirectory&gt;-&lt;classifier&gt;</code> and will preferably be looked up from there. In addition the embedded file names will be exchanged leveraging a classifier specific property.</description> |
| </parameter> |
| <parameter> |
| <name>delimiters</name> |
| <type>java.util.LinkedHashSet</type> |
| <typeJavadocUrl>apidocs/java/util/LinkedHashSet.html</typeJavadocUrl> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description><p>Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form 'beginToken*endToken'. If no '*' is given, the delimiter is assumed to be the same for start and end.</p> |
| <p>So, the default filtering delimiters might be specified as:</p> |
| <pre>&lt;delimiters&gt; |
| &lt;delimiter&gt;${*}&lt;/delimiter&gt; |
| &lt;delimiter&gt;@&lt;/delimiter&gt; |
| &lt;/delimiters&gt; |
| </pre> |
| <p>Since the '@' delimiter is the same on both ends, we don't need to specify '@*@' (though we can).</p></description> |
| </parameter> |
| <parameter> |
| <name>enableJcrRootFiltering</name> |
| <type>boolean</type> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Enables resource filtering on the <a href="#jcrRootSourceDirectory"><code>jcrRootSourceDirectory</code></a> source files similar to what the <a href="https://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html">maven-resources-plugin</a> does. It is recommended to limit filtering with <a href="#filteredFilePatterns"><code>filteredFilePatterns</code></a> and <a href="#nonFilteredFileExtensions"><code>nonFilteredFileExtensions</code></a>.</description> |
| </parameter> |
| <parameter> |
| <name>enableMetaInfFiltering</name> |
| <type>boolean</type> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Enables resource filtering on the meta-inf source files similar to what the <a href="https://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html">maven-resources-plugin</a> does. It is recommended to limit filtering with <a href="#filteredFilePatterns"><code>filteredFilePatterns</code></a> and <a href="#nonFilteredFileExtensions"><code>nonFilteredFileExtensions</code></a>.</description> |
| </parameter> |
| <parameter> |
| <name>escapedBackslashesInFilePath</name> |
| <type>boolean</type> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>To escape interpolated values with Windows path <code>c:\foo\bar</code> will be replaced with <code>c:\\foo\\bar</code>.</description> |
| </parameter> |
| <parameter> |
| <name>escapeString</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Expression preceded with this String won't be interpolated. <code>\${foo}</code> will be replaced with <code>${foo}</code>.</description> |
| </parameter> |
| <parameter> |
| <name>excludes</name> |
| <type>java.util.Set</type> |
| <typeJavadocUrl>apidocs/java/util/Set.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The file name patterns to exclude (in addition to the default ones mentioned at <a href="#addDefaultExcludes"><code>addDefaultExcludes</code></a>. The format of each pattern is described in <code>org.codehaus.plexus.util.DirectoryScanner</code><!-- this link does not have javadoc linked -->. The comparison is against the path relative to the according filter root. Since this is hardly predictable it is recommended to use only filename/directory name patterns here but not take into account file system hierarchies! |
| <p>Each value is either a regex pattern if enclosed within <code>%regex[</code> and <code>]</code>, otherwise an <a href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant pattern</a>.</p></description> |
| </parameter> |
| <parameter> |
| <name>failOnDuplicateEntries</name> |
| <type>boolean</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Set to <code>false</code> to not fail the build in case of files/directories being added to the resulting package more than once. Usually this indicates overlapping with embedded files or overlapping filter rules.</description> |
| </parameter> |
| <parameter> |
| <name>failOnUncoveredSourceFiles</name> |
| <type>boolean</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Set to <code>true</code> to fail the build in case of files are being contained in the <code>jcrRootSourceDirectory</code> which are not covered by the filter rules and therefore would not end up in the package.</description> |
| </parameter> |
| <parameter> |
| <name>filteredFilePatterns</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <since>1.1.8</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Restricts the files which should be filtered to the ones having matching one of the given <a href="http://ant.apache.org/manual/dirtasks.html#patterns">Ant patterns</a>. Evaluated before <a href="#nonFilteredFileExtensions"><code>nonFilteredFileExtensions</code></a>. All patterns are relative to the root paths (given through the filter.xml root entries or the META-INF directory). If empty or not set all files except for the ones from <a href="#nonFilteredFileExtensions"><code>nonFilteredFileExtensions</code></a> are filtered.</description> |
| </parameter> |
| <parameter> |
| <name>filterFiles</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.</description> |
| </parameter> |
| <parameter> |
| <name>finalName</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The name of the generated package ZIP file without the ".zip" file extension. The optional classifier parameter will be appended to the name of the package.</description> |
| </parameter> |
| <parameter> |
| <name>jcrRootSourceDirectory</name> |
| <type>java.io.File[]</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>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.</description> |
| </parameter> |
| <parameter> |
| <name>metaInfDirectory</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The directory that contains additional files and directories to end up in the package's META-INF directory. Every file and subdirectory is considered except for the subdirectory named <code>vault</code> and a file named <code>MANIFEST.MF</code>.</description> |
| </parameter> |
| <parameter> |
| <name>metaInfVaultDirectory</name> |
| <type>java.io.File[]</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The directory that contains the META-INF/vault. 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. |
| <p>This directory is added as fileset to the package archiver before the the <a href="#workDirectory"><code>workDirectory</code></a>. This means that files specified in this directory have precedence over the one present in the <a href="#workDirectory"><code>workDirectory</code></a>. For example, if this directory contains a <code>properties.xml</code> it will not be overwritten by the generated one. A special case is the <code>filter.xml</code> which will be merged with inline filters if present.</p></description> |
| </parameter> |
| <parameter> |
| <name>nonFilteredFileExtensions</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Additional list of file extensions that should not be filtered, e.g. binaries. Already predefined as extensions which should never be filtered are: jpg, jpeg, gif, bmp, png, ico. Instead of using this deny list approach for binary files and others which should not be filtered, consider using an allow list via <a href="#filteredFilePatterns"><code>filteredFilePatterns</code></a> instead.</description> |
| </parameter> |
| <parameter> |
| <name>outputDirectory</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Directory in which the built content package will be output.</description> |
| </parameter> |
| <parameter> |
| <name>outputTimestamp</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Timestamp for reproducible output archive entries, either formatted as ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ssXXX</code> or as an int representing seconds since the epoch (like <a href="https://reproducible-builds.org/docs/source-date-epoch/">SOURCE_DATE_EPOCH</a>).</description> |
| </parameter> |
| <parameter> |
| <name>prefix</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Adds a path prefix to all resources. Useful for shallower source trees. This does not apply to files in <a href="#workDirectory"><code>workDirectory</code></a> nor <a href="#metaInfVaultDirectory"><code>metaInfVaultDirectory</code></a> but e.g. is relevant for the default filter and for the jcr_root of the package. Must start with "/" if not empty. As separator only forward slashes are allowed. The trailing slash is automatically appended if not there.</description> |
| </parameter> |
| <parameter> |
| <name>project</name> |
| <type>org.apache.maven.project.MavenProject</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/project/MavenProject.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description>The Maven project.</description> |
| </parameter> |
| <parameter> |
| <name>resourceEncoding</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The character encoding scheme to be applied when filtering resources.</description> |
| </parameter> |
| <parameter> |
| <name>session</name> |
| <type>org.apache.maven.execution.MavenSession</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/execution/MavenSession.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>supportMultiLineFiltering</name> |
| <type>boolean</type> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Stop searching endToken at the end of line when filtering is applied.</description> |
| </parameter> |
| <parameter> |
| <name>useDefaultDelimiters</name> |
| <type>boolean</type> |
| <since>1.1.0</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Use default delimiters in addition to custom delimiters, if any.</description> |
| </parameter> |
| <parameter> |
| <name>workDirectory</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The output directory for goal "generate-metadata" and additional input directory containing the metadata to be packaged up into the content package for goal "package". The directory name is suffixed with <code>-&lt;classifier&gt;</code> in case a <a href="#classifier"><code>classifier</code></a> is used. In case of the "package" goal this falls back to the non-suffixed directory name in case the one with suffix does not exist.</description> |
| </parameter> |
| </parameters> |
| <configuration> |
| <addDefaultExcludes implementation="boolean" default-value="true"/> |
| <classifier implementation="java.lang.String">${vault.classifier}</classifier> |
| <delimiters implementation="java.util.LinkedHashSet">${vault.delimiters}</delimiters> |
| <enableJcrRootFiltering implementation="boolean" default-value="false">${vault.enableJcrRootFiltering}</enableJcrRootFiltering> |
| <enableMetaInfFiltering implementation="boolean" default-value="false">${vault.enableMetaInfFiltering}</enableMetaInfFiltering> |
| <escapedBackslashesInFilePath implementation="boolean" default-value="false">${vault.escapedBackslashesInFilePath}</escapedBackslashesInFilePath> |
| <escapeString implementation="java.lang.String">${vault.escapeString}</escapeString> |
| <excludes implementation="java.util.Set" default-value="**/.vlt,**/.vltignore,**/.gitignore">${vault.excludes}</excludes> |
| <failOnDuplicateEntries implementation="boolean" default-value="true">${vault.failOnDuplicateEntries}</failOnDuplicateEntries> |
| <failOnUncoveredSourceFiles implementation="boolean" default-value="true">${vault.failOnUncoveredSourceFiles}</failOnUncoveredSourceFiles> |
| <filteredFilePatterns implementation="java.util.List">${vault.filteredFilePatterns}</filteredFilePatterns> |
| <filterFiles implementation="java.util.List">${vault.filters}</filterFiles> |
| <finalName implementation="java.lang.String" default-value="${project.build.finalName}">${vault.finalName}</finalName> |
| <jcrRootSourceDirectory implementation="java.io.File[]" default-value="${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}">${vault.jcrRootSourceDirectory}</jcrRootSourceDirectory> |
| <metaInfDirectory implementation="java.io.File">${vault.metaInfDirectory}</metaInfDirectory> |
| <metaInfVaultDirectory implementation="java.io.File[]" default-value="${project.basedir}/META-INF/vault,${project.basedir}/src/main/META-INF/vault,${project.basedir}/src/main/content/META-INF/vault,${project.basedir}/src/content/META-INF/vault">${vault.metaInfVaultDirectory}</metaInfVaultDirectory> |
| <nonFilteredFileExtensions implementation="java.util.List">${vault.nonFilteredFileExtensions}</nonFilteredFileExtensions> |
| <outputDirectory implementation="java.io.File" default-value="${project.build.directory}">${vault.outputDirectory}</outputDirectory> |
| <outputTimestamp implementation="java.lang.String" default-value="${project.build.outputTimestamp}"/> |
| <prefix implementation="java.lang.String" default-value="">${vault.prefix}</prefix> |
| <project implementation="org.apache.maven.project.MavenProject">${project}</project> |
| <resourceEncoding implementation="java.lang.String" default-value="${project.build.sourceEncoding}">${vault.resourceEncoding}</resourceEncoding> |
| <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/> |
| <supportMultiLineFiltering implementation="boolean" default-value="false">${vault.supportMultiLineFiltering}</supportMultiLineFiltering> |
| <useDefaultDelimiters implementation="boolean" default-value="true">${vault.useDefaultDelimiters}</useDefaultDelimiters> |
| <workDirectory implementation="java.io.File" default-value="${project.build.directory}/vault-work"/> |
| </configuration> |
| <requirements> |
| <requirement> |
| <role>org.apache.maven.artifact.handler.manager.ArtifactHandlerManager</role> |
| <field-name>artifactHandlerManager</field-name> |
| </requirement> |
| <requirement> |
| <role>org.apache.maven.shared.filtering.MavenResourcesFiltering</role> |
| <role-hint>default</role-hint> |
| <field-name>mavenResourcesFiltering</field-name> |
| </requirement> |
| <requirement> |
| <role>org.apache.maven.project.MavenProjectHelper</role> |
| <field-name>projectHelper</field-name> |
| </requirement> |
| </requirements> |
| </mojo> |
| <mojo> |
| <goal>validate-files</goal> |
| <description>Validates individual files with all registered validators. This is only active for incremental builds (i.e. inside m2e) or when mojo "validate-package" is not executed in the current Maven execution. |
| <p><i>This goal is executed/bound by default for Maven modules of type <code>content-package</code>.</i></p><br /><strong>See also:</strong> <a href="https://jackrabbit.apache.org/filevault-package-maven-plugin/validators.html">Validators</a></description> |
| <requiresDependencyResolution>compile</requiresDependencyResolution> |
| <requiresDirectInvocation>false</requiresDirectInvocation> |
| <requiresProject>true</requiresProject> |
| <requiresReports>false</requiresReports> |
| <aggregator>false</aggregator> |
| <requiresOnline>false</requiresOnline> |
| <inheritedByDefault>true</inheritedByDefault> |
| <phase>process-test-sources</phase> |
| <implementation>org.apache.jackrabbit.filevault.maven.packaging.mojo.ValidateFilesMojo</implementation> |
| <language>java</language> |
| <instantiationStrategy>per-lookup</instantiationStrategy> |
| <executionStrategy>once-per-session</executionStrategy> |
| <since>1.1.0</since> |
| <threadSafe>true</threadSafe> |
| <parameters> |
| <parameter> |
| <name>builtContentDirectory</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <deprecated>No reason given</deprecated> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The directory containing the content to be packaged up into the content package. This property is deprecated; use <a href="#jcrRootSourceDirectory"><code>jcrRootSourceDirectory</code></a> instead.</description> |
| </parameter> |
| <parameter> |
| <name>classifier</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>If given validates files built for the given classifier. This modifies the <a href="#workDirectory"><code>workDirectory</code></a> and appends the suffix <code>-&lt;classifier&gt;</code> to it.</description> |
| </parameter> |
| <parameter> |
| <name>csvReportFile</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The file where to write a report of all found validation violations (warnings and errors) in CSV format as defined in <a href="https://tools.ietf.org/html/rfc4180">RFC 4180</a>. The generated file is using UTF-8 character encoding. No CSV report is written if this parameter is not set (default).</description> |
| </parameter> |
| <parameter> |
| <name>dependencies</name> |
| <type>java.util.Collection</type> |
| <typeJavadocUrl>apidocs/java/util/Collection.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines the list of dependencies. A dependency is declared as a <code>&lt;dependency&gt;</code> element of a list style <code>&lt;dependencies&gt;</code> element: |
| <pre>&lt;dependency&gt; |
| &lt;group&gt;theGroup&lt;/group&gt; |
| &lt;name&gt;theName&lt;/name&gt; |
| &lt;version&gt;1.5&lt;/version&gt; |
| &lt;/dependency&gt; |
| </pre> |
| <p>The dependency can also reference a maven project dependency, this is preferred as it yields to more robust builds.</p> |
| <pre>&lt;dependency&gt; |
| &lt;groupId&gt;theGroup&lt;/groupId&gt; |
| &lt;artifactId&gt;theName&lt;/artifactId&gt; |
| &lt;/dependency&gt; |
| </pre> |
| <p>The <code>versionRange</code> may be indicated as a single version, in which case the version range has no upper bound and defines the minimal version accepted. Otherwise, the version range defines a lower and upper bound of accepted versions, where the bounds are either included using parentheses <code>()</code> or excluded using brackets <code>[]</code></p></description> |
| </parameter> |
| <parameter> |
| <name>excludes</name> |
| <type>java.lang.String[]</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The file name patterns to exclude in addition to the ones listed in <code>org.codehaus.plexus.util.AbstractScanner.DEFAULTEXCLUDES</code><!-- this link does not have javadoc linked -->. The format of each pattern is described in <code>org.codehaus.plexus.util.DirectoryScanner</code><!-- this link does not have javadoc linked -->. The comparison is against the path relative to the according filter root. Since this is hardly predictable it is recommended to use only filename/directory name patterns here but not take into account file system hierarchies! |
| <p>Each value is either a regex pattern if enclosed within <code>%regex[</code> and <code>]</code>, otherwise an <a href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant pattern</a>.</p></description> |
| </parameter> |
| <parameter> |
| <name>failOnDependencyErrors</name> |
| <type>boolean</type> |
| <deprecated>Use <a href="#validatorsSettings"><code>validatorsSettings</code></a> with the following values instead |
| <pre> &lt;jackrabbit-dependencies&gt; |
| &lt;defaultSeverity&gt;debug&lt;/defaultSeverity&gt; |
| &lt;/jackrabbit-dependencies&gt; |
| </pre></deprecated> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Controls if errors during dependency validation should fail the build.</description> |
| </parameter> |
| <parameter> |
| <name>failOnValidationWarnings</name> |
| <type>boolean</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>If set to <code>true</code> will lead to all validation errors or warnings failing the build, otherwise only validation errors lead to a build failure</description> |
| </parameter> |
| <parameter> |
| <name>jcrRootSourceDirectory</name> |
| <type>java.io.File[]</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>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.</description> |
| </parameter> |
| <parameter> |
| <name>mapPackageDependencyToMavenGa</name> |
| <type>java.util.Collection</type> |
| <typeJavadocUrl>apidocs/java/util/Collection.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Mapping of package dependencies given via group and name to Maven identifiers for enhanced validation. Each entry must have the format <code>&lt;group&gt;:&lt;name&gt;=&lt;groupId&gt;:&lt;artifactId&gt;</code>. To disable lookup (e.g. because referenced artifact is not available in a Maven repository) use <code>&lt;group&gt;:&lt;name&gt;=ignore</code>. This will also prevent the WARNING which would be otherwise be emitted.</description> |
| </parameter> |
| <parameter> |
| <name>metaInfVaultDirectory</name> |
| <type>java.io.File[]</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The directory that contains the META-INF/vault. 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. |
| <p>This directory is added as fileset to the package archiver before the the <a href="#workDirectory"><code>workDirectory</code></a>. This means that files specified in this directory have precedence over the one present in the <a href="#workDirectory"><code>workDirectory</code></a>. For example, if this directory contains a <code>properties.xml</code> it will not be overwritten by the generated one. A special case is the <code>filter.xml</code> which will be merged with inline filters if present.</p></description> |
| </parameter> |
| <parameter> |
| <name>mojoExecution</name> |
| <type>org.apache.maven.plugin.MojoExecution</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/plugin/MojoExecution.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>project</name> |
| <type>org.apache.maven.project.MavenProject</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/project/MavenProject.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>false</editable> |
| <description>The Maven project (never <code>null</code>, but might be dummy project returning <code>null</code> for all methods if running outside a <code>pom.xml</code> context)</description> |
| </parameter> |
| <parameter> |
| <name>repositoryStructurePackages</name> |
| <type>java.util.Collection</type> |
| <typeJavadocUrl>apidocs/java/util/Collection.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines the packages that define the repository structure. They are sharing the same format as the elements used in <a href="#dependencies"><code>dependencies</code></a>. |
| <p>The <a href="https://sling.apache.org/documentation/bundles/repository-initialization.html">repoinit feature</a> of Sling can define initial content that will be available in the repository before the first package is installed. Packages that depend on those nodes have no way to reference a regular dependency package that provides these nodes. A "real" package that would creates those nodes cannot be installed in the repository, because it would void the repoinit structure. On the other hand FileVault would complain, if the package was listed as dependency but not installed in the repository. Therefore these repository-structure packages serve as build-time only dependency that help satisfy the structural dependencies, but are not added as real (i.e. run-time) dependencies to the package. Repository-structure packages are only evaluated for their contained <a href="https://jackrabbit.apache.org/filevault/filter.html">filter rules' root attributes</a>. Currently these packages are only used to define the <a href="https://jackrabbit.apache.org/filevault/validation.html#standard-validators"><code>validRoots</code> of the validator <code>jackrabbit-filter</code></a>.</p></description> |
| </parameter> |
| <parameter> |
| <name>session</name> |
| <type>org.apache.maven.execution.MavenSession</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/execution/MavenSession.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>skipValidation</name> |
| <type>boolean</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Skips validation.</description> |
| </parameter> |
| <parameter> |
| <name>validatorsSettings</name> |
| <type>java.util.Map</type> |
| <typeJavadocUrl>apidocs/java/util/Map.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>All validator settings in a map. The keys are the validator ids (optionally suffixed by <code>__</code> and some arbitrary string). Each key must only appear once. Use the suffix if you have validator settings for the same id with different restrictions. The values are a complex object of type <a href="apidocs/org/apache/jackrabbit/filevault/maven/packaging/ValidatorSettings.html"><code>org.apache.jackrabbit.filevault.maven.packaging.ValidatorSettings</code></a>. An example configuration looks like |
| <pre> &lt;jackrabbit-filter&gt; |
| &lt;options&gt; |
| &lt;severityForUncoveredAncestorNodes&gt;error&lt;/severityForUncoveredAncestorNodes&gt; |
| &lt;/options&gt; |
| &lt;/jackrabbit-filter&gt; |
| </pre> Each validator settings consists of the fields <code>isDisabled</code>, <code>defaultSeverity</code> and <code>options</code>. In addition the settings may be restricted to certain packages only with the help of field <code>packageRestriction</code>. |
| <pre> &lt;jackrabbit-filter__restricted1&gt; |
| &lt;options&gt; |
| &lt;severityForUncoveredAncestorNodes&gt;warning&lt;/severityForUncoveredAncestorNodes&gt; |
| &lt;/options&gt; |
| &lt;packageRestriction&gt; |
| &lt;group&gt;somegroup&lt;/group&gt; &lt;!-- optional, if set the enclosing settings apply only to packages with the given group --&gt; |
| &lt;name&gt;somename&lt;/name&gt; &lt;!-- optional, if set the enclosing settings apply only to packages with the given name --&gt; |
| &lt;subPackageOnly&gt;true&lt;/subPackageOnly&gt; &lt;!-- if set to true, the enclosing settings apply only to subpackages otherwise to all kinds of packages --&gt; |
| &lt;packageRestriction&gt; |
| &lt;/jackrabbit-filter__restricted1&gt; |
| </pre> As potentially multiple map entries may affect the same validator id (due to different suffixes) the settings for a single validator id are merged in the order from more specific to more generic settings: |
| <ol> |
| <li>settings for a specific package group and a specific package name</li> |
| <li>settings for any package group and a specific package name</li> |
| <li>settings for a specific package group and any package name</li> |
| <li>settings without restrictions</li> |
| </ol> Merging will only overwrite non-existing fields, i.e. same-named options from more specific settings will overwrite those from more generic ones (for the same validator id).</description> |
| </parameter> |
| <parameter> |
| <name>workDirectory</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>true</editable> |
| <description>The directory containing the metadata to be packaged up into the content package. Basically containing all files/directories being generated by goal <code>generate-metadata</code>.</description> |
| </parameter> |
| </parameters> |
| <configuration> |
| <classifier implementation="java.lang.String">${vault.classifier}</classifier> |
| <csvReportFile implementation="java.io.File">${vault.validation.csvReportFile}</csvReportFile> |
| <dependencies implementation="java.util.Collection">${vault.dependencies}</dependencies> |
| <excludes implementation="java.lang.String[]" default-value="**/.vlt,**/.vltignore">${vault.excludes}</excludes> |
| <failOnDependencyErrors implementation="boolean" default-value="true">${vault.failOnDependencyErrors}</failOnDependencyErrors> |
| <failOnValidationWarnings implementation="boolean" default-value="false">${vault.failOnValidationWarning}</failOnValidationWarnings> |
| <jcrRootSourceDirectory implementation="java.io.File[]" default-value="${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}">${vault.jcrRootSourceDirectory}</jcrRootSourceDirectory> |
| <mapPackageDependencyToMavenGa implementation="java.util.Collection">${vault.package.dependency.to.maven.ga}</mapPackageDependencyToMavenGa> |
| <metaInfVaultDirectory implementation="java.io.File[]" default-value="${project.basedir}/META-INF/vault,${project.basedir}/src/main/META-INF/vault,${project.basedir}/src/main/content/META-INF/vault,${project.basedir}/src/content/META-INF/vault">${vault.metaInfVaultDirectory}</metaInfVaultDirectory> |
| <mojoExecution implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/> |
| <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/> |
| <repositoryStructurePackages implementation="java.util.Collection">${vault.repository.structure.packages}</repositoryStructurePackages> |
| <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/> |
| <skipValidation implementation="boolean" default-value="false">${vault.skipValidation}</skipValidation> |
| <workDirectory implementation="java.io.File" default-value="${project.build.directory}/vault-work"/> |
| </configuration> |
| <requirements> |
| <requirement> |
| <role>org.sonatype.plexus.build.incremental.BuildContext</role> |
| <field-name>buildContext</field-name> |
| </requirement> |
| <requirement> |
| <role>org.apache.maven.lifecycle.LifecycleExecutor</role> |
| <field-name>lifecycleExecutor</field-name> |
| </requirement> |
| <requirement> |
| <role>org.apache.maven.repository.RepositorySystem</role> |
| <field-name>repositorySystem</field-name> |
| </requirement> |
| <requirement> |
| <role>org.apache.maven.artifact.resolver.ResolutionErrorHandler</role> |
| <field-name>resolutionErrorHandler</field-name> |
| </requirement> |
| </requirements> |
| </mojo> |
| <mojo> |
| <goal>validate-package</goal> |
| <description>Validates a package (and optionally in addition all attached packages with the given classifiers) with all registered validators. |
| <p><i>This goal is executed/bound by default for Maven modules of type <code>content-package</code>.</i></p><br /><strong>See also:</strong> <a href="https://jackrabbit.apache.org/filevault-package-maven-plugin/validators.html">Validators</a></description> |
| <requiresDependencyResolution>compile</requiresDependencyResolution> |
| <requiresDirectInvocation>false</requiresDirectInvocation> |
| <requiresProject>false</requiresProject> |
| <requiresReports>false</requiresReports> |
| <aggregator>false</aggregator> |
| <requiresOnline>false</requiresOnline> |
| <inheritedByDefault>true</inheritedByDefault> |
| <phase>verify</phase> |
| <implementation>org.apache.jackrabbit.filevault.maven.packaging.mojo.ValidatePackageMojo</implementation> |
| <language>java</language> |
| <instantiationStrategy>per-lookup</instantiationStrategy> |
| <executionStrategy>once-per-session</executionStrategy> |
| <since>1.1.0</since> |
| <threadSafe>true</threadSafe> |
| <parameters> |
| <parameter> |
| <name>attachedArtifacts</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>classifier</name> |
| <type>java.lang.String</type> |
| <typeJavadocUrl>apidocs/java/lang/String.html</typeJavadocUrl> |
| <since>1.2.2</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The given classifier is merged with the ones from parameter <a href="#classifiers"><code>classifiers</code></a>. All matching attached artifacts are validated (potentially in addition to the primary artifact depending on parameter <a href="#skipPrimaryArtifact"><code>skipPrimaryArtifact</code></a>).</description> |
| </parameter> |
| <parameter> |
| <name>classifiers</name> |
| <type>java.util.List</type> |
| <typeJavadocUrl>apidocs/java/util/List.html</typeJavadocUrl> |
| <since>1.1.4</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The given classifiers are merged with the one from parameter <a href="#classifier"><code>classifier</code></a>. All matching attached artifacts are validated (potentially in addition to the primary artifact depending on parameter <a href="#skipPrimaryArtifact"><code>skipPrimaryArtifact</code></a>).</description> |
| </parameter> |
| <parameter> |
| <name>csvReportFile</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>The file where to write a report of all found validation violations (warnings and errors) in CSV format as defined in <a href="https://tools.ietf.org/html/rfc4180">RFC 4180</a>. The generated file is using UTF-8 character encoding. No CSV report is written if this parameter is not set (default).</description> |
| </parameter> |
| <parameter> |
| <name>dependencies</name> |
| <type>java.util.Collection</type> |
| <typeJavadocUrl>apidocs/java/util/Collection.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines the list of dependencies. A dependency is declared as a <code>&lt;dependency&gt;</code> element of a list style <code>&lt;dependencies&gt;</code> element: |
| <pre>&lt;dependency&gt; |
| &lt;group&gt;theGroup&lt;/group&gt; |
| &lt;name&gt;theName&lt;/name&gt; |
| &lt;version&gt;1.5&lt;/version&gt; |
| &lt;/dependency&gt; |
| </pre> |
| <p>The dependency can also reference a maven project dependency, this is preferred as it yields to more robust builds.</p> |
| <pre>&lt;dependency&gt; |
| &lt;groupId&gt;theGroup&lt;/groupId&gt; |
| &lt;artifactId&gt;theName&lt;/artifactId&gt; |
| &lt;/dependency&gt; |
| </pre> |
| <p>The <code>versionRange</code> may be indicated as a single version, in which case the version range has no upper bound and defines the minimal version accepted. Otherwise, the version range defines a lower and upper bound of accepted versions, where the bounds are either included using parentheses <code>()</code> or excluded using brackets <code>[]</code></p></description> |
| </parameter> |
| <parameter> |
| <name>enforceRecursiveSubpackageValidation</name> |
| <type>boolean</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>If set to <code>true</code> always executes all validators also for all sub packages (recursively).</description> |
| </parameter> |
| <parameter> |
| <name>failOnDependencyErrors</name> |
| <type>boolean</type> |
| <deprecated>Use <a href="#validatorsSettings"><code>validatorsSettings</code></a> with the following values instead |
| <pre> &lt;jackrabbit-dependencies&gt; |
| &lt;defaultSeverity&gt;debug&lt;/defaultSeverity&gt; |
| &lt;/jackrabbit-dependencies&gt; |
| </pre></deprecated> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Controls if errors during dependency validation should fail the build.</description> |
| </parameter> |
| <parameter> |
| <name>failOnValidationWarnings</name> |
| <type>boolean</type> |
| <required>false</required> |
| <editable>true</editable> |
| <description>If set to <code>true</code> will lead to all validation errors or warnings failing the build, otherwise only validation errors lead to a build failure</description> |
| </parameter> |
| <parameter> |
| <name>mapPackageDependencyToMavenGa</name> |
| <type>java.util.Collection</type> |
| <typeJavadocUrl>apidocs/java/util/Collection.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Mapping of package dependencies given via group and name to Maven identifiers for enhanced validation. Each entry must have the format <code>&lt;group&gt;:&lt;name&gt;=&lt;groupId&gt;:&lt;artifactId&gt;</code>. To disable lookup (e.g. because referenced artifact is not available in a Maven repository) use <code>&lt;group&gt;:&lt;name&gt;=ignore</code>. This will also prevent the WARNING which would be otherwise be emitted.</description> |
| </parameter> |
| <parameter> |
| <name>mojoExecution</name> |
| <type>org.apache.maven.plugin.MojoExecution</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/plugin/MojoExecution.html</typeJavadocUrl> |
| <required>true</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>primaryArtifact</name> |
| <type>java.io.File</type> |
| <typeJavadocUrl>apidocs/java/io/File.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>false</editable> |
| <description>The main package file to validate.</description> |
| </parameter> |
| <parameter> |
| <name>project</name> |
| <type>org.apache.maven.project.MavenProject</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/project/MavenProject.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>false</editable> |
| <description>The Maven project (never <code>null</code>, but might be dummy project returning <code>null</code> for all methods if running outside a <code>pom.xml</code> context)</description> |
| </parameter> |
| <parameter> |
| <name>repositoryStructurePackages</name> |
| <type>java.util.Collection</type> |
| <typeJavadocUrl>apidocs/java/util/Collection.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>Defines the packages that define the repository structure. They are sharing the same format as the elements used in <a href="#dependencies"><code>dependencies</code></a>. |
| <p>The <a href="https://sling.apache.org/documentation/bundles/repository-initialization.html">repoinit feature</a> of Sling can define initial content that will be available in the repository before the first package is installed. Packages that depend on those nodes have no way to reference a regular dependency package that provides these nodes. A "real" package that would creates those nodes cannot be installed in the repository, because it would void the repoinit structure. On the other hand FileVault would complain, if the package was listed as dependency but not installed in the repository. Therefore these repository-structure packages serve as build-time only dependency that help satisfy the structural dependencies, but are not added as real (i.e. run-time) dependencies to the package. Repository-structure packages are only evaluated for their contained <a href="https://jackrabbit.apache.org/filevault/filter.html">filter rules' root attributes</a>. Currently these packages are only used to define the <a href="https://jackrabbit.apache.org/filevault/validation.html#standard-validators"><code>validRoots</code> of the validator <code>jackrabbit-filter</code></a>.</p></description> |
| </parameter> |
| <parameter> |
| <name>session</name> |
| <type>org.apache.maven.execution.MavenSession</type> |
| <typeJavadocUrl>apidocs/org/apache/maven/execution/MavenSession.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>false</editable> |
| <description></description> |
| </parameter> |
| <parameter> |
| <name>skipPrimaryArtifact</name> |
| <type>boolean</type> |
| <since>1.3.2</since> |
| <required>false</required> |
| <editable>true</editable> |
| <description>If set to <code>true</code> skips validating the project's primary artifact but only the ones being attached and having a classifier equal to the one(s) in either <a href="#classifiers"><code>classifiers</code></a> and/or <a href="#classifier"><code>classifier</code></a>.</description> |
| </parameter> |
| <parameter> |
| <name>skipSubPackageValidation</name> |
| <type>boolean</type> |
| <since>1.1.2</since> |
| <required>true</required> |
| <editable>true</editable> |
| <description>If set to <code>true</code> will not validate any sub packages. This settings overwrites the parameter <a href="#enforceRecursiveSubpackageValidation"><code>enforceRecursiveSubpackageValidation</code></a>.</description> |
| </parameter> |
| <parameter> |
| <name>skipValidation</name> |
| <type>boolean</type> |
| <required>true</required> |
| <editable>true</editable> |
| <description>Skips validation.</description> |
| </parameter> |
| <parameter> |
| <name>validatorsSettings</name> |
| <type>java.util.Map</type> |
| <typeJavadocUrl>apidocs/java/util/Map.html</typeJavadocUrl> |
| <required>false</required> |
| <editable>true</editable> |
| <description>All validator settings in a map. The keys are the validator ids (optionally suffixed by <code>__</code> and some arbitrary string). Each key must only appear once. Use the suffix if you have validator settings for the same id with different restrictions. The values are a complex object of type <a href="apidocs/org/apache/jackrabbit/filevault/maven/packaging/ValidatorSettings.html"><code>org.apache.jackrabbit.filevault.maven.packaging.ValidatorSettings</code></a>. An example configuration looks like |
| <pre> &lt;jackrabbit-filter&gt; |
| &lt;options&gt; |
| &lt;severityForUncoveredAncestorNodes&gt;error&lt;/severityForUncoveredAncestorNodes&gt; |
| &lt;/options&gt; |
| &lt;/jackrabbit-filter&gt; |
| </pre> Each validator settings consists of the fields <code>isDisabled</code>, <code>defaultSeverity</code> and <code>options</code>. In addition the settings may be restricted to certain packages only with the help of field <code>packageRestriction</code>. |
| <pre> &lt;jackrabbit-filter__restricted1&gt; |
| &lt;options&gt; |
| &lt;severityForUncoveredAncestorNodes&gt;warning&lt;/severityForUncoveredAncestorNodes&gt; |
| &lt;/options&gt; |
| &lt;packageRestriction&gt; |
| &lt;group&gt;somegroup&lt;/group&gt; &lt;!-- optional, if set the enclosing settings apply only to packages with the given group --&gt; |
| &lt;name&gt;somename&lt;/name&gt; &lt;!-- optional, if set the enclosing settings apply only to packages with the given name --&gt; |
| &lt;subPackageOnly&gt;true&lt;/subPackageOnly&gt; &lt;!-- if set to true, the enclosing settings apply only to subpackages otherwise to all kinds of packages --&gt; |
| &lt;packageRestriction&gt; |
| &lt;/jackrabbit-filter__restricted1&gt; |
| </pre> As potentially multiple map entries may affect the same validator id (due to different suffixes) the settings for a single validator id are merged in the order from more specific to more generic settings: |
| <ol> |
| <li>settings for a specific package group and a specific package name</li> |
| <li>settings for any package group and a specific package name</li> |
| <li>settings for a specific package group and any package name</li> |
| <li>settings without restrictions</li> |
| </ol> Merging will only overwrite non-existing fields, i.e. same-named options from more specific settings will overwrite those from more generic ones (for the same validator id).</description> |
| </parameter> |
| </parameters> |
| <configuration> |
| <attachedArtifacts implementation="java.util.List" default-value="${project.attachedArtifacts}"/> |
| <classifier implementation="java.lang.String">${vault.classifier}</classifier> |
| <classifiers implementation="java.util.List">${vault.classifiers}</classifiers> |
| <csvReportFile implementation="java.io.File">${vault.validation.csvReportFile}</csvReportFile> |
| <dependencies implementation="java.util.Collection">${vault.dependencies}</dependencies> |
| <enforceRecursiveSubpackageValidation implementation="boolean" default-value="false"/> |
| <failOnDependencyErrors implementation="boolean" default-value="true">${vault.failOnDependencyErrors}</failOnDependencyErrors> |
| <failOnValidationWarnings implementation="boolean" default-value="false">${vault.failOnValidationWarning}</failOnValidationWarnings> |
| <mapPackageDependencyToMavenGa implementation="java.util.Collection">${vault.package.dependency.to.maven.ga}</mapPackageDependencyToMavenGa> |
| <mojoExecution implementation="org.apache.maven.plugin.MojoExecution" default-value="${mojoExecution}"/> |
| <primaryArtifact implementation="java.io.File" default-value="${project.artifact.file}"/> |
| <project implementation="org.apache.maven.project.MavenProject" default-value="${project}"/> |
| <repositoryStructurePackages implementation="java.util.Collection">${vault.repository.structure.packages}</repositoryStructurePackages> |
| <session implementation="org.apache.maven.execution.MavenSession" default-value="${session}"/> |
| <skipSubPackageValidation implementation="boolean" default-value="false"/> |
| <skipValidation implementation="boolean" default-value="false">${vault.skipValidation}</skipValidation> |
| </configuration> |
| <requirements> |
| <requirement> |
| <role>org.sonatype.plexus.build.incremental.BuildContext</role> |
| <field-name>buildContext</field-name> |
| </requirement> |
| <requirement> |
| <role>org.apache.maven.repository.RepositorySystem</role> |
| <field-name>repositorySystem</field-name> |
| </requirement> |
| <requirement> |
| <role>org.apache.maven.artifact.resolver.ResolutionErrorHandler</role> |
| <field-name>resolutionErrorHandler</field-name> |
| </requirement> |
| </requirements> |
| </mojo> |
| </mojos> |
| <dependencies> |
| <dependency> |
| <groupId>org.apache.jackrabbit.vault</groupId> |
| <artifactId>org.apache.jackrabbit.vault</artifactId> |
| <type>jar</type> |
| <version>3.6.4</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.jackrabbit.vault</groupId> |
| <artifactId>vault-validation</artifactId> |
| <type>jar</type> |
| <version>3.6.4</version> |
| </dependency> |
| <dependency> |
| <groupId>javax.jcr</groupId> |
| <artifactId>jcr</artifactId> |
| <type>jar</type> |
| <version>2.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.jackrabbit</groupId> |
| <artifactId>jackrabbit-jcr-commons</artifactId> |
| <type>jar</type> |
| <version>2.20.6</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.jackrabbit</groupId> |
| <artifactId>oak-jackrabbit-api</artifactId> |
| <type>jar</type> |
| <version>1.42.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.jackrabbit</groupId> |
| <artifactId>jackrabbit-spi-commons</artifactId> |
| <type>jar</type> |
| <version>2.20.6</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.jackrabbit</groupId> |
| <artifactId>jackrabbit-spi</artifactId> |
| <type>jar</type> |
| <version>2.20.6</version> |
| </dependency> |
| <dependency> |
| <groupId>commons-collections</groupId> |
| <artifactId>commons-collections</artifactId> |
| <type>jar</type> |
| <version>3.2.2</version> |
| </dependency> |
| <dependency> |
| <groupId>org.osgi</groupId> |
| <artifactId>org.osgi.framework</artifactId> |
| <type>jar</type> |
| <version>1.8.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.plexus</groupId> |
| <artifactId>plexus-interpolation</artifactId> |
| <type>jar</type> |
| <version>1.21</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.commons</groupId> |
| <artifactId>commons-lang3</artifactId> |
| <type>jar</type> |
| <version>3.6</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.plexus</groupId> |
| <artifactId>plexus-utils</artifactId> |
| <type>jar</type> |
| <version>3.4.2</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.maven</groupId> |
| <artifactId>maven-archiver</artifactId> |
| <type>jar</type> |
| <version>3.6.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.plexus</groupId> |
| <artifactId>plexus-io</artifactId> |
| <type>jar</type> |
| <version>3.4.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.plexus</groupId> |
| <artifactId>plexus-archiver</artifactId> |
| <type>jar</type> |
| <version>4.4.0</version> |
| </dependency> |
| <dependency> |
| <groupId>javax.inject</groupId> |
| <artifactId>javax.inject</artifactId> |
| <type>jar</type> |
| <version>1</version> |
| </dependency> |
| <dependency> |
| <groupId>commons-io</groupId> |
| <artifactId>commons-io</artifactId> |
| <type>jar</type> |
| <version>2.5</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.commons</groupId> |
| <artifactId>commons-compress</artifactId> |
| <type>jar</type> |
| <version>1.21</version> |
| </dependency> |
| <dependency> |
| <groupId>org.iq80.snappy</groupId> |
| <artifactId>snappy</artifactId> |
| <type>jar</type> |
| <version>0.4</version> |
| </dependency> |
| <dependency> |
| <groupId>org.tukaani</groupId> |
| <artifactId>xz</artifactId> |
| <type>jar</type> |
| <version>1.9</version> |
| </dependency> |
| <dependency> |
| <groupId>org.slf4j</groupId> |
| <artifactId>jcl-over-slf4j</artifactId> |
| <type>jar</type> |
| <version>1.7.5</version> |
| </dependency> |
| <dependency> |
| <groupId>biz.aQute.bnd</groupId> |
| <artifactId>biz.aQute.bndlib</artifactId> |
| <type>jar</type> |
| <version>6.2.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.osgi</groupId> |
| <artifactId>org.osgi.dto</artifactId> |
| <type>jar</type> |
| <version>1.0.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.osgi</groupId> |
| <artifactId>org.osgi.resource</artifactId> |
| <type>jar</type> |
| <version>1.0.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.osgi</groupId> |
| <artifactId>org.osgi.util.tracker</artifactId> |
| <type>jar</type> |
| <version>1.5.4</version> |
| </dependency> |
| <dependency> |
| <groupId>org.osgi</groupId> |
| <artifactId>osgi.annotation</artifactId> |
| <type>jar</type> |
| <version>8.0.1</version> |
| </dependency> |
| <dependency> |
| <groupId>org.osgi</groupId> |
| <artifactId>org.osgi.service.log</artifactId> |
| <type>jar</type> |
| <version>1.3.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.osgi</groupId> |
| <artifactId>org.osgi.service.repository</artifactId> |
| <type>jar</type> |
| <version>1.1.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.osgi</groupId> |
| <artifactId>org.osgi.util.function</artifactId> |
| <type>jar</type> |
| <version>1.2.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.osgi</groupId> |
| <artifactId>org.osgi.util.promise</artifactId> |
| <type>jar</type> |
| <version>1.2.0</version> |
| </dependency> |
| <dependency> |
| <groupId>biz.aQute.bnd</groupId> |
| <artifactId>biz.aQute.bnd.util</artifactId> |
| <type>jar</type> |
| <version>6.2.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.mojo</groupId> |
| <artifactId>animal-sniffer-maven-plugin</artifactId> |
| <type>jar</type> |
| <version>1.21</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.mojo</groupId> |
| <artifactId>java-boot-classpath-detector</artifactId> |
| <type>jar</type> |
| <version>1.21</version> |
| </dependency> |
| <dependency> |
| <groupId>org.codehaus.mojo</groupId> |
| <artifactId>animal-sniffer</artifactId> |
| <type>jar</type> |
| <version>1.21</version> |
| </dependency> |
| <dependency> |
| <groupId>org.ow2.asm</groupId> |
| <artifactId>asm</artifactId> |
| <type>jar</type> |
| <version>9.2</version> |
| </dependency> |
| <dependency> |
| <groupId>io.github.classgraph</groupId> |
| <artifactId>classgraph</artifactId> |
| <type>jar</type> |
| <version>4.8.141</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.maven.shared</groupId> |
| <artifactId>maven-common-artifact-filters</artifactId> |
| <type>jar</type> |
| <version>3.3.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.sonatype.plexus</groupId> |
| <artifactId>plexus-build-api</artifactId> |
| <type>jar</type> |
| <version>0.0.7</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.maven.shared</groupId> |
| <artifactId>maven-filtering</artifactId> |
| <type>jar</type> |
| <version>3.3.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.commons</groupId> |
| <artifactId>commons-csv</artifactId> |
| <type>jar</type> |
| <version>1.9.0</version> |
| </dependency> |
| <dependency> |
| <groupId>org.apache.maven.shared</groupId> |
| <artifactId>maven-shared-utils</artifactId> |
| <type>jar</type> |
| <version>3.3.4</version> |
| </dependency> |
| </dependencies> |
| </plugin> |