Package com.rale4j.sb.core

Class TokenBucketRateLimiter

java.lang.Object

com.rale4j.sb.core.TokenBucketRateLimiter

All Implemented Interfaces:

RateLimitStrategy

@Component("tokenBucket")
public class TokenBucketRateLimiter
extends Object
implements RateLimitStrategy

Rate limiter implementation using the Token Bucket algorithm.

Constructor Summary

Constructors

Constructor	Description
TokenBucketRateLimiter()

Method Summary

Modifier and Type	Method	Description
boolean	allowRequest(String key, int limit, int duration)	Allows or denies a request based on the rate limit.

Methods inherited from class java.lang.Object

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

Constructor Details

TokenBucketRateLimiter

public TokenBucketRateLimiter()

Method Details

allowRequest

public boolean allowRequest(String key,
 int limit,
 int duration)

Allows or denies a request based on the rate limit.

Specified by:

allowRequest in interface RateLimitStrategy

Parameters:

key - the key to identify the rate limit bucket

limit - the maximum number of tokens available

duration - the duration in seconds for the rate limit

Returns:

true if the request is allowed, false otherwise