Package org.camunda.bpm.engine.authorization

Enum ProcessDefinitionPermissions

java.lang.Object

java.lang.Enum<ProcessDefinitionPermissions>

org.camunda.bpm.engine.authorization.ProcessDefinitionPermissions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProcessDefinitionPermissions>, Permission

public enum ProcessDefinitionPermissions
extends java.lang.Enum<ProcessDefinitionPermissions>
implements Permission

The set of built-in Permissions for Process definition in Camunda Platform.

Author:

Yana Vasileva

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Indicates that all 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_HISTORY_VARIABLE	Indicates that READ_HISTORY_VARIABLE interactions are permitted.
READ_INSTANCE	Indicates that READ_INSTANCE interactions are permitted.
READ_INSTANCE_VARIABLE	Indicates that READ_INSTANCE_VARIABLE interactions are permitted.
READ_TASK	Indicates that READ_TASK interactions are permitted.
READ_TASK_VARIABLE	Indicates that READ_TASK_VARIABLE interactions are permitted.
RETRY_JOB	Indicates that RETRY_JOB interactions are permitted.
SUSPEND	Indicates that SUSPEND interactions are permitted.
SUSPEND_INSTANCE	Indicates that SUSPEND_INSTANCE 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_HISTORY	Indicates that UPDATE_HISTORY interactions are permitted.
UPDATE_INSTANCE	Indicates that UPDATE_INSTANCE interactions are permitted.
UPDATE_INSTANCE_VARIABLE	Indicates that UPDATE_INSTANCE_VARIABLE interactions are permitted.
UPDATE_TASK	Indicates that UPDATE_TASK interactions are permitted.
UPDATE_TASK_VARIABLE	Indicates that UPDATE_TASK_VARIABLE interactions are permitted.

Method Summary

Modifier and Type	Method	Description
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.
static ProcessDefinitionPermissions	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ProcessDefinitionPermissions[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final ProcessDefinitionPermissions NONE

The none permission means 'no action', 'doing nothing'. It does not mean that no permissions are granted.

ALL

public static final ProcessDefinitionPermissions 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 ProcessDefinitionPermissions READ

Indicates that READ interactions are permitted.

UPDATE

public static final ProcessDefinitionPermissions UPDATE

Indicates that UPDATE interactions are permitted.

DELETE

public static final ProcessDefinitionPermissions DELETE

Indicates that DELETE interactions are permitted.

READ_TASK

public static final ProcessDefinitionPermissions READ_TASK

Indicates that READ_TASK interactions are permitted.

UPDATE_TASK

public static final ProcessDefinitionPermissions UPDATE_TASK

Indicates that UPDATE_TASK interactions are permitted.

CREATE_INSTANCE

public static final ProcessDefinitionPermissions CREATE_INSTANCE

Indicates that CREATE_INSTANCE interactions are permitted.

READ_INSTANCE

public static final ProcessDefinitionPermissions READ_INSTANCE

Indicates that READ_INSTANCE interactions are permitted.

UPDATE_INSTANCE

public static final ProcessDefinitionPermissions UPDATE_INSTANCE

Indicates that UPDATE_INSTANCE interactions are permitted.

DELETE_INSTANCE

public static final ProcessDefinitionPermissions DELETE_INSTANCE

Indicates that DELETE_INSTANCE interactions are permitted.

READ_HISTORY

public static final ProcessDefinitionPermissions READ_HISTORY

Indicates that READ_HISTORY interactions are permitted.

DELETE_HISTORY

public static final ProcessDefinitionPermissions DELETE_HISTORY

Indicates that DELETE_HISTORY interactions are permitted.

TASK_WORK

public static final ProcessDefinitionPermissions TASK_WORK

Indicates that TASK_WORK interactions are permitted

TASK_ASSIGN

public static final ProcessDefinitionPermissions TASK_ASSIGN

Indicates that TASK_ASSIGN interactions are permitted

MIGRATE_INSTANCE

public static final ProcessDefinitionPermissions MIGRATE_INSTANCE

Indicates that MIGRATE_INSTANCE interactions are permitted

RETRY_JOB

public static final ProcessDefinitionPermissions RETRY_JOB

Indicates that RETRY_JOB interactions are permitted.

SUSPEND

public static final ProcessDefinitionPermissions SUSPEND

Indicates that SUSPEND interactions are permitted.

SUSPEND_INSTANCE

public static final ProcessDefinitionPermissions SUSPEND_INSTANCE

Indicates that SUSPEND_INSTANCE interactions are permitted.

UPDATE_INSTANCE_VARIABLE

public static final ProcessDefinitionPermissions UPDATE_INSTANCE_VARIABLE

Indicates that UPDATE_INSTANCE_VARIABLE interactions are permitted.

UPDATE_TASK_VARIABLE

public static final ProcessDefinitionPermissions UPDATE_TASK_VARIABLE

Indicates that UPDATE_TASK_VARIABLE interactions are permitted.

READ_INSTANCE_VARIABLE

public static final ProcessDefinitionPermissions READ_INSTANCE_VARIABLE

Indicates that READ_INSTANCE_VARIABLE interactions are permitted.

READ_HISTORY_VARIABLE

public static final ProcessDefinitionPermissions READ_HISTORY_VARIABLE

Indicates that READ_HISTORY_VARIABLE interactions are permitted.

READ_TASK_VARIABLE

public static final ProcessDefinitionPermissions READ_TASK_VARIABLE

Indicates that READ_TASK_VARIABLE interactions are permitted.

UPDATE_HISTORY

public static final ProcessDefinitionPermissions UPDATE_HISTORY

Indicates that UPDATE_HISTORY interactions are permitted.

Method Detail

values

public static ProcessDefinitionPermissions[] 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 (ProcessDefinitionPermissions c : ProcessDefinitionPermissions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProcessDefinitionPermissions 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

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