Enum Class Role

java.lang.Object

java.lang.Enum<Role>

com.iantapply.orchestra.security.Role

All Implemented Interfaces:

Serializable, Comparable<Role>, Constable

public enum Role
extends Enum<Role>

Built-in role-to-permission mappings used by the HTTP API.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMINISTRATOR	Every available permission.
APPROVER	Read and approval access.
OPERATOR	Read and execution-operation access.
VIEWER	Read-only access.

Method Summary

Modifier and Type	Method	Description
boolean	allows(Permission permission)	Tests whether this role includes a permission.
static Role	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Role[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VIEWER

public static final Role VIEWER

Read-only access.

OPERATOR

public static final Role OPERATOR

Read and execution-operation access.

APPROVER

public static final Role APPROVER

Read and approval access.

ADMINISTRATOR

public static final Role ADMINISTRATOR

Every available permission.

Method Details

values

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

allows

public boolean allows(Permission permission)

Tests whether this role includes a permission.

Parameters:

permission - permission to test

Returns:

whether this role grants the permission