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 2021/06/08 15:48:42 UTC
svn commit: r1890613 [11/11] - in
/jackrabbit/site/live/filevault-package-maven-plugin-archives/1.1.9-SNAPSHOT:
./ css/ fonts/ images/ images/logos/ images/profiles/ img/ js/
Added: jackrabbit/site/live/filevault-package-maven-plugin-archives/1.1.9-SNAPSHOT/validators.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/filevault-package-maven-plugin-archives/1.1.9-SNAPSHOT/validators.html?rev=1890613&view=auto
==============================================================================
--- jackrabbit/site/live/filevault-package-maven-plugin-archives/1.1.9-SNAPSHOT/validators.html (added)
+++ jackrabbit/site/live/filevault-package-maven-plugin-archives/1.1.9-SNAPSHOT/validators.html Tue Jun 8 15:48:41 2021
@@ -0,0 +1,257 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/markdown/validators.md at 2021-06-08
+ | Rendered using Apache Maven Fluido Skin 1.9
+-->
+<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.9.2" />
+ <title>Jackrabbit FileVault Package Maven Plugin – Validators</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.9.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.9.min.js"></script>
+ </head>
+ <body class="topBarEnabled">
+ <a href="https://github.com/apache/jackrabbit-filevault-package-maven-plugin">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="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 href="#" 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 href="#" 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">Migration from Adobe</a></li>
+ <li><a href="validators.html" title="Validators">Validators</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" 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="plugin-info.html" title="Plugin Documentation">Plugin Documentation</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://jackrabbit.apache.org/filevault/" title="Apache Jackrabbit FileVault">Apache Jackrabbit FileVault</a></li>
+ <li><a href="http://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Site Versions <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.9-SNAPSHOT" title="1.1.9-SNAPSHOT">1.1.9-SNAPSHOT</a></li>
+ <li><a href="http://jackrabbit.apache.org/filevault-package-maven-plugin" title="1.1.8">1.1.8</a></li>
+ <li><a href="http://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.6" title="1.1.6">1.1.6</a></li>
+ <li><a href="http://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.4" title="1.1.4">1.1.4</a></li>
+ <li><a href="http://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.2" title="1.1.2">1.1.2</a></li>
+ <li><a href="http://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.0" title="1.1.0">1.1.0</a></li>
+ <li><a href="http://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.4" title="1.0.4">1.0.4</a></li>
+ <li><a href="http://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.3" title="1.0.3">1.0.3</a></li>
+ <li><a href="http://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.0.1" title="1.0.1">1.0.1</a></li>
+ <li><a href="http://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">
+ <header>
+ <div id="banner">
+ <div class="pull-left"><a href="https://jackrabbit.apache.org/" id="bannerLeft"><img src="jackrabbit.png" alt="Apache Jackrabbit"/></a></div>
+ <div class="pull-right"><a href="https://apache.org/" id="bannerRight"><img src="asf_logo.png" alt="Apache"/></a></div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li class=""><a href="http://jackrabbit.apache.org/" class="externalLink" title="Jackrabbit">Jackrabbit</a><span class="divider">/</span></li>
+ <li class=""><a href="http://jackrabbit.apache.org/filevault/" class="externalLink" title="Jackrabbit FileVault">Jackrabbit FileVault</a><span class="divider">/</span></li>
+ <li class=""><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.1.8/src/site/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: 2021-06-08</li>
+ <li id="projectVersion" class="pull-right">Version: 1.1.8</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"><span class="none"></span>Migration from Adobe</a></li>
+ <li class="active"><a href="#"><span class="none"></span>Validators</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="http://jackrabbit.apache.org/filevault/" class="externalLink" title="Apache Jackrabbit FileVault"><span class="none"></span>Apache Jackrabbit FileVault</a></li>
+ <li><a href="http://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="http://jackrabbit.apache.org/filevault-package-maven-plugin-archives/1.1.9-SNAPSHOT" class="externalLink" title="1.1.9-SNAPSHOT"><span class="none"></span>1.1.9-SNAPSHOT</a></li>
+ <li><a href="http://jackrabbit.apache.org/filevault-package-maven-plugin" class="externalLink" title="1.1.8"><span class="none"></span>1.1.8</a></li>
+ <li><a href="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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" />
+</form>
+<script>asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
+ <hr />
+ <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></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 (and optionally suffixed by <code>:<package group>:<package name></code> to restrict to only certain package ids) and the values being complex objects. Here is an example configuration</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint linenums"><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>
+ <options>
+ <severityForUncoveredAncestorNodes>error</severityForUncoveredAncestorNodes>
+ </options>
+ </jackrabbit-filter>
+ <!-- succeeding items potentially overwrite preceding items -->
+ <jackrabbit-filter:mygroup:mypackage>
+ <isDisabled>true</isDisabled><!-- disable the validator for a specific package -->
+ </jackrabbit-filter>
+ </validatorsSettings>
+</configuration>
+</pre></div></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><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">
+<div class="source"><pre class="prettyprint linenums"><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>
+</pre></div></div></section>
+ </main>
+ </div>
+ </div>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p>© 2021
+<a href="https://www.apache.org/">The Apache Software Foundation</a>
+</p>
+ </div>
+ <div id="ohloh" class="pull-right">
+ <script src="https://www.ohloh.net/p/jackrabbit-filevault-package-maven-plugin/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file