Index (bucket4j-spring-boot-starter-context 0.13.0 API)

A B C D E F G H I J K M N O P R S V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addFilterConfiguration(Bucket4JConfiguration) - Method in class com.giffing.bucket4j.spring.boot.starter.context.Bucket4jConfigurationHolder
addParam(String, Object) - Method in class com.giffing.bucket4j.spring.boot.starter.context.ExpressionParams
addParams(Map<String, Object>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.ExpressionParams
addPostRateLimitCheck(PostRateLimitCheck<R, P>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
addRateLimitCheck(RateLimitCheck<R>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
ALL - Enum constant in enum class 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 transferred.
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
Bucket4JConfigurationPredicateNameValidator - Class in com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations
Bucket4JConfigurationPredicateNameValidator(List<ExecutePredicate<?>>) - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.Bucket4JConfigurationPredicateNameValidator

C

cacheKey() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.RateLimiting: The cache key which is mayby modified the e.g. the method name RateLimiting.ratePerMethod()
com.giffing.bucket4j.spring.boot.starter.context - package com.giffing.bucket4j.spring.boot.starter.context
com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations - package com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations
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
com.giffing.bucket4j.spring.boot.starter.context.qualifier - package com.giffing.bucket4j.spring.boot.starter.context.qualifier
Condition<R> - Interface in com.giffing.bucket4j.spring.boot.starter.context: This condition is used to skip or execute a rate limit check.
CONSUMED_COUNTER - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType: Count token consumption.
consumeNotNullValues(RateLimit) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
copy() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit

D

DELAYED_COUNTER - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType: Count delayed tasks was submit to java.util.concurrent.ScheduledExecutorService because of wait for tokens refill in result of interaction with SchedulingBucket
DurationChronoUnitValidator - Class in com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations: This validator is used to check if a ChronoUnit is accepted by the Duration.of() method.
DurationChronoUnitValidator() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.DurationChronoUnitValidator

E

evaluate(ExpressionParams<R>) - Method in interface com.giffing.bucket4j.spring.boot.starter.context.Condition
executeCondition() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.RateLimiting: An optional execute condition which overrides the execute condition from the property file
ExecutePredicate<T> - Class in com.giffing.bucket4j.spring.boot.starter.context: The ExecutePredicate is used to conditionally execute a rate limit.
ExecutePredicate() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.ExecutePredicate
ExecutePredicateDefinition - Class in com.giffing.bucket4j.spring.boot.starter.context
ExecutePredicateDefinition(String) - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.ExecutePredicateDefinition
ExpressionParams<R> - Class in com.giffing.bucket4j.spring.boot.starter.context: Parameter information for the evaluation of a Spring Expression
ExpressionParams() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.ExpressionParams

F

fallbackMethodName() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.RateLimiting: An optional fall back method which is executed when the rate limit occurs instead of throwing the RateLimitException.
FilterConfiguration<R,P> - Class in com.giffing.bucket4j.spring.boot.starter.context.properties: This class is the main configuration class which is used to build the servlet|webflux|gateway request filter
FilterConfiguration() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.properties.FilterConfiguration
FilterMethod - Enum Class in com.giffing.bucket4j.spring.boot.starter.context: The filter method defines which type of should be used.
FIRST - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.RateLimitConditionMatchingStrategy: Only the first matching rate limit will be evaluated

G

Gateway - Annotation Interface in com.giffing.bucket4j.spring.boot.starter.context.qualifier
GATEWAY - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.FilterMethod: Spring Cloud Gateway GlobalFilter
getBucket4JVersionNumber() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
getPropertyPrefix() - Static method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties
GREEDY - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.RefillSpeed: Greedily regenerates tokens.
groups() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.ValidBandWidthIds
groups() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.ValidDurationChronoUnit
groups() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.ValidPredicateNames

H

handle(MetricType, String, long, List<MetricTagResult>) - Method in interface com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricHandler

I

IgnoreRateLimiting - Annotation Interface in com.giffing.bucket4j.spring.boot.starter.context: Ignores the rate limiting annotation for a class or method
init(Map<String, String>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.ExecutePredicate: Initialize the ExecutionPredicate with the provided property configuration.
INTERRUPTED_COUNTER - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType: Count interrupted threads during the wait of tokens refill in result of interaction with Bucket4js BlockingBucket
INTERVAL - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.RefillSpeed: Regenerates tokens in an interval manner.
isUrlValid() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
isValid(Bucket4JConfiguration, ConstraintValidatorContext) - Method in class com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.Bucket4JConfigurationPredicateNameValidator
isValid(RateLimit, ConstraintValidatorContext) - Method in class com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.RateLimitBandWidthIdsValidator
isValid(ChronoUnit, ConstraintValidatorContext) - Method in class com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.DurationChronoUnitValidator
isValidFilterIds() - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties

J

JMS - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.FilterMethod: See GitHub - Extend FilterMehod enum for custom filters (like JMS) #216

K

key(ExpressionParams<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

message() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.ValidBandWidthIds
message() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.ValidDurationChronoUnit
message() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.ValidPredicateNames
MethodProperties - Class in com.giffing.bucket4j.spring.boot.starter.context.properties
MethodProperties() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.properties.MethodProperties
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(List<MetricTag>) - 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 Class in com.giffing.bucket4j.spring.boot.starter.context.metrics

N

name() - Method in class com.giffing.bucket4j.spring.boot.starter.context.ExecutePredicate: The unique name of the ExecutionPredicate which can be used in the property configuration.
name() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.RateLimiting

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

PARKED_COUNTER - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType: Count parked threads which wait of tokens refill in result of interaction with Bucket4js BlockingBucket.
parseConfig(Map<String, String>) - Method in class com.giffing.bucket4j.spring.boot.starter.context.ExecutePredicate
parseSimpleConfig(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.ExecutePredicate
payload() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.ValidBandWidthIds
payload() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.ValidDurationChronoUnit
payload() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.ValidPredicateNames
PostRateLimitCheck<R,P> - Interface in com.giffing.bucket4j.spring.boot.starter.context: Used to check if the rate limit should be performed independently from the servlet|webflux|gateway request filter
PROPERTY_PREFIX - Static variable in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JBootProperties

R

rateLimit(ExpressionParams<R>, RateLimit) - Method in interface com.giffing.bucket4j.spring.boot.starter.context.RateLimitCheck
rateLimit(R, P) - Method in interface com.giffing.bucket4j.spring.boot.starter.context.PostRateLimitCheck
RateLimit - Class in com.giffing.bucket4j.spring.boot.starter.context.properties
RateLimit() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.properties.RateLimit
RateLimitBandWidthIdsValidator - Class in com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations
RateLimitBandWidthIdsValidator() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations.RateLimitBandWidthIdsValidator
RateLimitCheck<R> - Interface in com.giffing.bucket4j.spring.boot.starter.context: Used to check if the rate limit should be performed independently of the servlet|webflux|gateway request filter
RateLimitConditionMatchingStrategy - Enum Class in com.giffing.bucket4j.spring.boot.starter.context: Bad name :-)
RateLimitException - Exception in com.giffing.bucket4j.spring.boot.starter.context: This exception is thrown when the rate limit is reached in the context of a method level when using the RateLimiting annotation.
RateLimitException() - Constructor for exception com.giffing.bucket4j.spring.boot.starter.context.RateLimitException
RateLimiting - Annotation Interface in com.giffing.bucket4j.spring.boot.starter.context
RateLimitResult - Class in com.giffing.bucket4j.spring.boot.starter.context: This data class holds the information of a rate limit check.
RateLimitResult() - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.RateLimitResult
RateLimitResultWrapper - Class in com.giffing.bucket4j.spring.boot.starter.context: A wrapper class to distinguish the RateLimiting result between a synchronous and asynchronous call.
RateLimitResultWrapper(RateLimitResult) - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.RateLimitResultWrapper
RateLimitResultWrapper(CompletableFuture<RateLimitResult>) - Constructor for class com.giffing.bucket4j.spring.boot.starter.context.RateLimitResultWrapper
ratePerMethod() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.RateLimiting: The Name of the annotated method will be added to the cache key.
RefillSpeed - Enum Class in com.giffing.bucket4j.spring.boot.starter.context
REJECTED_COUNTER - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType: Count whenever consumption request for tokens is rejected.

S

Servlet - Annotation Interface in com.giffing.bucket4j.spring.boot.starter.context.qualifier
SERVLET - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.FilterMethod: Servlet Request Filter
setId(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.BandWidth
setId(String) - Method in class com.giffing.bucket4j.spring.boot.starter.context.properties.Bucket4JConfiguration
SIMPLE_CONFIG_KEY - Static variable in class com.giffing.bucket4j.spring.boot.starter.context.ExecutePredicateDefinition
skipCondition() - Element in annotation interface com.giffing.bucket4j.spring.boot.starter.context.RateLimiting: An optional execute condition which overrides the execute condition from the property file

V

ValidBandWidthIds - Annotation Interface in com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations
ValidDurationChronoUnit - Annotation Interface in com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations
ValidPredicateNames - Annotation Interface in com.giffing.bucket4j.spring.boot.starter.context.constraintvalidations
VALUE - Static variable in annotation interface com.giffing.bucket4j.spring.boot.starter.context.qualifier.Gateway
VALUE - Static variable in annotation interface com.giffing.bucket4j.spring.boot.starter.context.qualifier.Servlet
VALUE - Static variable in annotation interface com.giffing.bucket4j.spring.boot.starter.context.qualifier.Webflux
valueOf(String) - Static method in enum class com.giffing.bucket4j.spring.boot.starter.context.FilterMethod: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.giffing.bucket4j.spring.boot.starter.context.RateLimitConditionMatchingStrategy: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.giffing.bucket4j.spring.boot.starter.context.RefillSpeed: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.giffing.bucket4j.spring.boot.starter.context.FilterMethod: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.giffing.bucket4j.spring.boot.starter.context.metrics.MetricType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.giffing.bucket4j.spring.boot.starter.context.RateLimitConditionMatchingStrategy: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.giffing.bucket4j.spring.boot.starter.context.RefillSpeed: Returns an array containing the constants of this enum class, in the order they are declared.

W

Webflux - Annotation Interface in com.giffing.bucket4j.spring.boot.starter.context.qualifier
WEBFLUX - Enum constant in enum class com.giffing.bucket4j.spring.boot.starter.context.FilterMethod: Spring Boots 5 async WebFilter

A B C D E F G H I J K M N O P R S V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form