Enum Class Permissions
- All Implemented Interfaces:
Serializable
,Comparable<Permissions>
,Constable
,Permission
The set of built-in
Permissions
for Camunda Platform.- Author:
- Daniel Meyer
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionIndicates that ACCESS interactions are permitted.Indicates that all interactions are permitted.Indicates that CREATE interactions are permitted.Indicates that CREATE_INSTANCE interactions are permitted.Indicates that DELETE interactions are permitted.Indicates that DELETE_HISTORY interactions are permitted.Indicates that DELETE_INSTANCE interactions are permitted.Indicates that MIGRATE_INSTANCE interactions are permittedThe none permission means 'no action', 'doing nothing'.Indicates that READ interactions are permitted.Indicates that READ_HISTORY interactions are permitted.Indicates that READ_INSTANCE interactions are permitted.Indicates that READ_TASK interactions are permitted.Indicates that TASK_ASSIGN interactions are permittedIndicates that TASK_WORK interactions are permittedIndicates that UPDATE interactions are permitted.Indicates that UPDATE_INSTANCE interactions are permitted.Indicates that UPDATE_TASK interactions are permitted. -
Method Summary
Modifier and TypeMethodDescriptionstatic Permission
getName()
returns the name of the permission, ie.Resource[]
getTypes()
returns the resource types which are allowed for this permissionint
getValue()
returns the unique numeric value of the permission.toString()
static Permissions
Returns the enum constant of this class with the specified name.static Permissions[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NONE
The none permission means 'no action', 'doing nothing'. It does not mean that no permissions are granted. -
ALL
Indicates that all interactions are permitted. If ALL is revoked it means that the user is not permitted to do everything, which means that at least one permission is revoked. This does not implicate that all individual permissions are revoked. Example: If the UPDATE permission is revoked then the ALL permission is revoked as well, because the user is not authorized to execute all actions anymore. -
READ
Indicates that READ interactions are permitted. -
UPDATE
Indicates that UPDATE interactions are permitted. -
CREATE
Indicates that CREATE interactions are permitted. -
DELETE
Indicates that DELETE interactions are permitted. -
ACCESS
Indicates that ACCESS interactions are permitted. -
READ_TASK
Indicates that READ_TASK interactions are permitted. -
UPDATE_TASK
Indicates that UPDATE_TASK interactions are permitted. -
CREATE_INSTANCE
Indicates that CREATE_INSTANCE interactions are permitted. -
READ_INSTANCE
Indicates that READ_INSTANCE interactions are permitted. -
UPDATE_INSTANCE
Indicates that UPDATE_INSTANCE interactions are permitted. -
DELETE_INSTANCE
Indicates that DELETE_INSTANCE interactions are permitted. -
READ_HISTORY
Indicates that READ_HISTORY interactions are permitted.
There is no built-in functionality of Camunda Platform that uses the permission together with the resource
Resources.TASK
-
DELETE_HISTORY
Indicates that DELETE_HISTORY interactions are permitted. -
TASK_WORK
Indicates that TASK_WORK interactions are permitted -
TASK_ASSIGN
Indicates that TASK_ASSIGN interactions are permitted -
MIGRATE_INSTANCE
Indicates that MIGRATE_INSTANCE interactions are permitted
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
toString
- Overrides:
toString
in classEnum<Permissions>
-
getName
Description copied from interface:Permission
returns the name of the permission, ie. 'UPDATE'- Specified by:
getName
in interfacePermission
-
getValue
public int getValue()Description copied from interface:Permission
returns the unique numeric value of the permission. Must be a power of 2. ie 2^0, 2^1, 2^2, 2^3, 2^4 ...- Specified by:
getValue
in interfacePermission
-
getTypes
Description copied from interface:Permission
returns the resource types which are allowed for this permission- Specified by:
getTypes
in interfacePermission
-
forName
-