Package org.apache.jackrabbit.oak.plugins.tree

Interface TreeContext

  • All Known Subinterfaces:
    Context
    All Known Implementing Classes:
    Context.Default
    public interface TreeContext
    TreeContext represents item related information in relation to a dedicated module. This information allows to determine if a given Tree or PropertyState is defined by or related to the model provided by a given setup.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean definesContextRoot​(@NotNull Tree tree)
      Reveals if the specified Tree is the root of a subtree defined by the module that exposes this instance.
      boolean definesInternal​(@NotNull Tree tree)
      Reveals if the specified Tree defines repository internal information, which is not hidden by default.
      boolean definesLocation​(@NotNull TreeLocation location)
      Reveals if the specified TreeLocation is defined by the module that exposes this instance.
      boolean definesProperty​(@NotNull Tree parent, @NotNull PropertyState property)
      Reveals if the specified PropertyState is defined by the module that exposes this instance.
      boolean definesTree​(@NotNull Tree tree)
      Reveals if the specified Tree is defined by the module that exposes this instance.

    • Method Detail

      • definesProperty

        boolean definesProperty​(@NotNull
                        @NotNull Tree parent,
                        @NotNull
                        @NotNull PropertyState property)
        Reveals if the specified PropertyState is defined by the module that exposes this instance.
        Parameters:
        parent - The parent tree of the property state.
        property - The PropertyState to be tested.
        Returns:
        true if the specified property state is related to or defined by the security module.

      • definesContextRoot

        boolean definesContextRoot​(@NotNull
                           @NotNull Tree tree)
        Reveals if the specified Tree is the root of a subtree defined by the module that exposes this instance. Note, that in contrast to definesTree(Tree) this method will return false for any tree located in the subtree.
        Parameters:
        tree - The tree to be tested.
        Returns:
        true if the specified tree is the root of a subtree of items that are defined by the security module.

      • definesTree

        boolean definesTree​(@NotNull
                    @NotNull Tree tree)
        Reveals if the specified Tree is defined by the module that exposes this instance.
        Parameters:
        tree - The tree to be tested.
        Returns:
        true if the specified tree is related to or defined by the security module.

      • definesLocation

        boolean definesLocation​(@NotNull
                        @NotNull TreeLocation location)
        Reveals if the specified TreeLocation is defined by the module that exposes this instance.
        Parameters:
        location - The tree location to be tested.
        Returns:
        true if the specified tree location is related to or defined by the security module.

      • definesInternal

        boolean definesInternal​(@NotNull
                        @NotNull Tree tree)
        Reveals if the specified Tree defines repository internal information, which is not hidden by default.
        Parameters:
        tree - The tree to be tested.
        Returns:
        true if the specified tree defines repository internal information.
        See Also:
        NodeStateUtils.isHidden(String), NodeStateUtils.isHiddenPath(String)