RedisFeatureStoreBuilder (launchdarkly-java-server-sdk 4.6.6 API)

java.lang.Object
- com.launchdarkly.client.RedisFeatureStoreBuilder

All Implemented Interfaces:: FeatureStoreFactory

public final class RedisFeatureStoreBuilder
extends java.lang.Object
implements FeatureStoreFactory

This class exposes advanced configuration options for the RedisFeatureStore. A builder that helps construct RedisFeatureStore objects. RedisFeatureStoreBuilder calls can be chained, enabling the following pattern:

 RedisFeatureStore store = new RedisFeatureStoreBuilder("host", 443, 60)
      .refreshStaleValues(true)
      .asyncRefresh(true)
      .socketTimeout(200)
      .build()

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_CACHE_TIME_SECONDS` Deprecated. Use `FeatureStoreCacheConfig.DEFAULT`.
`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`

Constructor Summary

Constructors
Constructor and Description
`RedisFeatureStoreBuilder(java.lang.String scheme, java.lang.String host, int port, long cacheTimeSecs)` Deprecated. Please use `Components.redisFeatureStore(java.net.URI)`.
`RedisFeatureStoreBuilder(java.net.URI uri, long cacheTimeSecs)` Deprecated. Please use `Components.redisFeatureStore(java.net.URI)`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RedisFeatureStoreBuilder`	`asyncRefresh(boolean enabled)` Deprecated. Use `caching(FeatureStoreCacheConfig)` and `FeatureStoreCacheConfig.staleValuesPolicy(com.launchdarkly.client.FeatureStoreCacheConfig.StaleValuesPolicy)`.
`RedisFeatureStore`	`build()` Build a `RedisFeatureStore` based on the currently configured builder object.
`RedisFeatureStoreBuilder`	`cacheTime(long cacheTime, java.util.concurrent.TimeUnit timeUnit)` Deprecated. use `caching(FeatureStoreCacheConfig)` and `FeatureStoreCacheConfig.ttl(long, TimeUnit)`.
`RedisFeatureStoreBuilder`	`caching(FeatureStoreCacheConfig caching)` Specifies whether local caching should be enabled and if so, sets the cache properties.
`RedisFeatureStoreBuilder`	`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`
`RedisFeatureStore`	`createFeatureStore()` Synonym for `build()`.
`RedisFeatureStoreBuilder`	`poolConfig(redis.clients.jedis.JedisPoolConfig poolConfig)` Optional override if you wish to specify your own configuration to the underlying Jedis pool.
`RedisFeatureStoreBuilder`	`prefix(java.lang.String prefix)` Optionally configures the namespace prefix for all keys stored in Redis.
`RedisFeatureStoreBuilder`	`refreshStaleValues(boolean enabled)` Deprecated. Use `caching(FeatureStoreCacheConfig)` and `FeatureStoreCacheConfig.staleValuesPolicy(com.launchdarkly.client.FeatureStoreCacheConfig.StaleValuesPolicy)`.
`RedisFeatureStoreBuilder`	`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`

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
    
    Since:
    
    4.0.0
  - DEFAULT_PREFIX
```
public static final java.lang.String DEFAULT_PREFIX
```
    The default value for prefix(String).
    
    Since:
    
    4.0.0
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_TIME_SECONDS
```
public static final long DEFAULT_CACHE_TIME_SECONDS
```
    Deprecated. Use FeatureStoreCacheConfig.DEFAULT.
    
    The default value for cacheTime(long, TimeUnit) (in seconds).
    
    Since:
    
    4.0.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RedisFeatureStoreBuilder
```
public RedisFeatureStoreBuilder(java.net.URI uri,
                                long cacheTimeSecs)
```
    Deprecated. Please use Components.redisFeatureStore(java.net.URI).
    
    The constructor accepts the mandatory fields that must be specified at a minimum to construct a RedisFeatureStore.
    
    Parameters:
    
    uri - the uri of the Redis resource to connect to.
    
    cacheTimeSecs - the cache time in seconds. See cacheTime(long, TimeUnit) for more information.
  - RedisFeatureStoreBuilder
```
public RedisFeatureStoreBuilder(java.lang.String scheme,
                                java.lang.String host,
                                int port,
                                long cacheTimeSecs)
                         throws java.net.URISyntaxException
```
    Deprecated. Please use Components.redisFeatureStore(java.net.URI).
    
    The constructor accepts the mandatory fields that must be specified at a minimum to construct a RedisFeatureStore.
    
    Parameters:
    
    scheme - the URI scheme to use
    
    host - the hostname to connect to
    
    port - the port to connect to
    
    cacheTimeSecs - the cache time in seconds. See cacheTime(long, TimeUnit) for more information.
    
    Throws:
    
    java.net.URISyntaxException - if the URI is not valid
- Method Detail
  - caching
```
public RedisFeatureStoreBuilder caching(FeatureStoreCacheConfig caching)
```
    Specifies whether local caching should be enabled and if so, sets the cache properties. Local caching is enabled by default; see FeatureStoreCacheConfig.DEFAULT. To disable it, pass FeatureStoreCacheConfig.disabled() to this method.
    
    Parameters:
    
    caching - a FeatureStoreCacheConfig object specifying caching parameters
    
    Returns:
    
    the builder
    
    Since:
    
    4.6.0
  - refreshStaleValues
```
public RedisFeatureStoreBuilder refreshStaleValues(boolean enabled)
```
    Deprecated. Use caching(FeatureStoreCacheConfig) and FeatureStoreCacheConfig.staleValuesPolicy(com.launchdarkly.client.FeatureStoreCacheConfig.StaleValuesPolicy).
    
    Deprecated method for setting the cache expiration policy to FeatureStoreCacheConfig.StaleValuesPolicy.REFRESH or FeatureStoreCacheConfig.StaleValuesPolicy.REFRESH_ASYNC.
    
    Parameters:
    
    enabled - turns on lazy refresh of cached values
    
    Returns:
    
    the builder
  - asyncRefresh
```
public RedisFeatureStoreBuilder asyncRefresh(boolean enabled)
```
    Deprecated. Use caching(FeatureStoreCacheConfig) and FeatureStoreCacheConfig.staleValuesPolicy(com.launchdarkly.client.FeatureStoreCacheConfig.StaleValuesPolicy).
    
    Deprecated method for setting the cache expiration policy to FeatureStoreCacheConfig.StaleValuesPolicy.REFRESH_ASYNC.
    
    Parameters:
    
    enabled - turns on asynchronous refresh of cached values (only if refreshStaleValues(boolean) is also true)
    
    Returns:
    
    the builder
  - prefix
```
public RedisFeatureStoreBuilder prefix(java.lang.String prefix)
```
    Optionally configures the namespace prefix for all keys stored in Redis.
    
    Parameters:
    
    prefix - the namespace prefix
    
    Returns:
    
    the builder
  - cacheTime
```
public RedisFeatureStoreBuilder cacheTime(long cacheTime,
                                          java.util.concurrent.TimeUnit timeUnit)
```
    Deprecated. use caching(FeatureStoreCacheConfig) and FeatureStoreCacheConfig.ttl(long, TimeUnit).
    
    Deprecated method for enabling local caching and setting the cache TTL. Local caching is enabled by default; see FeatureStoreCacheConfig.DEFAULT.
    
    Parameters:
    
    cacheTime - the time value to cache for, or 0 to disable local caching
    
    timeUnit - the time unit for the time value
    
    Returns:
    
    the builder
  - poolConfig
```
public RedisFeatureStoreBuilder 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 RedisFeatureStoreBuilder 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 RedisFeatureStoreBuilder 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
  - build
```
public RedisFeatureStore build()
```
    Build a RedisFeatureStore based on the currently configured builder object.
    
    Returns:
    
    the RedisFeatureStore configured by this builder.
  - createFeatureStore
```
public RedisFeatureStore createFeatureStore()
```
    Synonym for build().
    
    Specified by:
    
    createFeatureStore in interface FeatureStoreFactory
    
    Returns:
    
    the RedisFeatureStore configured by this builder.
    
    Since:
    
    4.0.0

Class RedisFeatureStoreBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_URI

DEFAULT_PREFIX

DEFAULT_CACHE_TIME_SECONDS

Constructor Detail

RedisFeatureStoreBuilder

RedisFeatureStoreBuilder

Method Detail

caching

refreshStaleValues

asyncRefresh

prefix

cacheTime

poolConfig

connectTimeout

socketTimeout

build

createFeatureStore