Package google.registry.request.auth

Enum Class AuthSettings.UserPolicy

java.lang.Object

java.lang.Enum<AuthSettings.UserPolicy>

google.registry.request.auth.AuthSettings.UserPolicy

All Implemented Interfaces:

Serializable, Comparable<AuthSettings.UserPolicy>, Constable

Enclosing class:

AuthSettings

public static enum AuthSettings.UserPolicy
extends Enum<AuthSettings.UserPolicy>

User authorization policy options.

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
ADMIN	If there is a user, it must be an admin, as determined by UserAuthInfo.isUserAdmin().
PUBLIC	No user policy is enforced; anyone can access this action.

Method Summary

Modifier and Type	Method	Description
static AuthSettings.UserPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AuthSettings.UserPolicy[]	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

PUBLIC

public static final AuthSettings.UserPolicy PUBLIC

No user policy is enforced; anyone can access this action.

ADMIN

public static final AuthSettings.UserPolicy ADMIN

If there is a user, it must be an admin, as determined by UserAuthInfo.isUserAdmin().

Note that, if the user returned is an App Engine User , anybody with access to the app in the GCP Console, including editors and viewers, is an admin.

On the other hand, if the user is a User, the admin role is explicitly defined in that object via the UserRoles.isAdmin() method.

Method Details

values

public static AuthSettings.UserPolicy[] 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 AuthSettings.UserPolicy 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