Package org.camunda.bpm.engine.authorization

Enum Permissions

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACCESS
      Indicates that ACCESS interactions are permitted.
      ALL
      Indicates that all interactions are permitted.
      CREATE
      Indicates that CREATE interactions are permitted.
      CREATE_INSTANCE
      Indicates that CREATE_INSTANCE interactions are permitted.
      DELETE
      Indicates that DELETE interactions are permitted.
      DELETE_HISTORY
      Indicates that DELETE_HISTORY interactions are permitted.
      DELETE_INSTANCE
      Indicates that DELETE_INSTANCE interactions are permitted.
      MIGRATE_INSTANCE
      Indicates that MIGRATE_INSTANCE interactions are permitted
      NONE
      The none permission means 'no action', 'doing nothing'.
      READ
      Indicates that READ interactions are permitted.
      READ_HISTORY
      Indicates that READ_HISTORY interactions are permitted.
      READ_INSTANCE
      Indicates that READ_INSTANCE interactions are permitted.
      READ_TASK
      Indicates that READ_TASK interactions are permitted.
      TASK_ASSIGN
      Indicates that TASK_ASSIGN interactions are permitted
      TASK_WORK
      Indicates that TASK_WORK interactions are permitted
      UPDATE
      Indicates that UPDATE interactions are permitted.
      UPDATE_INSTANCE
      Indicates that UPDATE_INSTANCE interactions are permitted.
      UPDATE_TASK
      Indicates that UPDATE_TASK interactions are permitted.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Permission forName​(java.lang.String name)  
      java.lang.String getName()
      returns the name of the permission, ie.
      Resource[] getTypes()
      returns the resource types which are allowed for this permission
      int getValue()
      returns the unique numeric value of the permission.
      java.lang.String toString()  
      static Permissions valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Permissions[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NONE

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

      • ALL

        public static final Permissions 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 Permissions READ
        Indicates that READ interactions are permitted.

      • UPDATE

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

      • CREATE

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

      • DELETE

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

      • ACCESS

        public static final Permissions ACCESS
        Indicates that ACCESS interactions are permitted.

      • READ_TASK

        public static final Permissions READ_TASK
        Indicates that READ_TASK interactions are permitted.

      • UPDATE_TASK

        public static final Permissions UPDATE_TASK
        Indicates that UPDATE_TASK interactions are permitted.

      • CREATE_INSTANCE

        public static final Permissions CREATE_INSTANCE
        Indicates that CREATE_INSTANCE interactions are permitted.

      • READ_INSTANCE

        public static final Permissions READ_INSTANCE
        Indicates that READ_INSTANCE interactions are permitted.

      • UPDATE_INSTANCE

        public static final Permissions UPDATE_INSTANCE
        Indicates that UPDATE_INSTANCE interactions are permitted.

      • DELETE_INSTANCE

        public static final Permissions DELETE_INSTANCE
        Indicates that DELETE_INSTANCE interactions are permitted.

      • READ_HISTORY

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

        public static final Permissions DELETE_HISTORY
        Indicates that DELETE_HISTORY interactions are permitted.

      • TASK_WORK

        public static final Permissions TASK_WORK
        Indicates that TASK_WORK interactions are permitted

      • TASK_ASSIGN

        public static final Permissions TASK_ASSIGN
        Indicates that TASK_ASSIGN interactions are permitted

      • MIGRATE_INSTANCE

        public static final Permissions MIGRATE_INSTANCE
        Indicates that MIGRATE_INSTANCE interactions are permitted

    • Method Detail

      • values

        public static Permissions[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Permissions c : Permissions.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Permissions valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<Permissions>

      • getName

        public java.lang.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

      • forName

        public static Permission forName​(java.lang.String name)