org.apache.jackrabbit.oak.spi.security.privilege

Class PrivilegeBitsProvider

java.lang.Object

org.apache.jackrabbit.oak.spi.security.privilege.PrivilegeBitsProvider

All Implemented Interfaces:

PrivilegeConstants

public final class PrivilegeBitsProvider
extends Object
implements PrivilegeConstants

Reads and writes privilege definitions from and to the repository content without applying any validation.

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.spi.security.privilege.PrivilegeConstants

AGGREGATE_PRIVILEGES, JCR_ADD_CHILD_NODES, JCR_ALL, JCR_LIFECYCLE_MANAGEMENT, JCR_LOCK_MANAGEMENT, JCR_MODIFY_ACCESS_CONTROL, JCR_MODIFY_PROPERTIES, JCR_NAMESPACE_MANAGEMENT, JCR_NODE_TYPE_DEFINITION_MANAGEMENT, JCR_NODE_TYPE_MANAGEMENT, JCR_READ, JCR_READ_ACCESS_CONTROL, JCR_REMOVE_CHILD_NODES, JCR_REMOVE_NODE, JCR_RETENTION_MANAGEMENT, JCR_VERSION_MANAGEMENT, JCR_WORKSPACE_MANAGEMENT, JCR_WRITE, NON_AGGREGATE_PRIVILEGES, NT_REP_PRIVILEGE, NT_REP_PRIVILEGES, PRIVILEGE_NODETYPE_NAMES, PRIVILEGE_PROPERTY_NAMES, PRIVILEGES_PATH, REP_ADD_PROPERTIES, REP_AGGREGATES, REP_ALTER_PROPERTIES, REP_BITS, REP_INDEX_DEFINITION_MANAGEMENT, REP_IS_ABSTRACT, REP_NEXT, REP_PRIVILEGE_MANAGEMENT, REP_PRIVILEGES, REP_READ_NODES, REP_READ_PROPERTIES, REP_REMOVE_PROPERTIES, REP_USER_MANAGEMENT, REP_WRITE

Constructor Summary

Constructors

Constructor and Description
PrivilegeBitsProvider(Root root)

Method Summary

Modifier and Type	Method and Description
Iterable<String>	getAggregatedPrivilegeNames(String... privilegeNames) Return the names of the non-aggregate privileges corresponding to the specified privilegeNames.
PrivilegeBits	getBits(Iterable<String> privilegeNames) Returns the bits for the given privilege names
PrivilegeBits	getBits(Privilege[] privileges, NameMapper nameMapper) Returns the bits for the given privileges
PrivilegeBits	getBits(String... privilegeNames) Returns the bits for the given privilege names
Set<String>	getPrivilegeNames(PrivilegeBits privilegeBits) Resolve the given privilege bits to a set of privilege names.
Tree	getPrivilegesTree() Returns the root tree for all privilege definitions stored in the content repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrivilegeBitsProvider

public PrivilegeBitsProvider(Root root)

Method Detail

getPrivilegesTree

@Nonnull
public Tree getPrivilegesTree()

Returns the root tree for all privilege definitions stored in the content repository.

Returns:

The privileges root.

getBits

@Nonnull
public PrivilegeBits getBits(@Nonnull
                                       String... privilegeNames)

Returns the bits for the given privilege names

Parameters:

privilegeNames - the names

Returns:

the privilege bits

getBits

@Nonnull
public PrivilegeBits getBits(@Nonnull
                                       Iterable<String> privilegeNames)

Returns the bits for the given privilege names

Parameters:

privilegeNames - the names

Returns:

the privilege bits

getBits

@Nonnull
public PrivilegeBits getBits(@Nonnull
                                       Privilege[] privileges,
                                       @Nonnull
                                       NameMapper nameMapper)

Returns the bits for the given privileges

Parameters:

privileges - the privileges

nameMapper - the name mapper

Returns:

the privilege bits

getPrivilegeNames

@Nonnull
public Set<String> getPrivilegeNames(PrivilegeBits privilegeBits)

Resolve the given privilege bits to a set of privilege names.

Parameters:

privilegeBits - An instance of privilege bits.

Returns:

The names of the registered privileges associated with the given bits. Any bits that don't have a corresponding privilege definition will be ignored.

getAggregatedPrivilegeNames

@Nonnull
public Iterable<String> getAggregatedPrivilegeNames(@Nonnull
                                                              String... privilegeNames)

Return the names of the non-aggregate privileges corresponding to the specified privilegeNames.

Parameters:

privilegeNames - The privilege names to be converted.

Returns:

The names of the non-aggregate privileges that correspond to the given privilegeNames.