org.springframework.cloud.gateway.sample

Class ThrottleGatewayFilter

java.lang.Object

org.springframework.cloud.gateway.sample.ThrottleGatewayFilter

All Implemented Interfaces:

org.springframework.cloud.gateway.filter.GatewayFilter, org.springframework.cloud.gateway.support.ShortcutConfigurable

public class ThrottleGatewayFilter
extends Object
implements org.springframework.cloud.gateway.filter.GatewayFilter

Sample throttling filter. See https://github.com/bbeck/token-bucket

Nested Class Summary

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

org.springframework.cloud.gateway.support.ShortcutConfigurable.ShortcutType

Field Summary

Fields inherited from interface org.springframework.cloud.gateway.filter.GatewayFilter

NAME_KEY, VALUE_KEY

Constructor Summary

Constructors

Constructor and Description
ThrottleGatewayFilter()

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Void>	filter(org.springframework.web.server.ServerWebExchange exchange, org.springframework.cloud.gateway.filter.GatewayFilterChain chain)
int	getCapacity()
int	getRefillPeriod()
int	getRefillTokens()
TimeUnit	getRefillUnit()
ThrottleGatewayFilter	setCapacity(int capacity)
ThrottleGatewayFilter	setRefillPeriod(int refillPeriod)
ThrottleGatewayFilter	setRefillTokens(int refillTokens)
ThrottleGatewayFilter	setRefillUnit(TimeUnit refillUnit)

Methods inherited from class java.lang.Object

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

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

getValue, normalizeKey, shortcutFieldOrder, shortcutFieldPrefix, shortcutType

Constructor Detail

ThrottleGatewayFilter

public ThrottleGatewayFilter()

Method Detail

getCapacity

public int getCapacity()

setCapacity

public ThrottleGatewayFilter setCapacity(int capacity)

getRefillTokens

public int getRefillTokens()

setRefillTokens

public ThrottleGatewayFilter setRefillTokens(int refillTokens)

getRefillPeriod

public int getRefillPeriod()

setRefillPeriod

public ThrottleGatewayFilter setRefillPeriod(int refillPeriod)

getRefillUnit

public TimeUnit getRefillUnit()

setRefillUnit

public ThrottleGatewayFilter setRefillUnit(TimeUnit refillUnit)

filter

public reactor.core.publisher.Mono<Void> filter(org.springframework.web.server.ServerWebExchange exchange,
                                                org.springframework.cloud.gateway.filter.GatewayFilterChain chain)

Specified by:

filter in interface org.springframework.cloud.gateway.filter.GatewayFilter