org.camunda.bpm.engine.authorization

Enum Permissions

java.lang.Object

java.lang.Enum<Permissions>

org.camunda.bpm.engine.authorization.Permissions

All Implemented Interfaces:

Serializable, Comparable<Permissions>, Permission

public enum Permissions
extends Enum<Permissions>
implements Permission

The set of built-in Permissions for camunda BPM.

Author:

Daniel Meyer

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS Indicates that ACCESS interactions are permitted.
ALL Indicates that all interactions are permitted.
CREATE Indicates that CREATE interactions are permitted.
DELETE Indicates that DELETE interactions are permitted.
NONE The none permission means 'no action', 'doing nothing'.
READ Indicates that READ interactions are permitted.
UPDATE Indicates that UPDATE interactions are permitted.

Method Summary

Methods

Modifier and Type	Method and Description
static Permission	forName(String name)
String	getName() returns the name of the perwission, ie.
int	getValue() returns the unique numeric value of the permission.
String	toString()
static Permissions	valueOf(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 revoke also the ALL permission is revoked, 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.

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(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<Permissions>

getName

public String getName()

Description copied from interface: Permission

returns the name of the perwission, ie. 'WRITE'

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

forName

public static Permission forName(String name)