es.moki.ratelimitj.core.limiter.request

Class RequestLimitRule

java.lang.Object

es.moki.ratelimitj.core.limiter.request.RequestLimitRule

@ParametersAreNonnullByDefault
public class RequestLimitRule
extends java.lang.Object

Defines a limit rule that can support regular and token bucket rate limits.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	getDurationSeconds()
java.util.Set<java.lang.String>	getKeys()
long	getLimit()
java.lang.String	getName()
int	getPrecisionSeconds()
int	hashCode()
RequestLimitRule	matchingKeys(java.util.Set<java.lang.String> keys) Applies a key to the rate limit that defines to which keys, the rule applies, null for any unmatched key.
RequestLimitRule	matchingKeys(java.lang.String... keys) Applies a key to the rate limit that defines to which keys, the rule applies, empty for any unmatched key.
static RequestLimitRule	of(java.time.Duration duration, long limit) Initialise a request rate limit.
RequestLimitRule	withName(java.lang.String name) Applies a name to the rate limit that is useful for metrics.
RequestLimitRule	withPrecision(java.time.Duration precision) Controls (approximate) sliding window precision.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static RequestLimitRule of(java.time.Duration duration,
                                  long limit)

Initialise a request rate limit. Imagine the whole duration window as being one large bucket with a single count.

Parameters:

duration - The time the limit will be applied over. The duration must be greater than 1 second.

limit - A number representing the maximum operations that can be performed in the given duration.

Returns:

A limit rule.

withPrecision

public RequestLimitRule withPrecision(java.time.Duration precision)

Controls (approximate) sliding window precision. A lower duration increases precision and minimises the Thundering herd problem - https://en.wikipedia.org/wiki/Thundering_herd_problem

Parameters:

precision - Defines the time precision that will be used to approximate the sliding window. The precision must be greater than 1 second.

Returns:

a limit rule

withName

public RequestLimitRule withName(java.lang.String name)

Applies a name to the rate limit that is useful for metrics.

Parameters:

name - Defines a descriptive name for the rule limit.

Returns:

a limit rule

matchingKeys

public RequestLimitRule matchingKeys(java.lang.String... keys)

Applies a key to the rate limit that defines to which keys, the rule applies, empty for any unmatched key.

Parameters:

keys - Defines a set of keys to which the rule applies.

Returns:

a limit rule

matchingKeys

public RequestLimitRule matchingKeys(java.util.Set<java.lang.String> keys)

Applies a key to the rate limit that defines to which keys, the rule applies, null for any unmatched key.

Parameters:

keys - Defines a set of keys to which the rule applies.

Returns:

a limit rule

getDurationSeconds

public int getDurationSeconds()

Returns:

The limits duration in seconds.

getPrecisionSeconds

public int getPrecisionSeconds()

Returns:

The limits precision in seconds.

getName

public java.lang.String getName()

Returns:

The name.

getLimit

public long getLimit()

Returns:

The limit.

getKeys

@Nullable
public java.util.Set<java.lang.String> getKeys()

Returns:

The keys.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object