Class Bucket4jRateLimiter

java.lang.Object

org.springframework.cloud.gateway.support.AbstractConfigurable<Bucket4jRateLimiter.Config>

org.springframework.cloud.gateway.support.AbstractStatefulConfigurable<Bucket4jRateLimiter.Config>

org.springframework.cloud.gateway.filter.ratelimit.AbstractRateLimiter<Bucket4jRateLimiter.Config>

org.springframework.cloud.gateway.filter.ratelimit.Bucket4jRateLimiter

All Implemented Interfaces:

EventListener, RateLimiter<Bucket4jRateLimiter.Config>, Configurable<Bucket4jRateLimiter.Config>, StatefulConfigurable<Bucket4jRateLimiter.Config>, org.springframework.context.ApplicationListener<FilterArgsEvent>

public class Bucket4jRateLimiter
extends AbstractRateLimiter<Bucket4jRateLimiter.Config>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Bucket4jRateLimiter.Config
static enum	Bucket4jRateLimiter.RefillStyle

Nested classes/interfaces inherited from interface RateLimiter

RateLimiter.Response

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIGURATION_PROPERTY_NAME	Redis Rate Limiter property name.
static final String	DEFAULT_HEADER_NAME	Default Header Name.

Constructor Summary

Constructors

Constructor	Description
Bucket4jRateLimiter(io.github.bucket4j.distributed.proxy.AsyncProxyManager<String> proxyManager, ConfigurationService configurationService)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getHeaders(Bucket4jRateLimiter.Config config, Long tokensLeft)
reactor.core.publisher.Mono<RateLimiter.Response>	isAllowed(String routeId, String id)
protected Bucket4jRateLimiter.Config	loadRouteConfiguration(String routeId)

Methods inherited from class AbstractRateLimiter

getConfigurationPropertyName, onApplicationEvent, setConfigurationService, toString

Methods inherited from class AbstractStatefulConfigurable

getConfig

Methods inherited from class AbstractConfigurable

getConfigClass, newConfig

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.ApplicationListener

supportsAsyncExecution

Methods inherited from interface Configurable

getConfigClass, newConfig

Methods inherited from interface StatefulConfigurable

getConfig

Field Details

DEFAULT_HEADER_NAME

public static final String DEFAULT_HEADER_NAME

Default Header Name.

See Also:

• Constant Field Values

CONFIGURATION_PROPERTY_NAME

public static final String CONFIGURATION_PROPERTY_NAME

Redis Rate Limiter property name.

See Also:

• Constant Field Values

Constructor Details

Bucket4jRateLimiter

public Bucket4jRateLimiter(io.github.bucket4j.distributed.proxy.AsyncProxyManager<String> proxyManager,
 ConfigurationService configurationService)

Method Details

isAllowed

public reactor.core.publisher.Mono<RateLimiter.Response> isAllowed(String routeId,
 String id)

loadRouteConfiguration

protected Bucket4jRateLimiter.Config loadRouteConfiguration(String routeId)

getHeaders

public Map<String,String> getHeaders(Bucket4jRateLimiter.Config config,
 Long tokensLeft)