Package org.springframework.cloud.gateway.filter.factory

Class RequestRateLimiterGatewayFilterFactory

java.lang.Object

org.springframework.cloud.gateway.support.AbstractConfigurable<C>

org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory<RequestRateLimiterGatewayFilterFactory.Config>

org.springframework.cloud.gateway.filter.factory.RequestRateLimiterGatewayFilterFactory

All Implemented Interfaces:

org.springframework.beans.factory.Aware, GatewayFilterFactory<RequestRateLimiterGatewayFilterFactory.Config>, Configurable<RequestRateLimiterGatewayFilterFactory.Config>, ShortcutConfigurable, org.springframework.context.ApplicationEventPublisherAware

@ConfigurationProperties("spring.cloud.gateway.filter.request-rate-limiter")
public class RequestRateLimiterGatewayFilterFactory
extends AbstractGatewayFilterFactory<RequestRateLimiterGatewayFilterFactory.Config>

User Request Rate Limiter filter. See https://stripe.com/blog/rate-limiters and https://gist.github.com/ptarjan/e38f45f2dfe601419ca3af937fff574d#file-1-check_request_rate_limiter-rb-L11-L34.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequestRateLimiterGatewayFilterFactory.Config

Nested classes/interfaces inherited from class org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory

AbstractGatewayFilterFactory.NameConfig

Nested classes/interfaces inherited from interface org.springframework.cloud.gateway.support.ShortcutConfigurable

ShortcutConfigurable.GatewayEvaluationContext, ShortcutConfigurable.RestrictivePropertyAccessor, ShortcutConfigurable.ShortcutType

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_RESOLVER_KEY	Key-Resolver key.

Fields inherited from interface org.springframework.cloud.gateway.filter.factory.GatewayFilterFactory

NAME_KEY, VALUE_KEY

Constructor Summary

Constructors

Constructor	Description
RequestRateLimiterGatewayFilterFactory(RateLimiter defaultRateLimiter, KeyResolver defaultKeyResolver)

Method Summary

Modifier and Type	Method	Description
GatewayFilter	apply(RequestRateLimiterGatewayFilterFactory.Config config)
KeyResolver	getDefaultKeyResolver()
RateLimiter	getDefaultRateLimiter()
String	getEmptyKeyStatusCode()
boolean	isDenyEmptyKey()
void	setDenyEmptyKey(boolean denyEmptyKey)
void	setEmptyKeyStatusCode(String emptyKeyStatusCode)

Methods inherited from class org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory

getPublisher, setApplicationEventPublisher

Methods inherited from class org.springframework.cloud.gateway.support.AbstractConfigurable

getConfigClass, newConfig, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.gateway.filter.factory.GatewayFilterFactory

apply, apply, apply, getConfigClass, name, newConfig

Methods inherited from interface org.springframework.cloud.gateway.support.ShortcutConfigurable

shortcutFieldOrder, shortcutFieldPrefix, shortcutType

Field Detail

KEY_RESOLVER_KEY

public static final String KEY_RESOLVER_KEY

Key-Resolver key.

See Also:

Constant Field Values

Constructor Detail

RequestRateLimiterGatewayFilterFactory

public RequestRateLimiterGatewayFilterFactory(RateLimiter defaultRateLimiter,
                                              KeyResolver defaultKeyResolver)

Method Detail

getDefaultKeyResolver

public KeyResolver getDefaultKeyResolver()

getDefaultRateLimiter

public RateLimiter getDefaultRateLimiter()

isDenyEmptyKey

public boolean isDenyEmptyKey()

setDenyEmptyKey

public void setDenyEmptyKey(boolean denyEmptyKey)

getEmptyKeyStatusCode

public String getEmptyKeyStatusCode()

setEmptyKeyStatusCode

public void setEmptyKeyStatusCode(String emptyKeyStatusCode)

apply

public GatewayFilter apply(RequestRateLimiterGatewayFilterFactory.Config config)