Module io.github.bucket4j.core

Package io.github.bucket4j.distributed.proxy

Class ProxyManagerView<K,KeyOld>

java.lang.Object

io.github.bucket4j.distributed.proxy.ProxyManagerView<K,KeyOld>

All Implemented Interfaces:

ProxyManager<K>

public class ProxyManagerView<K,KeyOld>
extends Object
implements ProxyManager<K>

Constructor Summary

Constructors

Constructor	Description
ProxyManagerView(ProxyManager<KeyOld> target, Function<K,KeyOld> mapper)

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.
BucketProxy	getProxy(K key, Supplier<BucketConfiguration> configurationSupplier)	Creates bucket-proxy that configured by default parameters that set on proxy-manager level.
Optional<BucketConfiguration>	getProxyConfiguration(K key)	Locates configuration of bucket which actually stored in the underlying storage.
boolean	isAsyncModeSupported()	Describes whether this manager supports asynchronous API.
boolean	isExpireAfterWriteSupported()	Describes whether this manager supports expire-after-write feature.
void	removeProxy(K key)	Removes persisted state of bucket from underlying storage.
<K2> ProxyManager<K2>	withMapper(Function<? super K2,? extends K> innerMapper)	Returns a proxy object that wraps this ProxyManager such that keys are first mapped using the specified mapping function before being sent to the remote store.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyManagerView

public ProxyManagerView(ProxyManager<KeyOld> target,
                        Function<K,KeyOld> mapper)

Method Detail

getProxy

public BucketProxy getProxy(K key,
                            Supplier<BucketConfiguration> configurationSupplier)

Description copied from interface: ProxyManager

Creates bucket-proxy that configured by default parameters that set on proxy-manager level. In case if you need to configure something special for bucket like implicit config replacement you should to use ProxyManager.builder() instead of this method.

Specified by:

getProxy in interface ProxyManager<K>

Parameters:

key - the key that used in external storage to distinguish one bucket from another.

configurationSupplier - provider for bucket configuration

Returns:

new instance of BucketProxy

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.

removeProxy

public void removeProxy(K key)

Description copied from interface: ProxyManager

Removes persisted state of bucket from underlying storage.

Specified by:

removeProxy in interface ProxyManager<K>

Parameters:

key - the primary key of bucket which state need to be removed from underlying storage.

isAsyncModeSupported

public boolean isAsyncModeSupported()

Description copied from interface: ProxyManager

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

Specified by:

isAsyncModeSupported in interface ProxyManager<K>

Returns:

true if this manager supports asynchronous API

isExpireAfterWriteSupported

public boolean isExpireAfterWriteSupported()

Description copied from interface: ProxyManager

Describes whether this manager supports expire-after-write feature.

Specified by:

isExpireAfterWriteSupported in interface ProxyManager<K>

Returns:

true if this manager supports expire-after-write feature.

asAsync

public AsyncProxyManager<K> asAsync()
                             throws UnsupportedOperationException

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.

Throws:

UnsupportedOperationException - in case of this proxy manager does not support Async API.

withMapper

public <K2> ProxyManager<K2> withMapper(Function<? super K2,? extends K> innerMapper)

Description copied from interface: ProxyManager

Returns a proxy object that wraps this ProxyManager such that keys are first mapped using the specified mapping function before being sent to the remote store. The returned ProxyManager shares the same underlying store as the original, and keys that map to the same value will share the same remote state.

Specified by:

withMapper in interface ProxyManager<K>

Type Parameters:

K2 - the type of key accepted by returned ProxyManager

Parameters:

innerMapper - the mapper function to apply to keys

Returns:

a proxy object that wraps this ProxyManager