Plugin Documentation
This report describes goals, parameters details, requirements and sample usage of this plugin.
Goals
Goals available for this plugin:
| Goal | Description |
|---|---|
| filevault-package:analyze-classes | Analyzes the generated class files and generates a usage report. This report can be used by the generate-metadata goal to generate a manifest header out of it. |
| filevault-package:check-signature | Checks the embedded libraries against a defined signature. Based on the Animal Sniffer project. |
| filevault-package:format-xml | Either checks only the formatting of the Docview XML files to comply with the formatting rules from FileVault or also reformats those files. |
| filevault-package:generate-cnd | Generates a CND file containing all used node types and namespaces. It uses the default namespaces and node types 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 package metadata and all contained namespaces and node types are automatically registered during installation (in case they are not yet registered). |
| filevault-package:generate-metadata | Generates the metadata ending up in the content package like META-INF/MANIFEST.MF as well as the files ending up in META-INF/vault like filter.xml, properties.xml, config.xml and settings.xml. Those files will be written to the directory given via parameter workDirectory. 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 package.
This goal is executed/bound by default for Maven modules of type |
| filevault-package:help | Display help information on filevault-package-maven-plugin.
Call mvn filevault-package:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. |
| filevault-package:package | Builds a content package. Uses the metadata generated by and embedded artifacts (like subpackages or OSGi bundles) configured in a preceding execution of goal generate-metadata.
This goal is executed/bound by default for Maven modules of type |
| filevault-package:validate-files | 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.
This goal is executed/bound by default for Maven modules of type See also: Validators |
| filevault-package:validate-package | Validates a package (and optionally in addition all attached packages with the given classifiers) with all registered validators.
This goal is executed/bound by default for Maven modules of type See also: Validators |
System Requirements
The following specifies the minimum requirements to run this Maven plugin:
| Maven | 3.6.3 |
| JDK | 1.8 |
System Requirements History
The following specifies the minimum requirements to run this Maven plugin for historical versions:
| Plugin Version | Maven | JDK |
|---|---|---|
| from 1.1.0 to 1.3.6 | 3.3.9 | 8 |
| from 1.0.0 to 1.0.4 | 3.2.5 | 7 |
Usage
You should specify the version in your project's plugin configuration:
<project>
...
<build>
<!-- To define the plugin version in your parent POM -->
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.jackrabbit</groupId>
<artifactId>filevault-package-maven-plugin</artifactId>
<version>1.4.0-SNAPSHOT</version>
<extensions>true</extensions>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>org.apache.jackrabbit</groupId>
<artifactId>filevault-package-maven-plugin</artifactId>
</plugin>
...
</plugins>
</build>
...
</project>For more information, see "Guide to Configuring Plug-ins"