Index
All Classes and Interfaces|All Packages|Serialized Form
B
- bucket(String) - Method in class dev.voidframework.bucket4j.BucketTokenRegistry
-
Returns a managed Bucket or create a new one.
- bucket(String, String) - Method in class dev.voidframework.bucket4j.BucketTokenRegistry
-
Returns a managed Bucket or create a new one from the given configuration path.
- Bucket4JModule - Class in dev.voidframework.bucket4j.module
-
Bucket4J module.
- Bucket4JModule(Config) - Constructor for class dev.voidframework.bucket4j.module.Bucket4JModule
-
Build a new instance.
- BucketDoesNotExist(String) - Constructor for exception dev.voidframework.bucket4j.exception.BucketTokenException.BucketDoesNotExist
-
Build a new instance.
- bucketOrDie(String) - Method in class dev.voidframework.bucket4j.BucketTokenRegistry
-
Returns a managed Bucket or throw an exception if not exist.
- BucketToken - Annotation Interface in dev.voidframework.bucket4j.annotation
-
Annotation indicating that the current annotated method or all methods of the annotated class are protected with "Token-bucket" rate-limiting algorithm.
- BucketTokenException - Exception in dev.voidframework.bucket4j.exception
-
All exceptions thrown by "bucket-token" (Bucket4J) module are subclasses of
BucketTokenException. - BucketTokenException(String) - Constructor for exception dev.voidframework.bucket4j.exception.BucketTokenException
-
Build a new instance.
- BucketTokenException(String, Throwable) - Constructor for exception dev.voidframework.bucket4j.exception.BucketTokenException
-
Build a new instance.
- BucketTokenException.BucketDoesNotExist - Exception in dev.voidframework.bucket4j.exception
-
Exception indicates that requested Bucket does not exist.
- BucketTokenException.NoEnoughTokensAvailable - Exception in dev.voidframework.bucket4j.exception
-
Exception indicates that Bucket does not have enough tokens to enter protected method.
- BucketTokenException.UnknownRefillStrategy - Exception in dev.voidframework.bucket4j.exception
-
Exception indicates that specified refill strategy is unknown.
- BucketTokenInterceptor - Class in dev.voidframework.bucket4j.module
-
Intercepts method calls to apply "bucket-token" algorithm.
- BucketTokenInterceptor(BucketTokenRegistry) - Constructor for class dev.voidframework.bucket4j.module.BucketTokenInterceptor
-
Build a new instance.
- BucketTokenRegistry - Class in dev.voidframework.bucket4j
-
This is a factory to create Bucket instances which stores all Bucket instances in a registry.
- BucketTokenRegistry(Config) - Constructor for class dev.voidframework.bucket4j.BucketTokenRegistry
-
Build a new instance.
- BucketTokenRegistry(Config, Map<String, Bucket>) - Constructor for class dev.voidframework.bucket4j.BucketTokenRegistry
-
Build a new instance.
C
- configure() - Method in class dev.voidframework.bucket4j.module.Bucket4JModule
D
- dev.voidframework.bucket4j - package dev.voidframework.bucket4j
- dev.voidframework.bucket4j.annotation - package dev.voidframework.bucket4j.annotation
- dev.voidframework.bucket4j.exception - package dev.voidframework.bucket4j.exception
- dev.voidframework.bucket4j.module - package dev.voidframework.bucket4j.module
F
- fallbackMethod() - Element in annotation interface dev.voidframework.bucket4j.annotation.BucketToken
-
Name of the fallback method to use when "Token-bucket" rate-limiting algorithm block access to the protected method.
G
- getAllBuckets() - Method in class dev.voidframework.bucket4j.BucketTokenRegistry
-
Returns all managed Bucket instances.
- getBucketName() - Method in exception dev.voidframework.bucket4j.exception.BucketTokenException.NoEnoughTokensAvailable
-
Gets the bucket name.
I
- invoke(MethodInvocation) - Method in class dev.voidframework.bucket4j.module.BucketTokenInterceptor
N
- NoEnoughTokensAvailable(String) - Constructor for exception dev.voidframework.bucket4j.exception.BucketTokenException.NoEnoughTokensAvailable
-
Build a new instance.
P
- priority() - Method in class dev.voidframework.bucket4j.module.Bucket4JModule
T
- tokenToConsume() - Element in annotation interface dev.voidframework.bucket4j.annotation.BucketToken
-
Number of token to consume to execute protected method.
U
- UnknownRefillStrategy(String) - Constructor for exception dev.voidframework.bucket4j.exception.BucketTokenException.UnknownRefillStrategy
-
Build a new instance.
V
- value() - Element in annotation interface dev.voidframework.bucket4j.annotation.BucketToken
-
Name of the bucket to be used.
All Classes and Interfaces|All Packages|Serialized Form