Package org.apache.jackrabbit.oak.spi.security.authorization.restriction

Interface RestrictionPattern

All Known Implementing Classes:
CompositePattern
public interface RestrictionPattern
Interface used to verify if a given restriction applies to a given item or path.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final RestrictionPattern
    EMPTY
    Default implementation of the RestrictionPattern that always returns true and thus matches all items or paths.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    matches()
    Returns true if the underlying restriction matches for repository level permissions.
    boolean
    matches(@NotNull String path)
    Returns true if the underlying restriction matches the specified path.
    default boolean
    matches(@NotNull String path, boolean isProperty)
    Returns true if the underlying restriction matches the specified path and item type.
    boolean
    matches(@NotNull Tree tree, @Nullable PropertyState property)
    Returns true if the underlying restriction matches the specified tree or property state.

  • Field Details

    • EMPTY

      static final RestrictionPattern EMPTY
      Default implementation of the RestrictionPattern that always returns true and thus matches all items or paths.

  • Method Details

    • matches

      boolean matches(@NotNull @NotNull Tree tree, @Nullable @Nullable PropertyState property)
      Returns true if the underlying restriction matches the specified tree or property state.
      Parameters:
      tree - The target tree or the parent of the target property.
      property - The target property state or null if the target item is a tree.
      Returns:
      true if the underlying restriction matches the specified tree or property state; false otherwise.

    • matches

      boolean matches(@NotNull @NotNull String path)
      Returns true if the underlying restriction matches the specified path. Note, that if the nature of the item at path is know matches(String, boolean) should be called instead.
      Parameters:
      path - The path of the target item.
      Returns:
      true if the underlying restriction matches the specified path; false otherwise.

    • matches

      default boolean matches(@NotNull @NotNull String path, boolean isProperty)
      Returns true if the underlying restriction matches the specified path and item type. If the nature of the item at path is unknown matches(String) should be called instead. Note, for backwards compatibility this method comes with a default implementation making it equivalent to matches(String). Implementations of the RestrictionPattern interface should overwrite the default if the underlying restriction applies different behavior for nodes and properties.
      Parameters:
      path - The path of the target item.
      isProperty - If true the target item is known to be a property, otherwise it is known to be a node.
      Returns:
      true if the underlying restriction matches the specified path and item type; false otherwise.
      Since:
      OAK 1.42.0

    • matches

      boolean matches()
      Returns true if the underlying restriction matches for repository level permissions.
      Returns:
      true if the underlying restriction matches for repository level permissions that are not associated with a path or a dedicated item; false otherwise.