Package org.apache.jackrabbit.vault.validation.spi

Interface DocumentViewXmlValidator

  • All Superinterfaces:
    Validator
    @ProviderType
public interface DocumentViewXmlValidator
extends Validator
    Validator interface for (enhanced) Document View XML files within content packages.
    See Also:
    Filevault DocView

    • Method Detail

      • validate

        @Deprecated
@Nullable
default @Nullable Collection<ValidationMessage> validate​(@NotNull
                                                         @NotNull DocViewNode node,
                                                         @NotNull
                                                         @NotNull String nodePath,
                                                         @NotNull
                                                         @NotNull Path filePath,
                                                         boolean isRoot)
        Deprecated.
        Use validate(DocViewNode2, NodeContext, boolean) instead
        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 Name (i.e. including the namespace uri in the format {namespaceURI}localPart). This is also referred to as JCR name expanded form. To construct such names either use NameUtil or use the constants from NameConstants. The node's label refers to the XML element name specifying the node. There shouldn't be any checks derived from it, but only from the expanded name.
        Parameters:
        node - the node which should be validated
        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

      • validate

        @Deprecated
@Nullable
default @Nullable Collection<ValidationMessage> validate​(@NotNull
                                                         @NotNull DocViewNode node,
                                                         @NotNull
                                                         @NotNull NodeContext nodeContext,
                                                         boolean isRoot)
        Deprecated.
        Use validate(DocViewNode2, NodeContext, boolean) instead
        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 Name (i.e. including the namespace uri in the format {namespaceURI}localPart). This is also referred to as JCR name expanded form. To construct such names either use NameUtil or use the constants from NameConstants. The node's label refers to the XML element name specifying the node. There shouldn't be any checks derived from it, but only from the expanded name.
        Parameters:
        node - the node which should be validated
        nodeContext - the information about the node context (like path)
        isRoot - true in case this is the root node of the docview file otherwise false
        Returns:
        validation messages or null

      • validate

        @Nullable
default @Nullable Collection<ValidationMessage> validate​(@NotNull
                                                         @NotNull DocViewNode2 node,
                                                         @NotNull
                                                         @NotNull NodeContext nodeContext,
                                                         boolean isRoot)
        Called for the beginning of each deserialized new JCR document view node. Child nodes have not yet been deserialized at this point in time but only the node itself and its direct properties.
        Parameters:
        node - the node which should be validated
        nodeContext - the information about the node context (like path)
        isRoot - true in case this is the root node of the docview file otherwise false
        Returns:
        validation messages or null
        Since:
        3.6.0

      • validateEnd

        @Deprecated
@Nullable
default @Nullable Collection<ValidationMessage> validateEnd​(@NotNull
                                                            @NotNull DocViewNode node,
                                                            @NotNull
                                                            @NotNull NodeContext nodeContext,
                                                            boolean isRoot)
        Deprecated.
        Use validateEnd(DocViewNode2, NodeContext, boolean) instead
        Called for the end of each new JCR document view node. Deserialization of the node information was already done when this method is called as well as all child nodes within the same docview file have been processed. The node and attribute names have the string representation outlined in Name (i.e. including the namespace uri in the format {namespaceURI}localPart). This is also referred to as JCR name expanded form. To construct such names either use NameUtil or use the constants from NameConstants. The node's label refers to the XML element name specifying the node. There shouldn't be any checks derived from it, but only from the expanded name.
        Parameters:
        node - the node which should be validated
        nodeContext - the information about the node context (like path)
        isRoot - true in case this is the root node of the docview file otherwise false
        Returns:
        validation messages or null

      • validateEnd

        @Nullable
default @Nullable Collection<ValidationMessage> validateEnd​(@NotNull
                                                            @NotNull DocViewNode2 node,
                                                            @NotNull
                                                            @NotNull NodeContext nodeContext,
                                                            boolean isRoot)
        Called for the end of each new deserialized JCR document view node (after all child nodes have been processed).
        Parameters:
        node - the node which should be validated
        nodeContext - the information about the node context (like path)
        isRoot - true in case this is the root node of the docview file otherwise false
        Returns:
        validation messages or null
        Since:
        3.6.0