io.github.bucket4j.distributed.proxy

Class AbstractBackend<K>

java.lang.Object

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

All Implemented Interfaces:

Backend<K>

Direct Known Subclasses:

AbstractCompareAndSwapBasedBackend, AbstractLockBasedBackend

public abstract class AbstractBackend<K>
extends Object
implements Backend<K>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBackend(ClientSideConfig clientSideConfig)

Method Summary

Modifier and Type	Method and Description
AsyncBackend<K>	asAsync() TODO
RemoteBucketBuilder<K>	builder() TODO fix javadocs Constructs an instance of DefaultBucketProxy which state actually stored inside in-memory data-jvm, the bucket stored in the jvm immediately, so one network request will be issued to jvm.
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 outside current JVM.

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.Backend

isAsyncModeSupported

Constructor Detail

AbstractBackend

protected AbstractBackend(ClientSideConfig clientSideConfig)

Method Detail

asAsync

public AsyncBackend<K> asAsync()

Description copied from interface: Backend

TODO

Specified by:

asAsync in interface Backend<K>

Returns:

builder

public RemoteBucketBuilder<K> builder()

Description copied from interface: Backend

TODO fix javadocs Constructs an instance of DefaultBucketProxy which state actually stored inside in-memory data-jvm, the bucket stored in the jvm immediately, so one network request will be issued to jvm. Due to this method performs network IO, returned result must not be treated as light-weight entity, it will be a performance anti-pattern to use this method multiple times for same key, you need to cache result somewhere and reuse between invocations, else performance of all operation with bucket will be 2-x times slower.

Specified by:

builder in interface Backend<K>

Returns:

new distributed bucket

getProxyConfiguration

public Optional<BucketConfiguration> getProxyConfiguration(K key)

Description copied from interface: Backend

Locates configuration of bucket which actually stored outside current JVM.

Specified by:

getProxyConfiguration in interface Backend<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 are 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)

getClientSideConfig

protected ClientSideConfig getClientSideConfig()

getBackwardCompatibilityVersion

protected Version getBackwardCompatibilityVersion()

getClientSideTime

protected Long getClientSideTime()