com.launchdarkly.sdk.server.integrations.RedisDataStoreBuilder Maven / Gradle / Ivy
Show all versions of launchdarkly-java-server-sdk-redis-store Show documentation
package com.launchdarkly.sdk.server.integrations;
import com.launchdarkly.sdk.LDValue;
import com.launchdarkly.sdk.server.LDConfig;
import com.launchdarkly.sdk.server.interfaces.ClientContext;
import com.launchdarkly.sdk.server.interfaces.DiagnosticDescription;
import com.launchdarkly.sdk.server.interfaces.PersistentDataStore;
import com.launchdarkly.sdk.server.interfaces.PersistentDataStoreFactory;
import java.net.URI;
import java.time.Duration;
import redis.clients.jedis.JedisPoolConfig;
import redis.clients.jedis.Protocol;
/**
* A builder for configuring the Redis-based persistent data store.
*
* Obtain an instance of this class by calling {@link Redis#dataStore()}. After calling its methods
* to specify any desired custom settings, wrap it in a {@link com.launchdarkly.sdk.server.integrations.PersistentDataStoreBuilder}
* by calling {@code Components.persistentDataStore()}, then pass the result into the SDK configuration with
* {@link com.launchdarkly.sdk.server.LDConfig.Builder#dataStore(com.launchdarkly.sdk.server.interfaces.DataStoreFactory)}.
* You do not need to call {@link #createPersistentDataStore(ClientContext)} yourself to build the actual data store; that
* will be done by the SDK.
*
* Builder calls can be chained, for example:
*
*
* LDConfig config = new LDConfig.Builder()
* .dataStore(
* Components.persistentDataStore(
* Redis.dataStore()
* .url("redis://my-redis-host")
* .database(1)
* ).cacheSeconds(15)
* )
* .build();
*
*
* @since 4.12.0
*/
public final class RedisDataStoreBuilder implements PersistentDataStoreFactory, DiagnosticDescription {
/**
* The default value for the Redis URI: {@code redis://localhost:6379}
*/
public static final URI DEFAULT_URI = URI.create("redis://localhost:6379");
/**
* The default value for {@link #prefix(String)}.
*/
public static final String DEFAULT_PREFIX = "launchdarkly";
URI uri = DEFAULT_URI;
String prefix = DEFAULT_PREFIX;
Duration connectTimeout = Duration.ofMillis(Protocol.DEFAULT_TIMEOUT);
Duration socketTimeout = Duration.ofMillis(Protocol.DEFAULT_TIMEOUT);
Integer database = null;
String password = null;
boolean tls = false;
JedisPoolConfig poolConfig = null;
// These constructors are called only from Implementations
RedisDataStoreBuilder() {
}
/**
* 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
*/
public RedisDataStoreBuilder database(Integer database) {
this.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
*/
public RedisDataStoreBuilder password(String password) {
this.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
*/
public RedisDataStoreBuilder tls(boolean tls) {
this.tls = tls;
return this;
}
/**
* Specifies a Redis host URI other than {@link #DEFAULT_URI}.
*
* @param redisUri the URI of the Redis host
* @return the builder
*/
public RedisDataStoreBuilder uri(URI redisUri) {
this.uri = redisUri;
return this;
}
/**
* Optionally configures the namespace prefix for all keys stored in Redis.
*
* @param prefix the namespace prefix
* @return the builder
*/
public RedisDataStoreBuilder prefix(String prefix) {
this.prefix = prefix;
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 RedisDataStoreBuilder poolConfig(JedisPoolConfig poolConfig) {
this.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} milliseconds.
*
* @param connectTimeout the timeout
* @return the builder
*/
public RedisDataStoreBuilder connectTimeout(Duration connectTimeout) {
this.connectTimeout = connectTimeout == null ? Duration.ofMillis(Protocol.DEFAULT_TIMEOUT) : connectTimeout;
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} milliseconds.
*
* @param socketTimeout the socket timeout
* @return the builder
*/
public RedisDataStoreBuilder socketTimeout(Duration socketTimeout) {
this.socketTimeout = socketTimeout == null ? Duration.ofMillis(Protocol.DEFAULT_TIMEOUT) : socketTimeout;
return this;
}
/**
* Called internally by the SDK to create the actual data store instance.
* @return the data store configured by this builder
*/
@Override
public PersistentDataStore createPersistentDataStore(ClientContext context) {
return new RedisDataStoreImpl(this);
}
@Override
public LDValue describeConfiguration(LDConfig config) {
return LDValue.of("Redis");
}
}