com.launchdarkly.client.utils

Class CachingStoreWrapper

java.lang.Object

com.launchdarkly.client.utils.CachingStoreWrapper

All Implemented Interfaces:

FeatureStore, java.io.Closeable, java.lang.AutoCloseable

Deprecated.

Referencing this class directly is deprecated; it is now part of the implementation of PersistentDataStoreBuilder and will be made package-private starting in version 5.0.

@Deprecated
public class CachingStoreWrapper
extends java.lang.Object
implements FeatureStore

CachingStoreWrapper is a partial implementation of FeatureStore that delegates the basic functionality to an instance of FeatureStoreCore. It provides optional caching behavior and other logic that would otherwise be repeated in every feature store implementation. This makes it easier to create new database integrations by implementing only the database-specific logic.

Construct instances of this class with builder(FeatureStoreCore).

Since:

4.6.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CachingStoreWrapper.Builder Deprecated. Builder for instances of CachingStoreWrapper.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CachingStoreWrapper(FeatureStoreCore core, FeatureStoreCacheConfig caching, CacheMonitor cacheMonitor) Deprecated.

Method Summary

Modifier and Type	Method and Description
<T extends VersionedData> java.util.Map<java.lang.String,T>	all(VersionedDataKind<T> kind) Deprecated. Returns a Map of all associated objects of a given kind.
static CachingStoreWrapper.Builder	builder(FeatureStoreCore core) Deprecated. Creates a new builder.
void	close() Deprecated.
<T extends VersionedData> void	delete(VersionedDataKind<T> kind, java.lang.String key, int version) Deprecated. Deletes the object associated with the specified key, if it exists and its version is less than or equal to the specified version.
<T extends VersionedData> T	get(VersionedDataKind<T> kind, java.lang.String key) Deprecated. Returns the object to which the specified key is mapped, or null if the key is not associated or the associated object has been deleted.
com.google.common.cache.CacheStats	getCacheStats() Deprecated. Return the underlying Guava cache stats object.
FeatureStoreCore	getCore() Deprecated. Return the underlying implementation object.
void	init(java.util.Map<VersionedDataKind<?>,java.util.Map<java.lang.String,? extends VersionedData>> allData) Deprecated. Initializes (or re-initializes) the store with the specified set of objects.
boolean	initialized() Deprecated. Returns true if this store has been initialized.
<T extends VersionedData> void	upsert(VersionedDataKind<T> kind, T item) Deprecated. Update or insert the object associated with the specified key, if its version is less than or equal to the version specified in the argument object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingStoreWrapper

protected CachingStoreWrapper(FeatureStoreCore core,
                              FeatureStoreCacheConfig caching,
                              CacheMonitor cacheMonitor)

Deprecated.

Method Detail

builder

public static CachingStoreWrapper.Builder builder(FeatureStoreCore core)

Deprecated.

Creates a new builder.

Parameters:

core - the FeatureStoreCore instance

Returns:

the builder

close

public void close()
           throws java.io.IOException

Deprecated.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

get

public <T extends VersionedData> T get(VersionedDataKind<T> kind,
                                       java.lang.String key)

Deprecated.

Description copied from interface: FeatureStore

Returns the object to which the specified key is mapped, or null if the key is not associated or the associated object has been deleted.

Specified by:

get in interface FeatureStore

Type Parameters:

T - class of the object that will be returned

Parameters:

kind - the kind of object to get

key - the key whose associated object is to be returned

Returns:

the object to which the specified key is mapped, or null if the key is not associated or the associated object has been deleted.

all

public <T extends VersionedData> java.util.Map<java.lang.String,T> all(VersionedDataKind<T> kind)

Deprecated.

Description copied from interface: FeatureStore

Returns a Map of all associated objects of a given kind.

Specified by:

all in interface FeatureStore

Type Parameters:

T - class of the objects that will be returned in the map

Parameters:

kind - the kind of objects to get

Returns:

a map of all associated object.

init

public void init(java.util.Map<VersionedDataKind<?>,java.util.Map<java.lang.String,? extends VersionedData>> allData)

Deprecated.

Description copied from interface: FeatureStore

Initializes (or re-initializes) the store with the specified set of objects. Any existing entries will be removed. Implementations can assume that this set of objects is up to date-- there is no need to perform individual version comparisons between the existing objects and the supplied features.

If possible, the store should update the entire data set atomically. If that is not possible, it should iterate through the outer map and then the inner map in the order provided (the SDK will use a Map subclass that has a defined ordering), storing each item, and then delete any leftover items at the very end.

The store should not attempt to modify any of the Maps, and if it needs to retain the data in memory it should copy the Maps.

Specified by:

init in interface FeatureStore

Parameters:

allData - all objects to be stored

delete

public <T extends VersionedData> void delete(VersionedDataKind<T> kind,
                                             java.lang.String key,
                                             int version)

Deprecated.

Description copied from interface: FeatureStore

Deletes the object associated with the specified key, if it exists and its version is less than or equal to the specified version.

Specified by:

delete in interface FeatureStore

Type Parameters:

T - class of the object to be deleted

Parameters:

kind - the kind of object to delete

key - the key of the object to be deleted

version - the version for the delete operation

upsert

public <T extends VersionedData> void upsert(VersionedDataKind<T> kind,
                                             T item)

Deprecated.

Description copied from interface: FeatureStore

Update or insert the object associated with the specified key, if its version is less than or equal to the version specified in the argument object.

Specified by:

upsert in interface FeatureStore

Type Parameters:

T - class of the object to be updated

Parameters:

kind - the kind of object to update

item - the object to update or insert

initialized

public boolean initialized()

Deprecated.

Description copied from interface: FeatureStore

Returns true if this store has been initialized.

Specified by:

initialized in interface FeatureStore

Returns:

true if this store has been initialized

getCacheStats

public com.google.common.cache.CacheStats getCacheStats()

Deprecated.

Return the underlying Guava cache stats object.

Returns:

the cache statistics object

getCore

public FeatureStoreCore getCore()

Deprecated.

Return the underlying implementation object.

Returns:

the underlying implementation object