io.muserver

Class RateLimitBuilder

java.lang.Object

io.muserver.RateLimitBuilder

public class RateLimitBuilder
extends Object

A builder to create RateLimit objects. The built limit is returned by a RateLimitSelector. See MuServerBuilder.withRateLimiter(RateLimitSelector) for more details on how to use this.

Constructor Summary

Constructors

Constructor and Description
RateLimitBuilder()

Method Summary

Modifier and Type	Method and Description
RateLimit	build() Creates the rate limit from the builder
static RateLimitBuilder	rateLimit() Creates a new builder
RateLimitBuilder	withBucket(String name) Sets the bucket that the limit applies to.
RateLimitBuilder	withRate(long rate) Sets the allowed rate.
RateLimitBuilder	withRejectionAction(RateLimitRejectionAction action) Specifies what to do when this limit is breached.
RateLimitBuilder	withWindow(long period, TimeUnit unit) The period that the limit applies to.

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitBuilder

public RateLimitBuilder()

Method Detail

withRate

public RateLimitBuilder withRate(long rate)

Sets the allowed rate. For example, this would be 10 if you allowed 10 per second.

Parameters:

rate - The rate to use for this bucket

Returns:

This builder

Throws:

IllegalArgumentException - if the parameter is 0 or negative.

withWindow

public RateLimitBuilder withWindow(long period,
                                   TimeUnit unit)

The period that the limit applies to. For example, this would be 1 second if you allowed 10 per 1 second. The default is 1 second.

Parameters:

period - The time period of the limit.

unit - The unit of the period

Returns:

This builder.

Throws:

IllegalArgumentException - if period is less than 1, or unit is null.

withBucket

public RateLimitBuilder withBucket(String name)

Sets the bucket that the limit applies to.

Parameters:

name - The bucket, for example when limiting by IP address this would be an IP address.

Returns:

This builder.

withRejectionAction

public RateLimitBuilder withRejectionAction(RateLimitRejectionAction action)

Specifies what to do when this limit is breached.

Parameters:

action - The action to take

Returns:

This builder

Throws:

IllegalArgumentException - If the action is null

rateLimit

public static RateLimitBuilder rateLimit()

Creates a new builder

Returns:

A new rate limit builder

build

public RateLimit build()

Creates the rate limit from the builder

Returns:

a new Rate Limit