Package org.codelibs.fess.api.v2.handlers

Enum Class LoginRateLimiter.Scope

java.lang.Object

java.lang.Enum<LoginRateLimiter.Scope>

org.codelibs.fess.api.v2.handlers.LoginRateLimiter.Scope

All Implemented Interfaces:

Serializable, Comparable<LoginRateLimiter.Scope>, Constable

Enclosing class:

LoginRateLimiter

public static enum LoginRateLimiter.Scope
extends Enum<LoginRateLimiter.Scope>

Rate-limit scope: distinguishes the bucket namespace so the same key value (e.g. "alice") can be tracked independently for login throttling and chat throttling.

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
CHAT	Per-user chat-invocation bucket used by the v2 chat endpoints.
IP	Per-client-IP login bucket.
USER	Per-username login bucket.

Method Summary

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

IP

public static final LoginRateLimiter.Scope IP

Per-client-IP login bucket.

USER

public static final LoginRateLimiter.Scope USER

Per-username login bucket.

CHAT

public static final LoginRateLimiter.Scope CHAT

Per-user chat-invocation bucket used by the v2 chat endpoints.

Method Details

values

public static LoginRateLimiter.Scope[] 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 LoginRateLimiter.Scope 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