Package org.dspace.app.rest.security

Enum DSpaceRestPermission

java.lang.Object

java.lang.Enum<DSpaceRestPermission>

org.dspace.app.rest.security.DSpaceRestPermission

All Implemented Interfaces:

Serializable, Comparable<DSpaceRestPermission>

public enum DSpaceRestPermission
extends Enum<DSpaceRestPermission>

Enum that lists all available "permissions" an authenticated user can have on a specific REST endpoint.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD
ADMIN
DELETE
READ
STATUS
WRITE

Method Summary

Modifier and Type	Method	Description
static DSpaceRestPermission	convert(Object object)	Convert a given object to a DSpaceRestPermission if possible.
int	getDspaceApiActionId()
static DSpaceRestPermission	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DSpaceRestPermission[]	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

READ

public static final DSpaceRestPermission READ

WRITE

public static final DSpaceRestPermission WRITE

DELETE

public static final DSpaceRestPermission DELETE

ADD

public static final DSpaceRestPermission ADD

ADMIN

public static final DSpaceRestPermission ADMIN

STATUS

public static final DSpaceRestPermission STATUS

Method Detail

values

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

Returns:

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

valueOf

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

getDspaceApiActionId

public int getDspaceApiActionId()

convert

public static DSpaceRestPermission convert(Object object)

Convert a given object to a DSpaceRestPermission if possible.

Parameters:

object - The object to convert

Returns:

A DSpaceRestPersmission value if the conversion succeeded, null otherwise