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

Class AbstractRateLimiter

java.lang.Object

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

All Implemented Interfaces:

RateLimiter

Direct Known Subclasses:

ConsulRateLimiter, JpaRateLimiter

public abstract class AbstractRateLimiter
extends Object
implements RateLimiter

Abstract implementation for RateLimiter.

Since:

2017-08-28

Author:

Liel Chayoun, Marcos Barbero

Field Summary

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

QUOTA_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRateLimiter(RateLimiterErrorHandler rateLimiterErrorHandler)

Method Summary

Modifier and Type	Method	Description
Rate	consume(RateLimitProperties.Policy policy, String key, Long requestTime)
protected abstract Rate	getRate(String key)
protected abstract void	saveRate(Rate rate)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRateLimiter

protected AbstractRateLimiter(RateLimiterErrorHandler rateLimiterErrorHandler)

Method Detail

getRate

protected abstract Rate getRate(String key)

saveRate

protected abstract void saveRate(Rate rate)

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