From commits-return-22028-archive-asf-public=cust-asf.ponee.io@jackrabbit.apache.org Tue Oct 8 09:37:41 2019 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id 5E434180654 for ; Tue, 8 Oct 2019 11:37:40 +0200 (CEST) Received: (qmail 79131 invoked by uid 500); 8 Oct 2019 09:37:39 -0000 Mailing-List: contact commits-help@jackrabbit.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jackrabbit.apache.org Delivered-To: mailing list commits@jackrabbit.apache.org Received: (qmail 79121 invoked by uid 99); 8 Oct 2019 09:37:39 -0000 Received: from Unknown (HELO svn01-us-west.apache.org) (209.188.14.144) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 08 Oct 2019 09:37:39 +0000 Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id 351B03A0917 for ; Tue, 8 Oct 2019 09:37:38 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1868123 - in /jackrabbit/commons/filevault/trunk: ./ parent/ vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/impl/ vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/ vault-core/src/main/java/org/apache/... Date: Tue, 08 Oct 2019 09:37:37 -0000 To: commits@jackrabbit.apache.org From: kwin@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20191008093738.351B03A0917@svn01-us-west.apache.org> Author: kwin Date: Tue Oct 8 09:37:36 2019 New Revision: 1868123 URL: http://svn.apache.org/viewvc?rev=1868123&view=rev Log: JCRVLT-345 improve javadoc Modified: jackrabbit/commons/filevault/trunk/parent/pom.xml jackrabbit/commons/filevault/trunk/pom.xml jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/impl/DefaultPackageProperties.java jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/OutputFormat.java jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/XMLSerializer.java jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/dom/DOMMessageFormatter.java jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/EncodingMap.java jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/SymbolTable.java jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/XMLChar.java jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/validation.md jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationExecutor.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationExecutorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationViolation.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/impl/util/DocumentViewXmlContentHandler.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/impl/util/ResettableInputStream.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/package-info.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/DocumentViewXmlValidator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/FilterValidator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/GenericJcrDataValidator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/GenericMetaInfDataValidator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/JcrPathValidator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/MetaInfPathValidator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/NodePathValidator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/PropertiesValidator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationContext.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationMessage.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationMessageSeverity.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/Validator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidatorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidatorSettings.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/AdvancedFilterValidatorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/AdvancedPropertiesValidatorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DependencyValidator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DependencyValidatorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DocumentViewParserValidatorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/EmptyElementsValidator.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/EmptyElementsValidatorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/MergeLimitationsValidatorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/OakIndexDefinitionValidatorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/PackageTypeValidatorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/PrimaryNodeTypeValidatorFactory.java jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/package-info.java Modified: jackrabbit/commons/filevault/trunk/parent/pom.xml URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/parent/pom.xml?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/parent/pom.xml (original) +++ jackrabbit/commons/filevault/trunk/parent/pom.xml Tue Oct 8 09:37:36 2019 @@ -268,6 +268,11 @@ maven-scm-publish-plugin 3.0.0 + + org.apache.maven.plugins + maven-javadoc-plugin + 3.1.1 + Modified: jackrabbit/commons/filevault/trunk/pom.xml URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/pom.xml?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/pom.xml (original) +++ jackrabbit/commons/filevault/trunk/pom.xml Tue Oct 8 09:37:36 2019 @@ -72,16 +72,21 @@ org.apache.maven.plugins maven-javadoc-plugin - 2.7 Apache Jackrabbit FileVault ${project.version} API Apache Jackrabbit FileVault ${project.version} API - org.apache.jackrabbit.vault.cli*,org.apache.jackrabbit.vault.davex,*.impl*,org.apache.jackrabbit.vault.util.xml,org.apache.jackrabbit.vault.vlt.actions,org.apache.jackrabbit.vault.vlt.meta.*,org.apache.jackrabbit.vault.packaging.hotfix + org.apache.jackrabbit.vault.cli*,org.apache.jackrabbit.vault.davex,*.impl*,org.apache.jackrabbit.vault.util.xml,org.apache.jackrabbit.vault.vlt.actions,org.apache.jackrabbit.vault.vlt.meta.*,org.apache.jackrabbit.vault.packaging.hotfix,org.apache.jackrabbit.vault.validation.impl*,org.apache.jackrabbit.vault.validation.spi.impl ${basedir}/vault-doc/target/site -notimestamp + true + true + + https://docs.adobe.com/docs/en/spec/javax.jcr/javadocs/jcr-2.0 + http://jackrabbit.apache.org/api/2.18 + Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/impl/DefaultPackageProperties.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/impl/DefaultPackageProperties.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/impl/DefaultPackageProperties.java (original) +++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/impl/DefaultPackageProperties.java Tue Oct 8 09:37:36 2019 @@ -35,25 +35,33 @@ public class DefaultPackageProperties ex private final Properties properties; - public static DefaultPackageProperties fromFile(Path path) throws InvalidPropertiesFormatException, IOException { + /** + * Reads package properties from a file. + * @param path the path from which to read package properties + * @return the package properties deserialized from the given file + * @throws IOException in case deserializing from the file failed + */ + public static DefaultPackageProperties fromFile(Path path) throws IOException { return new DefaultPackageProperties(path); } /** + * Reads package properties from an input stream. *

The specified stream remains open after this method returns. - * @param input - * @return the package properties being exposed through this input - * @throws IOException + * + * @param input the input from which to generate the package properties + * @return the package properties deserialized from the given input + * @throws IOException in case deserializing from the input stream failed */ - public static DefaultPackageProperties fromInputStream(InputStream input) throws InvalidPropertiesFormatException, IOException { + public static DefaultPackageProperties fromInputStream(InputStream input) throws IOException { return new DefaultPackageProperties(input); } - protected DefaultPackageProperties(InputStream input) throws IOException { + private DefaultPackageProperties(InputStream input) throws IOException { properties = getPropertiesMap(input); } - - protected DefaultPackageProperties(Path path) throws IOException { + + private DefaultPackageProperties(Path path) throws IOException { try (InputStream fileInput = Files.newInputStream(path)) { properties = getPropertiesMap(fileInput); } Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/OutputFormat.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/OutputFormat.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/OutputFormat.java (original) +++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/OutputFormat.java Tue Oct 8 09:37:36 2019 @@ -449,7 +449,7 @@ public class OutputFormat { } /** - * Returns an {@code EncodingInfo{@code instance for the encoding. + * Returns an {@code EncodingInfo} instance for the encoding. * * @see #setEncoding */ Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/XMLSerializer.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/XMLSerializer.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/XMLSerializer.java (original) +++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/serialize/XMLSerializer.java Tue Oct 8 09:37:36 2019 @@ -62,16 +62,16 @@ import org.xml.sax.helpers.AttributeList import org.xml.sax.helpers.AttributesImpl; /** - * ASF Note: This class and dependencies were copied from the sun jdk1.5 + * ASF Note: This class and dependencies were copied from the sun jdk1.5 * source base. The original serializer is extended by a new OutputFormat * setting that allows to break the line for each attribute. additionally, * all attribute names are sorted alphabetically. * Some Features were removed to limit the number of dependent classes: *

    - *
  • dom filter support - *
  • all text nodes as CDATA feature - *
  • skip attribute default values feature - *
  • entity node reference feature + *
  • dom filter support
    • + *
  • all text nodes as CDATA feature
    • + *
  • skip attribute default values feature
    • + *
  • entity node reference feature
    • *
*

* Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/dom/DOMMessageFormatter.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/dom/DOMMessageFormatter.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/dom/DOMMessageFormatter.java (original) +++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/dom/DOMMessageFormatter.java Tue Oct 8 09:37:36 2019 @@ -131,7 +131,7 @@ public class DOMMessageFormatter { /** * setLocale to be used by the formatter. * - * @param locale + * @param dlocale the locale */ public static void setLocale(Locale dlocale) { locale = dlocale; Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/EncodingMap.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/EncodingMap.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/EncodingMap.java (original) +++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/EncodingMap.java Tue Oct 8 09:37:36 2019 @@ -26,7 +26,7 @@ import java.util.Hashtable; * be the IANA encoding names specified or one of the aliases for those names * which IANA defines. *

- * + *
* *
*

Common Name Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/SymbolTable.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/SymbolTable.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/SymbolTable.java (original) +++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/SymbolTable.java Tue Oct 8 09:37:36 2019 @@ -42,7 +42,6 @@ package org.apache.jackrabbit.vault.util * * @author Andy Clark * @version $Id$ - * @see SymbolHash */ public class SymbolTable { Modified: jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/XMLChar.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/XMLChar.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/XMLChar.java (original) +++ jackrabbit/commons/filevault/trunk/vault-core/src/main/java/org/apache/jackrabbit/vault/util/xml/xerces/util/XMLChar.java Tue Oct 8 09:37:36 2019 @@ -933,7 +933,7 @@ public class XMLChar { * Check to see if a string is a valid NCName according to [4] * from the XML Namespaces 1.0 Recommendation * - * @param name string to check + * @param ncName string to check * @return true if name is a valid NCName */ public static boolean isValidNCName(String ncName) { Modified: jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/validation.md URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/validation.md?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/validation.md (original) +++ jackrabbit/commons/filevault/trunk/vault-doc/src/site/markdown/validation.md Tue Oct 8 09:37:36 2019 @@ -45,7 +45,7 @@ Each validator settings are set for a sp ID | Description | Options --- | --- | --- -`jackrabbit-filter` | Checks for validity of the [filter.xml](./filter.html]) (according to a predefined XML schema). In addition checks that every [docview xml node](./docview.html) is contained in the filter. It also makes sure that all filter root's ancestors are either known/valid roots or are contained in the package dependencies. For ancestor nodes which are not covered by a filter at least a `warn` is emitted. Also it makes sure that `pattern` values for includes/excludes as well as `root` values for each filter entry are valid. Orphaned filter rules (i.e. ones not being necessary) lead to validation issues as well. | *severityForUncoveredAncestorNodes*: severity of validation messages for uncovered ancestor nodes.
*severityForUncoveredFilterRootAncestors*: severity of validation messages for uncovered filter root ancestors. Only relevant for package type != application (default = warn)
*severityForOrphanedFilterRules*: severity of validation messages for orphaned f ilter rules (default = info)
*validRoots*: comma-separated list of valid roots (default = `"/,/libs,/apps,/etc,/var,/tmp,/content"`) +`jackrabbit-filter` | Checks for validity of the [filter.xml](./filter.html) (according to a predefined XML schema). In addition checks that every [docview xml node](./docview.html) is contained in the filter. It also makes sure that all filter root's ancestors are either known/valid roots or are contained in the package dependencies. For ancestor nodes which are not covered by a filter at least a `warn` is emitted. Also it makes sure that `pattern` values for includes/excludes as well as `root` values for each filter entry are valid. Orphaned filter rules (i.e. ones not being necessary) lead to validation issues as well. | *severityForUncoveredAncestorNodes*: severity of validation messages for uncovered ancestor nodes.
*severityForUncoveredFilterRootAncestors*: severity of validation messages for uncovered filter root ancestors. Only relevant for package type != application (default = warn)
*severityForOrphanedFilterRules*: severity of validation messages for orphaned fi lter rules (default = info)
*validRoots*: comma-separated list of valid roots (default = `"/,/libs,/apps,/etc,/var,/tmp,/content"`) `jackrabbit-properties ` | Checks for validity of the [properties.xml](./properties.html) | none `jackrabbit-dependencies` | Checks for overlapping filter roots of the referenced package dependencies as well as for valid package dependency references (i.e. references which can be resolved). | *severityForUnresolvedDependencies*: severity of validation messages for unresolved dependencies (default = warn) `jackrabbit-docviewparser` | Checks if all docview files in the package are compliant with the [(extended) Document View Format](docview.html). This involves checking for XML validity as well as checking for correct property types. | none @@ -85,7 +85,7 @@ For each new `ValidationContext` (i.e. n For each file you then call either - `ValidationExecutor.validateJcrRoot(...)` for input streams referring to files which are supposed to end up in the repository or -- `ValidationExecutor.validateMetaInf(...)` for input stream representing metaInf data of the FileVault package +- `ValidationExecutor.validateMetaInf(...)` for input streams representing metaInf data of the FileVault package The Validation API is currently used by the [FileVault Package Maven Plugin][filevault.maven]. Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationExecutor.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationExecutor.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationExecutor.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationExecutor.java Tue Oct 8 09:37:36 2019 @@ -42,7 +42,6 @@ import org.apache.jackrabbit.vault.valid import org.apache.jackrabbit.vault.validation.spi.MetaInfPathValidator; import org.apache.jackrabbit.vault.validation.spi.NodePathValidator; import org.apache.jackrabbit.vault.validation.spi.PropertiesValidator; -import org.apache.jackrabbit.vault.validation.spi.ValidationContext; import org.apache.jackrabbit.vault.validation.spi.ValidationMessage; import org.apache.jackrabbit.vault.validation.spi.ValidationMessageSeverity; import org.apache.jackrabbit.vault.validation.spi.Validator; @@ -52,9 +51,10 @@ import org.apache.jackrabbit.vault.valid import org.slf4j.Logger; import org.slf4j.LoggerFactory; -/** Calls all registered low-level validators. This instance is bound to the {@link ValidationContext} being given in the +/** + * Prrovides methods to call all registered validators. This instance is bound to the {@link ValidationContext} being given in the * {@link ValidationExecutorFactory#createValidationExecutor(org.apache.jackrabbit.vault.validation.spi.ValidationContext, boolean, boolean, Map)}. - * This class is thread-safe (i.e. methods can be used from different threads on the same instance) + * This class is thread-safe (i.e. methods can be used from different threads on the same instance). * @see ValidationExecutorFactory */ public class ValidationExecutor { @@ -74,6 +74,11 @@ public class ValidationExecutor { */ private static final Logger log = LoggerFactory.getLogger(ValidationExecutor.class); + /** + * Creates a new instance with the given validators. + * + * @param validatorsById a map of validator ids and actual validators + */ public ValidationExecutor(@Nonnull Map validatorsById) { this.validatorsById = validatorsById; this.documentViewXmlValidators = ValidationExecutor.filterValidatorsByClass(validatorsById, DocumentViewXmlValidator.class); @@ -99,10 +104,20 @@ public class ValidationExecutor { } } + /** + * Returns all bound validators by id. + * @return a map with all validators (key=validator id, value=actual validator) + */ public @Nonnull Map getAllValidatorsById() { return validatorsById; } + /** + * Returns all unused validators by id. Unused validators are those implementing an interface which + * is not understood by this executor. + * + * @return a map with all unused validators (key=validator id, value=actual validator) + */ public @Nonnull Map getUnusedValidatorsById() { Map unusedValidators = new HashMap<>(validatorsById); unusedValidators.keySet().removeAll(documentViewXmlValidators.keySet()); @@ -117,7 +132,10 @@ public class ValidationExecutor { return unusedValidators; } - /** @param input the input stream (it is not closed during processing, this is obligation of the caller). Should not be buffered as buffering is done internally! + /** + * Validates a package META-INF input stream with all relevant validators. + * + * @param input the input stream (it is not closed during processing, this is obligation of the caller). Should not be buffered as buffering is done internally! * @param filePath should be relative to the META-INF directory (i.e. should not start with {@code META-INF}) * @param basePath the path to which the file path is relative * @return the list of validation messages @@ -138,7 +156,10 @@ public class ValidationExecutor { return messages; } - /** @param input the input stream (it is not closed during processing, this is obligation of the caller). Should not be buffered as buffering is done internally! + /** + * Validates a package jcr_root input stream with all relevant validators. + * + * @param input the input stream (it is not closed during processing, this is obligation of the caller). Should not be buffered as buffering is done internally! * @param filePath file path relative to the content package jcr root (i.e. the folder named "jcr_root") * @param basePath the path to which the file path is relative * @return the list of validation messages @@ -160,9 +181,12 @@ public class ValidationExecutor { return messages; } - /** Must be called at the end of the validation (i.e. when the validation context is not longer used) + /** + * Must be called at the end of the validation (when the validation context is no longer used). + * This is important as some validators emit violation messages only when this method is called. * - * @return the list of additional validation violations (might be empty) which have not been reported before */ + * @return the list of additional validation violations (might be empty) which have not been reported before + */ public @Nonnull Collection done() { Collection allViolations = new LinkedList<>(); // go through all validators (even the nested ones) @@ -175,7 +199,7 @@ public class ValidationExecutor { return allViolations; } - protected Collection validateNodePaths(Path filePath, Path basePath, Map nodePathsAndLineNumbers) { + private Collection validateNodePaths(Path filePath, Path basePath, Map nodePathsAndLineNumbers) { List enrichedMessages = new LinkedList<>(); for (Map.Entry nodePathAndLineNumber : nodePathsAndLineNumbers.entrySet()) { @@ -191,7 +215,7 @@ public class ValidationExecutor { return enrichedMessages; } - protected Collection validateGenericMetaInfData(InputStream input, Path filePath, Path basePath) throws IOException { + private Collection validateGenericMetaInfData(InputStream input, Path filePath, Path basePath) throws IOException { Collection enrichedMessages = new LinkedList<>(); ResettableInputStream resettableInputStream = null; InputStream currentInput = input; @@ -227,7 +251,7 @@ public class ValidationExecutor { return enrichedMessages; } - protected Collection validateGenericJcrData(InputStream input, Path filePath, Path basePath) throws IOException { + private Collection validateGenericJcrData(InputStream input, Path filePath, Path basePath) throws IOException { Map nodePathsAndLineNumbers = new HashMap<>(); Collection enrichedMessages = new LinkedList<>(); ResettableInputStream resettableInputStream = null; @@ -274,7 +298,12 @@ public class ValidationExecutor { return enrichedMessages; } - public static String filePathToNodePath(Path filePath) { + /** + * Converts the given file path (a relative one) to the absolute node path. + * @param filePath the relative file path to convert + * @return the node path + */ + public static @Nonnull String filePathToNodePath(@Nonnull Path filePath) { // convert to forward slashes and make absolute by prefixing it with "/" String platformPath = "/" + FilenameUtils.separatorsToUnix(filePath.toString()); return PlatformNameFormat.getRepositoryPath(platformPath, true); Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationExecutorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationExecutorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationExecutorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationExecutorFactory.java Tue Oct 8 09:37:36 2019 @@ -39,7 +39,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Creates {@link ValidationExecutor}s. + * Creates {@link ValidationExecutor}s. Holds a number of {@link ValidatorFactory} instances. */ public class ValidationExecutorFactory { @@ -51,6 +51,10 @@ public class ValidationExecutorFactory { */ private static final Logger log = LoggerFactory.getLogger(ValidationExecutorFactory.class); + /** Creates a new instance with {@code ValidatorFactory} instances being created via the {@link ServiceLoader} being used with the given classloader. + * + * @param classLoader the class loader to be used with the service loader + */ public ValidationExecutorFactory(ClassLoader classLoader) { this(ServiceLoader.load(ValidatorFactory.class, classLoader)); } @@ -66,7 +70,10 @@ public class ValidationExecutorFactory { } - /** @param context the validation context given to the validators + /** + * Creates a {@link ValidationExecutor} for the given context. + * + * @param context the validation context given to the validators * @param isSubPackage {@code true} in case this is a subpackage, otherwise {@code false} * @param enforceSubpackageValidation {@code true} in case all validators should be also applied in any case to the sub package * (independent of their {@link ValidatorFactory#shouldValidateSubpackages()} return value) Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationViolation.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationViolation.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationViolation.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/ValidationViolation.java Tue Oct 8 09:37:36 2019 @@ -20,12 +20,14 @@ import java.nio.file.Path; import java.util.Collection; import java.util.LinkedList; +import javax.annotation.CheckForNull; + import org.apache.jackrabbit.vault.validation.spi.ValidationMessage; import org.apache.jackrabbit.vault.validation.spi.ValidationMessageSeverity; /** * A ValidationViolation is a {@link ValidationMessage} enriched with additional meta information like - * file path, node path and validator id. + * validator id, file path and node path. */ public class ValidationViolation extends ValidationMessage { @@ -90,18 +92,30 @@ public class ValidationViolation extends this(validatorId, new ValidationMessage(severity, message), filePath, basePath, nodePath, line, column, t); } - public Path getFilePath() { + /** + * Returns the file path bound to this message. + * @return the absolute file path or {@code null} if the message does not belong to a file + */ + public @CheckForNull Path getFilePath() { if (basePath != null && filePath != null) { return basePath.resolve(filePath); } return filePath; } - public String getNodePath() { + /** + * Returns the node path bound to this message. + * @return the node path or {@code null} if the message does not belong to a specific node + */ + public @CheckForNull String getNodePath() { return nodePath; } - public String getValidatorId() { + /** + * Returns the validator id bound to this message. + * @return the validator id or {@code null} if the message does not belong to a specific {@link ValidatorFactory} + */ + public @CheckForNull String getValidatorId() { return validatorId; } Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/impl/util/DocumentViewXmlContentHandler.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/impl/util/DocumentViewXmlContentHandler.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/impl/util/DocumentViewXmlContentHandler.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/impl/util/DocumentViewXmlContentHandler.java Tue Oct 8 09:37:36 2019 @@ -25,6 +25,8 @@ import java.util.LinkedList; import java.util.List; import java.util.Map; +import javax.annotation.Nonnull; + import org.apache.jackrabbit.spi.Name; import org.apache.jackrabbit.spi.commons.name.NameConstants; import org.apache.jackrabbit.spi.commons.name.NameFactoryImpl; @@ -56,7 +58,7 @@ public class DocumentViewXmlContentHandl private List violations; - public List getViolations() { + public @Nonnull List getViolations() { return violations; } @@ -170,7 +172,7 @@ public class DocumentViewXmlContentHandl } /** @return a Collection of absolute node paths (i.e. starting with "/") with "/" as path delimiter. */ - public Map getNodePaths() { + public @Nonnull Map getNodePaths() { return nodePathsAndLineNumbers; } Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/impl/util/ResettableInputStream.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/impl/util/ResettableInputStream.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/impl/util/ResettableInputStream.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/impl/util/ResettableInputStream.java Tue Oct 8 09:37:36 2019 @@ -29,6 +29,11 @@ import org.apache.commons.io.input.TeeIn import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * An input stream wrapper which is resettable, i.e. allows {{@link #mark(int)} and {{@link #reset()} to be called. + * It uses a temporary file for buffering the given input stream, except for the case where it is already a {@link FileInputStream} + * in which case it uses the seeking methods of that. + */ public class ResettableInputStream extends InputStream { private final Path tmpFile; Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/package-info.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/package-info.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/package-info.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/package-info.java Tue Oct 8 09:37:36 2019 @@ -14,7 +14,9 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - +/** + * The FileVault validation framework API. Provides classes to execute validations on FileVault packages. + */ @Version("1.0.0") package org.apache.jackrabbit.vault.validation; Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/DocumentViewXmlValidator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/DocumentViewXmlValidator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/DocumentViewXmlValidator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/DocumentViewXmlValidator.java Tue Oct 8 09:37:36 2019 @@ -22,14 +22,12 @@ import java.util.Collection; import javax.annotation.CheckForNull; import javax.annotation.Nonnull; -import org.apache.jackrabbit.spi.Name; import org.apache.jackrabbit.vault.util.DocViewNode; import org.osgi.annotation.versioning.ProviderType; /** - * Similar to a SAX content handler but specific for (enhanced) Document View XML files within content packages. + * Validator interface for (enhanced) Document View XML files within content packages. * - * Allows to add violations. * @see Filevault DocView * */ @@ -37,10 +35,11 @@ import org.osgi.annotation.versioning.Pr public interface DocumentViewXmlValidator extends Validator { /** - * Called for the beginning of each new JCR document view node (not part of the SAXHandler interface). + * Called for the beginning of each new JCR document view node. * Deserialization of the node information was already done when this method is called! - * The node and attribute names have the string representation outlined in {@link Name} (i.e. including the expanded namespace uri) - * @param node the node which is represented by the current XML element + * The node and attribute names have the string representation outlined in {@link Name} (i.e. including the expanded namespace uri in the format {namespaceURI}localPart). + * + * @param node the node which should be validated * @param nodePath the absolute repository path of the given node * @param filePath the relative file path of the docview file containing this node * @param isRoot {@code true} in case this is the root node of the docview file otherwise {@code false} Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/FilterValidator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/FilterValidator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/FilterValidator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/FilterValidator.java Tue Oct 8 09:37:36 2019 @@ -25,12 +25,13 @@ import org.apache.jackrabbit.vault.fs.ap import org.osgi.annotation.versioning.ProviderType; /** - * This validator is called for each {@code META-INF/vault/filter.xml} being found + * Validator interface for package filters. Called for each {@code META-INF/vault/filter.xml} being found. * */ @ProviderType public interface FilterValidator extends Validator { /** + * Called when a filter is validated. * * @param filter the deserialized filter * @return validation messages or {@code null} Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/GenericJcrDataValidator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/GenericJcrDataValidator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/GenericJcrDataValidator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/GenericJcrDataValidator.java Tue Oct 8 09:37:36 2019 @@ -27,17 +27,19 @@ import javax.annotation.Nonnull; import org.osgi.annotation.versioning.ProviderType; /** - * Low-level validator for all files below jcr_root. + * Low-level validator interface for all files below jcr_root. * For Document View XML files rather use {@link DocumentViewXmlValidator}. - * For validators only considering file name or node name use {@link NodePathValidator} + * For validators only considering file name or node name use {@link JcrPathValidator} or {@link NodePathValidator} instead. */ @ProviderType public interface GenericJcrDataValidator extends Validator { /** + * Called for each file below jcr_root. * Only called in case {@link #shouldValidateJcrData(Path)} returned {@code true} for the given path. + * * @param input the input stream of the file which ends up below jcr_root in the package located at filePath - * @param filePath is relative to the jcr_root directory (i.e. does not start with {@code jcr_root}) + * @param filePath file path relative to the jcr_root directory (i.e. does not start with {@code jcr_root}) * @param nodePathsAndLineNumbers a map which should be filled with all node path and their according line numbers if nodes are detected in the given input * @return a collection of validation messages or {@code null} * @throws IOException in case the input stream could not be accessed @@ -45,7 +47,9 @@ public interface GenericJcrDataValidator Collection validateJcrData(@Nonnull InputStream input, @Nonnull Path filePath, @Nonnull Map nodePathsAndLineNumbers) throws IOException; /** - * @param filePath is relative to the jcr_root directory (i.e. does not start with {@code jcr_root}) + * Called for each file below jcr_root. + * + * @param filePath file path relative to the jcr_root directory (i.e. does not start with {@code jcr_root}) * @return {@code true} in case the file should be validated, otherwise {@code false} */ boolean shouldValidateJcrData(@Nonnull Path filePath); Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/GenericMetaInfDataValidator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/GenericMetaInfDataValidator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/GenericMetaInfDataValidator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/GenericMetaInfDataValidator.java Tue Oct 8 09:37:36 2019 @@ -27,22 +27,30 @@ import javax.annotation.Nonnull; import org.osgi.annotation.versioning.ProviderType; /** - * Called for each file below META-INF (including {@code vault/filter.xml} and {@code vault/properties.xml}) + * Low-level validator interface for all files below META-INF (including {@code vault/filter.xml} and {@code vault/properties.xml}). + * + * For validating properties and filter rather use the high-level validators {@link PropertiesValidator} or {@link FilterValidator}. + * For validators only considering the file name use {@link MetaInfPathValidator} instead. + */ @ProviderType public interface GenericMetaInfDataValidator extends Validator { /** + * Called for each file below META-INF. * Only called in case {@link #shouldValidateMetaInfData(Path)} returned true for the given path. + * * @param input the input stream of the META-INF file located at filePath - * @param filePath is relative to the META-INF directory (i.e. does not start with {@code META-INF}) + * @param filePath file path relative to the META-INF directory (i.e. does not start with {@code META-INF}) * @return a collection of validation messages or {@code null} * @throws IOException in case the input stream could not be accessed */ @CheckForNull Collection validateMetaInfData(@Nonnull InputStream input, @Nonnull Path filePath) throws IOException; /** - * @param filePath is relative to the META-INF directory (i.e. does not start with {@code META-INF}) + * Called for each file below META-INF. + * + * @param filePath file path relative to the META-INF directory (i.e. does not start with {@code META-INF}) * @return {@code true} in case the file should be validated, otherwise {@code false} */ boolean shouldValidateMetaInfData(@Nonnull Path filePath); Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/JcrPathValidator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/JcrPathValidator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/JcrPathValidator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/JcrPathValidator.java Tue Oct 8 09:37:36 2019 @@ -26,12 +26,13 @@ import org.osgi.annotation.versioning.Pr /** - * Interface for validators which are only interested in file path for files + * Validator interface for validating file paths for files * below jcr_root. */ @ProviderType public interface JcrPathValidator extends Validator { /** + * Called for each file below jcr_root. * * @param filePath the relative file path to the jcr_root directory * @return validation messages or {@code null} Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/MetaInfPathValidator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/MetaInfPathValidator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/MetaInfPathValidator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/MetaInfPathValidator.java Tue Oct 8 09:37:36 2019 @@ -26,13 +26,14 @@ import org.osgi.annotation.versioning.Pr /** - * Interface for validators which are only interested in file path for files - * below META-INF + * Validator interface for validating file paths for files + * below META-INF. */ @ProviderType public interface MetaInfPathValidator extends Validator { /** - * + * Called for each file below META-INF. + * * @param filePath the relative file path to the META-INF directory * @return validation messages or {@code null} */ Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/NodePathValidator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/NodePathValidator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/NodePathValidator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/NodePathValidator.java Tue Oct 8 09:37:36 2019 @@ -25,13 +25,14 @@ import org.osgi.annotation.versioning.Pr /** - * Interface for validators which are only interested in the node paths but not any other information. - * For validators interested in the actual properties use either {@link DocumentViewXmlValidator} or {@link GenericJcrDataValidator} + * Validator interface for validating node paths. + * For validators interested in the actual properties use either {@link DocumentViewXmlValidator} or {@link GenericJcrDataValidator}. * */ @ProviderType public interface NodePathValidator extends Validator { /** + * Called for each node being found in a package. * * @param nodePath the absolute node path * @return validation messages or {@code null} Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/PropertiesValidator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/PropertiesValidator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/PropertiesValidator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/PropertiesValidator.java Tue Oct 8 09:37:36 2019 @@ -25,13 +25,14 @@ import org.apache.jackrabbit.vault.packa import org.osgi.annotation.versioning.ProviderType; /** - * This validator is called for each {@code META-INF/vault/properties.xml} being found + * Validator interface for package properties. * */ @ProviderType public interface PropertiesValidator extends Validator { /** - * Called once for each each {@code META-INF/vault/properties.xml} being found + * Called once for each each {@code META-INF/vault/properties.xml} being found. + * * @param properties the deserialized properties.xml * @return validation messages or {@code null} */ Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationContext.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationContext.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationContext.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationContext.java Tue Oct 8 09:37:36 2019 @@ -27,33 +27,35 @@ import org.apache.jackrabbit.vault.packa import org.osgi.annotation.versioning.ProviderType; /** - * The validation context for a specific run of validators (bound to at most one Maven Module and package) + * The validation context encapsulates information about the package for which the validation is being triggered. * */ @ProviderType public interface ValidationContext extends PackageInfo { /** + * Returns the package properties. + * * @return the package properties or some exception in case none could be found (will always point to the root package's properties). */ @Nonnull PackageProperties getProperties(); /** + * Returns the validation context of the container package. * @return the validation context of the container in case this is the context of a sub package otherwise {@code null}. */ @CheckForNull ValidationContext getContainerValidationContext(); /** + * Returns the root path of the package. * @return either the path to the ZIP file or a directory containing an exploded package. */ @Nonnull Path getPackageRootPath(); /** - * PackageInfo for all resolved package dependencies + * PackageInfo for all resolved package dependencies. * In contrast to {@link PackageProperties#getDependencies()} the resolved dependencies also * carry the main metadata of the dependencies. - * This might even include artificial dependencies (i.e. repositoryStructureDependencies) which never - * appear in the package properties, but are only given at build time! * @return the package info of all resolved package dependencies (i.e. the ones for which an artifact was found). */ @Nonnull Collection getDependenciesMetaInfo(); Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationMessage.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationMessage.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationMessage.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationMessage.java Tue Oct 8 09:37:36 2019 @@ -16,8 +16,11 @@ */ package org.apache.jackrabbit.vault.validation.spi; +import javax.annotation.CheckForNull; +import javax.annotation.Nonnull; + /** - * Class encapsulating the actual message together with a {@link ValidationMessageSeverity} + * Class encapsulating the actual message together with a {@link ValidationMessageSeverity}. */ public class ValidationMessage { @@ -30,15 +33,15 @@ public class ValidationMessage { /** the underlying exception if there was any, may be null */ private final Throwable throwable; - public ValidationMessage(ValidationMessageSeverity severity, String message) { + public ValidationMessage(@Nonnull ValidationMessageSeverity severity, @Nonnull String message) { this(severity, message, 0, 0, null); } - public ValidationMessage(ValidationMessageSeverity severity, String message, Throwable throwable) { + public ValidationMessage(@Nonnull ValidationMessageSeverity severity, @Nonnull String message, Throwable throwable) { this(severity, message, 0, 0, throwable); } - public ValidationMessage(ValidationMessageSeverity severity, String message, int line, int column, Throwable throwable) { + public ValidationMessage(@Nonnull ValidationMessageSeverity severity, @Nonnull String message, int line, int column, Throwable throwable) { this.severity = severity; this.message = message; this.line = line; @@ -46,27 +49,45 @@ public class ValidationMessage { this.throwable = throwable; } - public ValidationMessageSeverity getSeverity() { + + + /** + * Returns the severity of this message. + * @return the severity of this message + */ + public @Nonnull ValidationMessageSeverity getSeverity() { return severity; } - - public String getMessage() { - // prefix message with + /** + * Returns the message text. + * @return the message text + */ + public @Nonnull String getMessage() { return message; } - /** @return the line number of this violation (1-based) or 0 if not bound to any specific line number */ + /** + * Returns the line number. + * @return the line number of this violation (1-based) or 0 if not bound to any specific line number + */ public int getLine() { return line; } - /** @return the column number of this violation (1-based) or 0 if not bound to any specific column number */ + /** + * Returns the column number. + * @return the column number of this violation (1-based) or 0 if not bound to any specific column number + */ public int getColumn() { return column; } - public Throwable getThrowable() { + /** + * Returns the underlying throwable. + * @return the throwable bound to this message or {@code null} if the message has no underlying throwable + */ + public @CheckForNull Throwable getThrowable() { return throwable; } Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationMessageSeverity.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationMessageSeverity.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationMessageSeverity.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidationMessageSeverity.java Tue Oct 8 09:37:36 2019 @@ -16,13 +16,16 @@ */ package org.apache.jackrabbit.vault.validation.spi; +/** + * The severity of a {@link ValidationMessage}. + */ public enum ValidationMessageSeverity { - /** should only be emitted in case a debug option is enabled, not a real violation */ + /** Should only be emitted in case a debug option is enabled, not a real violation. */ DEBUG, - /** only for informational purposes, not a real violation */ + /** Only for informational purposes, not a real violation. */ INFO, - /** a violation which might lead to unintended side-effects during package installation */ + /** A violation which might lead to unintended side-effects during package installation. */ WARN, - /** a severe violation which very likely leads to unintended side-effects during package installation */ + /** A severe violation which very likely leads to unintended side-effects during package installation. */ ERROR } Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/Validator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/Validator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/Validator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/Validator.java Tue Oct 8 09:37:36 2019 @@ -23,17 +23,16 @@ import javax.annotation.CheckForNull; import org.osgi.annotation.versioning.ProviderType; /** - * A validator is created per Maven module individually and only used from a single thread. - * Also the instance is only used for one package at most (i.e. subpackages get another instance) - * Instead of implementing this generic interface each validator should rather implement one of the + * Base interface for all validators. Instead of implementing this generic interface each validator should rather implement one of the * sub interfaces. - * + * A validator is created per {@link ValidationContext} individually and only used from a single thread. + * Also the instance is only used for one package at most (i.e. subpackages get another instance). */ @ProviderType public interface Validator { /** - * Called when the validation is done for one {@link ValidationContext} (i.e. this instance is no longer needed) + * Called when the validation is done for one {@link ValidationContext} (this instance is no longer needed) * @return validation messages or {@code null} */ @CheckForNull Collection done(); Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidatorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidatorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidatorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidatorFactory.java Tue Oct 8 09:37:36 2019 @@ -16,8 +16,6 @@ */ package org.apache.jackrabbit.vault.validation.spi; -import java.util.ServiceLoader; - import javax.annotation.CheckForNull; import javax.annotation.Nonnull; @@ -30,18 +28,20 @@ import org.osgi.annotation.versioning.Pr @ProviderType public interface ValidatorFactory { /** - * Reserved prefix for all validators integrated in this JAR + * Reserved prefix for all validator ids integrated in this JAR. No custom validator ids must start with this prefix. */ - public static final String PREFIX_JACKRABBIT = "jackrabbit-"; + public static final String ID_PREFIX_JACKRABBIT = "jackrabbit-"; /** + * Creates a new validator for the given context. * - * @param context the context of Validator (info about package) + * @param context the validation context * @param settings the validator settings - * @return a new validator instance (lifecycle bound to the package outlined in context and the current maven module) or {@code null} in case there is no validation relevant for the given context + * @return a new validator instance (lifecycle bound to the package outlined in context) or {@code null} in case there is no validation relevant for the given context */ @CheckForNull Validator createValidator(@Nonnull ValidationContext context, @Nonnull ValidatorSettings settings); /** + * Returns whether the validator should by default also called for subpackages. * * @return {@code true} in case the validation with this validator should also happen for subpackages (recursively), otherwise {@code false} */ @@ -49,9 +49,9 @@ public interface ValidatorFactory { /** * Returns the validator ID. It should be unique i.e. not overlap between any two validators. To achieve that - * use a {@code -} as ID. Reserved prefixes are "jackrabbit" (used by all OOTB validators), "aem" and "sling". + * use the format {@code -} for every ID. Reserved prefixes are "jackrabbit" (used by all OOTB validators), "aem" and "sling". * For custom validators use a company name as prefix. The name should not contain the string "validator". - * The id should only use lower case characters. + * The id should only contain lower case characters. * @return the id of the validator returned by {@link #createValidator(ValidationContext, ValidatorSettings)} */ @Nonnull String getId(); @@ -59,7 +59,7 @@ public interface ValidatorFactory { /** * The service ranking will influence the order in which the validators will be called. * In general: - * The higher the ranking the earlier it will be executed + * The higher the ranking the earlier it will be executed. * @return the service ranking */ int getServiceRanking(); Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidatorSettings.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidatorSettings.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidatorSettings.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/ValidatorSettings.java Tue Oct 8 09:37:36 2019 @@ -21,27 +21,31 @@ import java.util.Map; import javax.annotation.Nonnull; import org.osgi.annotation.versioning.ProviderType; + /** - * Settings relevant for one {@link Validator}. + * Settings relevant for one {@link ValidatorFactory}. */ @ProviderType public interface ValidatorSettings { /** + * Returns the default severity. * - * @return the default severity for most {@link ValidationMessage}s being returned by the validator + * @return the default severity for most {@link ValidationMessage}s being returned by the validator. */ @Nonnull ValidationMessageSeverity getDefaultSeverity(); /** + * Returns the additional options. * * @return list of options relevant for this validator */ @Nonnull Map getOptions(); /** + * Returns whether the validator is disabled. * - * @return {@code true} in case validator + * @return {@code true} in case validator is disabled otherwise {@code false} */ @Nonnull boolean isDisabled(); Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/AdvancedFilterValidatorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/AdvancedFilterValidatorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/AdvancedFilterValidatorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/AdvancedFilterValidatorFactory.java Tue Oct 8 09:37:36 2019 @@ -36,7 +36,7 @@ import org.slf4j.LoggerFactory; @MetaInfServices public final class AdvancedFilterValidatorFactory implements ValidatorFactory { - public static final String ID = PREFIX_JACKRABBIT + "filter"; + public static final String ID = ID_PREFIX_JACKRABBIT + "filter"; public static final String OPTION_SEVERITY_FOR_UNCOVERED_ANCESTOR_NODES = "severityForUncoveredAncestorNodes"; private static final Object OPTION_SEVERITY_FOR_UNCOVERED_FILTER_ROOT_ANCESTORS = "severityForUncoveredFilterRootAncestors"; Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/AdvancedPropertiesValidatorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/AdvancedPropertiesValidatorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/AdvancedPropertiesValidatorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/AdvancedPropertiesValidatorFactory.java Tue Oct 8 09:37:36 2019 @@ -37,7 +37,7 @@ public final class AdvancedPropertiesVal @Override public String getId() { - return ValidatorFactory.PREFIX_JACKRABBIT + "properties"; + return ValidatorFactory.ID_PREFIX_JACKRABBIT + "properties"; } @Override Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DependencyValidator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DependencyValidator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DependencyValidator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DependencyValidator.java Tue Oct 8 09:37:36 2019 @@ -32,7 +32,7 @@ import org.apache.jackrabbit.vault.valid public final class DependencyValidator implements PropertiesValidator { static final String MESSAGE_DEPENDENCIES_WITH_OVERLAPPING_FILTERS = "Dependency '%s' defines same filter root '%s' as dependency '%s'"; - static final String MESSAGE_UNRESOLVED_DEPENDENCY = "Dependency '%s' is not using maven coordinates and cannot be used for analysis."; + static final String MESSAGE_UNRESOLVED_DEPENDENCY = "Dependency '%s'was not successfully resolved and can therefore not be used for analysis."; private final Collection dependenciesMetaInfo; private final ValidationMessageSeverity severity; private final ValidationMessageSeverity severityForUnresolvedDependencies; Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DependencyValidatorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DependencyValidatorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DependencyValidatorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DependencyValidatorFactory.java Tue Oct 8 09:37:36 2019 @@ -26,7 +26,7 @@ import org.kohsuke.MetaInfServices; @MetaInfServices public final class DependencyValidatorFactory implements ValidatorFactory { - public static final String ID = PREFIX_JACKRABBIT + "dependencies"; + public static final String ID = ID_PREFIX_JACKRABBIT + "dependencies"; public static final String OPTION_SEVERITY_FOR_UNRESOLVED_DEPENDENCIES = "severityForUnresolvedDependencies"; private static final ValidationMessageSeverity DEFAULT_SEVERITY_FOR_UNRESOLVED_DEPENDENCIES = ValidationMessageSeverity.WARN; Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DocumentViewParserValidatorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DocumentViewParserValidatorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DocumentViewParserValidatorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/DocumentViewParserValidatorFactory.java Tue Oct 8 09:37:36 2019 @@ -52,7 +52,7 @@ public class DocumentViewParserValidator @Override public String getId() { - return ValidatorFactory.PREFIX_JACKRABBIT + "docviewparser"; + return ValidatorFactory.ID_PREFIX_JACKRABBIT + "docviewparser"; } @Override Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/EmptyElementsValidator.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/EmptyElementsValidator.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/EmptyElementsValidator.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/EmptyElementsValidator.java Tue Oct 8 09:37:36 2019 @@ -38,7 +38,7 @@ import org.apache.jackrabbit.vault.valid /** * Check for empty elements (used for ordering purposes) * which are included in the filter with import=replace as those are actually not replaced! - * @see JCRVLT-251 + * @see JCRVLT-251 */ public class EmptyElementsValidator implements DocumentViewXmlValidator, GenericJcrDataValidator { Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/EmptyElementsValidatorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/EmptyElementsValidatorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/EmptyElementsValidatorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/EmptyElementsValidatorFactory.java Tue Oct 8 09:37:36 2019 @@ -39,7 +39,7 @@ public final class EmptyElementsValidato @Override public String getId() { - return ValidatorFactory.PREFIX_JACKRABBIT + "emptyelements"; + return ValidatorFactory.ID_PREFIX_JACKRABBIT + "emptyelements"; } @Override Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/MergeLimitationsValidatorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/MergeLimitationsValidatorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/MergeLimitationsValidatorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/MergeLimitationsValidatorFactory.java Tue Oct 8 09:37:36 2019 @@ -39,7 +39,7 @@ public final class MergeLimitationsValid @Override public String getId() { - return ValidatorFactory.PREFIX_JACKRABBIT + "mergelimitations"; + return ValidatorFactory.ID_PREFIX_JACKRABBIT + "mergelimitations"; } @Override Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/OakIndexDefinitionValidatorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/OakIndexDefinitionValidatorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/OakIndexDefinitionValidatorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/OakIndexDefinitionValidatorFactory.java Tue Oct 8 09:37:36 2019 @@ -64,7 +64,7 @@ public final class OakIndexDefinitionVal @Override public String getId() { - return ValidatorFactory.PREFIX_JACKRABBIT + "oakindex"; + return ValidatorFactory.ID_PREFIX_JACKRABBIT + "oakindex"; } @Override Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/PackageTypeValidatorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/PackageTypeValidatorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/PackageTypeValidatorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/PackageTypeValidatorFactory.java Tue Oct 8 09:37:36 2019 @@ -58,7 +58,7 @@ public final class PackageTypeValidatorF @Override public String getId() { - return ValidatorFactory.PREFIX_JACKRABBIT + "packagetype"; + return ValidatorFactory.ID_PREFIX_JACKRABBIT + "packagetype"; } @Override Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/PrimaryNodeTypeValidatorFactory.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/PrimaryNodeTypeValidatorFactory.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/PrimaryNodeTypeValidatorFactory.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/impl/PrimaryNodeTypeValidatorFactory.java Tue Oct 8 09:37:36 2019 @@ -39,7 +39,7 @@ public final class PrimaryNodeTypeValida @Override public String getId() { - return ValidatorFactory.PREFIX_JACKRABBIT + "primarynodetype"; + return ValidatorFactory.ID_PREFIX_JACKRABBIT + "primarynodetype"; } @Override Modified: jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/package-info.java URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/package-info.java?rev=1868123&r1=1868122&r2=1868123&view=diff ============================================================================== --- jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/package-info.java (original) +++ jackrabbit/commons/filevault/trunk/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/spi/package-info.java Tue Oct 8 09:37:36 2019 @@ -15,6 +15,9 @@ * limitations under the License. */ +/** + * The FileVault validation framework SPI. Provides classes/interfaces to implement validators on FileVault packages. + */ @Version("1.0.0") package org.apache.jackrabbit.vault.validation.spi;