Module io.github.bucket4j.core

Package io.github.bucket4j.distributed.proxy

Class AbstractProxyManager<K>

java.lang.Object

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

All Implemented Interfaces:

ProxyManager<K>

Direct Known Subclasses:

AbstractCompareAndSwapBasedProxyManager, AbstractLockBasedProxyManager, AbstractSelectForUpdateBasedProxyManager

public abstract class AbstractProxyManager<K>
extends Object
implements ProxyManager<K>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractProxyManager(ClientSideConfig clientSideConfig)

Method Summary

Modifier and Type	Method	Description
AsyncProxyManager<K>	asAsync()	Returns asynchronous API for this proxy manager.
RemoteBucketBuilder<K>	builder()	Creates new instance of RemoteBucketBuilder.
protected long	currentTimeNanos()
protected abstract <T> CommandResult<T>	execute(K key, Request<T> request)
protected abstract <T> CompletableFuture<CommandResult<T>>	executeAsync(K key, Request<T> request)
protected Version	getBackwardCompatibilityVersion()
protected ClientSideConfig	getClientSideConfig()
protected Long	getClientSideTime()
Optional<BucketConfiguration>	getProxyConfiguration(K key)	Locates configuration of bucket which actually stored in the underlying storage.
protected abstract CompletableFuture<Void>	removeAsync(K key)

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

getProxy, isAsyncModeSupported, isExpireAfterWriteSupported, removeProxy, withMapper

Constructor Details

AbstractProxyManager

protected AbstractProxyManager(ClientSideConfig clientSideConfig)

Method Details

asAsync

public AsyncProxyManager<K> asAsync()

Description copied from interface: ProxyManager

Returns asynchronous API for this proxy manager.

Specified by:

asAsync in interface ProxyManager<K>

Returns:

asynchronous API for this proxy manager.

builder

public RemoteBucketBuilder<K> builder()

Description copied from interface: ProxyManager

Creates new instance of RemoteBucketBuilder.

Use this method only if you need to create bucket with parameters that can not be specified via AbstractProxyManagerBuilder, otherwise prefer ProxyManager.getProxy(Object, Supplier)

Specified by:

builder in interface ProxyManager<K>

Returns:

new instance of RemoteBucketBuilder

getProxyConfiguration

public Optional<BucketConfiguration> getProxyConfiguration(K key)

Description copied from interface: ProxyManager

Locates configuration of bucket which actually stored in the underlying storage.

Specified by:

getProxyConfiguration in interface ProxyManager<K>

Parameters:

key - the unique identifier used to point to the bucket in external storage.

Returns:

Optional surround the configuration or empty optional if bucket with specified key is not stored.

execute

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

executeAsync

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

removeAsync

protected abstract CompletableFuture<Void> removeAsync(K key)

getClientSideConfig

protected ClientSideConfig getClientSideConfig()

getBackwardCompatibilityVersion

protected Version getBackwardCompatibilityVersion()

currentTimeNanos

protected long currentTimeNanos()

getClientSideTime

protected Long getClientSideTime()