Package eu.rarogsoftware.rarog.platform.api.security.anonymous

Enum Class AnonymousAllowedLevel

java.lang.Object

java.lang.Enum<AnonymousAllowedLevel>

eu.rarogsoftware.rarog.platform.api.security.anonymous.AnonymousAllowedLevel

All Implemented Interfaces:

Serializable, Comparable<AnonymousAllowedLevel>, Constable

public enum AnonymousAllowedLevel
extends Enum<AnonymousAllowedLevel>

Levels of anonymous access that are determining which endpoints have disabled anonymous access, when admin disables system-wide anonymous access.

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
BASIC	Default level of anonymous access for endpoints.
CORE	Endpoints annotated as CORE endpoints will never have disabled anonymous.
OPTIONAL	Endpoints with this level provide functionalities for users that don't have account in system.

Method Summary

Modifier and Type	Method	Description
static AnonymousAllowedLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AnonymousAllowedLevel[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CORE

public static final AnonymousAllowedLevel CORE

Endpoints annotated as CORE endpoints will never have disabled anonymous. It's level reserved to endpoints that are necessary for system to work, like `/status` endpoint. Endpoints of this level cannot leak any user data or system configuration that can be considered confidential.

BASIC

public static final AnonymousAllowedLevel BASIC

Default level of anonymous access for endpoints. Endpoints of this type provide some functionality that is not necessary for system to work, but disabling them may cause some functionalities or integrations to stop working. Endpoints of this level must strictly control what kind of data they expose.

OPTIONAL

public static final AnonymousAllowedLevel OPTIONAL

Endpoints with this level provide functionalities for users that don't have account in system. These endpoints usually expose data that may be undesirable to be exposed when no anonymous users are intended in system. Endpoints of this level are intended to provide functionality for anonymous users and can be safely disabled, or they work correctly for logged-in users.

Method Details

values

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