Module io.github.bucket4j.core

Package io.github.bucket4j.distributed.proxy

Class DefaultBucketProxy

java.lang.Object

io.github.bucket4j.AbstractBucket

io.github.bucket4j.distributed.proxy.DefaultBucketProxy

All Implemented Interfaces:

BlockingBucket, Bucket, BucketProxy, OptimizationController, SchedulingBucket

public class DefaultBucketProxy
extends AbstractBucket
implements BucketProxy, OptimizationController

Field Summary

Fields inherited from class io.github.bucket4j.AbstractBucket

INFINITY_DURATION, UNLIMITED_AMOUNT

Constructor Summary

Constructors

Constructor	Description
DefaultBucketProxy(Supplier<BucketConfiguration> configurationSupplier, CommandExecutor commandExecutor, RecoveryStrategy recoveryStrategy, ImplicitConfigurationReplacement implicitConfigurationReplacement)

Method Summary

Modifier and Type	Method	Description
protected void	addTokensImpl(long tokensToAdd)
protected VerboseResult<Nothing>	addTokensVerboseImpl(long tokensToAdd)
protected long	consumeAsMuchAsPossibleImpl(long limit)
protected VerboseResult<Long>	consumeAsMuchAsPossibleVerboseImpl(long limit)
protected long	consumeIgnoringRateLimitsImpl(long tokensToConsume)
protected VerboseResult<Long>	consumeIgnoringRateLimitsVerboseImpl(long tokensToConsume)
protected EstimationProbe	estimateAbilityToConsumeImpl(long numTokens)
protected VerboseResult<EstimationProbe>	estimateAbilityToConsumeVerboseImpl(long numTokens)
protected void	forceAddTokensImpl(long tokensToAdd)
protected VerboseResult<Nothing>	forceAddTokensVerboseImpl(long tokensToAdd)
long	getAvailableTokens()	Returns amount of available tokens in this bucket.
protected VerboseResult<Long>	getAvailableTokensVerboseImpl()
OptimizationController	getOptimizationController()	Returns optimization controller for this proxy.
protected void	replaceConfigurationImpl(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)
protected VerboseResult<Nothing>	replaceConfigurationVerboseImpl(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)
protected long	reserveAndCalculateTimeToSleepImpl(long tokensToConsume, long waitIfBusyNanosLimit)
void	reset()	Reset all tokens up to maximum capacity.
protected VerboseResult<Nothing>	resetVerboseImpl()
void	syncByCondition(long unsynchronizedTokens, Duration timeSinceLastSync)	Initiates immediate synchronization of local copy of bucket with remote storage in case of both conditions bellow are true: Accumulated amount of locally consumed tokens without external synchronization is greater than or equal to unsynchronizedTokens Time passed since last synchronization with external storage is greater than or equal to timeSinceLastSync
BucketProxy	toListenable(BucketListener listener)	Returns new copy of this bucket instance decorated by listener.
protected ConsumptionProbe	tryConsumeAndReturnRemainingTokensImpl(long tokensToConsume)
protected VerboseResult<ConsumptionProbe>	tryConsumeAndReturnRemainingTokensVerboseImpl(long tokensToConsume)
protected boolean	tryConsumeImpl(long tokensToConsume)
protected VerboseResult<Boolean>	tryConsumeVerboseImpl(long tokensToConsume)

Methods inherited from class io.github.bucket4j.AbstractBucket

addTokens, asBlocking, asScheduler, asVerbose, completedFuture, consume, consume, consumeIgnoringRateLimits, consumeUninterruptibly, estimateAbilityToConsume, failedFuture, forceAddTokens, getListener, replaceConfiguration, tryConsume, tryConsume, tryConsume, tryConsumeAndReturnRemaining, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible, tryConsumeUninterruptibly

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.bucket4j.BlockingBucket

consume, consumeUninterruptibly, tryConsume, tryConsume, tryConsume, tryConsumeUninterruptibly, tryConsumeUninterruptibly, tryConsumeUninterruptibly

Methods inherited from interface io.github.bucket4j.Bucket

addTokens, asBlocking, asScheduler, asVerbose, consumeIgnoringRateLimits, estimateAbilityToConsume, forceAddTokens, replaceConfiguration, tryConsume, tryConsumeAndReturnRemaining, tryConsumeAsMuchAsPossible, tryConsumeAsMuchAsPossible

Methods inherited from interface io.github.bucket4j.distributed.OptimizationController

syncImmediately

Methods inherited from interface io.github.bucket4j.SchedulingBucket

tryConsume

Constructor Detail

DefaultBucketProxy

public DefaultBucketProxy(Supplier<BucketConfiguration> configurationSupplier,
                          CommandExecutor commandExecutor,
                          RecoveryStrategy recoveryStrategy,
                          ImplicitConfigurationReplacement implicitConfigurationReplacement)

Method Detail

toListenable

public BucketProxy toListenable(BucketListener listener)

Description copied from interface: Bucket

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.

Specified by:

toListenable in interface Bucket

Specified by:

toListenable in interface BucketProxy

Parameters:

listener - the listener of bucket events.

Returns:

new bucket instance decorated by listener

getOptimizationController

public OptimizationController getOptimizationController()

Description copied from interface: BucketProxy

Returns optimization controller for this proxy.

This method is actual only if an optimization was applied during bucket construction via RemoteBucketBuilder.withOptimization(Optimization) otherwise returned controller will do nothing.

Specified by:

getOptimizationController in interface BucketProxy

Returns:

optimization controller for this proxy

syncByCondition

public void syncByCondition(long unsynchronizedTokens,
                            Duration timeSinceLastSync)

Description copied from interface: OptimizationController

Initiates immediate synchronization of local copy of bucket with remote storage in case of both conditions bellow are true:

• Accumulated amount of locally consumed tokens without external synchronization is greater than or equal to unsynchronizedTokens
• Time passed since last synchronization with external storage is greater than or equal to timeSinceLastSync

Specified by:

syncByCondition in interface OptimizationController

Parameters:

unsynchronizedTokens - criterion for accumulated amount of unsynchronized tokens

timeSinceLastSync - criterion for time passed since last synchronization

consumeAsMuchAsPossibleImpl

protected long consumeAsMuchAsPossibleImpl(long limit)

Specified by:

consumeAsMuchAsPossibleImpl in class AbstractBucket

tryConsumeImpl

protected boolean tryConsumeImpl(long tokensToConsume)

Specified by:

tryConsumeImpl in class AbstractBucket

tryConsumeAndReturnRemainingTokensImpl

protected ConsumptionProbe tryConsumeAndReturnRemainingTokensImpl(long tokensToConsume)

Specified by:

tryConsumeAndReturnRemainingTokensImpl in class AbstractBucket

estimateAbilityToConsumeImpl

protected EstimationProbe estimateAbilityToConsumeImpl(long numTokens)

Specified by:

estimateAbilityToConsumeImpl in class AbstractBucket

reserveAndCalculateTimeToSleepImpl

protected long reserveAndCalculateTimeToSleepImpl(long tokensToConsume,
                                                  long waitIfBusyNanosLimit)

Specified by:

reserveAndCalculateTimeToSleepImpl in class AbstractBucket

addTokensImpl

protected void addTokensImpl(long tokensToAdd)

Specified by:

addTokensImpl in class AbstractBucket

forceAddTokensImpl

protected void forceAddTokensImpl(long tokensToAdd)

Specified by:

forceAddTokensImpl in class AbstractBucket

replaceConfigurationImpl

protected void replaceConfigurationImpl(BucketConfiguration newConfiguration,
                                        TokensInheritanceStrategy tokensInheritanceStrategy)

Specified by:

replaceConfigurationImpl in class AbstractBucket

consumeIgnoringRateLimitsImpl

protected long consumeIgnoringRateLimitsImpl(long tokensToConsume)

Specified by:

consumeIgnoringRateLimitsImpl in class AbstractBucket

reset

public void reset()

Description copied from interface: Bucket

Reset all tokens up to maximum capacity.

Specified by:

reset in interface Bucket

getAvailableTokens

public long getAvailableTokens()

Description copied from interface: Bucket

Returns amount of available tokens in this bucket.

Typically you should avoid using of this method for, because available tokens can be changed by concurrent transactions for case of multithreaded/multi-process environment.

Specified by:

getAvailableTokens in interface Bucket

Returns:

amount of available tokens

consumeAsMuchAsPossibleVerboseImpl

protected VerboseResult<Long> consumeAsMuchAsPossibleVerboseImpl(long limit)

Specified by:

consumeAsMuchAsPossibleVerboseImpl in class AbstractBucket

tryConsumeVerboseImpl

protected VerboseResult<Boolean> tryConsumeVerboseImpl(long tokensToConsume)

Specified by:

tryConsumeVerboseImpl in class AbstractBucket

tryConsumeAndReturnRemainingTokensVerboseImpl

protected VerboseResult<ConsumptionProbe> tryConsumeAndReturnRemainingTokensVerboseImpl(long tokensToConsume)

Specified by:

tryConsumeAndReturnRemainingTokensVerboseImpl in class AbstractBucket

estimateAbilityToConsumeVerboseImpl

protected VerboseResult<EstimationProbe> estimateAbilityToConsumeVerboseImpl(long numTokens)

Specified by:

estimateAbilityToConsumeVerboseImpl in class AbstractBucket

getAvailableTokensVerboseImpl

protected VerboseResult<Long> getAvailableTokensVerboseImpl()

Specified by:

getAvailableTokensVerboseImpl in class AbstractBucket

addTokensVerboseImpl

protected VerboseResult<Nothing> addTokensVerboseImpl(long tokensToAdd)

Specified by:

addTokensVerboseImpl in class AbstractBucket

forceAddTokensVerboseImpl

protected VerboseResult<Nothing> forceAddTokensVerboseImpl(long tokensToAdd)

Specified by:

forceAddTokensVerboseImpl in class AbstractBucket

resetVerboseImpl

protected VerboseResult<Nothing> resetVerboseImpl()

Specified by:

resetVerboseImpl in class AbstractBucket

replaceConfigurationVerboseImpl

protected VerboseResult<Nothing> replaceConfigurationVerboseImpl(BucketConfiguration newConfiguration,
                                                                 TokensInheritanceStrategy tokensInheritanceStrategy)

Specified by:

replaceConfigurationVerboseImpl in class AbstractBucket

consumeIgnoringRateLimitsVerboseImpl

protected VerboseResult<Long> consumeIgnoringRateLimitsVerboseImpl(long tokensToConsume)

Specified by:

consumeIgnoringRateLimitsVerboseImpl in class AbstractBucket