CmsPermissionSet (OpenCms Core API, version 11.0.0)

java.lang.Object
- org.opencms.security.CmsPermissionSet

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CmsPermissionSetCustom
```
public class CmsPermissionSet
extends java.lang.Object
implements java.io.Serializable
```
An immutable permission set that contains both allowed and denied permissions as bitsets.
Currently supported permissions are:
- PERMISSION_READ (r) the right to read the contents of a resource
- PERMISSION_WRITE (w) the right to write the contents of a resource
- PERMISSION_VIEW (v) the right to see a resource in listings (workplace)
- PERMISSION_CONTROL (c) the right to set permissions of a resource
- PERMISSION_DIRECT_PUBLISH (d) the right direct publish a resource even without publish project permissions
Since:

6.0.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static CmsPermissionSet`	`ACCESS_CONTROL` Permission set to check control access.
`static CmsPermissionSet`	`ACCESS_DIRECT_PUBLISH` Permission set to check direct publish permissions.
`static CmsPermissionSet`	`ACCESS_READ` Permission set to check read access.
`static CmsPermissionSet`	`ACCESS_VIEW` Permission set to check view access.
`static CmsPermissionSet`	`ACCESS_WRITE` Permission set to check write access.
`protected int`	`m_allowed` The set of allowed permissions.
`protected int`	`m_denied` The set of denied permissions.
`static int`	`PERMISSION_CONTROL` The permission to control a resource.
`static int`	`PERMISSION_DIRECT_PUBLISH` The permission to direct publish a resource.
`static int`	`PERMISSION_EMPTY` No permissions for a resource (used especially for denied permissions).
`static int`	`PERMISSION_FULL` All allowed permissions for a resource.
`static int`	`PERMISSION_READ` The permission to read a resource.
`static int`	`PERMISSION_VIEW` The permission to view a resource.
`static int`	`PERMISSION_WRITE` The permission to write a resource.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CmsPermissionSet()` Constructor to create an empty permission set.
`protected`	`CmsPermissionSet(int allowedPermissions)` Constructor to create a permission set with preset allowed permissions.
	`CmsPermissionSet(int allowedPermissions, int deniedPermissions)` Constructor to create a permission set with preset allowed and denied permissions.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`int`	`getAllowedPermissions()` Returns the currently allowed permissions of ths permission set.
`int`	`getDeniedPermissions()` Returns the currently denied permissions of this permission set.
`static java.util.Set<java.lang.String>`	`getPermissionKeys()` Returns the message keys of each permission known in the system.
`int`	`getPermissions()` Returns the permissions calculated from this permission set.
`java.lang.String`	`getPermissionString()` Returns the string representation of the current permissions in this permission set.
`static int`	`getPermissionValue(java.lang.String key)` Returns the value of a single permission.
`int`	`hashCode()`
`boolean`	`requiresControlPermission()` Returns true if control permissions (+c) are required by this permission set.
`boolean`	`requiresDirectPublishPermission()` Returns true if direct publish permissions (+d) are required by this permission set.
`boolean`	`requiresReadPermission()` Returns true if read permissions (+r) are required by this permission set.
`boolean`	`requiresViewPermission()` Returns true if view permissions (+v) are required by this permission set.
`boolean`	`requiresWritePermission()` Returns true if write permissions (+w) are required by this permission set.
`java.lang.String`	`toString()` Returns the String representation of this permission set object.

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

- Field Detail
  - ACCESS_CONTROL
```
public static final CmsPermissionSet ACCESS_CONTROL
```
    Permission set to check control access.
  - ACCESS_DIRECT_PUBLISH
```
public static final CmsPermissionSet ACCESS_DIRECT_PUBLISH
```
    Permission set to check direct publish permissions.
  - ACCESS_READ
```
public static final CmsPermissionSet ACCESS_READ
```
    Permission set to check read access.
  - ACCESS_VIEW
```
public static final CmsPermissionSet ACCESS_VIEW
```
    Permission set to check view access.
  - ACCESS_WRITE
```
public static final CmsPermissionSet ACCESS_WRITE
```
    Permission set to check write access.
  - PERMISSION_CONTROL
```
public static final int PERMISSION_CONTROL
```
    The permission to control a resource.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_DIRECT_PUBLISH
```
public static final int PERMISSION_DIRECT_PUBLISH
```
    The permission to direct publish a resource.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_EMPTY
```
public static final int PERMISSION_EMPTY
```
    No permissions for a resource (used especially for denied permissions).
    
    See Also:
    
    Constant Field Values
  - PERMISSION_FULL
```
public static final int PERMISSION_FULL
```
    All allowed permissions for a resource.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_READ
```
public static final int PERMISSION_READ
```
    The permission to read a resource.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_VIEW
```
public static final int PERMISSION_VIEW
```
    The permission to view a resource.
    
    See Also:
    
    Constant Field Values
  - PERMISSION_WRITE
```
public static final int PERMISSION_WRITE
```
    The permission to write a resource.
    
    See Also:
    
    Constant Field Values
  - m_allowed
```
protected int m_allowed
```
    The set of allowed permissions.
  - m_denied
```
protected int m_denied
```
    The set of denied permissions.
- Constructor Detail
  - CmsPermissionSet
```
public CmsPermissionSet(int allowedPermissions,
                        int deniedPermissions)
```
    Constructor to create a permission set with preset allowed and denied permissions.
    
    Parameters:
    
    allowedPermissions - the set of permissions to allow
    
    deniedPermissions - the set of permissions to deny
  - CmsPermissionSet
```
protected CmsPermissionSet()
```
    Constructor to create an empty permission set.
  - CmsPermissionSet
```
protected CmsPermissionSet(int allowedPermissions)
```
    Constructor to create a permission set with preset allowed permissions.
    
    Parameters:
    
    allowedPermissions - bitset of allowed permissions
- Method Detail
  - getPermissionKeys
```
public static java.util.Set<java.lang.String> getPermissionKeys()
```
    Returns the message keys of each permission known in the system.
    
    Returns:
    
    Enumeration of message keys
  - getPermissionValue
```
public static int getPermissionValue(java.lang.String key)
```
    Returns the value of a single permission.
    
    Parameters:
    
    key - the key of the permission
    
    Returns:
    
    the value of the given permission
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - getAllowedPermissions
```
public int getAllowedPermissions()
```
    Returns the currently allowed permissions of ths permission set.
    
    Returns:
    
    the allowed permissions as bitset
  - getDeniedPermissions
```
public int getDeniedPermissions()
```
    Returns the currently denied permissions of this permission set.
    
    Returns:
    
    the denied permissions as bitset.
  - getPermissions
```
public int getPermissions()
```
    Returns the permissions calculated from this permission set.
    These are all permissions allowed but not denied.
    
    Returns:
    
    the resulting permission set
  - getPermissionString
```
public java.lang.String getPermissionString()
```
    Returns the string representation of the current permissions in this permission set.
    
    Returns:
    
    string of the format {{+|-}{r|w|v|c|d}}*
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    See Also:
    
    Object.hashCode()
  - requiresControlPermission
```
public boolean requiresControlPermission()
```
    Returns true if control permissions (+c) are required by this permission set.
    
    Returns:
    
    true if control permissions (+c) are required by this permission set
  - requiresDirectPublishPermission
```
public boolean requiresDirectPublishPermission()
```
    Returns true if direct publish permissions (+d) are required by this permission set.
    
    Returns:
    
    true if direct publish permissions (+d) are required by this permission set
  - requiresReadPermission
```
public boolean requiresReadPermission()
```
    Returns true if read permissions (+r) are required by this permission set.
    
    Returns:
    
    true if read permissions (+r) are required by this permission set
  - requiresViewPermission
```
public boolean requiresViewPermission()
```
    Returns true if view permissions (+v) are required by this permission set.
    
    Returns:
    
    true if view permissions (+v) are required by this permission set
  - requiresWritePermission
```
public boolean requiresWritePermission()
```
    Returns true if write permissions (+w) are required by this permission set.
    
    Returns:
    
    true if write permissions (+w) are required by this permission set
  - toString
```
public java.lang.String toString()
```
    Returns the String representation of this permission set object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString()

Class CmsPermissionSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACCESS_CONTROL

ACCESS_DIRECT_PUBLISH

ACCESS_READ

ACCESS_VIEW

ACCESS_WRITE

PERMISSION_CONTROL

PERMISSION_DIRECT_PUBLISH

PERMISSION_EMPTY

PERMISSION_FULL

PERMISSION_READ

PERMISSION_VIEW

PERMISSION_WRITE

m_allowed

m_denied

Constructor Detail

CmsPermissionSet

CmsPermissionSet

CmsPermissionSet

Method Detail

getPermissionKeys

getPermissionValue

equals

getAllowedPermissions

getDeniedPermissions

getPermissions

getPermissionString

hashCode

requiresControlPermission

requiresDirectPublishPermission

requiresReadPermission

requiresViewPermission

requiresWritePermission

toString