Bucket (bucket4j-core 6.2.0 API)

All Known Subinterfaces:

LocalBucket

All Known Implementing Classes:

AbstractBucket, GridBucket, LockFreeBucket, SynchronizedBucket
```
public interface Bucket
```
Performs rate limiting using algorithm based on top of ideas of Token Bucket.
Use following links for further details:
- Basic example of usage
- Advanced examples of usage

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addTokens(long tokensToAdd)` Add `tokensToAdd` to bucket.
`AsyncBucket`	`asAsync()` Returns asynchronous view of this bucket.
`AsyncScheduledBucket`	`asAsyncScheduler()` Returns asynchronous view of this bucket that allows to use bucket as async scheduler.
`BlockingBucket`	`asScheduler()` Returns the `BlockingBucket` view of this bucket, that provides operations which are able to block caller thread.
`VerboseBucket`	`asVerbose()` Returns the verbose view of this bucket.
`long`	`consumeIgnoringRateLimits(long tokens)` Consumes `tokens` from bucket ignoring all limits.
`BucketState`	`createSnapshot()` Creates the copy of internal state.
`EstimationProbe`	`estimateAbilityToConsume(long numTokens)` Estimates ability to consume a specified number of tokens.
`void`	`forceAddTokens(long tokensToAdd)` Add `tokensToAdd` to bucket.
`long`	`getAvailableTokens()` Returns amount of available tokens in this bucket.
`boolean`	`isAsyncModeSupported()` Describes whether or not this bucket supports asynchronous mode.
`void`	`replaceConfiguration(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)` Replaces configuration of this bucket.
`Bucket`	`toListenable(BucketListener listener)` Returns new copy of this bucket instance decorated by `listener`.
`boolean`	`tryConsume(long numTokens)` Tries to consume a specified number of tokens from this bucket.
`ConsumptionProbe`	`tryConsumeAndReturnRemaining(long numTokens)` Tries to consume a specified number of tokens from this bucket.
`long`	`tryConsumeAsMuchAsPossible()` Tries to consume as much tokens from this bucket as available at the moment of invocation.
`long`	`tryConsumeAsMuchAsPossible(long limit)` Tries to consume as much tokens from bucket as available in the bucket at the moment of invocation, but tokens which should be consumed is limited by `limit`.

- Method Detail
  - asScheduler
```
BlockingBucket asScheduler()
```
    Returns the BlockingBucket view of this bucket, that provides operations which are able to block caller thread.
    
    Returns:
    
    the view to bucket that can be used as scheduler
  - asVerbose
```
VerboseBucket asVerbose()
```
    Returns the verbose view of this bucket.
  - isAsyncModeSupported
```
boolean isAsyncModeSupported()
```
    Describes whether or not this bucket supports asynchronous mode.
    If asynchronous mode is not supported any attempt to call asAsync() will fail with UnsupportedOperationException
    
    Returns:
    
    true if this extension supports asynchronous mode.
  - asAsync
```
AsyncBucket asAsync()
```
    Returns asynchronous view of this bucket.
    If asynchronous mode is not supported by particular extension behind this bucket, then any attempt to call this method will fail with UnsupportedOperationException.
    
    Returns:
    
    Asynchronous view of this bucket.
    
    Throws:
    
    UnsupportedOperationException - if particular extension behind the bucket does not support asynchronous mode.
  - asAsyncScheduler
```
AsyncScheduledBucket asAsyncScheduler()
```
    Returns asynchronous view of this bucket that allows to use bucket as async scheduler.
    If asynchronous mode is not supported by particular extension behind this bucket, then any attempt to call this method will fail with UnsupportedOperationException.
    
    Returns:
    
    Asynchronous view of this bucket that allows to use bucket as async scheduler.
    
    Throws:
    
    UnsupportedOperationException - if particular extension behind the bucket does not support asynchronous mode.
  - tryConsume
```
boolean tryConsume(long numTokens)
```
    Tries to consume a specified number of tokens from this bucket.
    
    Parameters:
    
    numTokens - The number of tokens to consume from the bucket, must be a positive number.
    
    Returns:
    
    true if the tokens were consumed, false otherwise.
  - consumeIgnoringRateLimits
```
long consumeIgnoringRateLimits(long tokens)
```
    Consumes tokens from bucket ignoring all limits. In result of this operation amount of tokens in the bucket could became negative. There are two possible reasons to use this method:
    - An operation with high priority should be executed independently of rate limits, but it should take effect to subsequent operation with bucket.
    - You want to apply custom blocking strategy instead of default which applied on asScheduler().consume(tokens)
    Parameters:
    
    tokens - amount of tokens that should be consumed from bucket.
    
    Returns:
    the amount of rate limit violation in nanoseconds calculated in following way:
    
    zero if rate limit was not violated. For example bucket had 5 tokens before invocation of consumeIgnoringRateLimits(2), after invocation there are 3 tokens remain in the bucket, since limits were not violated zero returned as result.
    
    Positive value which describes the amount of rate limit violation in nanoseconds. For example bucket with limit 10 tokens per 1 second, currently has the 2 tokens available, last refill happen 100 milliseconds ago, and consumeIgnoringRateLimits(6) called. 300_000_000 will be returned as result and available tokens in the bucket will became -3, and any variation of tryConsume... will not be successful for 400 milliseconds(time required to refill amount of available tokens until 1).
  - tryConsumeAndReturnRemaining
```
ConsumptionProbe tryConsumeAndReturnRemaining(long numTokens)
```
    Tries to consume a specified number of tokens from this bucket.
    
    Parameters:
    
    numTokens - The number of tokens to consume from the bucket, must be a positive number.
    
    Returns:
    
    ConsumptionProbe which describes both result of consumption and tokens remaining in the bucket after consumption.
  - estimateAbilityToConsume
```
EstimationProbe estimateAbilityToConsume(long numTokens)
```
    Estimates ability to consume a specified number of tokens.
    
    Parameters:
    
    numTokens - The number of tokens to consume, must be a positive number.
    
    Returns:
    
    EstimationProbe which describes the ability to consume.
  - tryConsumeAsMuchAsPossible
```
long tryConsumeAsMuchAsPossible()
```
    Tries to consume as much tokens from this bucket as available at the moment of invocation.
    
    Returns:
    
    number of tokens which has been consumed, or zero if was consumed nothing.
  - tryConsumeAsMuchAsPossible
```
long tryConsumeAsMuchAsPossible(long limit)
```
    Tries to consume as much tokens from bucket as available in the bucket at the moment of invocation, but tokens which should be consumed is limited by limit.
    
    Parameters:
    
    limit - maximum number of tokens to consume, should be positive.
    
    Returns:
    
    number of tokens which has been consumed, or zero if was consumed nothing.
  - addTokens
```
void addTokens(long tokensToAdd)
```
    Add tokensToAdd to bucket. Resulted count of tokens are calculated by following formula:
```
newTokens = Math.min(capacity, currentTokens + tokensToAdd)
```
    in other words resulted number of tokens never exceeds capacity independent of tokensToAdd.
    Example of usage
    The "compensating transaction" is one of obvious use case, when any piece of code consumed tokens from bucket, tried to do something and failed, the "addTokens" will be helpful to return tokens back to bucket:
```
      Bucket wallet;
      ...
      if(wallet.tryConsume(50)) {// get 50 cents from wallet
         try {
             buyCocaCola();
         } catch(NoCocaColaException e) {
             // return money to wallet
             wallet.addTokens(50);
         }
      };
 
```
    Parameters:
    
    tokensToAdd - number of tokens to add
  - forceAddTokens
```
void forceAddTokens(long tokensToAdd)
```
    Add tokensToAdd to bucket. In opposite to addTokens(long) usage of this method can lead to overflow bucket capacity.
    Example of usage
    The "compensating transaction" is one of obvious use case, when any piece of code consumed tokens from bucket, tried to do something and failed, the "addTokens" will be helpful to return tokens back to bucket:
```
      Bucket wallet;
      ...
      if(wallet.tryConsume(50)) {// get 50 cents from wallet
         try {
             buyCocaCola();
         } catch(NoCocaColaException e) {
             // return money to wallet
             wallet.addTokens(50);
         }
      };
 
```
    Parameters:
    
    tokensToAdd - number of tokens to add
  - getAvailableTokens
```
long getAvailableTokens()
```
    Returns amount of available tokens in this bucket.
    This method designed to be used only for monitoring and testing, you should never use this method for business cases, because available tokens can be changed by concurrent transactions for case of multithreaded/multi-process environment.
    
    Returns:
    
    amount of available tokens
  - replaceConfiguration
```
void replaceConfiguration(BucketConfiguration newConfiguration,
                          TokensInheritanceStrategy tokensInheritanceStrategy)
```
    Replaces configuration of this bucket.
    The first hard problem of configuration replacement is making decision how to propagate available tokens from bucket with previous configuration to bucket with new configuration. If you don't care about previous bucket state then use TokensInheritanceStrategy.RESET. But it becomes to a tricky problem when we expect that previous consumption(that has not been compensated by refill yet) should take effect to the bucket with new configuration. In this case you need to make a choice between TokensInheritanceStrategy.PROPORTIONALLY and TokensInheritanceStrategy.AS_IS, read documentation about both with strong attention.
    There is another problem when you are choosing TokensInheritanceStrategy.PROPORTIONALLY and TokensInheritanceStrategy.AS_IS and bucket has more then one bandwidth. For example how does replaceConfiguration implementation should bind bandwidths to each other in the following example?
```
 
     Bucket bucket = Bucket4j.builder()
                       .addLimit(Bandwidth.simple(10, Duration.ofSeconds(1)))
                       .addLimit(Bandwidth.simple(10000, Duration.ofHours(1)))
                       .build();
     ...
     BucketConfiguration newConfiguration = Bucket4j.configurationBuilder()
                                               .addLimit(Bandwidth.simple(5000, Duration.ofHours(1)))
                                               .addLimit(Bandwidth.simple(100, Duration.ofSeconds(10)))
                                               .build();
     bucket.replaceConfiguration(newConfiguration, TokensInheritanceStrategy.AS_IS);
 
 
```
    It is obviously that simple strategy - copying tokens by bandwidth index will not work well in this case, because of it highly depends from order. Instead of inventing the backward maggic Bucket4j provides to you ability to deap controll of this process by specifying identifiers for bandwidth, so in case of multiple bandwidth configuratoin replacement code can copy available tokens by bandwidth ID. So it is better to rewrite code above as following:
```
 
 Bucket bucket = Bucket4j.builder()
                            .addLimit(Bandwidth.simple(10, Duration.ofSeconds(1)).withId("technical-limit"))
                            .addLimit(Bandwidth.simple(10000, Duration.ofHours(1)).withId("business-limit"))
                            .build();
 ...
 BucketConfiguration newConfiguration = Bucket4j.configurationBuilder()
                            .addLimit(Bandwidth.simple(5000, Duration.ofHours(1)).withId("business-limit"))
                            .addLimit(Bandwidth.simple(100, Duration.ofSeconds(10)).withId("technical-limit"))
                            .build();
 bucket.replaceConfiguration(newConfiguration, TokensInheritanceStrategy.AS_IS);
 
 
```
    There are following rules for bandwidth identifiers:
    - By default bandwidth has null identifier.
    - null value of identifier equals to another null value if and only if there is only one bandwidth with null identifier.
    - If identifier for bandwidth is specified then it must has unique in the bucket. Bucket does not allow to create several bandwidth with same ID.
    - TokensInheritanceStrategy.RESET strategy will be applied for tokens migration during config replacement for bandwidth which has no bound bandwidth with same ID in previous configuration, idependently of strategy that was requested.
    Parameters:
    
    newConfiguration - the new configuration
    
    tokensInheritanceStrategy - specifies the rules for inheritance of available tokens
  - createSnapshot
```
BucketState createSnapshot()
```
    Creates the copy of internal state.
    This method is designed to be used only for monitoring and testing, you should never use this method for business cases.
    
    Returns:
    
    snapshot of internal state
  - toListenable
```
Bucket toListenable(BucketListener listener)
```
    Returns new copy of this bucket instance decorated by listener. The created bucket will share same tokens with source bucket and vice versa. See javadocs for BucketListener in order to understand semantic of listener.
    
    Parameters:
    
    listener - the listener of bucket events.
    
    Returns:
    
    new bucket instance decorated by listener

Interface Bucket

Method Summary

Method Detail

asScheduler

asVerbose

isAsyncModeSupported

asAsync

asAsyncScheduler

tryConsume

consumeIgnoringRateLimits

tryConsumeAndReturnRemaining

estimateAbilityToConsume

tryConsumeAsMuchAsPossible

tryConsumeAsMuchAsPossible

addTokens

Example of usage

forceAddTokens

Example of usage

getAvailableTokens

replaceConfiguration

createSnapshot

toListenable