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, InMemoryRateLimiter, JpaRateLimiter

public abstract class AbstractRateLimiter
extends Object
implements RateLimiter

Abstract implementation for RateLimiter.

Since:

2017-08-28

Author:

Liel Chayoun, Marcos Barbero

Constructor Summary

Constructors

Constructor and Description
AbstractRateLimiter()

Method Summary

Modifier and Type	Method and 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

public AbstractRateLimiter()

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