Enum Class ProcessInstancePermissions
java.lang.Object
java.lang.Enum<ProcessInstancePermissions>
org.camunda.bpm.engine.authorization.ProcessInstancePermissions
- All Implemented Interfaces:
Serializable
,Comparable<ProcessInstancePermissions>
,Constable
,Permission
public enum ProcessInstancePermissions
extends Enum<ProcessInstancePermissions>
implements Permission
The set of built-in
Permissions
for Process instances
in Camunda Platform.- Author:
- Yana Vasileva
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionIndicates that all interactions are permitted.Indicates that CREATE interactions are permitted.Indicates that DELETE interactions are permitted.The none permission means 'no action', 'doing nothing'.Indicates that READ interactions are permitted.Indicates that RETRY_JOB interactions are permitted.Indicates that SUSPEND interactions are permitted.Indicates that UPDATE interactions are permitted.Indicates that UPDATE_VARIABLE interactions are permitted. -
Method Summary
Modifier and TypeMethodDescriptiongetName()
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.static ProcessInstancePermissions
Returns the enum constant of this class with the specified name.static ProcessInstancePermissions[]
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. -
RETRY_JOB
Indicates that RETRY_JOB interactions are permitted. -
SUSPEND
Indicates that SUSPEND interactions are permitted. -
UPDATE_VARIABLE
Indicates that UPDATE_VARIABLE 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
-
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
-