Package org.camunda.bpm.engine.authorization

Enum Class ProcessInstancePermissions

java.lang.Object
java.lang.Enum<ProcessInstancePermissions>
org.camunda.bpm.engine.authorization.ProcessInstancePermissions
All Implemented Interfaces:
Serializable, Comparable<ProcessInstancePermissions>, java.lang.constant.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

  • Enum Constant Details

    • NONE

      public static final ProcessInstancePermissions NONE
      The none permission means 'no action', 'doing nothing'. It does not mean that no permissions are granted.

    • ALL

      public static final ProcessInstancePermissions 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

      public static final ProcessInstancePermissions READ
      Indicates that READ interactions are permitted.

    • UPDATE

      public static final ProcessInstancePermissions UPDATE
      Indicates that UPDATE interactions are permitted.

    • CREATE

      public static final ProcessInstancePermissions CREATE
      Indicates that CREATE interactions are permitted.

    • DELETE

      public static final ProcessInstancePermissions DELETE
      Indicates that DELETE interactions are permitted.

    • RETRY_JOB

      public static final ProcessInstancePermissions RETRY_JOB
      Indicates that RETRY_JOB interactions are permitted.

    • SUSPEND

      public static final ProcessInstancePermissions SUSPEND
      Indicates that SUSPEND interactions are permitted.

    • UPDATE_VARIABLE

      public static final ProcessInstancePermissions UPDATE_VARIABLE
      Indicates that UPDATE_VARIABLE interactions are permitted.

  • Method Details

    • values

      public static ProcessInstancePermissions[] 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

      public static ProcessInstancePermissions valueOf(String name)
      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 name
      NullPointerException - if the argument is null

    • getName

      public String getName()
      Description copied from interface: Permission
      returns the name of the permission, ie. 'UPDATE'
      Specified by:
      getName in interface Permission

    • 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 interface Permission

    • getTypes

      public Resource[] getTypes()
      Description copied from interface: Permission
      returns the resource types which are allowed for this permission
      Specified by:
      getTypes in interface Permission