software.amazon.jdbc.util.storage

Interface StorageService

All Known Implementing Classes:

StorageServiceImpl

public interface StorageService

Method Summary

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)
<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.
<V> void	set(java.lang.Object key, V item) Stores an item in the storage service under the given item class.
int	size(java.lang.Class<?> itemClass)

Method Detail

registerItemClassIfAbsent

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

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

<V> void set(java.lang.Object key,
             V item)

Stores an item in the storage service under the given item class.

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

item - the item to store.

get

<V> V get(java.lang.Class<V> itemClass,
          java.lang.Object key)

Gets an item stored in the storage service.

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

boolean exists(java.lang.Class<?> itemClass,
               java.lang.Object key)

Indicates whether an item exists under the given item class and key.

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

void remove(java.lang.Class<?> itemClass,
            java.lang.Object key)

Removes an item stored under the given item class.

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

void clear(java.lang.Class<?> itemClass)

Clears all items of the given item class. For example, storageService.clear(AllowedAndBlockedHosts.class) will remove all AllowedAndBlockedHost items from the storage service.

Parameters:

itemClass - the class of the items to clear.

clearAll

void clearAll()

Clears all items from the storage service.

getEntries

<K,V> @Nullable java.util.Map<K,V> getEntries(java.lang.Class<V> itemClass)

size

int size(java.lang.Class<?> itemClass)