You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by kw...@apache.org on 2023/11/16 18:45:04 UTC
svn commit: r1913843 [40/40] - in /jackrabbit/site/live/filevault-package-maven-plugin-archives/1.3.6: ./ apidocs/ apidocs/jquery/ apidocs/jquery/external/ apidocs/jquery/external/jquery/ apidocs/jquery/jszip-utils/ apidocs/jquery/jszip-utils/dist/ api...
Added: jackrabbit/site/live/filevault-package-maven-plugin-archives/1.3.6/validate-package-mojo.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/filevault-package-maven-plugin-archives/1.3.6/validate-package-mojo.html?rev=1913843&view=auto
==============================================================================
--- jackrabbit/site/live/filevault-package-maven-plugin-archives/1.3.6/validate-package-mojo.html (added)
+++ jackrabbit/site/live/filevault-package-maven-plugin-archives/1.3.6/validate-package-mojo.html Thu Nov 16 18:45:02 2023
@@ -0,0 +1,737 @@
+<!DOCTYPE html>
+
+
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/validate-package-mojo.xml at 2023-11-16
+ | Rendered using Apache Maven Fluido Skin 1.12.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
+ <title>Jackrabbit FileVault Package Maven Plugin – filevault-package:validate-package</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.12.0.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+ <script src="./js/apache-maven-fluido-1.12.0.min.js"></script>
+
+ <!-- Matomo -->
+ <script>
+ var _paq = window._paq = window._paq || [];
+ _paq.push(['disableCookies']);
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+
+ (function() {
+ var u="https://analytics.apache.org";
+ _paq.push(['setTrackerUrl', u+'/matomo.php']);
+ _paq.push(['setSiteId', '4']);
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+ g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s);
+ })();
+ </script>
+ <!-- End Matomo Code -->
+ </head>
+ <body class="topBarEnabled">
+ <a class="github-fork-ribbon right-top" href="https://github.com/apache/jackrabbit-filevault-package-maven-plugin" data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a>
+ <header id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <ul class="nav">
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="index.html" title="Introduction">Introduction</a></li>
+ <li><a href="plugin-info.html" title="Goals">Goals</a></li>
+ <li><a href="dev.html" title="Developing">Developing</a></li>
+ <li><a href="howto_release.html" title="Releasing">Releasing</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="import_package.html" title="Import-package Generation">Import-package Generation</a></li>
+ <li><a href="migrating.html" title="Migration from Adobe's Plugin">Migration from Adobe's Plugin</a></li>
+ <li><a href="validators.html" title="Validators">Validators</a></li>
+ <li><a href="classifiers.html" title="Classifier Support">Classifier Support</a></li>
+ <li><a href="filtering.html" title="Filtering">Filtering</a></li>
+ <li><a href="osgi.html" title="OSGi">OSGi</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="dropdown-submenu">
+<a href="project-info.html" title="Project Information">Project Information</a>
+ <ul class="dropdown-menu">
+ <li><a href="ci-management.html" title="CI Management">CI Management</a></li>
+ <li><a href="dependencies.html" title="Dependencies">Dependencies</a></li>
+ <li><a href="dependency-info.html" title="Dependency Information">Dependency Information</a></li>
+ <li><a href="dependency-management.html" title="Dependency Management">Dependency Management</a></li>
+ <li><a href="distribution-management.html" title="Distribution Management">Distribution Management</a></li>
+ <li><a href="index.html" title="About">About</a></li>
+ <li><a href="issue-management.html" title="Issue Management">Issue Management</a></li>
+ <li><a href="licenses.html" title="Licenses">Licenses</a></li>
+ <li><a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a></li>
+ <li><a href="plugin-management.html" title="Plugin Management">Plugin Management</a></li>
+ <li><a href="plugins.html" title="Plugins">Plugins</a></li>
+ <li><a href="scm.html" title="Source Code Management">Source Code Management</a></li>
+ <li><a href="summary.html" title="Summary">Summary</a></li>
+ </ul>
+ </li>
+ <li class="dropdown-submenu">
+<a href="project-reports.html" title="Project Reports">Project Reports</a>
+ <ul class="dropdown-menu">
+ <li><a href="apidocs/index.html" title="Javadoc">Javadoc</a></li>
+ <li><a href="plugin-info.html" title="Plugin Documentation">Plugin Documentation</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://jackrabbit.apache.org/filevault/" title="Apache Jackrabbit FileVault">Apache Jackrabbit FileVault</a></li>
+ <li><a href="https://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown">Site Versions <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.7-SNAPSHOT" title="1.3.7-SNAPSHOT">1.3.7-SNAPSHOT</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin" title="1.3.6">1.3.6</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.4" title="1.3.4">1.3.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.2" title="1.3.2">1.3.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.0" title="1.3.0">1.3.0</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.2.2" title="1.2.2">1.2.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.8" title="1.1.8">1.1.8</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.6" title="1.1.6">1.1.6</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.4" title="1.1.4">1.1.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.2" title="1.1.2">1.1.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.0" title="1.1.0">1.1.0</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.4" title="1.0.4">1.0.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.3" title="1.0.3">1.0.3</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.1" title="1.0.1">1.0.1</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.0" title="1.0.0">1.0.0</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </header>
+ <div class="container-fluid container-fluid-top">
+ <header>
+ <div id="banner">
+ <div class="pull-left"><a href="https://jackrabbit.apache.org/" id="bannerLeft"><img src="jackrabbit.png" alt="Apache Jackrabbit" style="" /></a></div>
+ <div class="pull-right"><a href="https://apache.org/" id="bannerRight"><img src="asf_logo.png" alt="Apache" style="" /></a></div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li><a href="https://jackrabbit.apache.org/" class="externalLink" title="Jackrabbit">Jackrabbit</a><span class="divider">/</span></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin" class="externalLink" title="Jackrabbit FileVault Package Maven Plugin">Jackrabbit FileVault Package Maven Plugin</a><span class="divider">/</span></li>
+ <li class="active ">filevault-package:validate-package</li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-11-16</li>
+ <li id="projectVersion" class="pull-right">Version: 1.3.6</li>
+ </ul>
+ </div>
+ </header>
+ <div class="row-fluid">
+ <header id="leftColumn" class="span2">
+ <nav class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+ <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li>
+ <li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a></li>
+ <li><a href="dev.html" title="Developing"><span class="none"></span>Developing</a></li>
+ <li><a href="howto_release.html" title="Releasing"><span class="none"></span>Releasing</a></li>
+ <li class="nav-header">Documentation</li>
+ <li><a href="import_package.html" title="Import-package Generation"><span class="none"></span>Import-package Generation</a></li>
+ <li><a href="migrating.html" title="Migration from Adobe's Plugin"><span class="none"></span>Migration from Adobe's Plugin</a></li>
+ <li><a href="validators.html" title="Validators"><span class="none"></span>Validators</a></li>
+ <li><a href="classifiers.html" title="Classifier Support"><span class="none"></span>Classifier Support</a></li>
+ <li><a href="filtering.html" title="Filtering"><span class="none"></span>Filtering</a></li>
+ <li><a href="osgi.html" title="OSGi"><span class="none"></span>OSGi</a></li>
+ <li class="nav-header">Project Documentation</li>
+ <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
+ <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li>
+ <li class="nav-header">Links</li>
+ <li><a href="https://jackrabbit.apache.org/filevault/" class="externalLink" title="Apache Jackrabbit FileVault"><span class="none"></span>Apache Jackrabbit FileVault</a></li>
+ <li><a href="https://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit"><span class="none"></span>Apache Jackrabbit</a></li>
+ <li class="nav-header">Site Versions</li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.7-SNAPSHOT" class="externalLink" title="1.3.7-SNAPSHOT"><span class="none"></span>1.3.7-SNAPSHOT</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin" class="externalLink" title="1.3.6"><span class="none"></span>1.3.6</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.4" class="externalLink" title="1.3.4"><span class="none"></span>1.3.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.2" class="externalLink" title="1.3.2"><span class="none"></span>1.3.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.0" class="externalLink" title="1.3.0"><span class="none"></span>1.3.0</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.2.2" class="externalLink" title="1.2.2"><span class="none"></span>1.2.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.8" class="externalLink" title="1.1.8"><span class="none"></span>1.1.8</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.6" class="externalLink" title="1.1.6"><span class="none"></span>1.1.6</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.4" class="externalLink" title="1.1.4"><span class="none"></span>1.1.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.2" class="externalLink" title="1.1.2"><span class="none"></span>1.1.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.0" class="externalLink" title="1.1.0"><span class="none"></span>1.1.0</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.4" class="externalLink" title="1.0.4"><span class="none"></span>1.0.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.3" class="externalLink" title="1.0.3"><span class="none"></span>1.0.3</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.1" class="externalLink" title="1.0.1"><span class="none"></span>1.0.1</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.0" class="externalLink" title="1.0.0"><span class="none"></span>1.0.0</a></li>
+ </ul>
+ </nav>
+ <div class="well sidebar-nav">
+<form id="search-form" action="https://www.google.com/search" method="get" >
+ <input value="jackrabbit.apache.org/filevault-package-maven-plugin/" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" placeholder="Search with Google..." />
+</form>
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+ </div>
+ </div>
+ </header>
+ <main id="bodyColumn" class="span10" >
+
+
+ <section>
+<h2><a name="filevault-package:validate-package"></a>filevault-package:validate-package</h2>
+
+<p><b>Full name</b>:</p>
+
+<p>org.apache.jackrabbit:filevault-package-maven-plugin:1.3.6:validate-package</p>
+
+<p><b>Description</b>:</p>
+
+<div>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 /><b>See also:</b> <a class="externalLink" href="https://jackrabbit.apache.org/filevault-package-maven-plugin/validators.html">Validators</a></div>
+
+<p><b>Attributes</b>:</p>
+
+<ul>
+
+<li>Requires dependency resolution of artifacts in scope: <code>compile</code>.</li>
+
+<li>The goal is thread-safe and supports parallel builds.</li>
+
+<li>Since version: <code>1.1.0</code>.</li>
+
+<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>verify</code>.</li>
+ </ul>
+ <section>
+<h3><a name="Required_Parameters"></a>Required Parameters</h3>
+
+<table border="0" class="table table-striped">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
+ </tr>
+
+<tr class="b">
+
+<td align="left"><code><a href="#enforceRecursiveSubpackageValidation"><enforceRecursiveSubpackageValidation></a></code></td>
+
+<td><code>boolean</code></td>
+
+<td><code>-</code></td>
+
+<td>If set to <code>true</code> always executes all validators also for all sub packages (recursively).<br /><b>Default value is</b>: <code>false</code>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td align="left"><code><a href="#skipSubPackageValidation"><skipSubPackageValidation></a></code></td>
+
+<td><code>boolean</code></td>
+
+<td><code>1.1.2</code></td>
+
+<td>If set to <code>true</code> will not validate any sub packages. This settings overwrites the parameter <a href="#enforceRecursiveSubpackageValidation"><code>enforceRecursiveSubpackageValidation</code></a>.<br /><b>Default value is</b>: <code>false</code>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td align="left"><code><a href="#skipValidation"><skipValidation></a></code></td>
+
+<td><code>boolean</code></td>
+
+<td><code>-</code></td>
+
+<td>Skips validation.<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>vault.skipValidation</code>.<br /></td>
+ </tr>
+ </table>
+ </section>
+ <section>
+<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
+
+<table border="0" class="table table-striped">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
+ </tr>
+
+<tr class="b">
+
+<td align="left"><code><a href="#classifier"><classifier></a></code></td>
+
+<td><code><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">String</a></code></td>
+
+<td><code>1.2.2</code></td>
+
+<td>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 main package depending on parameter <a href="#skipPackageFile"><code>skipPackageFile</code></a>).<br /><b>User property is</b>: <code>vault.classifier</code>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td align="left"><code><a href="#classifiers"><classifiers></a></code></td>
+
+<td><code><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">List<String></a></code></td>
+
+<td><code>1.1.4</code></td>
+
+<td>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 main package depending on parameter <a href="#skipPackageFile"><code>skipPackageFile</code></a>).<br /><b>User property is</b>: <code>vault.classifiers</code>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td align="left"><code><a href="#csvReportFile"><csvReportFile></a></code></td>
+
+<td><code><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html">File</a></code></td>
+
+<td><code>-</code></td>
+
+<td>The file where to write a report of all found validation violations (warnings and errors) in CSV format as defined in <a class="externalLink" 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).<br /><b>User property is</b>: <code>vault.validation.csvReportFile</code>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td align="left"><code><a href="#dependencies"><dependencies></a></code></td>
+
+<td><code><a href="apidocs/org/apache/jackrabbit/filevault/maven/packaging/MavenBasedPackageDependency.html">Collection<MavenBasedPackageDependency></a></code></td>
+
+<td><code>-</code></td>
+
+<td>Defines the list of dependencies. A dependency is declared as a <code><dependency></code> element of a list style <code><dependencies></code> element:
+
+<div>
+<pre><dependency>
+ <group>theGroup</group>
+ <name>theName</name>
+ <version>1.5</version>
+</dependency>
+</pre></div>
+
+<p>The dependency can also reference a maven project dependency, this is preferred as it yields to more robust builds.</p>
+
+<div>
+<pre><dependency>
+ <groupId>theGroup</groupId>
+ <artifactId>theName</artifactId>
+</dependency>
+</pre></div>
+
+<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><br /><b>User property is</b>: <code>vault.dependencies</code>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td align="left"><code><a href="#failOnDependencyErrors"><failOnDependencyErrors></a></code></td>
+
+<td><code>boolean</code></td>
+
+<td><code>-</code></td>
+
+<td><b>Deprecated.</b> Controls if errors during dependency validation should fail the build.<br /><b>Default value is</b>: <code>true</code>.<br /><b>User property is</b>: <code>vault.failOnDependencyErrors</code>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td align="left"><code><a href="#failOnValidationWarnings"><failOnValidationWarnings></a></code></td>
+
+<td><code>boolean</code></td>
+
+<td><code>-</code></td>
+
+<td>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<br /><b>Default value is</b>: <code>false</code>.<br /><b>User property is</b>: <code>vault.failOnValidationWarning</code>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td align="left"><code><a href="#mapPackageDependencyToMavenGa"><mapPackageDependencyToMavenGa></a></code></td>
+
+<td><code><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">Collection<String></a></code></td>
+
+<td><code>-</code></td>
+
+<td>Mapping of package dependencies given via group and name to Maven identifiers for enhanced validation. Each entry must have the format <code><group>:<name>=<groupId>:<artifactId></code>. To disable lookup (e.g. because referenced artifact is not available in a Maven repository) use <code><group>:<name>=ignore</code>. This will also prevent the WARNING which would be otherwise be emitted.<br /><b>User property is</b>: <code>vault.package.dependency.to.maven.ga</code>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td align="left"><code><a href="#packageFile"><packageFile></a></code></td>
+
+<td><code><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html">File</a></code></td>
+
+<td><code>-</code></td>
+
+<td>The path to the main package file to validate.<br /><b>Default value is</b>: <code>${project.artifact.file}</code>.<br /><b>User property is</b>: <code>vault.packageToValidate</code>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td align="left"><code><a href="#repositoryStructurePackages"><repositoryStructurePackages></a></code></td>
+
+<td><code><a href="apidocs/org/apache/jackrabbit/filevault/maven/packaging/MavenBasedPackageDependency.html">Collection<MavenBasedPackageDependency></a></code></td>
+
+<td><code>-</code></td>
+
+<td>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 class="externalLink" 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 class="externalLink" href="https://jackrabbit.apache.org/filevault/filter.html">filter rule
s' root attributes</a>. Currently these packages are only used to define the <a class="externalLink" href="https://jackrabbit.apache.org/filevault/validation.html#standard-validators"><code>validRoots</code> of the validator <code>jackrabbit-filter</code></a>.</p><br /><b>User property is</b>: <code>vault.repository.structure.packages</code>.<br /></td>
+ </tr>
+
+<tr class="a">
+
+<td align="left"><code><a href="#skipPackageFile"><skipPackageFile></a></code></td>
+
+<td><code>boolean</code></td>
+
+<td><code>1.3.2</code></td>
+
+<td>If set to <code>true</code> skips validating the package given via <a href="#packageFile"><code>packageFile</code></a> but only validates the ones being attached to the current project 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>.<br /><b>User property is</b>: <code>vault.skipPackageFile</code>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td align="left"><code><a href="#validatorsSettings"><validatorsSettings></a></code></td>
+
+<td><code><a href="apidocs/org/apache/jackrabbit/filevault/maven/packaging/ValidatorSettings.html">Map<String,ValidatorSettings></a></code></td>
+
+<td><code>-</code></td>
+
+<td>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
+
+<div>
+<pre> <jackrabbit-filter>
+ <options>
+ <severityForUncoveredAncestorNodes>error</severityForUncoveredAncestorNodes>
+ </options>
+ </jackrabbit-filter>
+</pre></div> 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>.
+
+<div>
+<pre> <jackrabbit-filter__restricted1>
+ <options>
+ <severityForUncoveredAncestorNodes>warning</severityForUncoveredAncestorNodes>
+ </options>
+ <packageRestriction>
+ <group>somegroup</group> <!-- optional, if set the enclosing settings apply only to packages with the given group -->
+ <name>somename</name> <!-- optional, if set the enclosing settings apply only to packages with the given name -->
+ <subPackageOnly>true</subPackageOnly> <!-- if set to true, the enclosing settings apply only to subpackages otherwise to all kinds of packages -->
+ <packageRestriction>
+ </jackrabbit-filter__restricted1>
+</pre></div> 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 style="list-style-type: decimal">
+
+<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).<br /></td>
+ </tr>
+ </table>
+ </section>
+ <section>
+<h3><a name="Parameter_Details"></a>Parameter Details</h3>
+ <section>
+<h4><a name="a.3Cclassifier.3E"></a><b><a name="classifier"><classifier></a></b></h4>
+
+<div>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 main package depending on parameter <a href="#skipPackageFile"><code>skipPackageFile</code></a>).</div>
+
+<ul>
+
+<li><b>Type</b>: <code><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">java.lang.String</a></code></li>
+
+<li><b>Since</b>: <code>1.2.2</code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>User Property</b>: <code>vault.classifier</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3Cclassifiers.3E"></a><b><a name="classifiers"><classifiers></a></b></h4>
+
+<div>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 main package depending on parameter <a href="#skipPackageFile"><code>skipPackageFile</code></a>).</div>
+
+<ul>
+
+<li><b>Type</b>: <code><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">java.util.List<java.lang.String></a></code></li>
+
+<li><b>Since</b>: <code>1.1.4</code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>User Property</b>: <code>vault.classifiers</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CcsvReportFile.3E"></a><b><a name="csvReportFile"><csvReportFile></a></b></h4>
+
+<div>The file where to write a report of all found validation violations (warnings and errors) in CSV format as defined in <a class="externalLink" 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).</div>
+
+<ul>
+
+<li><b>Type</b>: <code><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html">java.io.File</a></code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>User Property</b>: <code>vault.validation.csvReportFile</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3Cdependencies.3E"></a><b><a name="dependencies"><dependencies></a></b></h4>
+
+<div>Defines the list of dependencies. A dependency is declared as a <code><dependency></code> element of a list style <code><dependencies></code> element:
+
+<div>
+<pre><dependency>
+ <group>theGroup</group>
+ <name>theName</name>
+ <version>1.5</version>
+</dependency>
+</pre></div>
+
+<p>The dependency can also reference a maven project dependency, this is preferred as it yields to more robust builds.</p>
+
+<div>
+<pre><dependency>
+ <groupId>theGroup</groupId>
+ <artifactId>theName</artifactId>
+</dependency>
+</pre></div>
+
+<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></div>
+
+<ul>
+
+<li><b>Type</b>: <code><a href="apidocs/org/apache/jackrabbit/filevault/maven/packaging/MavenBasedPackageDependency.html">java.util.Collection<org.apache.jackrabbit.filevault.maven.packaging.MavenBasedPackageDependency></a></code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>User Property</b>: <code>vault.dependencies</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CenforceRecursiveSubpackageValidation.3E"></a><b><a name="enforceRecursiveSubpackageValidation"><enforceRecursiveSubpackageValidation></a></b></h4>
+
+<div>If set to <code>true</code> always executes all validators also for all sub packages (recursively).</div>
+
+<ul>
+
+<li><b>Type</b>: <code>boolean</code></li>
+
+<li><b>Required</b>: <code>Yes</code></li>
+
+<li><b>Default</b>: <code>false</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CfailOnDependencyErrors.3E"></a><b><a name="failOnDependencyErrors"><failOnDependencyErrors></a></b></h4>
+
+<div><b>Deprecated.</b> Use <a href="#validatorsSettings"><code>validatorsSettings</code></a> with the following values instead
+
+<div>
+<pre> <jackrabbit-dependencies>
+ <defaultSeverity>debug</defaultSeverity>
+ </jackrabbit-dependencies>
+</pre></div></div>
+
+<div>Controls if errors during dependency validation should fail the build.</div>
+
+<ul>
+
+<li><b>Type</b>: <code>boolean</code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>User Property</b>: <code>vault.failOnDependencyErrors</code></li>
+
+<li><b>Default</b>: <code>true</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CfailOnValidationWarnings.3E"></a><b><a name="failOnValidationWarnings"><failOnValidationWarnings></a></b></h4>
+
+<div>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</div>
+
+<ul>
+
+<li><b>Type</b>: <code>boolean</code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>User Property</b>: <code>vault.failOnValidationWarning</code></li>
+
+<li><b>Default</b>: <code>false</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CmapPackageDependencyToMavenGa.3E"></a><b><a name="mapPackageDependencyToMavenGa"><mapPackageDependencyToMavenGa></a></b></h4>
+
+<div>Mapping of package dependencies given via group and name to Maven identifiers for enhanced validation. Each entry must have the format <code><group>:<name>=<groupId>:<artifactId></code>. To disable lookup (e.g. because referenced artifact is not available in a Maven repository) use <code><group>:<name>=ignore</code>. This will also prevent the WARNING which would be otherwise be emitted.</div>
+
+<ul>
+
+<li><b>Type</b>: <code><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">java.util.Collection<java.lang.String></a></code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>User Property</b>: <code>vault.package.dependency.to.maven.ga</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CpackageFile.3E"></a><b><a name="packageFile"><packageFile></a></b></h4>
+
+<div>The path to the main package file to validate.</div>
+
+<ul>
+
+<li><b>Type</b>: <code><a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html">java.io.File</a></code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>User Property</b>: <code>vault.packageToValidate</code></li>
+
+<li><b>Default</b>: <code>${project.artifact.file}</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CrepositoryStructurePackages.3E"></a><b><a name="repositoryStructurePackages"><repositoryStructurePackages></a></b></h4>
+
+<div>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 class="externalLink" 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 class="externalLink" href="https://jackrabbit.apache.org/filevault/filter.html">filter rule
s' root attributes</a>. Currently these packages are only used to define the <a class="externalLink" href="https://jackrabbit.apache.org/filevault/validation.html#standard-validators"><code>validRoots</code> of the validator <code>jackrabbit-filter</code></a>.</p></div>
+
+<ul>
+
+<li><b>Type</b>: <code><a href="apidocs/org/apache/jackrabbit/filevault/maven/packaging/MavenBasedPackageDependency.html">java.util.Collection<org.apache.jackrabbit.filevault.maven.packaging.MavenBasedPackageDependency></a></code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>User Property</b>: <code>vault.repository.structure.packages</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CskipPackageFile.3E"></a><b><a name="skipPackageFile"><skipPackageFile></a></b></h4>
+
+<div>If set to <code>true</code> skips validating the package given via <a href="#packageFile"><code>packageFile</code></a> but only validates the ones being attached to the current project 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>.</div>
+
+<ul>
+
+<li><b>Type</b>: <code>boolean</code></li>
+
+<li><b>Since</b>: <code>1.3.2</code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+
+<li><b>User Property</b>: <code>vault.skipPackageFile</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CskipSubPackageValidation.3E"></a><b><a name="skipSubPackageValidation"><skipSubPackageValidation></a></b></h4>
+
+<div>If set to <code>true</code> will not validate any sub packages. This settings overwrites the parameter <a href="#enforceRecursiveSubpackageValidation"><code>enforceRecursiveSubpackageValidation</code></a>.</div>
+
+<ul>
+
+<li><b>Type</b>: <code>boolean</code></li>
+
+<li><b>Since</b>: <code>1.1.2</code></li>
+
+<li><b>Required</b>: <code>Yes</code></li>
+
+<li><b>Default</b>: <code>false</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CskipValidation.3E"></a><b><a name="skipValidation"><skipValidation></a></b></h4>
+
+<div>Skips validation.</div>
+
+<ul>
+
+<li><b>Type</b>: <code>boolean</code></li>
+
+<li><b>Required</b>: <code>Yes</code></li>
+
+<li><b>User Property</b>: <code>vault.skipValidation</code></li>
+
+<li><b>Default</b>: <code>false</code></li>
+ </ul><hr /></section><section>
+<h4><a name="a.3CvalidatorsSettings.3E"></a><b><a name="validatorsSettings"><validatorsSettings></a></b></h4>
+
+<div>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
+
+<div>
+<pre> <jackrabbit-filter>
+ <options>
+ <severityForUncoveredAncestorNodes>error</severityForUncoveredAncestorNodes>
+ </options>
+ </jackrabbit-filter>
+</pre></div> 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>.
+
+<div>
+<pre> <jackrabbit-filter__restricted1>
+ <options>
+ <severityForUncoveredAncestorNodes>warning</severityForUncoveredAncestorNodes>
+ </options>
+ <packageRestriction>
+ <group>somegroup</group> <!-- optional, if set the enclosing settings apply only to packages with the given group -->
+ <name>somename</name> <!-- optional, if set the enclosing settings apply only to packages with the given name -->
+ <subPackageOnly>true</subPackageOnly> <!-- if set to true, the enclosing settings apply only to subpackages otherwise to all kinds of packages -->
+ <packageRestriction>
+ </jackrabbit-filter__restricted1>
+</pre></div> 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 style="list-style-type: decimal">
+
+<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).</div>
+
+<ul>
+
+<li><b>Type</b>: <code><a href="apidocs/org/apache/jackrabbit/filevault/maven/packaging/ValidatorSettings.html">java.util.Map<java.lang.String, org.apache.jackrabbit.filevault.maven.packaging.ValidatorSettings></a></code></li>
+
+<li><b>Required</b>: <code>No</code></li>
+ </ul>
+ </section></section>
+ </section>
+
+
+ </main>
+ </div>
+ </div>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+<p>© 2023
+<a href="https://www.apache.org/">The Apache Software Foundation</a> | <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a>
+</p>
+ </div>
+ </div>
+ </footer>
+<script>
+ if(anchors) {
+ anchors.add();
+ }
+</script>
+ </body>
+</html>
\ No newline at end of file
Added: jackrabbit/site/live/filevault-package-maven-plugin-archives/1.3.6/validators.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/filevault-package-maven-plugin-archives/1.3.6/validators.html?rev=1913843&view=auto
==============================================================================
--- jackrabbit/site/live/filevault-package-maven-plugin-archives/1.3.6/validators.html (added)
+++ jackrabbit/site/live/filevault-package-maven-plugin-archives/1.3.6/validators.html Thu Nov 16 18:45:02 2023
@@ -0,0 +1,307 @@
+<!DOCTYPE html>
+
+
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/site-src/markdown/validators.md at 2023-11-16
+ | Rendered using Apache Maven Fluido Skin 1.12.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" />
+ <title>Jackrabbit FileVault Package Maven Plugin – Validators</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.12.0.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+ <script src="./js/apache-maven-fluido-1.12.0.min.js"></script>
+
+ <!-- Matomo -->
+ <script>
+ var _paq = window._paq = window._paq || [];
+ _paq.push(['disableCookies']);
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+
+ (function() {
+ var u="https://analytics.apache.org";
+ _paq.push(['setTrackerUrl', u+'/matomo.php']);
+ _paq.push(['setSiteId', '4']);
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+ g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s);
+ })();
+ </script>
+ <!-- End Matomo Code -->
+ </head>
+ <body class="topBarEnabled">
+ <a class="github-fork-ribbon right-top" href="https://github.com/apache/jackrabbit-filevault-package-maven-plugin" data-ribbon="Fork me on GitHub" title="Fork me on GitHub">Fork me on GitHub</a>
+ <header id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <ul class="nav">
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="index.html" title="Introduction">Introduction</a></li>
+ <li><a href="plugin-info.html" title="Goals">Goals</a></li>
+ <li><a href="dev.html" title="Developing">Developing</a></li>
+ <li><a href="howto_release.html" title="Releasing">Releasing</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="import_package.html" title="Import-package Generation">Import-package Generation</a></li>
+ <li><a href="migrating.html" title="Migration from Adobe's Plugin">Migration from Adobe's Plugin</a></li>
+ <li><a title="Validators">Validators</a></li>
+ <li><a href="classifiers.html" title="Classifier Support">Classifier Support</a></li>
+ <li><a href="filtering.html" title="Filtering">Filtering</a></li>
+ <li><a href="osgi.html" title="OSGi">OSGi</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="dropdown-submenu">
+<a href="project-info.html" title="Project Information">Project Information</a>
+ <ul class="dropdown-menu">
+ <li><a href="ci-management.html" title="CI Management">CI Management</a></li>
+ <li><a href="dependencies.html" title="Dependencies">Dependencies</a></li>
+ <li><a href="dependency-info.html" title="Dependency Information">Dependency Information</a></li>
+ <li><a href="dependency-management.html" title="Dependency Management">Dependency Management</a></li>
+ <li><a href="distribution-management.html" title="Distribution Management">Distribution Management</a></li>
+ <li><a href="index.html" title="About">About</a></li>
+ <li><a href="issue-management.html" title="Issue Management">Issue Management</a></li>
+ <li><a href="licenses.html" title="Licenses">Licenses</a></li>
+ <li><a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a></li>
+ <li><a href="plugin-management.html" title="Plugin Management">Plugin Management</a></li>
+ <li><a href="plugins.html" title="Plugins">Plugins</a></li>
+ <li><a href="scm.html" title="Source Code Management">Source Code Management</a></li>
+ <li><a href="summary.html" title="Summary">Summary</a></li>
+ </ul>
+ </li>
+ <li class="dropdown-submenu">
+<a href="project-reports.html" title="Project Reports">Project Reports</a>
+ <ul class="dropdown-menu">
+ <li><a href="apidocs/index.html" title="Javadoc">Javadoc</a></li>
+ <li><a href="plugin-info.html" title="Plugin Documentation">Plugin Documentation</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://jackrabbit.apache.org/filevault/" title="Apache Jackrabbit FileVault">Apache Jackrabbit FileVault</a></li>
+ <li><a href="https://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a class="dropdown-toggle" data-toggle="dropdown">Site Versions <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.7-SNAPSHOT" title="1.3.7-SNAPSHOT">1.3.7-SNAPSHOT</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin" title="1.3.6">1.3.6</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.4" title="1.3.4">1.3.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.2" title="1.3.2">1.3.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.0" title="1.3.0">1.3.0</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.2.2" title="1.2.2">1.2.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.8" title="1.1.8">1.1.8</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.6" title="1.1.6">1.1.6</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.4" title="1.1.4">1.1.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.2" title="1.1.2">1.1.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.0" title="1.1.0">1.1.0</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.4" title="1.0.4">1.0.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.3" title="1.0.3">1.0.3</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.1" title="1.0.1">1.0.1</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.0" title="1.0.0">1.0.0</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </header>
+ <div class="container-fluid container-fluid-top">
+ <header>
+ <div id="banner">
+ <div class="pull-left"><a href="https://jackrabbit.apache.org/" id="bannerLeft"><img src="jackrabbit.png" alt="Apache Jackrabbit" style="" /></a></div>
+ <div class="pull-right"><a href="https://apache.org/" id="bannerRight"><img src="asf_logo.png" alt="Apache" style="" /></a></div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li><a href="https://jackrabbit.apache.org/" class="externalLink" title="Jackrabbit">Jackrabbit</a><span class="divider">/</span></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin" class="externalLink" title="Jackrabbit FileVault Package Maven Plugin">Jackrabbit FileVault Package Maven Plugin</a><span class="divider">/</span></li>
+ <li class="active ">Validators <a href="https://github.com/apache/jackrabbit-filevault-package-maven-plugin/tree/filevault-package-maven-plugin-1.3.6/target/site-src/markdown/validators.md"><img src="./images/accessories-text-editor.png" title="Edit" /></a></li>
+ <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-11-16</li>
+ <li id="projectVersion" class="pull-right">Version: 1.3.6</li>
+ </ul>
+ </div>
+ </header>
+ <div class="row-fluid">
+ <header id="leftColumn" class="span2">
+ <nav class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+ <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li>
+ <li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a></li>
+ <li><a href="dev.html" title="Developing"><span class="none"></span>Developing</a></li>
+ <li><a href="howto_release.html" title="Releasing"><span class="none"></span>Releasing</a></li>
+ <li class="nav-header">Documentation</li>
+ <li><a href="import_package.html" title="Import-package Generation"><span class="none"></span>Import-package Generation</a></li>
+ <li><a href="migrating.html" title="Migration from Adobe's Plugin"><span class="none"></span>Migration from Adobe's Plugin</a></li>
+ <li class="active"><a><span class="none"></span>Validators</a></li>
+ <li><a href="classifiers.html" title="Classifier Support"><span class="none"></span>Classifier Support</a></li>
+ <li><a href="filtering.html" title="Filtering"><span class="none"></span>Filtering</a></li>
+ <li><a href="osgi.html" title="OSGi"><span class="none"></span>OSGi</a></li>
+ <li class="nav-header">Project Documentation</li>
+ <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li>
+ <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li>
+ <li class="nav-header">Links</li>
+ <li><a href="https://jackrabbit.apache.org/filevault/" class="externalLink" title="Apache Jackrabbit FileVault"><span class="none"></span>Apache Jackrabbit FileVault</a></li>
+ <li><a href="https://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit"><span class="none"></span>Apache Jackrabbit</a></li>
+ <li class="nav-header">Site Versions</li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.7-SNAPSHOT" class="externalLink" title="1.3.7-SNAPSHOT"><span class="none"></span>1.3.7-SNAPSHOT</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin" class="externalLink" title="1.3.6"><span class="none"></span>1.3.6</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.4" class="externalLink" title="1.3.4"><span class="none"></span>1.3.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.2" class="externalLink" title="1.3.2"><span class="none"></span>1.3.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.3.0" class="externalLink" title="1.3.0"><span class="none"></span>1.3.0</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.2.2" class="externalLink" title="1.2.2"><span class="none"></span>1.2.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.8" class="externalLink" title="1.1.8"><span class="none"></span>1.1.8</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.6" class="externalLink" title="1.1.6"><span class="none"></span>1.1.6</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.4" class="externalLink" title="1.1.4"><span class="none"></span>1.1.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.2" class="externalLink" title="1.1.2"><span class="none"></span>1.1.2</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.0" class="externalLink" title="1.1.0"><span class="none"></span>1.1.0</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.4" class="externalLink" title="1.0.4"><span class="none"></span>1.0.4</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.3" class="externalLink" title="1.0.3"><span class="none"></span>1.0.3</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.1" class="externalLink" title="1.0.1"><span class="none"></span>1.0.1</a></li>
+ <li><a href="https://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.0" class="externalLink" title="1.0.0"><span class="none"></span>1.0.0</a></li>
+ </ul>
+ </nav>
+ <div class="well sidebar-nav">
+<form id="search-form" action="https://www.google.com/search" method="get" >
+ <input value="jackrabbit.apache.org/filevault-package-maven-plugin/" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" placeholder="Search with Google..." />
+</form>
+ <div id="poweredBy">
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+ </div>
+ </div>
+ </header>
+ <main id="bodyColumn" class="span10" >
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<h1>Validators</h1>
+<ul>
+<li><a href="#Overview">Overview</a></li>
+<li><a href="#Configuration">Configuration</a>
+<ul>
+<li><a href="#Package_Restriction">Package Restriction</a></li></ul></li>
+<li><a href="#Severities">Severities</a></li>
+<li><a href="#Dependencies">Dependencies</a></li>
+<li><a href="#Reference_External_Validators">Reference External Validators</a></li></ul>
+<section>
+<h2><a name="Overview"></a>Overview</h2>
+<p>With the goals <a href="validate-package-mojo.html"><code>validate-package</code></a> and <a href="validate-files-mojo.html"><code>validate-files</code></a> it is possible to run validation on top of the given package or the package source files.
+Validation itself is implemented with the <a class="externalLink" href="https://jackrabbit.apache.org/filevault/validation.html">Jackrabbit FileVault Validation Framework</a> which also contains a lot of standard validators.
+Look there on which validators are contained and what options they provide.</p></section><section>
+<h2><a name="Configuration"></a>Configuration</h2>
+<p>It is possible to adjust every validator registered in the system (both default and external validators) with the parameter <code>validatorsSettings</code>. This is a map with the keys being the validator ids (optionally suffixed by <code>__</code> and some arbitrary string) and the values being complex objects.
+Here is an example configuration</p>
+
+<div class="source"><pre class="prettyprint linenums"><code><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>
+ </validatorsSettings>
+</configuration>
+</code></pre></div>
+<p>The options for the individual validators together with the validator ids are documented at <a class="externalLink" href="https://jackrabbit.apache.org/filevault/validation.html">Jackrabbit FileVault Validation Framework</a>.</p><section>
+<h3><a name="Package_Restriction"></a>Package Restriction</h3>
+<p>It is possible to restrict a setting for a particular validator id to certain packages only.</p>
+
+<div class="source"><pre class="prettyprint linenums"><code><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>
+
+</code></pre></div>
+<p>** It is necessary that each element below <code>validatorsSettings</code> has a unique name (as otherwise it will overwrite previous elements with the same name **</p>
+<p>In order to achieve that the validator id can be suffixed with <code>__</code> and an arbitrary string in the configuration element name.</p></section></section><section>
+<h2><a name="Severities"></a>Severities</h2>
+<p>The validation message severities have an impact on the build outcome. By default every validation message with severity <code>error</code> will fail the build. One can adjust this setting by leveraging the configuration parameter <code>failOnValidationWarnings</code>.</p></section><section>
+<h2><a name="Dependencies"></a>Dependencies</h2>
+<p>All package dependencies are resolved via the <a class="externalLink" href="https://maven.apache.org/resolver/index.html">Maven Artifact Resolver</a>. If package dependencies are only given via their package id a best guess resolution is tried by using the <code>name</code> as <code>artifactId</code> and <code>group</code> as <code>groupId</code>. You can tweak this fallback behaviour by leveraging the configuration parameter <code>mapPackageDependencyToMavenGa</code>.</p></section><section>
+<h2><a name="Reference_External_Validators"></a>Reference External Validators</h2>
+<p>To reference an external validator it just needs to be given as <a class="externalLink" href="https://maven.apache.org/guides/mini/guide-configuring-plugins.html#Using_the_dependencies_Tag">plugin dependency</a> to the <code>filevault-package-maven-plugin</code>.</p>
+
+<div class="source"><pre class="prettyprint linenums"><code><plugin>
+ <groupId>org.apache.jackrabbit</groupId>
+ <artifactId>filevault-package-maven-plugin</artifactId>
+ <version>1.3.6</version>
+ <dependencies>
+ <!-- some validator extension -->
+ <dependency>
+ <artifactId>myartifact</artifactId>
+ <groupId>mygroup</groupId>
+ <version>1.0.0</version>
+ </dependency>
+ </dependencies>
+</plugin>
+</code></pre></div></section>
+ </main>
+ </div>
+ </div>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+<p>© 2023
+<a href="https://www.apache.org/">The Apache Software Foundation</a> | <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a>
+</p>
+ </div>
+ </div>
+ </footer>
+<script>
+ if(anchors) {
+ anchors.add();
+ }
+</script>
+ </body>
+</html>
\ No newline at end of file