Index
All Classes|All Packages
A
- addFilterConfiguration(Bucket4JConfiguration) - Method in class com.giffing.bucket4j.spring.boot.starter.context.Bucket4jConfigurationHolder
- ALL - com.giffing.bucket4j.spring.boot.starter.context.RateLimitConditionMatchingStrategy
-
All rate limits should be evaluated
B
- BandWidth - Class in com.giffing.bucket4j.spring.boot.starter.context.properties
-
Configures the rate of data which should be transfered
- BandWidth() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- Bucket4JBootProperties - Class in com.giffing.bucket4j.spring.boot.starter.context.properties
-
Holds all the relevant starter properties which can be configured with Spring Boots application.properties / application.yml configuration files.
- Bucket4JBootProperties() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties
- Bucket4JConfiguration - Class in com.giffing.bucket4j.spring.boot.starter.context.properties
- Bucket4JConfiguration() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- Bucket4jConfigurationHolder - Class in com.giffing.bucket4j.spring.boot.starter.context
- Bucket4jConfigurationHolder() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.Bucket4jConfigurationHolder
C
- com.giffing.bucket4j.spring.boot.starter.context - package com.giffing.bucket4j.spring.boot.starter.context
- com.giffing.bucket4j.spring.boot.starter.context.metrics - package com.giffing.bucket4j.spring.boot.starter.context.metrics
- com.giffing.bucket4j.spring.boot.starter.context.properties - package com.giffing.bucket4j.spring.boot.starter.context.properties
- Condition<R> - Interface in com.giffing.bucket4j.spring.boot.starter.context
-
The skip condition is used to skip or execute a rate limit check.
- CONSUMED_COUNTER - com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType
- ConsumptionProbeHolder - Class in com.giffing.bucket4j.spring.boot.starter.context
- ConsumptionProbeHolder(ConsumptionProbe) - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.ConsumptionProbeHolder
- ConsumptionProbeHolder(CompletableFuture<ConsumptionProbe>) - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.ConsumptionProbeHolder
D
- DEFAULT - com.giffing.bucket4j.spring.boot.starter.context.FilterKeyType
-
Deprecated.No special filter is applied.
E
- evalute(R) - Method in interface com.giffing.bucket4j.spring.boot.starter.context.Condition
- EXPRESSION - com.giffing.bucket4j.spring.boot.starter.context.FilterKeyType
-
Deprecated.The expression type is used to define an individual expression based on the Spring Expression Language.
F
- FilterConfiguration<R> - Class in com.giffing.bucket4j.spring.boot.starter.context.properties
-
This class is the main configuration class which is used to build the Servlet Filter or ZuulFilter.
- FilterConfiguration() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- FilterKeyType - Enum in com.giffing.bucket4j.spring.boot.starter.context
-
Deprecated.
- FilterMethod - Enum in com.giffing.bucket4j.spring.boot.starter.context
-
The filter method defines which type of should be used.
- FIRST - com.giffing.bucket4j.spring.boot.starter.context.RateLimitConditionMatchingStrategy
-
Only the first matching rate limit will be evaluated
G
- GATEWAY - com.giffing.bucket4j.spring.boot.starter.context.FilterMethod
-
Spring Cloud Gateway GlobalFilter
- getBandwidths() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
- getCacheName() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- getCapacity() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- getConsumed() - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
- getConsumptionProbe() - Method in class com.giffing.bucket4j.spring.boot.starter.context.ConsumptionProbeHolder
- getConsumptionProbeCompletableFuture() - Method in class com.giffing.bucket4j.spring.boot.starter.context.ConsumptionProbeHolder
- getEnabled() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties
- getExecuteCondition() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
- getExpression() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.MetricTag
- getExpression() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
-
SPEL expression to dynamic evaluate filter key
- getFilterConfiguration() - Method in class com.giffing.bucket4j.spring.boot.starter.context.Bucket4jConfigurationHolder
- getFilterKeyType() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
- getFilterMethod() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- getFilterOrder() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- getFilters() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties
- getFixedRefillInterval() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- getFixedRefillIntervalUnit() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- getHttpResponseBody() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- getHttpResponseBody() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- getInterrupted() - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
- getKey() - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricTagResult
- getKey() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.MetricTag
- getMetrics() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- getMetrics() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- getName() - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
- getOrder() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- getParkedNanos() - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
- getPropertyPrefix() - Static method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties
- getRateLimitChecks() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- getRateLimits() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- getRejected() - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
- getSkipCondition() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
- getStrategy() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- getStrategy() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- getTags() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Metrics
- getTime() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- getTypes() - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricTagResult
- getTypes() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Metrics
- getTypes() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.MetricTag
- getUnit() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- getUrl() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- getUrl() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- getValue() - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricTagResult
H
- handle(MetricType, String, long, List<MetricTagResult>) - Method in interface com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricHandler
I
- IP - com.giffing.bucket4j.spring.boot.starter.context.FilterKeyType
-
Deprecated.IP based filtering.
- isEnabled() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Metrics
K
- key(R) - Method in interface com.giffing.bucket4j.spring.boot.starter.context.KeyFilter
-
Return the unique Bucket4j storage key.
- KeyFilter<R> - Interface in com.giffing.bucket4j.spring.boot.starter.context
-
Functional interface to retrieve the Bucket4j key.
M
- MetricBucketListener - Class in com.giffing.bucket4j.spring.boot.starter.context.metrics
-
Marker Interface
- MetricBucketListener(String, List<MetricHandler>, List<MetricType>, List<MetricTagResult>) - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
- MetricHandler - Interface in com.giffing.bucket4j.spring.boot.starter.context.metrics
- Metrics - Class in com.giffing.bucket4j.spring.boot.starter.context.properties
- Metrics() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.properties.Metrics
- MetricTag - Class in com.giffing.bucket4j.spring.boot.starter.context.properties
- MetricTag() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.properties.MetricTag
- MetricTagResult - Class in com.giffing.bucket4j.spring.boot.starter.context.metrics
- MetricTagResult(String, String, List<MetricType>) - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricTagResult
- MetricType - Enum in com.giffing.bucket4j.spring.boot.starter.context.metrics
O
- onConsumed(long) - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
- onDelayed(long) - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
- onInterrupted(InterruptedException) - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
- onParked(long) - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
- onRejected(long) - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricBucketListener
P
- PROPERTY_PREFIX - Static variable in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties
R
- rateLimit(R, boolean) - Method in interface com.giffing.bucket4j.spring.boot.starter.context.RateLimitCheck
- RateLimit - Class in com.giffing.bucket4j.spring.boot.starter.context.properties
- RateLimit() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
- RateLimitCheck<R> - Interface in com.giffing.bucket4j.spring.boot.starter.context
-
Used to check if the rate limit should be performed independently from the Servlet Filter or ZuulFilter.
- RateLimitConditionMatchingStrategy - Enum in com.giffing.bucket4j.spring.boot.starter.context
-
Bad name :-) If multiple rate limits configured this strategy decides when to stop the evaluation.
- REJECTED_COUNTER - com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType
S
- SERVLET - com.giffing.bucket4j.spring.boot.starter.context.FilterMethod
-
Servlet Request Filter
- setBandwidths(List<BandWidth>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
- setCacheName(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- setCapacity(long) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- setConsumptionProbe(ConsumptionProbe) - Method in class com.giffing.bucket4j.spring.boot.starter.context.ConsumptionProbeHolder
- setConsumptionProbeCompletableFuture(CompletableFuture<ConsumptionProbe>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.ConsumptionProbeHolder
- setEnabled(boolean) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Metrics
- setEnabled(Boolean) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties
- setExecuteCondition(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
- setExpression(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.MetricTag
- setExpression(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
- setFilterConfiguration(List<Bucket4JConfiguration>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.Bucket4jConfigurationHolder
- setFilterKeyType(FilterKeyType) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
- setFilterMethod(FilterMethod) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- setFilterOrder(int) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- setFilters(List<Bucket4JConfiguration>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties
- setFixedRefillInterval(long) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- setFixedRefillIntervalUnit(ChronoUnit) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- setHttpResponseBody(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- setHttpResponseBody(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- setKey(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricTagResult
- setKey(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.MetricTag
- setMetrics(Metrics) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- setMetrics(Metrics) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- setOrder(int) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- setRateLimitChecks(List<RateLimitCheck<R>>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- setRateLimits(List<RateLimit>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- setSkipCondition(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
- setStrategy(RateLimitConditionMatchingStrategy) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- setStrategy(RateLimitConditionMatchingStrategy) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- setTags(List<MetricTag>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Metrics
- setTime(long) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- setTypes(List<MetricType>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricTagResult
- setTypes(List<MetricType>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Metrics
- setTypes(List<MetricType>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.MetricTag
- setUnit(ChronoUnit) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
- setUrl(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
- setUrl(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
- setValue(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricTagResult
V
- valueOf(String) - Static method in enum com.giffing.bucket4j.spring.boot.starter.context.FilterKeyType
-
Deprecated.Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.giffing.bucket4j.spring.boot.starter.context.FilterMethod
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.giffing.bucket4j.spring.boot.starter.context.RateLimitConditionMatchingStrategy
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.giffing.bucket4j.spring.boot.starter.context.FilterKeyType
-
Deprecated.Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.giffing.bucket4j.spring.boot.starter.context.FilterMethod
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.giffing.bucket4j.spring.boot.starter.context.RateLimitConditionMatchingStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WEBFLUX - com.giffing.bucket4j.spring.boot.starter.context.FilterMethod
-
Spring Boots 5 async WebFilter
Z
- ZUUL - com.giffing.bucket4j.spring.boot.starter.context.FilterMethod
-
ZuulRoute filter
All Classes|All Packages