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

Class AbstractCacheRateLimiter

java.lang.Object

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

All Implemented Interfaces:

RateLimiter

Direct Known Subclasses:

Bucket4jHazelcastRateLimiter, Bucket4jIgniteRateLimiter, Bucket4jInfinispanRateLimiter, Bucket4jJCacheRateLimiter, RedisRateLimiter

public abstract class AbstractCacheRateLimiter
extends Object
implements RateLimiter

Bucket4j rate limiter configuration.

Since:

2018-04-06

Author:

Liel Chayoun

Field Summary

Fields inherited from interface com.marcosbarbero.cloud.autoconfigure.zuul.ratelimit.config.RateLimiter

QUOTA_SUFFIX

Constructor Summary

Constructors

Constructor	Description
AbstractCacheRateLimiter()

Method Summary

Modifier and Type	Method	Description
protected abstract void	calcRemainingLimit(Long limit, Long refreshInterval, Long requestTime, String key, Rate rate)
protected abstract void	calcRemainingQuota(Long quota, Long refreshInterval, Long requestTime, String key, Rate rate)
Rate	consume(RateLimitProperties.Policy policy, String key, Long requestTime)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCacheRateLimiter

public AbstractCacheRateLimiter()

Method Detail

consume

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

Specified by:

consume in interface RateLimiter

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

calcRemainingLimit

protected abstract void calcRemainingLimit(Long limit,
                                           Long refreshInterval,
                                           Long requestTime,
                                           String key,
                                           Rate rate)

calcRemainingQuota

protected abstract void calcRemainingQuota(Long quota,
                                           Long refreshInterval,
                                           Long requestTime,
                                           String key,
                                           Rate rate)