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

Class ReadPolicy

java.lang.Object

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

All Implemented Interfaces:

AccessControlPolicy, NamedAccessControlPolicy

public final class ReadPolicy
extends Object
implements NamedAccessControlPolicy

Field Summary

Fields

Modifier and Type	Field	Description
static final NamedAccessControlPolicy	INSTANCE

Method Summary

Modifier and Type	Method	Description
static boolean	canAccessReadPolicy(@NotNull PermissionProvider permissionProvider, @NotNull String... oakPaths)	Evaluates if a ReadPolicy is accessible for a session object.
String	getName()
static boolean	hasEffectiveReadPolicy(@NotNull Collection<String> readPaths, @Nullable String oakPath)

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final NamedAccessControlPolicy INSTANCE

Method Details

getName

public String getName()

Specified by:

getName in interface NamedAccessControlPolicy

hasEffectiveReadPolicy

public static boolean hasEffectiveReadPolicy(@NotNull
 @NotNull Collection<String> readPaths,
 @Nullable
 @Nullable String oakPath)

canAccessReadPolicy

public static boolean canAccessReadPolicy(@NotNull
 @NotNull PermissionProvider permissionProvider,
 @NotNull
 @NotNull 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.