FeatureStoreCacheConfig (launchdarkly-java-server-sdk 4.13.0 API)

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

Deprecated.
This has been superseded by the PersistentDataStoreBuilder interface.
```
@Deprecated
public final class FeatureStoreCacheConfig
extends java.lang.Object
```
Parameters that can be used for FeatureStore implementations that support local caching. If a store implementation uses this class, then it is using the standard caching mechanism that is built into the SDK, and is guaranteed to support all the properties defined in this class.
This is an immutable class that uses a fluent interface. Obtain an instance by calling the static methods disabled() or enabled(); then, if desired, you can use chained methods to set other properties:
```
     Components.redisFeatureStore()
         .caching(
             FeatureStoreCacheConfig.enabled()
                 .ttlSeconds(30)
                 .staleValuesPolicy(FeatureStoreCacheConfig.StaleValuesPolicy.REFRESH)
         )
 
```
Since:

4.6.0

See Also:

RedisFeatureStoreBuilder.caching(FeatureStoreCacheConfig)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FeatureStoreCacheConfig.StaleValuesPolicy
Deprecated.

Possible values for staleValuesPolicy(StaleValuesPolicy).

Nested Classes
Modifier and Type	Class and Description
`static class`	`FeatureStoreCacheConfig.StaleValuesPolicy` Deprecated. Possible values for `staleValuesPolicy(StaleValuesPolicy)`.

Field Summary

Fields
Modifier and Type	Field and Description
`static FeatureStoreCacheConfig`	`DEFAULT` Deprecated. The caching parameters that feature store should use by default.
`static long`	`DEFAULT_TIME_SECONDS` Deprecated. The default TTL, in seconds, used by `DEFAULT`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static FeatureStoreCacheConfig`	`disabled()` Deprecated. Returns a parameter object indicating that caching should be disabled.
`static FeatureStoreCacheConfig`	`enabled()` Deprecated. Returns a parameter object indicating that caching should be enabled, using the default TTL of `DEFAULT_TIME_SECONDS`.
`boolean`	`equals(java.lang.Object other)` Deprecated.
`long`	`getCacheTime()` Deprecated. Returns the cache TTL.
`long`	`getCacheTimeMillis()` Deprecated. Returns the cache TTL converted to milliseconds.
`java.util.concurrent.TimeUnit`	`getCacheTimeUnit()` Deprecated. Returns the time unit for the cache TTL.
`FeatureStoreCacheConfig.StaleValuesPolicy`	`getStaleValuesPolicy()` Deprecated. Returns the `FeatureStoreCacheConfig.StaleValuesPolicy` setting.
`int`	`hashCode()` Deprecated.
`boolean`	`isEnabled()` Deprecated. Returns true if caching will be enabled.
`boolean`	`isInfiniteTtl()` Deprecated. Returns true if caching is enabled and does not have a finite TTL.
`FeatureStoreCacheConfig`	`staleValuesPolicy(FeatureStoreCacheConfig.StaleValuesPolicy policy)` Deprecated. Specifies how the cache (if any) should deal with old values when the cache TTL expires.
`FeatureStoreCacheConfig`	`ttl(long cacheTime, java.util.concurrent.TimeUnit timeUnit)` Deprecated. Specifies the cache TTL.
`FeatureStoreCacheConfig`	`ttlMillis(long millis)` Deprecated. Shortcut for calling `ttl(long, TimeUnit)` with `TimeUnit.MILLISECONDS`.
`FeatureStoreCacheConfig`	`ttlSeconds(long seconds)` Deprecated. Shortcut for calling `ttl(long, TimeUnit)` with `TimeUnit.SECONDS`.

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

- Field Detail
  - DEFAULT_TIME_SECONDS
```
public static final long DEFAULT_TIME_SECONDS
```
    Deprecated.
    
    The default TTL, in seconds, used by DEFAULT.
    
    See Also:
    
    Constant Field Values
  - DEFAULT
```
public static final FeatureStoreCacheConfig DEFAULT
```
    Deprecated.
    
    The caching parameters that feature store should use by default. Caching is enabled, with a TTL of DEFAULT_TIME_SECONDS and the FeatureStoreCacheConfig.StaleValuesPolicy.EVICT policy.
- Method Detail
  - disabled
```
public static FeatureStoreCacheConfig disabled()
```
    Deprecated.
    
    Returns a parameter object indicating that caching should be disabled. Specifying any additional properties on this object will have no effect.
    
    Returns:
    
    a FeatureStoreCacheConfig instance
  - enabled
```
public static FeatureStoreCacheConfig enabled()
```
    Deprecated.
    
    Returns a parameter object indicating that caching should be enabled, using the default TTL of DEFAULT_TIME_SECONDS. You can further modify the cache properties using the other methods of this class.
    
    Returns:
    
    a FeatureStoreCacheConfig instance
  - isEnabled
```
public boolean isEnabled()
```
    Deprecated.
    
    Returns true if caching will be enabled.
    
    Returns:
    
    true if the cache TTL is nonzero
  - isInfiniteTtl
```
public boolean isInfiniteTtl()
```
    Deprecated.
    
    Returns true if caching is enabled and does not have a finite TTL.
    
    Returns:
    
    true if the cache TTL is negative
  - getCacheTime
```
public long getCacheTime()
```
    Deprecated.
    
    Returns the cache TTL.
    If the value is zero, caching is disabled.
    If the value is negative, data is cached forever (i.e. it will only be read again from the database if the SDK is restarted). Use the "cached forever" mode with caution: it means that in a scenario where multiple processes are sharing the database, and the current process loses connectivity to LaunchDarkly while other processes are still receiving updates and writing them to the database, the current process will have stale data.
    
    Returns:
    
    the cache TTL in whatever units were specified
    
    See Also:
    
    getCacheTimeUnit()
  - getCacheTimeUnit
```
public java.util.concurrent.TimeUnit getCacheTimeUnit()
```
    Deprecated.
    
    Returns the time unit for the cache TTL.
    
    Returns:
    
    the time unit
  - getCacheTimeMillis
```
public long getCacheTimeMillis()
```
    Deprecated.
    
    Returns the cache TTL converted to milliseconds.
    If the value is zero, caching is disabled.
    If the value is negative, data is cached forever (i.e. it will only be read again from the database if the SDK is restarted). Use the "cached forever" mode with caution: it means that in a scenario where multiple processes are sharing the database, and the current process loses connectivity to LaunchDarkly while other processes are still receiving updates and writing them to the database, the current process will have stale data.
    
    Returns:
    
    the TTL in milliseconds
  - getStaleValuesPolicy
```
public FeatureStoreCacheConfig.StaleValuesPolicy getStaleValuesPolicy()
```
    Deprecated.
    
    Returns the FeatureStoreCacheConfig.StaleValuesPolicy setting.
    
    Returns:
    
    the expiration policy
  - ttl
```
public FeatureStoreCacheConfig ttl(long cacheTime,
                                   java.util.concurrent.TimeUnit timeUnit)
```
    Deprecated.
    
    Specifies the cache TTL. Items will be evicted or refreshed (depending on staleValuesPolicy(StaleValuesPolicy)) after this amount of time from the time when they were originally cached. If the time is less than or equal to zero, caching is disabled. after this amount of time from the time when they were originally cached.
    If the value is zero, caching is disabled.
    If the value is negative, data is cached forever (i.e. it will only be read again from the database if the SDK is restarted). Use the "cached forever" mode with caution: it means that in a scenario where multiple processes are sharing the database, and the current process loses connectivity to LaunchDarkly while other processes are still receiving updates and writing them to the database, the current process will have stale data.
    
    Parameters:
    
    cacheTime - the cache TTL in whatever units you wish
    
    timeUnit - the time unit
    
    Returns:
    
    an updated parameters object
  - ttlMillis
```
public FeatureStoreCacheConfig ttlMillis(long millis)
```
    Deprecated.
    
    Shortcut for calling ttl(long, TimeUnit) with TimeUnit.MILLISECONDS.
    
    Parameters:
    
    millis - the cache TTL in milliseconds
    
    Returns:
    
    an updated parameters object
  - ttlSeconds
```
public FeatureStoreCacheConfig ttlSeconds(long seconds)
```
    Deprecated.
    
    Shortcut for calling ttl(long, TimeUnit) with TimeUnit.SECONDS.
    
    Parameters:
    
    seconds - the cache TTL in seconds
    
    Returns:
    
    an updated parameters object
  - staleValuesPolicy
```
public FeatureStoreCacheConfig staleValuesPolicy(FeatureStoreCacheConfig.StaleValuesPolicy policy)
```
    Deprecated.
    
    Specifies how the cache (if any) should deal with old values when the cache TTL expires. The default is FeatureStoreCacheConfig.StaleValuesPolicy.EVICT. This property has no effect if caching is disabled.
    
    Parameters:
    
    policy - a FeatureStoreCacheConfig.StaleValuesPolicy constant
    
    Returns:
    
    an updated parameters object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Deprecated.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class java.lang.Object

Class FeatureStoreCacheConfig

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TIME_SECONDS

DEFAULT

Method Detail

disabled

enabled

isEnabled

isInfiniteTtl

getCacheTime

getCacheTimeUnit

getCacheTimeMillis

getStaleValuesPolicy

ttl

ttlMillis

ttlSeconds

staleValuesPolicy

equals

hashCode