Module com.erudika.para.core

Package com.erudika.para.core

Enum Class App.AllowedMethods

java.lang.Object

java.lang.Enum<App.AllowedMethods>

com.erudika.para.core.App.AllowedMethods

All Implemented Interfaces:

Serializable, Comparable<App.AllowedMethods>, Constable

Enclosing class:

App

public static enum App.AllowedMethods
extends Enum<App.AllowedMethods>

Represents HTTP methods allowed to be executed on a specific resource/type. For example; the 'books' type can have a permission '{ "*" : ["GET"] }' which means "give read-only permissions to everyone". It is backed by a map of resource names (object types) to a set of allowed HTTP methods.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DELETE	Allows DELETE method only.
EMPTY	Deny all requests (no access).
GET	Allows GET method only.
GUEST	Allow unauthenticated requests (guest access).
OWN	Restrict access to objects with creatorid matching that of auth user.
PATCH	ALlows PATCH method only.
POST	Allows POST method only.
PUT	Allows PUT method only.
READ_ONLY	Allows read methods: GET, same as GET.
READ_WRITE	Allows all HTTP methods (full access).
WRITE_ONLY	Allows write methods: POST, PUT, PATCH and DELETE.

Field Summary

Fields

Modifier and Type	Field	Description
static final EnumSet<App.AllowedMethods>	ALL	All methods allowed.
static final EnumSet<App.AllowedMethods>	ALL_EXCEPT_DELETE	All methods allowed, except DELETE.
static final EnumSet<App.AllowedMethods>	NONE	No methods allowed.
static final EnumSet<App.AllowedMethods>	READ	Only GET is allowed.
static final EnumSet<App.AllowedMethods>	READ_AND_WRITE	All methods allowed (*).
static final EnumSet<App.AllowedMethods>	WRITE	All methods allowed, except GET.

Method Summary

Modifier and Type	Method	Description
static App.AllowedMethods	fromString(String value)	Constructs the enum from a string value.
String	toString()
static App.AllowedMethods	valueOf(String name)	Returns the enum constant of this class with the specified name.
static App.AllowedMethods[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GUEST

public static final App.AllowedMethods GUEST

Allow unauthenticated requests (guest access).

EMPTY

public static final App.AllowedMethods EMPTY

Deny all requests (no access).

OWN

public static final App.AllowedMethods OWN

Restrict access to objects with creatorid matching that of auth user.

READ_WRITE

public static final App.AllowedMethods READ_WRITE

Allows all HTTP methods (full access).

GET

public static final App.AllowedMethods GET

Allows GET method only.

POST

public static final App.AllowedMethods POST

Allows POST method only.

PUT

public static final App.AllowedMethods PUT

Allows PUT method only.

PATCH

public static final App.AllowedMethods PATCH

ALlows PATCH method only.

DELETE

public static final App.AllowedMethods DELETE

Allows DELETE method only.

READ_ONLY

public static final App.AllowedMethods READ_ONLY

Allows read methods: GET, same as GET.

WRITE_ONLY

public static final App.AllowedMethods WRITE_ONLY

Allows write methods: POST, PUT, PATCH and DELETE.

Field Details

ALL

public static final EnumSet<App.AllowedMethods> ALL

All methods allowed.

READ_AND_WRITE

public static final EnumSet<App.AllowedMethods> READ_AND_WRITE

All methods allowed (*).

READ

public static final EnumSet<App.AllowedMethods> READ

Only GET is allowed.

WRITE

public static final EnumSet<App.AllowedMethods> WRITE

All methods allowed, except GET.

ALL_EXCEPT_DELETE

public static final EnumSet<App.AllowedMethods> ALL_EXCEPT_DELETE

All methods allowed, except DELETE.

NONE

public static final EnumSet<App.AllowedMethods> NONE

No methods allowed.

Method Details

values

public static App.AllowedMethods[] 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 App.AllowedMethods 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

fromString

public static App.AllowedMethods fromString(String value)

Constructs the enum from a string value.

Parameters:

value - a method name, or ?,w

Returns:

an enum instance

toString

public String toString()

Overrides:

toString in class Enum<App.AllowedMethods>