PrivilegeBits ("The Adobe AEM Quickstart and Web Application.")

java.lang.Object
- org.apache.jackrabbit.oak.spi.security.privilege.PrivilegeBits

All Implemented Interfaces:: PrivilegeConstants

public final class PrivilegeBits
extends java.lang.Object
implements PrivilegeConstants

Internal representation of JCR privileges.

Field Summary

Fields
Modifier and Type Field and Description

static java.util.Map<java.lang.String,PrivilegeBits> BUILT_IN

static PrivilegeBits EMPTY

static PrivilegeBits NEXT_AFTER_BUILT_INS
- 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

Fields
Modifier and Type	Field and Description
`static java.util.Map<java.lang.String,PrivilegeBits>`	`BUILT_IN`
`static PrivilegeBits`	`EMPTY`
`static PrivilegeBits`	`NEXT_AFTER_BUILT_INS`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PrivilegeBits`	`add(PrivilegeBits other)` Adds the other privilege bits to this instance.
`PrivilegeBits`	`addDifference(PrivilegeBits a, PrivilegeBits b)` Subtracts the `b` from `a` and adds the result (diff) to this instance.
`PropertyState`	`asPropertyState(java.lang.String name)`
`static long`	`calculatePermissions(PrivilegeBits bits, PrivilegeBits parentBits, boolean isAllow)` Calculate the granted permissions by evaluating the given privileges.
`PrivilegeBits`	`diff(PrivilegeBits other)` Subtracts the other PrivilegeBits from the this. If the specified bits do not intersect with this, it isn't modified. If `this` is included in `other` `empty` privilege bits is returned.
`boolean`	`equals(java.lang.Object o)`
`static PrivilegeBits`	`getInstance()` Creates a mutable instance of privilege bits.
`static PrivilegeBits`	`getInstance(PrivilegeBits... base)` Creates a mutable instance of privilege bits.
`static PrivilegeBits`	`getInstance(PropertyState property)` Get or create an instance of privilege bits for a specific property that stores privileges.
`static PrivilegeBits`	`getInstance(Tree tree)` Get or create an instance of privilege bits for a privilege definition.
`int`	`hashCode()`
`boolean`	`includes(PrivilegeBits otherBits)` Returns `true` if all privileges defined by the specified `otherBits` are present in this instance.
`boolean`	`isEmpty()` Returns `true` if this privilege bits includes no privileges at all.
`PrivilegeBits`	`modifiable()`
`PrivilegeBits`	`nextBits()` Method to calculate the next privilege bits associated with this instance.
`PrivilegeBits`	`retain(PrivilegeBits other)` Retains the elements in this `PrivilegeBits` that are contained in the specified other `PrivilegeBits`.
`java.lang.String`	`toString()`
`PrivilegeBits`	`unmodifiable()` Returns an unmodifiable instance.
`void`	`writeTo(Tree tree)` Write this instance as property to the specified tree.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY
```
public static final PrivilegeBits EMPTY
```
  - BUILT_IN
```
public static final java.util.Map<java.lang.String,PrivilegeBits> BUILT_IN
```
  - NEXT_AFTER_BUILT_INS
```
public static final PrivilegeBits NEXT_AFTER_BUILT_INS
```
- Method Detail
  - getInstance
```
public static PrivilegeBits getInstance()
```
    Creates a mutable instance of privilege bits.
    
    Returns:
    
    a new instance of privilege bits.
  - getInstance
```
public static PrivilegeBits getInstance(PrivilegeBits... base)
```
    Creates a mutable instance of privilege bits.
    
    Parameters:
    
    base - The base for this mutable instance.
    
    Returns:
    
    a new instance of privilege bits.
  - getInstance
```
public static PrivilegeBits getInstance(PropertyState property)
```
    Get or create an instance of privilege bits for a specific property that stores privileges.
    
    Parameters:
    
    property - The property state storing privilege bits information.
    
    Returns:
    
    an instance of PrivilegeBits
  - getInstance
```
public static PrivilegeBits getInstance(Tree tree)
```
    Get or create an instance of privilege bits for a privilege definition.
    
    Parameters:
    
    tree - A privilege definition tree or the privileges root.
    
    Returns:
    
    an instance of PrivilegeBits
  - calculatePermissions
```
public static long calculatePermissions(PrivilegeBits bits,
                                        PrivilegeBits parentBits,
                                        boolean isAllow)
```
    Calculate the granted permissions by evaluating the given privileges. Note, that only built-in privileges can be mapped to permissions. Any other privileges will be ignored.
    
    Parameters:
    
    bits - The set of privileges present at given tree.
    
    parentBits - The privileges present on the parent tree. These are required in order to determine permissions that include a modification of the parent tree (add_child_nodes, remove_child_nodes).
    
    isAllow - true if the privileges are granted; false otherwise.
    
    Returns:
    
    the resulting permissions.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this privilege bits includes no privileges at all.
    
    Returns:
    
    true if this privilege bits includes no privileges at all; false otherwise.
    
    See Also:
    
    Permissions.NO_PERMISSION
  - unmodifiable
```
public PrivilegeBits unmodifiable()
```
    Returns an unmodifiable instance.
    
    Returns:
    
    an unmodifiable PrivilegeBits instance.
  - modifiable
```
public PrivilegeBits modifiable()
```
  - includes
```
public boolean includes(PrivilegeBits otherBits)
```
    Returns true if all privileges defined by the specified otherBits are present in this instance.
    
    Parameters:
    
    otherBits -
    
    Returns:
    
    true if all privileges defined by the specified otherBits are included in this instance; false otherwise.
  - add
```
public PrivilegeBits add(PrivilegeBits other)
```
    Adds the other privilege bits to this instance.
    
    Parameters:
    
    other - The other privilege bits to be added.
    
    Returns:
    
    The updated instance.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this instance is immutable.
  - diff
```
public PrivilegeBits diff(PrivilegeBits other)
```
    Subtracts the other PrivilegeBits from the this.
    If the specified bits do not intersect with this, it isn't modified.
    If this is included in other empty privilege bits is returned.
    
    Parameters:
    
    other - The other privilege bits to be subtracted from this instance.
    
    Returns:
    
    The updated instance.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this instance is immutable.
  - addDifference
```
public PrivilegeBits addDifference(PrivilegeBits a,
                                   PrivilegeBits b)
```
    Subtracts the b from a and adds the result (diff) to this instance.
    
    Parameters:
    
    a - An instance of privilege bits.
    
    b - An instance of privilege bits.
    
    Returns:
    
    The updated instance.
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this instance is immutable.
  - retain
```
public PrivilegeBits retain(PrivilegeBits other)
```
    Retains the elements in this PrivilegeBits that are contained in the specified other PrivilegeBits.
    
    Parameters:
    
    other - Other privilege bits.
    
    Returns:
    
    This modifiable instance of privilege bits modified such it contains only privileges that were also contained in the other instance.
  - asPropertyState
```
public PropertyState asPropertyState(java.lang.String name)
```
  - nextBits
```
public PrivilegeBits nextBits()
```
    Method to calculate the next privilege bits associated with this instance.
    
    Returns:
    
    an new instance of PrivilegeBits
  - writeTo
```
public void writeTo(Tree tree)
```
    Write this instance as property to the specified tree.
    
    Parameters:
    
    tree - The target tree.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PrivilegeBits

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

BUILT_IN

NEXT_AFTER_BUILT_INS

Method Detail

getInstance

getInstance

getInstance

getInstance

calculatePermissions

isEmpty

unmodifiable

modifiable

includes

add

diff

addDifference

retain

asPropertyState

nextBits

writeTo

hashCode

equals

toString