Jackrabbit FileVault Package Maven Plugin

Plugin Documentation

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-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`.
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 an execution of goal `generate-metadata`.
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.
filevault-package:validate-package	Validates a package (and optionally in addition all attached packages with the given classifiers) with all registered validators.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.3.9
JDK	1.8
Memory	No minimum requirement.
Disk Space	No minimum requirement.

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.2.3-SNAPSHOT</version>
        </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>
        <version>1.2.3-SNAPSHOT</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"