Package com.marcosbarbero.cloud.autoconfigure.zuul.ratelimit.config

Interface RateLimiter

All Known Implementing Classes:

AbstractCacheRateLimiter, AbstractRateLimiter, Bucket4jHazelcastRateLimiter, Bucket4jIgniteRateLimiter, Bucket4jInfinispanRateLimiter, Bucket4jJCacheRateLimiter, ConsulRateLimiter, JpaRateLimiter, RedisRateLimiter

public interface RateLimiter

Author:

Marcos Barbero, Liel Chayoun

Field Summary

Fields

Modifier and Type	Field	Description
static String	QUOTA_SUFFIX

Method Summary

Modifier and Type	Method	Description
Rate	consume(RateLimitProperties.Policy policy, String key, Long requestTime)

Field Detail

QUOTA_SUFFIX

static final String QUOTA_SUFFIX

See Also:

Constant Field Values

Method Detail

consume

Rate consume(RateLimitProperties.Policy policy,
             String key,
             Long requestTime)

Parameters:

policy - Template for which rates should be created in case there's no rate limit associated with the key

key - Unique key that identifies a request

requestTime - The total time it took to handle the request

Returns:

a view of a user's rate request limit