Module io.github.bucket4j.core

Package io.github.bucket4j.distributed.proxy.generic.pessimistic_locking

Class AbstractLockBasedProxyManager<K>

java.lang.Object

io.github.bucket4j.distributed.proxy.AbstractProxyManager<K>

io.github.bucket4j.distributed.proxy.generic.pessimistic_locking.AbstractLockBasedProxyManager<K>

Type Parameters:

K - the generic type for unique identifiers that used to point to the bucket in external storage.

All Implemented Interfaces:

ProxyManager<K>

public abstract class AbstractLockBasedProxyManager<K>
extends AbstractProxyManager<K>

The base class for proxy managers that built on top of idea that underlining storage provide Compare-And-Swap functionality.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLockBasedProxyManager(ClientSideConfig clientSideConfig)

Method Summary

Modifier and Type	Method	Description
protected abstract LockBasedTransaction	allocateTransaction(K key)
<T> CommandResult<T>	execute(K key, Request<T> request)
<T> CompletableFuture<CommandResult<T>>	executeAsync(K key, Request<T> request)
boolean	isAsyncModeSupported()	Describes whether or not this manager supports asynchronous API.
protected CompletableFuture<Void>	removeAsync(Object key)

Methods inherited from class io.github.bucket4j.distributed.proxy.AbstractProxyManager

asAsync, builder, getBackwardCompatibilityVersion, getClientSideConfig, getClientSideTime, getProxyConfiguration

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.distributed.proxy.ProxyManager

removeProxy

Constructor Detail

AbstractLockBasedProxyManager

protected AbstractLockBasedProxyManager(ClientSideConfig clientSideConfig)

Method Detail

execute

public <T> CommandResult<T> execute(K key,
                                    Request<T> request)

Specified by:

execute in class AbstractProxyManager<K>

isAsyncModeSupported

public boolean isAsyncModeSupported()

Description copied from interface: ProxyManager

Describes whether or not this manager supports asynchronous API. If this method returns false then any invocation of ProxyManager.asAsync() will throw UnsupportedOperationException.

Returns:

true if this extension supports asynchronous API

executeAsync

public <T> CompletableFuture<CommandResult<T>> executeAsync(K key,
                                                            Request<T> request)

Specified by:

executeAsync in class AbstractProxyManager<K>

removeAsync

protected CompletableFuture<Void> removeAsync(Object key)

Specified by:

removeAsync in class AbstractProxyManager<K>

allocateTransaction

protected abstract LockBasedTransaction allocateTransaction(K key)