RedisStoreBuilder (launchdarkly-java-server-sdk-redis-store 3.0.0 API)

java.lang.Object
- com.launchdarkly.sdk.server.integrations.RedisStoreBuilder<T>

Type Parameters:

T - the component type that this builder is being used for

All Implemented Interfaces:

com.launchdarkly.sdk.server.subsystems.ComponentConfigurer<T>, com.launchdarkly.sdk.server.subsystems.DiagnosticDescription
```
public abstract class RedisStoreBuilder<T>
extends java.lang.Object
implements com.launchdarkly.sdk.server.subsystems.ComponentConfigurer<T>, com.launchdarkly.sdk.server.subsystems.DiagnosticDescription
```
A builder for configuring the Redis-based persistent data store and/or Big Segment store.
Both Redis.dataStore() and Redis.bigSegmentStore() return instances of this class. You can use methods of the builder to specify any non-default Redis options you may want, before passing the builder to either Components.persistentDataStore(ComponentConfigurer) or Components.bigSegments(ComponentConfigurer) as appropriate. The two types of stores are independent of each other; you do not need a Big Segment store if you are not using the Big Segments feature, and you do not need to use the same database for both. In this example, the main data store uses a Redis host called "host1", and the Big Segment store uses a Redis host called "host2":
```
     LDConfig config = new LDConfig.Builder()
         .dataStore(
             Components.persistentDataStore(
                 Redis.dataStore().uri(URI.create("redis://host1:6379")
             )
         )
         .bigSegments(
             Components.bigSegments(
                 Redis.dataStore().uri(URI.create("redis://host2:6379")
             )
         )
         .build();
 
```
Note that the SDK also has its own options related to data storage that are configured at a different level, because they are independent of what database is being used. For instance, the builder returned by Components.persistentDataStore(ComponentConfigurer) has options for caching:
```
     LDConfig config = new LDConfig.Builder()
         .dataStore(
             Components.persistentDataStore(
                 Redis.dataStore().uri(URI.create("redis://my-redis-host"))
             ).cacheSeconds(15)
         )
         .build();
 
```
Since:

5.0.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
`RedisStoreBuilder<T>`	`connectTimeout(java.time.Duration connectTimeout)` Optional override which sets the connection timeout for the underlying Jedis pool which otherwise defaults to `Protocol.DEFAULT_TIMEOUT` milliseconds.
`RedisStoreBuilder<T>`	`database(java.lang.Integer database)` Specifies the database number to use.
`com.launchdarkly.sdk.LDValue`	`describeConfiguration(com.launchdarkly.sdk.server.subsystems.ClientContext clientContext)`
`RedisStoreBuilder<T>`	`password(java.lang.String password)` Specifies a password that will be sent to Redis in an AUTH command.
`RedisStoreBuilder<T>`	`poolConfig(redis.clients.jedis.JedisPoolConfig poolConfig)` Optional override if you wish to specify your own configuration to the underlying Jedis pool.
`RedisStoreBuilder<T>`	`prefix(java.lang.String prefix)` Optionally configures the namespace prefix for all keys stored in Redis.
`RedisStoreBuilder<T>`	`socketTimeout(java.time.Duration socketTimeout)` Optional override which sets the connection timeout for the underlying Jedis pool which otherwise defaults to `Protocol.DEFAULT_TIMEOUT` milliseconds.
`RedisStoreBuilder<T>`	`tls(boolean tls)` Optionally enables TLS for secure connections to Redis.
`RedisStoreBuilder<T>`	`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

Methods inherited from interface com.launchdarkly.sdk.server.subsystems.ComponentConfigurer
build

- 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 RedisStoreBuilder<T> 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 RedisStoreBuilder<T> 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 RedisStoreBuilder<T> 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 RedisStoreBuilder<T> 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 RedisStoreBuilder<T> 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 RedisStoreBuilder<T> 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 RedisStoreBuilder<T> connectTimeout(java.time.Duration connectTimeout)
```
    Optional override which sets the connection timeout for the underlying Jedis pool which otherwise defaults to Protocol.DEFAULT_TIMEOUT milliseconds.
    
    Parameters:
    
    connectTimeout - the timeout
    
    Returns:
    
    the builder
  - socketTimeout
```
public RedisStoreBuilder<T> socketTimeout(java.time.Duration socketTimeout)
```
    Optional override which sets the connection timeout for the underlying Jedis pool which otherwise defaults to Protocol.DEFAULT_TIMEOUT milliseconds.
    
    Parameters:
    
    socketTimeout - the socket timeout
    
    Returns:
    
    the builder
  - describeConfiguration
```
public com.launchdarkly.sdk.LDValue describeConfiguration(com.launchdarkly.sdk.server.subsystems.ClientContext clientContext)
```
    Specified by:
    
    describeConfiguration in interface com.launchdarkly.sdk.server.subsystems.DiagnosticDescription

Class RedisStoreBuilder<T>

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.launchdarkly.sdk.server.subsystems.ComponentConfigurer

Field Detail

DEFAULT_URI

DEFAULT_PREFIX

Method Detail

database

password

tls

uri

prefix

poolConfig

connectTimeout

socketTimeout

describeConfiguration