@ConfigurationProperties(value="spring.cloud.gateway.redis-rate-limiter") public class RedisRateLimiter extends AbstractRateLimiter<RedisRateLimiter.Config> implements org.springframework.context.ApplicationContextAware
Modifier and Type | Class and Description |
---|---|
static class |
RedisRateLimiter.Config |
RateLimiter.Response
Modifier and Type | Field and Description |
---|---|
static String |
BURST_CAPACITY_HEADER
Burst Capacity Header name.
|
static String |
BURST_CAPACITY_KEY
Deprecated.
|
static String |
CONFIGURATION_PROPERTY_NAME
Redis Rate Limiter property name.
|
static String |
REDIS_SCRIPT_NAME
Redis Script name.
|
static String |
REMAINING_HEADER
Remaining Rate Limit header name.
|
static String |
REPLENISH_RATE_HEADER
Replenish Rate Limit header name.
|
static String |
REPLENISH_RATE_KEY
Deprecated.
|
Constructor and Description |
---|
RedisRateLimiter(int defaultReplenishRate,
int defaultBurstCapacity) |
RedisRateLimiter(org.springframework.data.redis.core.ReactiveRedisTemplate<String,String> redisTemplate,
org.springframework.data.redis.core.script.RedisScript<List<Long>> script,
org.springframework.validation.Validator validator) |
Modifier and Type | Method and Description |
---|---|
String |
getBurstCapacityHeader() |
Map<String,String> |
getHeaders(RedisRateLimiter.Config config,
Long tokensLeft) |
String |
getRemainingHeader() |
String |
getReplenishRateHeader() |
reactor.core.publisher.Mono<RateLimiter.Response> |
isAllowed(String routeId,
String id)
This uses a basic token bucket algorithm and relies on the fact that Redis scripts
execute atomically.
|
boolean |
isIncludeHeaders() |
void |
setApplicationContext(org.springframework.context.ApplicationContext context) |
void |
setBurstCapacityHeader(String burstCapacityHeader) |
void |
setIncludeHeaders(boolean includeHeaders) |
void |
setRemainingHeader(String remainingHeader) |
void |
setReplenishRateHeader(String replenishRateHeader) |
getConfigurationPropertyName, getValidator, onApplicationEvent, setValidator, toString
getConfig
getConfigClass, newConfig
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getConfig
getConfigClass, newConfig
@Deprecated public static final String REPLENISH_RATE_KEY
RedisRateLimiter.Config.replenishRate
@Deprecated public static final String BURST_CAPACITY_KEY
RedisRateLimiter.Config.burstCapacity
public static final String CONFIGURATION_PROPERTY_NAME
public static final String REDIS_SCRIPT_NAME
public static final String REMAINING_HEADER
public static final String REPLENISH_RATE_HEADER
public static final String BURST_CAPACITY_HEADER
public RedisRateLimiter(org.springframework.data.redis.core.ReactiveRedisTemplate<String,String> redisTemplate, org.springframework.data.redis.core.script.RedisScript<List<Long>> script, org.springframework.validation.Validator validator)
public RedisRateLimiter(int defaultReplenishRate, int defaultBurstCapacity)
public boolean isIncludeHeaders()
public void setIncludeHeaders(boolean includeHeaders)
public String getRemainingHeader()
public void setRemainingHeader(String remainingHeader)
public String getReplenishRateHeader()
public void setReplenishRateHeader(String replenishRateHeader)
public String getBurstCapacityHeader()
public void setBurstCapacityHeader(String burstCapacityHeader)
public void setApplicationContext(org.springframework.context.ApplicationContext context) throws org.springframework.beans.BeansException
setApplicationContext
in interface org.springframework.context.ApplicationContextAware
org.springframework.beans.BeansException
public reactor.core.publisher.Mono<RateLimiter.Response> isAllowed(String routeId, String id)
isAllowed
in interface RateLimiter<RedisRateLimiter.Config>
@NotNull public Map<String,String> getHeaders(RedisRateLimiter.Config config, Long tokensLeft)
Copyright © 2020 Pivotal Software, Inc.. All rights reserved.