StorageServiceImpl (aws-advanced-jdbc-wrapper 2.6.4 API)

java.lang.Object
- software.amazon.jdbc.util.storage.StorageServiceImpl

All Implemented Interfaces:: StorageService

public class StorageServiceImpl
extends java.lang.Object
implements StorageService

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map<java.lang.Class<?>,ExpirationCache<java.lang.Object,?>>`	`caches`
`protected java.util.concurrent.ScheduledExecutorService`	`cleanupExecutor`
`protected static long`	`DEFAULT_CLEANUP_INTERVAL_NANOS`
`protected static java.util.Map<java.lang.Class<?>,java.util.function.Supplier<ExpirationCache<java.lang.Object,?>>>`	`defaultCacheSuppliers`
`protected EventPublisher`	`publisher`

Constructor Summary

Constructors
Constructor and Description

StorageServiceImpl(EventPublisher publisher)

StorageServiceImpl(long cleanupIntervalNanos, EventPublisher publisher)

Constructors
Constructor and Description
`StorageServiceImpl(EventPublisher publisher)`
`StorageServiceImpl(long cleanupIntervalNanos, EventPublisher publisher)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear(java.lang.Class<?> itemClass)` Clears all items of the given item class.
`void`	`clearAll()` Clears all items from the storage service.
`boolean`	`exists(java.lang.Class<?> itemClass, java.lang.Object key)` Indicates whether an item exists under the given item class and key.
`<V> V`	`get(java.lang.Class<V> itemClass, java.lang.Object key)` Gets an item stored in the storage service.
`<K,V> @Nullable java.util.Map<K,V>`	`getEntries(java.lang.Class<V> itemClass)`
`protected void`	`initCleanupThread(long cleanupIntervalNanos)`
`<V> void`	`registerItemClassIfAbsent(java.lang.Class<V> itemClass, boolean isRenewableExpiration, long timeToLiveNanos, @Nullable ShouldDisposeFunc<V> shouldDisposeFunc, @Nullable ItemDisposalFunc<V> itemDisposalFunc)` Registers a new item class with the storage service.
`void`	`remove(java.lang.Class<?> itemClass, java.lang.Object key)` Removes an item stored under the given item class.
`protected void`	`removeExpiredItems()`
`<V> void`	`set(java.lang.Object key, V value)` Stores an item in the storage service under the given item class.
`int`	`size(java.lang.Class<?> itemClass)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CLEANUP_INTERVAL_NANOS
```
protected static final long DEFAULT_CLEANUP_INTERVAL_NANOS
```
  - defaultCacheSuppliers
```
protected static final java.util.Map<java.lang.Class<?>,java.util.function.Supplier<ExpirationCache<java.lang.Object,?>>> defaultCacheSuppliers
```
  - publisher
```
protected final EventPublisher publisher
```
  - caches
```
protected final java.util.Map<java.lang.Class<?>,ExpirationCache<java.lang.Object,?>> caches
```
  - cleanupExecutor
```
protected final java.util.concurrent.ScheduledExecutorService cleanupExecutor
```
- Constructor Detail
  - StorageServiceImpl
```
public StorageServiceImpl(EventPublisher publisher)
```
  - StorageServiceImpl
```
public StorageServiceImpl(long cleanupIntervalNanos,
                          EventPublisher publisher)
```
- Method Detail
  - initCleanupThread
```
protected void initCleanupThread(long cleanupIntervalNanos)
```
  - removeExpiredItems
```
protected void removeExpiredItems()
```
  - registerItemClassIfAbsent
```
public <V> void registerItemClassIfAbsent(java.lang.Class<V> itemClass,
                                          boolean isRenewableExpiration,
                                          long timeToLiveNanos,
                                          @Nullable ShouldDisposeFunc<V> shouldDisposeFunc,
                                          @Nullable ItemDisposalFunc<V> itemDisposalFunc)
```
    Description copied from interface: StorageService
    
    Registers a new item class with the storage service. This method needs to be called before adding new classes of items to the service, so that the service knows when and how to dispose of the item. Expected item classes will be added automatically during driver initialization, but this method can be called to add new classes of items.
    
    Specified by:
    
    registerItemClassIfAbsent in interface StorageService
    
    Type Parameters:
    
    V - the type of item that will be stored under the item class.
    
    Parameters:
    
    itemClass - the class of the item that will be stored, eg `CustomEndpointInfo.class`.
    
    isRenewableExpiration - controls whether the item's expiration should be renewed if the item is fetched, regardless of whether it is already expired or not.
    
    timeToLiveNanos - how long an item should be stored before being considered expired, in nanoseconds.
    
    shouldDisposeFunc - a function defining whether an item should be disposed if expired. If null is passed, the item will always be disposed if expired.
    
    itemDisposalFunc - a function defining how to dispose of an item when it is removed. If null is passed, the item will be removed without performing any additional operations.
  - set
```
public <V> void set(java.lang.Object key,
                    V value)
```
    Description copied from interface: StorageService
    
    Stores an item in the storage service under the given item class.
    
    Specified by:
    
    set in interface StorageService
    
    Type Parameters:
    
    V - the type of the item being retrieved.
    
    Parameters:
    
    key - the key for the item, eg "custom-endpoint.cluster-custom-XYZ.us-east-2.rds.amazonaws.com:5432".
    
    value - the item to store.
  - get
```
public <V> V get(java.lang.Class<V> itemClass,
                 java.lang.Object key)
```
    Description copied from interface: StorageService
    
    Gets an item stored in the storage service.
    
    Specified by:
    
    get in interface StorageService
    
    Type Parameters:
    
    V - the type of the item being retrieved.
    
    Parameters:
    
    itemClass - the expected class of the item being retrieved, eg `CustomEndpointInfo.class`.
    
    key - the key for the item, eg "custom-endpoint.cluster-custom-XYZ.us-east-2.rds.amazonaws.com:5432".
    
    Returns:
    
    the item stored at the given key for the given item class.
  - exists
```
public boolean exists(java.lang.Class<?> itemClass,
                      java.lang.Object key)
```
    Description copied from interface: StorageService
    
    Indicates whether an item exists under the given item class and key.
    
    Specified by:
    
    exists in interface StorageService
    
    Parameters:
    
    itemClass - the class of the item.
    
    key - the key for the item, eg "custom-endpoint.cluster-custom-XYZ.us-east-2.rds.amazonaws.com:5432".
    
    Returns:
    
    true if the item exists under the given item class and key, otherwise returns false.
  - remove
```
public void remove(java.lang.Class<?> itemClass,
                   java.lang.Object key)
```
    Description copied from interface: StorageService
    
    Removes an item stored under the given item class.
    
    Specified by:
    
    remove in interface StorageService
    
    Parameters:
    
    itemClass - the class of the item.
    
    key - the key for the item, eg "custom-endpoint.cluster-custom-XYZ.us-east-2.rds.amazonaws.com:5432".
  - clear
```
public void clear(java.lang.Class<?> itemClass)
```
    Description copied from interface: StorageService
    
    Clears all items of the given item class. For example, storageService.clear(AllowedAndBlockedHosts.class) will remove all AllowedAndBlockedHost items from the storage service.
    
    Specified by:
    
    clear in interface StorageService
    
    Parameters:
    
    itemClass - the class of the items to clear.
  - clearAll
```
public void clearAll()
```
    Description copied from interface: StorageService
    
    Clears all items from the storage service.
    
    Specified by:
    
    clearAll in interface StorageService
  - getEntries
```
public <K,V> @Nullable java.util.Map<K,V> getEntries(java.lang.Class<V> itemClass)
```
    Specified by:
    
    getEntries in interface StorageService
  - size
```
public int size(java.lang.Class<?> itemClass)
```
    Specified by:
    
    size in interface StorageService

Class StorageServiceImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CLEANUP_INTERVAL_NANOS

defaultCacheSuppliers

publisher

caches

cleanupExecutor

Constructor Detail

StorageServiceImpl

StorageServiceImpl

Method Detail

initCleanupThread

removeExpiredItems

registerItemClassIfAbsent

set

get

exists

remove

clear

clearAll

getEntries

size