com.launchdarkly.client.RedisFeatureStoreBuilder Maven / Gradle / Ivy
package com.launchdarkly.client;
import com.launchdarkly.client.integrations.CacheMonitor;
import com.launchdarkly.client.integrations.PersistentDataStoreBuilder;
import com.launchdarkly.client.integrations.Redis;
import com.launchdarkly.client.integrations.RedisDataStoreBuilder;
import com.launchdarkly.client.interfaces.DiagnosticDescription;
import com.launchdarkly.client.value.LDValue;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.concurrent.TimeUnit;
import redis.clients.jedis.JedisPoolConfig;
/**
* Deprecated builder class for the Redis-based persistent data store.
*
* The replacement for this class is {@link com.launchdarkly.client.integrations.RedisDataStoreBuilder}.
* This class is retained for backward compatibility and will be removed in a future version.
*
* @deprecated Use {@link com.launchdarkly.client.integrations.Redis#dataStore()}
*/
@Deprecated
public final class RedisFeatureStoreBuilder implements FeatureStoreFactory, DiagnosticDescription {
/**
* The default value for the Redis URI: {@code redis://localhost:6379}
* @since 4.0.0
*/
public static final URI DEFAULT_URI = RedisDataStoreBuilder.DEFAULT_URI;
/**
* The default value for {@link #prefix(String)}.
* @since 4.0.0
*/
public static final String DEFAULT_PREFIX = RedisDataStoreBuilder.DEFAULT_PREFIX;
/**
* The default value for {@link #cacheTime(long, TimeUnit)} (in seconds).
* @deprecated Use {@link FeatureStoreCacheConfig#DEFAULT}.
* @since 4.0.0
*/
public static final long DEFAULT_CACHE_TIME_SECONDS = FeatureStoreCacheConfig.DEFAULT_TIME_SECONDS;
final PersistentDataStoreBuilder wrappedOuterBuilder;
final RedisDataStoreBuilder wrappedBuilder;
// We have to keep track of these caching parameters separately in order to support some deprecated setters
boolean refreshStaleValues = false;
boolean asyncRefresh = false;
// These constructors are called only from Components
RedisFeatureStoreBuilder() {
wrappedBuilder = Redis.dataStore();
wrappedOuterBuilder = Components.persistentDataStore(wrappedBuilder);
// In order to make the cacheStats() method on the deprecated RedisFeatureStore class work, we need to
// turn on cache monitoring. In the newer API, cache monitoring would only be turned on if the application
// specified its own CacheMonitor, but in the deprecated API there's no way to know if they will want the
// statistics or not.
wrappedOuterBuilder.cacheMonitor(new CacheMonitor());
}
RedisFeatureStoreBuilder(URI uri) {
this();
wrappedBuilder.uri(uri);
}
/**
* The constructor accepts the mandatory fields that must be specified at a minimum to construct a {@link com.launchdarkly.client.RedisFeatureStore}.
*
* @param uri the uri of the Redis resource to connect to.
* @param cacheTimeSecs the cache time in seconds. See {@link RedisFeatureStoreBuilder#cacheTime(long, TimeUnit)} for more information.
* @deprecated Please use {@link Components#redisFeatureStore(java.net.URI)}.
*/
public RedisFeatureStoreBuilder(URI uri, long cacheTimeSecs) {
this();
wrappedBuilder.uri(uri);
wrappedOuterBuilder.cacheSeconds(cacheTimeSecs);
}
/**
* The constructor accepts the mandatory fields that must be specified at a minimum to construct a {@link com.launchdarkly.client.RedisFeatureStore}.
*
* @param scheme the URI scheme to use
* @param host the hostname to connect to
* @param port the port to connect to
* @param cacheTimeSecs the cache time in seconds. See {@link RedisFeatureStoreBuilder#cacheTime(long, TimeUnit)} for more information.
* @throws URISyntaxException if the URI is not valid
* @deprecated Please use {@link Components#redisFeatureStore(java.net.URI)}.
*/
public RedisFeatureStoreBuilder(String scheme, String host, int port, long cacheTimeSecs) throws URISyntaxException {
this();
wrappedBuilder.uri(new URI(scheme, null, host, port, null, null, null));
wrappedOuterBuilder.cacheSeconds(cacheTimeSecs);
}
/**
* Specifies the database number to use.
*
* The database number can also be specified in the Redis URI, in the form {@code redis://host:port/NUMBER}. Any
* non-null value that you set with {@link #database(Integer)} will override the URI.
*
* @param database the database number, or null to fall back to the URI or the default
* @return the builder
*
* @since 4.7.0
*/
public RedisFeatureStoreBuilder database(Integer database) {
wrappedBuilder.database(database);
return this;
}
/**
* Specifies a password that will be sent to Redis in an AUTH command.
*
* It is also possible to include a password in the Redis URI, in the form {@code redis://:PASSWORD@host:port}. Any
* password that you set with {@link #password(String)} will override the URI.
*
* @param password the password
* @return the builder
*
* @since 4.7.0
*/
public RedisFeatureStoreBuilder password(String password) {
wrappedBuilder.password(password);
return this;
}
/**
* Optionally enables TLS for secure connections to Redis.
*
* This is equivalent to specifying a Redis URI that begins with {@code rediss:} rather than {@code redis:}.
*
* Note that not all Redis server distributions support TLS.
*
* @param tls true to enable TLS
* @return the builder
*
* @since 4.7.0
*/
public RedisFeatureStoreBuilder tls(boolean tls) {
wrappedBuilder.tls(tls);
return this;
}
/**
* Specifies whether local caching should be enabled and if so, sets the cache properties. Local
* caching is enabled by default; see {@link FeatureStoreCacheConfig#DEFAULT}. To disable it, pass
* {@link FeatureStoreCacheConfig#disabled()} to this method.
*
* @param caching a {@link FeatureStoreCacheConfig} object specifying caching parameters
* @return the builder
*
* @since 4.6.0
*/
public RedisFeatureStoreBuilder caching(FeatureStoreCacheConfig caching) {
wrappedOuterBuilder.cacheTime(caching.getCacheTime(), caching.getCacheTimeUnit());
wrappedOuterBuilder.staleValuesPolicy(caching.getStaleValuesPolicy().toNewEnum());
return this;
}
/**
* Deprecated method for setting the cache expiration policy to {@link FeatureStoreCacheConfig.StaleValuesPolicy#REFRESH}
* or {@link FeatureStoreCacheConfig.StaleValuesPolicy#REFRESH_ASYNC}.
*
* @param enabled turns on lazy refresh of cached values
* @return the builder
*
* @deprecated Use {@link #caching(FeatureStoreCacheConfig)} and
* {@link FeatureStoreCacheConfig#staleValuesPolicy(com.launchdarkly.client.FeatureStoreCacheConfig.StaleValuesPolicy)}.
*/
public RedisFeatureStoreBuilder refreshStaleValues(boolean enabled) {
this.refreshStaleValues = enabled;
updateCachingStaleValuesPolicy();
return this;
}
/**
* Deprecated method for setting the cache expiration policy to {@link FeatureStoreCacheConfig.StaleValuesPolicy#REFRESH_ASYNC}.
*
* @param enabled turns on asynchronous refresh of cached values (only if {@link #refreshStaleValues(boolean)}
* is also true)
* @return the builder
*
* @deprecated Use {@link #caching(FeatureStoreCacheConfig)} and
* {@link FeatureStoreCacheConfig#staleValuesPolicy(com.launchdarkly.client.FeatureStoreCacheConfig.StaleValuesPolicy)}.
*/
public RedisFeatureStoreBuilder asyncRefresh(boolean enabled) {
this.asyncRefresh = enabled;
updateCachingStaleValuesPolicy();
return this;
}
private void updateCachingStaleValuesPolicy() {
// We need this logic in order to support the existing behavior of the deprecated methods above:
// asyncRefresh is supposed to have no effect unless refreshStaleValues is true
if (refreshStaleValues) {
wrappedOuterBuilder.staleValuesPolicy(this.asyncRefresh ?
PersistentDataStoreBuilder.StaleValuesPolicy.REFRESH_ASYNC :
PersistentDataStoreBuilder.StaleValuesPolicy.REFRESH);
} else {
wrappedOuterBuilder.staleValuesPolicy(PersistentDataStoreBuilder.StaleValuesPolicy.EVICT);
}
}
/**
* Optionally configures the namespace prefix for all keys stored in Redis.
*
* @param prefix the namespace prefix
* @return the builder
*/
public RedisFeatureStoreBuilder prefix(String prefix) {
wrappedBuilder.prefix(prefix);
return this;
}
/**
* Deprecated method for enabling local caching and setting the cache TTL. Local caching is enabled
* by default; see {@link FeatureStoreCacheConfig#DEFAULT}.
*
* @param cacheTime the time value to cache for, or 0 to disable local caching
* @param timeUnit the time unit for the time value
* @return the builder
*
* @deprecated use {@link #caching(FeatureStoreCacheConfig)} and {@link FeatureStoreCacheConfig#ttl(long, TimeUnit)}.
*/
public RedisFeatureStoreBuilder cacheTime(long cacheTime, TimeUnit timeUnit) {
wrappedOuterBuilder.cacheTime(cacheTime, timeUnit);
return this;
}
/**
* Optional override if you wish to specify your own configuration to the underlying Jedis pool.
*
* @param poolConfig the Jedis pool configuration.
* @return the builder
*/
public RedisFeatureStoreBuilder poolConfig(JedisPoolConfig poolConfig) {
wrappedBuilder.poolConfig(poolConfig);
return this;
}
/**
* Optional override which sets the connection timeout for the underlying Jedis pool which otherwise defaults to
* {@link redis.clients.jedis.Protocol#DEFAULT_TIMEOUT}
*
* @param connectTimeout the timeout
* @param timeUnit the time unit for the timeout
* @return the builder
*/
public RedisFeatureStoreBuilder connectTimeout(int connectTimeout, TimeUnit timeUnit) {
wrappedBuilder.connectTimeout(connectTimeout, timeUnit);
return this;
}
/**
* Optional override which sets the connection timeout for the underlying Jedis pool which otherwise defaults to
* {@link redis.clients.jedis.Protocol#DEFAULT_TIMEOUT}
*
* @param socketTimeout the socket timeout
* @param timeUnit the time unit for the timeout
* @return the builder
*/
public RedisFeatureStoreBuilder socketTimeout(int socketTimeout, TimeUnit timeUnit) {
wrappedBuilder.socketTimeout(socketTimeout, timeUnit);
return this;
}
/**
* Build a {@link RedisFeatureStore} based on the currently configured builder object.
* @return the {@link RedisFeatureStore} configured by this builder.
*/
public RedisFeatureStore build() {
return new RedisFeatureStore(this);
}
/**
* Synonym for {@link #build()}.
* @return the {@link RedisFeatureStore} configured by this builder.
* @since 4.0.0
*/
public RedisFeatureStore createFeatureStore() {
return build();
}
@Override
public LDValue describeConfiguration(LDConfig config) {
return LDValue.of("Redis");
}
}