Package org.infinispan.security

Enum AuthorizationPermission

java.lang.Object

java.lang.Enum<AuthorizationPermission>

org.infinispan.security.AuthorizationPermission

All Implemented Interfaces:

Serializable, Comparable<AuthorizationPermission>

@ProtoTypeId(1012)
public enum AuthorizationPermission
extends Enum<AuthorizationPermission>

AuthorizationPermission.

Since:

7.0

Author:

Tristan Tarrant

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMIN	Allows performing "administrative" operations on a cache
ALL	Aggregate permission which implies all the others
ALL_READ	Aggregate permission which implies all read permissions
ALL_WRITE	Aggregate permission which implies all write permissions
BULK_READ	Allows bulk-read operations (e.g.
BULK_WRITE	Allows bulk-write operations (e.g.
CREATE	Allows creation of resources (caches, counters, schemas, tasks)
EXEC	Allows performing task execution (e.g.
LIFECYCLE	Allows control of a cache's lifecycle (i.e.
LISTEN	Allows attaching listeners to a cache
MONITOR	Allows retrieval of stats
NONE	No permissions
READ	Allows reading data from a cache
WRITE	Allows writing data to a cache

Method Summary

Modifier and Type	Method	Description
int	getMask()
CachePermission	getSecurityPermission()
boolean	implies(AuthorizationPermission that)
boolean	matches(int mask)
static AuthorizationPermission	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AuthorizationPermission[]	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 Details

LIFECYCLE

@ProtoEnumValue(value=1,
                name="LIFECYCLE_PERMISSION")
public static final AuthorizationPermission LIFECYCLE

Allows control of a cache's lifecycle (i.e. invoke Lifecycle.start() and Cache.stop()

READ

@ProtoEnumValue(2)
public static final AuthorizationPermission READ

Allows reading data from a cache

WRITE

@ProtoEnumValue(4)
public static final AuthorizationPermission WRITE

Allows writing data to a cache

EXEC

@ProtoEnumValue(8)
public static final AuthorizationPermission EXEC

Allows performing task execution (e.g. cluster executor, tasks) on a cache

LISTEN

@ProtoEnumValue(16)
public static final AuthorizationPermission LISTEN

Allows attaching listeners to a cache

BULK_READ

@ProtoEnumValue(32)
public static final AuthorizationPermission BULK_READ

Allows bulk-read operations (e.g. Cache.keySet()) on a cache

BULK_WRITE

@ProtoEnumValue(64)
public static final AuthorizationPermission BULK_WRITE

Allows bulk-write operations (e.g. Cache.clear()) on a cache

ADMIN

@ProtoEnumValue(128)
public static final AuthorizationPermission ADMIN

Allows performing "administrative" operations on a cache

CREATE

@ProtoEnumValue(256)
public static final AuthorizationPermission CREATE

Allows creation of resources (caches, counters, schemas, tasks)

MONITOR

@ProtoEnumValue(512)
public static final AuthorizationPermission MONITOR

Allows retrieval of stats

ALL

@ProtoEnumValue(2147483647)
public static final AuthorizationPermission ALL

Aggregate permission which implies all the others

ALL_READ

@ProtoEnumValue(34)
public static final AuthorizationPermission ALL_READ

Aggregate permission which implies all read permissions

ALL_WRITE

@ProtoEnumValue(68)
public static final AuthorizationPermission ALL_WRITE

Aggregate permission which implies all write permissions

NONE

@ProtoEnumValue
public static final AuthorizationPermission NONE

No permissions

Method Details

values

public static AuthorizationPermission[] values()

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

Returns:

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

valueOf

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

getMask

public int getMask()

getSecurityPermission

public CachePermission getSecurityPermission()

matches

public boolean matches(int mask)

implies

public boolean implies(AuthorizationPermission that)