RedisDataStoreBuilder (launchdarkly-java-server-sdk 4.14.2 API)

java.lang.Object
- com.launchdarkly.client.integrations.RedisDataStoreBuilder

All Implemented Interfaces:

DiagnosticDescription, PersistentDataStoreFactory
```
public final class RedisDataStoreBuilder
extends java.lang.Object
implements PersistentDataStoreFactory, DiagnosticDescription
```
A builder for configuring the Redis-based persistent data store.
Obtain an instance of this class by calling Redis.dataStore(). After calling its methods to specify any desired custom settings, you can pass it directly into the SDK configuration with LDConfig.Builder.dataStore(com.launchdarkly.client.FeatureStoreFactory). You do not need to call createPersistentDataStore() 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

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_PREFIX` The default value for `prefix(String)`.
`static java.net.URI`	`DEFAULT_URI` The default value for the Redis URI: `redis://localhost:6379`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RedisDataStoreBuilder`	`connectTimeout(int connectTimeout, java.util.concurrent.TimeUnit timeUnit)` Optional override which sets the connection timeout for the underlying Jedis pool which otherwise defaults to `Protocol.DEFAULT_TIMEOUT`
`FeatureStoreCore`	`createPersistentDataStore()` Called internally from `PersistentDataStoreBuilder` to create the implementation object for the specific type of data store.
`RedisDataStoreBuilder`	`database(java.lang.Integer database)` Specifies the database number to use.
`LDValue`	`describeConfiguration(LDConfig config)` Used internally by the SDK to inspect the configuration.
`RedisDataStoreBuilder`	`password(java.lang.String password)` Specifies a password that will be sent to Redis in an AUTH command.
`RedisDataStoreBuilder`	`poolConfig(redis.clients.jedis.JedisPoolConfig poolConfig)` Optional override if you wish to specify your own configuration to the underlying Jedis pool.
`RedisDataStoreBuilder`	`prefix(java.lang.String prefix)` Optionally configures the namespace prefix for all keys stored in Redis.
`RedisDataStoreBuilder`	`socketTimeout(int socketTimeout, java.util.concurrent.TimeUnit timeUnit)` Optional override which sets the connection timeout for the underlying Jedis pool which otherwise defaults to `Protocol.DEFAULT_TIMEOUT`
`RedisDataStoreBuilder`	`tls(boolean tls)` Optionally enables TLS for secure connections to Redis.
`RedisDataStoreBuilder`	`uri(java.net.URI redisUri)` Specifies a Redis host URI other than `DEFAULT_URI`.

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

- Field Detail
  - DEFAULT_URI
```
public static final java.net.URI DEFAULT_URI
```
    The default value for the Redis URI: redis://localhost:6379
  - DEFAULT_PREFIX
```
public static final java.lang.String DEFAULT_PREFIX
```
    The default value for prefix(String).
    
    See Also:
    
    Constant Field Values
- Method Detail
  - database
```
public RedisDataStoreBuilder database(java.lang.Integer database)
```
    Specifies the database number to use.
    The database number can also be specified in the Redis URI, in the form redis://host:port/NUMBER. Any non-null value that you set with database(Integer) will override the URI.
    
    Parameters:
    
    database - the database number, or null to fall back to the URI or the default
    
    Returns:
    
    the builder
  - password
```
public RedisDataStoreBuilder password(java.lang.String password)
```
    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 redis://:PASSWORD@host:port. Any password that you set with password(String) will override the URI.
    
    Parameters:
    
    password - the password
    
    Returns:
    
    the builder
  - tls
```
public RedisDataStoreBuilder tls(boolean tls)
```
    Optionally enables TLS for secure connections to Redis.
    This is equivalent to specifying a Redis URI that begins with rediss: rather than redis:.
    Note that not all Redis server distributions support TLS.
    
    Parameters:
    
    tls - true to enable TLS
    
    Returns:
    
    the builder
  - uri
```
public RedisDataStoreBuilder uri(java.net.URI redisUri)
```
    Specifies a Redis host URI other than DEFAULT_URI.
    
    Parameters:
    
    redisUri - the URI of the Redis host
    
    Returns:
    
    the builder
  - prefix
```
public RedisDataStoreBuilder prefix(java.lang.String prefix)
```
    Optionally configures the namespace prefix for all keys stored in Redis.
    
    Parameters:
    
    prefix - the namespace prefix
    
    Returns:
    
    the builder
  - poolConfig
```
public RedisDataStoreBuilder poolConfig(redis.clients.jedis.JedisPoolConfig poolConfig)
```
    Optional override if you wish to specify your own configuration to the underlying Jedis pool.
    
    Parameters:
    
    poolConfig - the Jedis pool configuration.
    
    Returns:
    
    the builder
  - connectTimeout
```
public RedisDataStoreBuilder connectTimeout(int connectTimeout,
                                            java.util.concurrent.TimeUnit timeUnit)
```
    Optional override which sets the connection timeout for the underlying Jedis pool which otherwise defaults to Protocol.DEFAULT_TIMEOUT
    
    Parameters:
    
    connectTimeout - the timeout
    
    timeUnit - the time unit for the timeout
    
    Returns:
    
    the builder
  - socketTimeout
```
public RedisDataStoreBuilder socketTimeout(int socketTimeout,
                                           java.util.concurrent.TimeUnit timeUnit)
```
    Optional override which sets the connection timeout for the underlying Jedis pool which otherwise defaults to Protocol.DEFAULT_TIMEOUT
    
    Parameters:
    
    socketTimeout - the socket timeout
    
    timeUnit - the time unit for the timeout
    
    Returns:
    
    the builder
  - createPersistentDataStore
```
public FeatureStoreCore createPersistentDataStore()
```
    Description copied from interface: PersistentDataStoreFactory
    
    Called internally from PersistentDataStoreBuilder to create the implementation object for the specific type of data store.
    
    Specified by:
    
    createPersistentDataStore in interface PersistentDataStoreFactory
    
    Returns:
    
    the implementation object
  - describeConfiguration
```
public LDValue describeConfiguration(LDConfig config)
```
    Description copied from interface: DiagnosticDescription
    
    Used internally by the SDK to inspect the configuration.
    
    Specified by:
    
    describeConfiguration in interface DiagnosticDescription
    
    Parameters:
    
    config - the full configuration, in case this component depends on properties outside itself
    
    Returns:
    
    an LDValue or null

Class RedisDataStoreBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_URI

DEFAULT_PREFIX

Method Detail

database

password

tls

uri

prefix

poolConfig

connectTimeout

socketTimeout

createPersistentDataStore

describeConfiguration