Type Parameters:

K - type of primary key

All Known Implementing Classes:

AbstractCompareAndSwapBasedProxyManager, AbstractLockBasedProxyManager, AbstractProxyManager, AbstractSelectForUpdateBasedProxyManager
```
public interface ProxyManager<K>
```
Represents an extension point of bucket4j library. ProxyManager provides API for building and managing the collection of BucketProxy in backing storage. Typically an instance of ProxyManager is organized around RDBMS table, GRID cache, or some similarly isolated part of external storage. Primary keys are used to distinguish persisted state of different buckets.

See Also:

BucketProxy, AsyncProxyManager

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`AsyncProxyManager<K>`	`asAsync()`	Returns asynchronous API for this proxy manager.
`RemoteBucketBuilder<K>`	`builder()`
`Optional<BucketConfiguration>`	`getProxyConfiguration(K key)`	Locates configuration of bucket which actually stored in the underlying storage.
`boolean`	`isAsyncModeSupported()`	Describes whether or not this manager supports asynchronous API.
`void`	`removeProxy(K key)`	Removes persisted state of bucket from underlying storage.
`default <K1> ProxyManager<K1>`	`withMapper(Function<? super K1,? extends K> mapper)`	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.

- Method Detail
  - builder
```
RemoteBucketBuilder<K> builder()
```
  - getProxyConfiguration
```
Optional<BucketConfiguration> getProxyConfiguration(K key)
```
    Locates configuration of bucket which actually stored in the underlying storage.
    
    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
```
void removeProxy(K key)
```
    Removes persisted state of bucket from underlying storage.
    
    Parameters:
    
    key - the primary key of bucket which state need to be removed from underlying storage.
  - isAsyncModeSupported
```
boolean isAsyncModeSupported()
```
    Describes whether or not this manager supports asynchronous API. If this method returns false then any invocation of asAsync() will throw UnsupportedOperationException.
    
    Returns:
    
    true if this extension supports asynchronous API
  - asAsync
```
AsyncProxyManager<K> asAsync()
                      throws UnsupportedOperationException
```
    Returns asynchronous API for this proxy manager.
    
    Returns:
    
    asynchronous API for this proxy manager.
    
    Throws:
    
    UnsupportedOperationException - in case of this proxy manager does not support Async API.
  - withMapper
```
default <K1> ProxyManager<K1> withMapper(Function<? super K1,? extends K> mapper)
```
    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.
    
    Type Parameters:
    
    K1 - the type of key accepted by returned ProxyManager
    
    Parameters:
    
    mapper - the mapper function to apply to keys
    
    Returns:
    
    a proxy object that wraps this ProxyManager

Interface ProxyManager<K>

Method Summary

Method Detail

builder

getProxyConfiguration

removeProxy

isAsyncModeSupported

asAsync

withMapper