Uses of Class org.apache.jackrabbit.vault.validation.ValidationViolation (Apache Jackrabbit FileVault 3.4.1-SNAPSHOT API)

+ + + + + + + + + + + + +
Packages that use ValidationViolation
Package Description
org.apache.jackrabbit.vault.validation
+

Packages that use ValidationViolation
Package	Description
org.apache.jackrabbit.vault.validation

Uses of ValidationViolation in org.apache.jackrabbit.vault.validation

+ + + + + + + + + + + + +

Methods in org.apache.jackrabbit.vault.validation that return ValidationViolation
Modifier and Type	Method and Description
`static ValidationViolation`	ValidationViolation.`wrapMessage(java.lang.String validatorId, + ValidationMessage message, + java.nio.file.Path filePath, + java.nio.file.Path basePath, + java.lang.String nodePath, + int line, + int column)`

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods in org.apache.jackrabbit.vault.validation that return types with arguments of type ValidationViolation
Modifier and Type	Method and Description
`java.util.Collection<ValidationViolation>`	ValidationExecutor.`done()` + Must be called at the end of the validation (i.e. +
`protected java.util.Collection<ValidationViolation>`	ValidationExecutor.`validateGenericJcrData(java.io.InputStream input, + java.nio.file.Path filePath, + java.nio.file.Path basePath)`
`protected java.util.Collection<ValidationViolation>`	ValidationExecutor.`validateGenericMetaInfData(java.io.InputStream input, + java.nio.file.Path filePath, + java.nio.file.Path basePath)`
`java.util.Collection<ValidationViolation>`	ValidationExecutor.`validateJcrRoot(java.io.InputStream input, + java.nio.file.Path filePath, + java.nio.file.Path basePath)`
`java.util.Collection<ValidationViolation>`	ValidationExecutor.`validateMetaInf(java.io.InputStream input, + java.nio.file.Path filePath, + java.nio.file.Path basePath)`
`protected java.util.Collection<ValidationViolation>`	ValidationExecutor.`validateNodePaths(java.nio.file.Path filePath, + java.nio.file.Path basePath, + java.util.Map<java.lang.String,java.lang.Integer> nodePathsAndLineNumbers)`
`static java.util.Collection<ValidationViolation>`	ValidationViolation.`wrapMessages(java.lang.String validatorId, + java.util.Collection<? extends ValidationMessage> messages, + java.nio.file.Path filePath, + java.nio.file.Path basePath, + java.lang.String nodePath, + int line, + int column)`

org.apache.jackrabbit.vault.validation

+ + + + + + + + + + + + + + + + + + + + +

Class Summary
Class	Description
ValidationExecutor	+ Calls all registered low-level validators. +
ValidationExecutorFactory	+ Creates `ValidationExecutor`s. +
ValidationViolation	+ A ValidationViolation is a `ValidationMessage` enriched with additional meta information like + file path, node path and validator id. +

Class Hierarchy

java.lang.Object +
- org.apache.jackrabbit.vault.validation.ValidationExecutor
- org.apache.jackrabbit.vault.validation.ValidationExecutorFactory
- org.apache.jackrabbit.vault.validation.spi.ValidationMessage +
  - org.apache.jackrabbit.vault.validation.ValidationViolation
  +
+

+ + + + + + + + + + + + +
Packages that use org.apache.jackrabbit.vault.validation
Package Description
org.apache.jackrabbit.vault.validation
+

Packages that use org.apache.jackrabbit.vault.validation
Package	Description
org.apache.jackrabbit.vault.validation

+ + + + + + + + + + + + + + + +

Classes in org.apache.jackrabbit.vault.validation used by org.apache.jackrabbit.vault.validation
Class and Description
ValidationExecutor + Calls all registered low-level validators. +
ValidationViolation + A ValidationViolation is a `ValidationMessage` enriched with additional meta information like + file path, node path and validator id. +

+
+
All Superinterfaces:
+
Validator
+
+
+
+
```
@ProviderType
+public interface DocumentViewXmlValidator
+extends Validator
```
+
Similar to a SAX content handler but specific for (enhanced) Document View XML files within content packages. + + Allows to add violations.
+
+
See Also:
+
Filevault DocView
+
+

+ +

+ + +

Method Summary

+ + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.Collection<ValidationMessage>`	`validate(DocViewNode node, + java.lang.String nodePath, + java.nio.file.Path filePath, + boolean isRoot)` + Called for the beginning of each new JCR document view node (not part of the SAXHandler interface). +

+ + +
Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator
+done

+ +
- + + +
  Method Detail
  + + + +
  - +
    validate
    +
```
@CheckForNull
+java.util.Collection<ValidationMessage> validate(@Nonnull
+                                                               DocViewNode node,
+                                                               @Nonnull
+                                                               java.lang.String nodePath,
+                                                               @Nonnull
+                                                               java.nio.file.Path filePath,
+                                                               boolean isRoot)
```
    +
    Called for the beginning of each new JCR document view node (not part of the SAXHandler interface). + Deserialization of the node information was already done when this method is called! + The node and attribute names have the string representation outlined in Name (i.e. including the expanded namespace uri)
    +
    +
    Parameters:
    +
    node - the node which is represented by the current XML element
    +
    nodePath - the absolute repository path of the given node
    +
    filePath - the relative file path of the docview file containing this node
    +
    isRoot - true in case this is the root node of the docview file otherwise false
    +
    Returns:
    +
    validation messages or null
    +
    +
  +
+

+
+
All Superinterfaces:
+
Validator
+
+
+
+
```
@ProviderType
+public interface FilterValidator
+extends Validator
```
+
This validator is called for each META-INF/vault/filter.xml being found
+

+ +
- + + +
  Method Summary
  + + + + + + + + + + +
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method and Description
  java.util.Collection<ValidationMessage> validate(WorkspaceFilter filter)
  +
  - + + +
    Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator
    +done
  +
+

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.Collection<ValidationMessage>`	`validate(WorkspaceFilter filter)`

+ +

+ + +

Method Detail

+ + + +

validate

@CheckForNull
+java.util.Collection<ValidationMessage> validate(@Nonnull
+                                                               WorkspaceFilter filter)

Parameters:: filter - the deserialized filter
Returns:: validation messages or null

+
+
All Superinterfaces:
+
Validator
+
+
+
+
```
@ProviderType
+public interface GenericJcrDataValidator
+extends Validator
```
+
Low-level validator for all files below jcr_root. + For Document View XML files rather use DocumentViewXmlValidator. + For validators only considering file name or node name use NodePathValidator
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`shouldValidateJcrData(java.nio.file.Path filePath)`
`java.util.Collection<ValidationMessage>`	`validateJcrData(java.io.InputStream input, + java.nio.file.Path filePath, + java.util.Map<java.lang.String,java.lang.Integer> nodePathsAndLineNumbers)` + Only called in case `shouldValidateJcrData(Path)` returned `true` for the given path. +

+ + +
Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator
+done

+ +
- + + +
  Method Detail
  + + + +
  - +
    validateJcrData
    +
```
java.util.Collection<ValidationMessage> validateJcrData(@Nonnull
+                                                        java.io.InputStream input,
+                                                        @Nonnull
+                                                        java.nio.file.Path filePath,
+                                                        @Nonnull
+                                                        java.util.Map<java.lang.String,java.lang.Integer> nodePathsAndLineNumbers)
+                                                 throws java.io.IOException
```
    +
    Only called in case shouldValidateJcrData(Path) returned true for the given path.
    +
    +
    Parameters:
    +
    input - the input stream of the file which ends up below jcr_root in the package located at filePath
    +
    filePath - is relative to the jcr_root directory (i.e. does not start with jcr_root)
    +
    nodePathsAndLineNumbers - a map which should be filled with all node path and their according line numbers if nodes are detected in the given input
    +
    Returns:
    +
    a collection of validation messages or null
    +
    Throws:
    +
    java.io.IOException - in case the input stream could not be accessed
    +
    +
  + + + +
  - +
    shouldValidateJcrData
    +
```
boolean shouldValidateJcrData(@Nonnull
+                              java.nio.file.Path filePath)
```
    +
    +
    Parameters:
    +
    filePath - is relative to the jcr_root directory (i.e. does not start with jcr_root)
    +
    Returns:
    +
    true in case the file should be validated, otherwise false
    +
    +
  +
+

+
+
All Superinterfaces:
+
Validator
+
+
+
+
```
@ProviderType
+public interface GenericMetaInfDataValidator
+extends Validator
```
+
Called for each file below META-INF (including vault/filter.xml and vault/properties.xml)
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`shouldValidateMetaInfData(java.nio.file.Path filePath)`
`java.util.Collection<ValidationMessage>`	`validateMetaInfData(java.io.InputStream input, + java.nio.file.Path filePath)` + Only called in case `shouldValidateMetaInfData(Path)` returned true for the given path. +

+ + +
Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator
+done

+ +
- + + +
  Method Detail
  + + + +
  - +
    validateMetaInfData
    +
```
@CheckForNull
+java.util.Collection<ValidationMessage> validateMetaInfData(@Nonnull
+                                                                          java.io.InputStream input,
+                                                                          @Nonnull
+                                                                          java.nio.file.Path filePath)
+                                                                   throws java.io.IOException
```
    +
    Only called in case shouldValidateMetaInfData(Path) returned true for the given path.
    +
    +
    Parameters:
    +
    input - the input stream of the META-INF file located at filePath
    +
    filePath - is relative to the META-INF directory (i.e. does not start with META-INF)
    +
    Returns:
    +
    a collection of validation messages or null
    +
    Throws:
    +
    java.io.IOException - in case the input stream could not be accessed
    +
    +
  + + + +
  - +
    shouldValidateMetaInfData
    +
```
boolean shouldValidateMetaInfData(@Nonnull
+                                  java.nio.file.Path filePath)
```
    +
    +
    Parameters:
    +
    filePath - is relative to the META-INF directory (i.e. does not start with META-INF)
    +
    Returns:
    +
    true in case the file should be validated, otherwise false
    +
    +
  +
+

Uses of Class
org.apache.jackrabbit.vault.validation.ValidationViolation

Uses of ValidationViolation in org.apache.jackrabbit.vault.validation

org.apache.jackrabbit.vault.validation

Classes

Package org.apache.jackrabbit.vault.validation

Hierarchy For Package org.apache.jackrabbit.vault.validation

Class Hierarchy

Uses of Package
org.apache.jackrabbit.vault.validation

Interface DocumentViewXmlValidator

Method Summary

Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator

Method Detail

validate

Interface FilterValidator

Method Summary

Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator

Method Detail

validate

Interface GenericJcrDataValidator

Method Summary

Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator

Method Detail

validateJcrData

shouldValidateJcrData

Interface GenericMetaInfDataValidator

Method Summary

Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator

Method Detail

validateMetaInfData

shouldValidateMetaInfData

Uses of Classorg.apache.jackrabbit.vault.validation.ValidationViolation

Uses of ValidationViolation in org.apache.jackrabbit.vault.validation

org.apache.jackrabbit.vault.validation

Classes

Package org.apache.jackrabbit.vault.validation

Hierarchy For Package org.apache.jackrabbit.vault.validation

Class Hierarchy

Uses of Packageorg.apache.jackrabbit.vault.validation

Interface DocumentViewXmlValidator

Method Summary

Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator

Method Detail

validate

Interface FilterValidator

Method Summary

Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator

Method Detail

validate

Interface GenericJcrDataValidator

Method Summary

Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator

Method Detail

validateJcrData

shouldValidateJcrData

Interface GenericMetaInfDataValidator

Method Summary

Methods inherited from interface org.apache.jackrabbit.vault.validation.spi.Validator

Method Detail

validateMetaInfData

shouldValidateMetaInfData

Uses of Class
org.apache.jackrabbit.vault.validation.ValidationViolation

Uses of Package
org.apache.jackrabbit.vault.validation