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

Class OpenPermissionProvider

java.lang.Object

org.apache.jackrabbit.oak.spi.security.authorization.permission.OpenPermissionProvider

All Implemented Interfaces:

PermissionProvider

public final class OpenPermissionProvider
extends Object
implements PermissionProvider

Permission provider implementation that grants full access everywhere.

Method Summary

Modifier and Type	Method	Description
static PermissionProvider	getInstance()
@NotNull Set<String>	getPrivileges(@Nullable Tree tree)	Returns the set of privilege names which are granted to the set of Principals associated with this provider instance for the specified Tree.
@NotNull RepositoryPermission	getRepositoryPermission()	Return the RepositoryPermission for the set of Principals associated with this provider instance.
@NotNull TreePermission	getTreePermission(@NotNull Tree tree, @NotNull TreePermission parentPermission)	Return the TreePermission for the set of Principals associated with this provider at the specified tree.
boolean	hasPrivileges(@Nullable Tree tree, @NotNull String... privilegeNames)	Returns whether the principal set associated with this PrivilegeManager is granted the privileges identified by the specified privilege names for the given tree.
boolean	isGranted(@NotNull String oakPath, @NotNull String jcrActions)	Tests if the the specified actions are granted at the given path for the set of Principals associated with this provider instance.
boolean	isGranted(@NotNull Tree tree, @Nullable PropertyState property, long permissions)	Test if the specified permissions are granted for the set of Principals associated with this provider instance for the item identified by the given tree and optionally property.
void	refresh()	Refresh this PermissionProvider.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PermissionProvider getInstance()

refresh

public void refresh()

Description copied from interface: PermissionProvider

Refresh this PermissionProvider. The implementation is expected to subsequently return permission evaluation results that reflect the most recent revision of the repository.

Specified by:

refresh in interface PermissionProvider

getPrivileges

@NotNull
public @NotNull Set<String> getPrivileges(@Nullable
                                          @Nullable Tree tree)

Description copied from interface: PermissionProvider

Returns the set of privilege names which are granted to the set of Principals associated with this provider instance for the specified Tree.

Specified by:

getPrivileges in interface PermissionProvider

Parameters:

tree - The tree for which the privileges should be retrieved.

Returns:

set of privilege names

hasPrivileges

public boolean hasPrivileges(@Nullable
                             @Nullable Tree tree,
                             @NotNull
                             @NotNull String... privilegeNames)

Description copied from interface: PermissionProvider

Returns whether the principal set associated with this PrivilegeManager is granted the privileges identified by the specified privilege names for the given tree. In order to test for privileges being granted on a repository level rather than on a particular tree a null tree should be passed to this method.

Testing a name identifying an aggregate privilege is equivalent to testing each non aggregate privilege name.

Specified by:

hasPrivileges in interface PermissionProvider

Parameters:

tree - The tree to test for privileges being granted.

privilegeNames - The name of the privileges.

Returns:

true if all privileges are granted; false otherwise.

getRepositoryPermission

@NotNull
public @NotNull RepositoryPermission getRepositoryPermission()

Description copied from interface: PermissionProvider

Return the RepositoryPermission for the set of Principals associated with this provider instance.

Specified by:

getRepositoryPermission in interface PermissionProvider

Returns:

The RepositoryPermission for the set of Principals this provider instance has been created for.

getTreePermission

@NotNull
public @NotNull TreePermission getTreePermission(@NotNull
                                                 @NotNull Tree tree,
                                                 @NotNull
                                                 @NotNull TreePermission parentPermission)

Description copied from interface: PermissionProvider

Return the TreePermission for the set of Principals associated with this provider at the specified tree.

Specified by:

getTreePermission in interface PermissionProvider

Parameters:

tree - The tree for which the TreePermission object should be built.

parentPermission - The TreePermission object that has been obtained before for the parent tree.

Returns:

The TreePermission object for the specified tree.

isGranted

public boolean isGranted(@NotNull
                         @NotNull Tree tree,
                         @Nullable
                         @Nullable PropertyState property,
                         long permissions)

Description copied from interface: PermissionProvider

Test if the specified permissions are granted for the set of Principals associated with this provider instance for the item identified by the given tree and optionally property. This method will only return true if all permissions are granted.

Specified by:

isGranted in interface PermissionProvider

Parameters:

tree - The Tree to test the permissions for.

property - A PropertyState if the item to test is a property or null if the item is a Tree.

permissions - The permissions to be tested.

Returns:

true if the specified permissions are granted for the item identified by the given tree and optionally property state.

isGranted

public boolean isGranted(@NotNull
                         @NotNull String oakPath,
                         @NotNull
                         @NotNull String jcrActions)

Description copied from interface: PermissionProvider

Tests if the the specified actions are granted at the given path for the set of Principals associated with this provider instance.

The jcrActions parameter is a comma separated list of action strings such as defined by Session and passed to Session.hasPermission(String, String). When more than one action is specified in the jcrActions parameter, this method will only return true if all of them are granted on the specified path.

Specified by:

isGranted in interface PermissionProvider

Parameters:

oakPath - A valid oak path.

jcrActions - The JCR actions that should be tested separated by ','

Returns:

true if all actions are granted at the specified path; false otherwise.