Validators

Overview

With the goals validate-package and validate-files it is possible to run validation on top of the given package or the package source files. Validation itself is implemented with the Jackrabbit FileVault Validation Framework which also contains a lot of standard validators. Look there on which validators are contained and what options they provide.

Configuration

It is possible to adjust every validator registered in the system (both default and external validators) with the parameter validatorsSettings. This is a map with the keys being the validator ids (optionally suffixed by __ and some arbitrary string) and the values being complex objects. Here is an example configuration

<configuration>
  <validatorsSettings>
    <jackrabbit-filter>
      <isDisabled>false</isDisabled><!-- false is default, true disables the validator completely, all other setting are not relevant then -->
      <defaultSeverity>error</defaultSeverity><!-- valid severities: debug, info, warn, error (default) -->
      <options>
        <severityForUncoveredAncestorNodes>error</severityForUncoveredAncestorNodes>
      </options>
    </jackrabbit-filter>
    <!-- more specific items  potentially overwrite more generic items -->
    <jackrabbit-filter:mygroup:mypackage>
      <isDisabled>true</isDisabled><!-- disable the validator for a specific package -->
    </jackrabbit-filter>
  </validatorsSettings>
</configuration>

The options for the individual validators together with the validator ids are documented at Jackrabbit FileVault Validation Framework.

<configuration>
  <validatorsSettings>
    <!-- more specific items  potentially overwrite more generic items -->
    <jackrabbit-filter__formypackage>
      <isDisabled>true</isDisabled><!-- disable the validator for a specific package -->
      <packageRestriction>
        <name>myPackageName</name><!-- optional, if set the surrounding settings apply only to packages with the given name -->
        <group>myPackageGroup</group><!-- optional, if set the surrounding settings apply only to packages with the given group -->
        <subPackageOnly>true</subPackageOnly><!-- optional, if set to true the surrounding settings apply only to subpackages otherwise to all package types -->
      </packageRestriction>
    </jackrabbit-filter__formypackage>
  </validatorsSettings>
</configuration>

Severities

The validation message severities have an impact on the build outcome. By default every validation message with severity error will fail the build. One can adjust this setting by leveraging the configuration parameter failOnValidationWarnings.

Dependencies

All package dependencies are resolved via the Maven Artifact Resolver. If package dependencies are only given via their package id a best guess resolution is tried by using the name as artifactId and group as groupId. You can tweak this fallback behaviour by leveraging the configuration parameter mapPackageDependencyToMavenGa.

Reference External Validators

To reference an external validator it just needs to be given as plugin dependency to the filevault-package-maven-plugin.

<plugin>
  <groupId>org.apache.jackrabbit</groupId>
  <artifactId>filevault-package-maven-plugin</artifactId>
  <dependencies>
    <!-- some validator extension -->
    <dependency>
      <artifactId>myartifact</artifactId>
      <groupId>mygroup</groupId>
      <version>1.0.0</version>
    </dependency>
  </dependencies>
</plugin>