es.moki.ratelimitj.core.limiter.request

Interface RequestLimitRulesSupplier<T>

All Known Implementing Classes:

DefaultRequestLimitRulesSupplier

public interface RequestLimitRulesSupplier<T>

Method Summary

Modifier and Type	Method and Description
static java.util.Set<RequestLimitRule>	buildDefaultRuleSet(java.util.Set<RequestLimitRule> rules) Build the default rule set.
static java.util.Map<java.lang.String,java.util.Set<RequestLimitRule>>	buildRuleMap(java.util.Set<RequestLimitRule> rules) Build the rule map.
T	getRules(java.lang.String key) Provides the rule set for the given key.

Method Detail

buildDefaultRuleSet

static java.util.Set<RequestLimitRule> buildDefaultRuleSet(java.util.Set<RequestLimitRule> rules)

Build the default rule set.

Parameters:

rules - The complete rule set.

Returns:

The rule set for any key that doesn't match a specific rule set.

buildRuleMap

static java.util.Map<java.lang.String,java.util.Set<RequestLimitRule>> buildRuleMap(java.util.Set<RequestLimitRule> rules)

Build the rule map.

Parameters:

rules - The complete rule set.

Returns:

A map of rule set by key.

getRules

T getRules(java.lang.String key)

Provides the rule set for the given key.

Parameters:

key - The key for which the rule set should be provided.

Returns:

The rule set for the given key.