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

Class ReadPolicy

  • All Implemented Interfaces:
    javax.jcr.security.AccessControlPolicy, javax.jcr.security.NamedAccessControlPolicy
    public final class ReadPolicy
extends java.lang.Object
implements javax.jcr.security.NamedAccessControlPolicy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static javax.jcr.security.NamedAccessControlPolicy INSTANCE  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean canAccessReadPolicy​(@NotNull PermissionProvider permissionProvider, @NotNull java.lang.String... oakPaths)
      Evaluates if a ReadPolicy is accessible for a session object.
      java.lang.String getName()  
      static boolean hasEffectiveReadPolicy​(@NotNull java.util.Collection<java.lang.String> readPaths, @Nullable java.lang.String oakPath)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • INSTANCE

        public static final javax.jcr.security.NamedAccessControlPolicy INSTANCE

    • Method Detail

      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface javax.jcr.security.NamedAccessControlPolicy

      • hasEffectiveReadPolicy

        public static boolean hasEffectiveReadPolicy​(@NotNull
                                             @NotNull java.util.Collection<java.lang.String> readPaths,
                                             @Nullable
                                             @Nullable java.lang.String oakPath)

      • canAccessReadPolicy

        public static boolean canAccessReadPolicy​(@NotNull
                                          @NotNull PermissionProvider permissionProvider,
                                          @NotNull
                                          @NotNull java.lang.String... oakPaths)
        Evaluates if a ReadPolicy is accessible for a session object. Note that this method does not verify if the specified paths point to existing/accessible trees.
        Parameters:
        permissionProvider - A permission provider used for evaluating access
        oakPaths - The set of configured readable paths.
        Returns:
        true if the given permission provider has READ_ACCESS_CONTROL granted on any of the specified readable oak paths; false otherwise.