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

Interface RateLimiter

All Known Implementing Classes:

AbstractRateLimiter, ConsulRateLimiter, InMemoryRateLimiter, JpaRateLimiter, RedisRateLimiter

public interface RateLimiter

Author:

Marcos Barbero, Liel Chayoun

Method Summary

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

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