io.jooby

Class RateLimitHandler

java.lang.Object

io.jooby.RateLimitHandler

All Implemented Interfaces:

Route.Before

public class RateLimitHandler
extends Object
implements Route.Before

Rate limit handler using https://github.com/vladimir-bukhtoyarov/bucket4j. NOTE: bucket4j must be included as part of your project dependencies (classpath). Example 1: 10 requests per minute

 {
   Bandwidth limit = Bandwidth.simple(10, Duration.ofMinutes(1));
   Bucket bucket = Bucket4j.builder().addLimit(limit).build();

   before(new RateLimitHandler(bucket));
 }
 

Example 2: 10 requests per minute per IP address

 {
   before(new RateLimitHandler(remoteAddress -> {
       Bandwidth limit = Bandwidth.simple(10, Duration.ofMinutes(1));
       return Bucket4j.builder().addLimit(limit).build();
   }));
 }
 

Example 3: 10 requests per minute using an ApiKey header.

 {
   before(new RateLimitHandler(key -> {
       Bandwidth limit = Bandwidth.simple(10, Duration.ofMinutes(1));
       return Bucket4j.builder().addLimit(limit).build();
   }, "ApiKey"));
 }
 

Example 4: Rate limit in a cluster

 {
   // Get one of the proxy manager from bucket4j
   ProxyManager<String> buckets = ...;
   before(RateLimitHandler.cluster(key -> {
       buckets.getProxy(key, () -> {
           return Bucket4j.configurationBuilder()
             .addLimit(Bandwidth.classic(100, Refill.intervally(100, Duration.ofMinutes(1))))
             .build();
       });
   }));
 }
 

Since:

2.5.2

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
RateLimitHandler(io.github.bucket4j.Bucket bucket) Rate limiter with a shared/global bucket.
RateLimitHandler(SneakyThrows.Function<String,io.github.bucket4j.Bucket> bucketFactory) Rate limit per IP/Remote Address.
RateLimitHandler(SneakyThrows.Function<String,io.github.bucket4j.Bucket> bucketFactory, SneakyThrows.Function<Context,String> classifier) Rate limiter with a custom key provider.
RateLimitHandler(SneakyThrows.Function<String,io.github.bucket4j.Bucket> bucketFactory, String headerName) Rate limit per header key.

Method Summary

Modifier and Type	Method and Description
void	apply(Context ctx) Execute application code before next handler.
static RateLimitHandler	cluster(SneakyThrows.Function<String,io.github.bucket4j.Bucket> proxyManager) Rate limiter per IP/Remote address using a cluster.
static RateLimitHandler	cluster(SneakyThrows.Function<String,io.github.bucket4j.Bucket> proxyManager, SneakyThrows.Function<Context,String> classifier) Rate limiter per key using a cluster.
static RateLimitHandler	cluster(SneakyThrows.Function<String,io.github.bucket4j.Bucket> proxyManager, String headerName) Rate limiter per header key using a cluster.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jooby.Route.Before

then, then

Constructor Detail

RateLimitHandler

public RateLimitHandler(@Nonnull
                        SneakyThrows.Function<String,io.github.bucket4j.Bucket> bucketFactory)

Rate limit per IP/Remote Address.

Parameters:

bucketFactory - Bucket factory.

RateLimitHandler

public RateLimitHandler(@Nonnull
                        SneakyThrows.Function<String,io.github.bucket4j.Bucket> bucketFactory,
                        @Nonnull
                        String headerName)

Rate limit per header key.

Parameters:

bucketFactory - Bucket factory.

headerName - Header to use as key.

RateLimitHandler

public RateLimitHandler(@Nonnull
                        SneakyThrows.Function<String,io.github.bucket4j.Bucket> bucketFactory,
                        @Nonnull
                        SneakyThrows.Function<Context,String> classifier)

Rate limiter with a custom key provider.

Parameters:

bucketFactory - Bucket factory.

classifier - Key provider.

RateLimitHandler

public RateLimitHandler(@Nonnull
                        io.github.bucket4j.Bucket bucket)

Rate limiter with a shared/global bucket.

Parameters:

bucket - Bucket to use.

Method Detail

cluster

@Nonnull
public static RateLimitHandler cluster(@Nonnull
                                                SneakyThrows.Function<String,io.github.bucket4j.Bucket> proxyManager)

Rate limiter per IP/Remote address using a cluster.

Parameters:

proxyManager - Cluster bucket configuration.

Returns:

Rate limiter.

cluster

@Nonnull
public static RateLimitHandler cluster(@Nonnull
                                                SneakyThrows.Function<String,io.github.bucket4j.Bucket> proxyManager,
                                                @Nonnull
                                                String headerName)

Rate limiter per header key using a cluster.

Parameters:

proxyManager - Cluster bucket configuration.

headerName - Header to use as key.

Returns:

Rate limiter.

cluster

public static RateLimitHandler cluster(@Nonnull
                                       SneakyThrows.Function<String,io.github.bucket4j.Bucket> proxyManager,
                                       @Nonnull
                                       SneakyThrows.Function<Context,String> classifier)

Rate limiter per key using a cluster.

Parameters:

proxyManager - Cluster bucket configuration.

classifier - Key provider.

Returns:

Rate limiter.

apply

public void apply(@Nonnull
                  Context ctx)
           throws Exception

Description copied from interface: Route.Before

Execute application code before next handler.

Specified by:

apply in interface Route.Before

Parameters:

ctx - Web context.

Throws:

Exception - If something goes wrong.