com.google.gerrit.server.permissions

Enum GlobalPermission

java.lang.Object

java.lang.Enum<GlobalPermission>

com.google.gerrit.server.permissions.GlobalPermission

All Implemented Interfaces:

GerritPermission, GlobalOrPluginPermission, java.io.Serializable, java.lang.Comparable<GlobalPermission>

public enum GlobalPermission
extends java.lang.Enum<GlobalPermission>
implements GlobalOrPluginPermission

Global server permissions built into Gerrit.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS_DATABASE
ADMINISTRATE_SERVER
CREATE_ACCOUNT
CREATE_GROUP
CREATE_PROJECT
EMAIL_REVIEWERS
FLUSH_CACHES
KILL_TASK
MAINTAIN_SERVER
MODIFY_ACCOUNT
READ_AS
RUN_AS
RUN_GC
STREAM_EVENTS
VIEW_ACCESS
VIEW_ALL_ACCOUNTS
VIEW_CACHES
VIEW_CONNECTIONS
VIEW_PLUGINS
VIEW_QUEUE

Method Summary

Modifier and Type	Method and Description
java.lang.String	describeForException() A description in the context of an exception message.
static java.util.Set<GlobalOrPluginPermission>	fromAnnotation(java.lang.Class<?> clazz)
static java.util.Set<GlobalOrPluginPermission>	fromAnnotation(java.lang.String pluginName, java.lang.Class<?> clazz) Extracts the @RequiresCapability or @RequiresAnyCapability annotation.
static GlobalPermission	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GlobalPermission[]	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

Methods inherited from interface com.google.gerrit.extensions.api.access.GerritPermission

describeEnumValue

Enum Constant Detail

ACCESS_DATABASE

public static final GlobalPermission ACCESS_DATABASE

ADMINISTRATE_SERVER

public static final GlobalPermission ADMINISTRATE_SERVER

CREATE_ACCOUNT

public static final GlobalPermission CREATE_ACCOUNT

CREATE_GROUP

public static final GlobalPermission CREATE_GROUP

CREATE_PROJECT

public static final GlobalPermission CREATE_PROJECT

EMAIL_REVIEWERS

public static final GlobalPermission EMAIL_REVIEWERS

FLUSH_CACHES

public static final GlobalPermission FLUSH_CACHES

KILL_TASK

public static final GlobalPermission KILL_TASK

MAINTAIN_SERVER

public static final GlobalPermission MAINTAIN_SERVER

MODIFY_ACCOUNT

public static final GlobalPermission MODIFY_ACCOUNT

READ_AS

public static final GlobalPermission READ_AS

RUN_AS

public static final GlobalPermission RUN_AS

RUN_GC

public static final GlobalPermission RUN_GC

STREAM_EVENTS

public static final GlobalPermission STREAM_EVENTS

VIEW_ALL_ACCOUNTS

public static final GlobalPermission VIEW_ALL_ACCOUNTS

VIEW_CACHES

public static final GlobalPermission VIEW_CACHES

VIEW_CONNECTIONS

public static final GlobalPermission VIEW_CONNECTIONS

VIEW_PLUGINS

public static final GlobalPermission VIEW_PLUGINS

VIEW_QUEUE

public static final GlobalPermission VIEW_QUEUE

VIEW_ACCESS

public static final GlobalPermission VIEW_ACCESS

Method Detail

values

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

Returns:

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

valueOf

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

fromAnnotation

public static java.util.Set<GlobalOrPluginPermission> fromAnnotation(java.lang.String pluginName,
                                                                     java.lang.Class<?> clazz)
                                                              throws PermissionBackendException

Extracts the @RequiresCapability or @RequiresAnyCapability annotation.

Parameters:

pluginName - name of the declaring plugin. May be null or "gerrit" for classes originating from the core server.

clazz - target class to extract annotation from.

Returns:

empty set if no annotations were found, or a collection of permissions, any of which are suitable to enable access.

Throws:

PermissionBackendException - the annotation could not be parsed.

fromAnnotation

public static java.util.Set<GlobalOrPluginPermission> fromAnnotation(java.lang.Class<?> clazz)
                                                              throws PermissionBackendException

Throws:

PermissionBackendException

describeForException

public java.lang.String describeForException()

Description copied from interface: GerritPermission

A description in the context of an exception message.

Should be grammatical when used in the construction "not permitted: [description] on [resource]", although individual PermissionBackend implementations may vary the wording.

Specified by:

describeForException in interface GerritPermission