use newer API for Java SDK 4.12.0 and above (#7)

Author: eli-darkly

README.md

@@ -3,13 +3,13 @@
 [![Circle CI](https://circleci.com/gh/launchdarkly/java-server-sdk-dynamodb.svg?style=shield)](https://circleci.com/gh/launchdarkly/java-server-sdk-dynamodb)
 [![Javadocs](http://javadoc.io/badge/com.launchdarkly/launchdarkly-java-server-sdk-dynamodb-store.svg)](http://javadoc.io/doc/com.launchdarkly/launchdarkly-java-server-sdk-dynamodb-store)
 
-This library provides a DynamoDB-backed persistence mechanism (feature store) for the [LaunchDarkly Java SDK](https://github.com/launchdarkly/java-server-sdk), replacing the default in-memory feature store.
+This library provides a DynamoDB-backed persistence mechanism (data store) for the [LaunchDarkly Java SDK](https://github.com/launchdarkly/java-server-sdk), replacing the default in-memory data store.
 
-This version of the library requires at least version 2.1 of the AWS SDK for Java, and at least version 4.6.4 of the LaunchDarkly Java SDK. The minimum Java version is 8 (because that is the minimum Java version of the AWS SDK 2.x). If you need to use Java 7, or if you are already using AWS SDK 1.x for some other purpose, you can use the 1.x releases of this library (which are developed on the "aws-v1" branch of the repository).
+This version of the library requires at least version 2.1 of the AWS SDK for Java, and at least version 4.12.0 of the LaunchDarkly Java SDK. The minimum Java version is 8 (because that is the minimum Java version of the AWS SDK 2.x). If you need to use Java 7, or if you are already using AWS SDK 1.x for some other purpose, you can use the 1.x releases of this library (which are developed on the "aws-v1" branch of the repository).
 
 See the [API documentation](https://launchdarkly.github.io/java-server-sdk-dynamodb) for details on classes and methods.
 
-For more information, see also: [Using a persistent feature store](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
+For more information, see also: [Using a persistent data store](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
 
 ## Quick setup
 
@@ -36,32 +36,42 @@ This assumes that you have already installed the LaunchDarkly Java SDK.
 4. Import the LaunchDarkly package and the package for this library:
 
         import com.launchdarkly.client.*;
-        import com.launchdarkly.client.dynamodb.*;
+        import com.launchdarkly.client.integrations.*;
 
 5. When configuring your SDK client, add the DynamoDB feature store:
 
-        DynamoDbFeatureStoreBuilder store = DynamoDbComponents.dynamoDbFeatureStore("my-table-name")
-            .caching(FeatureStoreCacheConfig.enabled().ttlSeconds(30));
+        DynamoDbDataStoreBuilder dynamoDbStore = DynamoDb.dataStore("my-table-name");
         
         LDConfig config = new LDConfig.Builder()
-            .featureStoreFactory(store)
+            .dataStore(Components.persistentDataStore(dynamoDbStore))
             .build();
         
         LDClient client = new LDClient("YOUR SDK KEY", config);
 
-By default, the DynamoDB client will try to get your AWS credentials and region name from environment variables and/or local configuration files, as described in the AWS SDK documentation. There are methods in `DynamoDBFeatureStoreBuilder` for changing the configuration options. Alternatively, if you already have a fully configured DynamoDB client object, you can tell LaunchDarkly to use that:
+By default, the DynamoDB client will try to get your AWS credentials and region name from environment variables and/or local configuration files, as described in the AWS SDK documentation. There are methods in `DynamoDbDataStoreBuilder` for changing the configuration options. Alternatively, if you already have a fully configured DynamoDB client object, you can tell LaunchDarkly to use that:
 
-        DynamoDbFeatureStoreBuilder store = DynamoDbComponents.dynamoDbFeatureStore("my-table-name")
+        DynamoDbDataStoreBuilder dynamoDbStore = DynamoDb.dataStore("my-table-name")
             .existingClient(myDynamoDbClientInstance);
 
 ## Caching behavior
 
 To reduce traffic to DynamoDB, there is an optional in-memory cache that retains the last known data for a configurable amount of time. This is on by default; to turn it off (and guarantee that the latest feature flag data will always be retrieved from DynamoDB for every flag evaluation), configure the store as follows:
 
-        DynamoDbFeatureStoreBuilder store = DynamoDbComponents.dynamoDbFeatureStore("my-table-name")
-            .caching(FeatureStoreCacheConfig.disabled());
+By default, for any persistent data store, the Java SDK uses an in-memory cache to reduce traffic to the database; this retains the last known data for a configurable amount of time. To change the caching behavior or disable caching, use the `PersistentDataStoreBuilder` methods:
 
-For other ways to control the behavior of the cache, see `DynamoDbFeatureStoreBuilder.caching()`.
+        LDConfig configWithLongerCacheTtl = new LDConfig.Builder()
+            .dataStore(
+                Components.persistentDataStore(dynamoDbStore).cacheSeconds(60)
+            )
+            .build();
+
+        LDConfig configWithNoCaching = new LDConfig.Builder()
+            .dataStore(
+                Components.persistentDataStore(dynamoDbStore).noCaching()
+            )
+            .build();
+
+For other ways to control the behavior of the cache, see `PersistentDataStoreBuilder` in the Java SDK.
 
 ## About LaunchDarkly
 

build.gradle

@@ -44,7 +44,7 @@ libraries.internal = [
 // global state that must be shared between the SDK and the caller. These are not embedded
 // in the uberjar; the caller must provide them on the classpath at runtime.
 libraries.external = [
-    "com.launchdarkly:launchdarkly-java-server-sdk:4.6.4",
+    "com.launchdarkly:launchdarkly-java-server-sdk:4.12.0",
     "software.amazon.awssdk:dynamodb:2.10.32",
     "org.slf4j:slf4j-api:1.7.21"
 ]
@@ -54,7 +54,7 @@ libraries.test = [
     "org.hamcrest:hamcrest-all:1.3",
     "junit:junit:4.12",
     "ch.qos.logback:logback-classic:1.1.7",
-    "com.launchdarkly:launchdarkly-java-server-sdk:4.6.4:test" // our unit tests use helper classes from the SDK
+    "com.launchdarkly:launchdarkly-java-server-sdk:4.12.0:test" // our unit tests use helper classes from the SDK
 ]
 
 dependencies {

src/main/java/com/launchdarkly/client/dynamodb/DynamoDbComponents.java

@@ -1,8 +1,12 @@
 package com.launchdarkly.client.dynamodb;
 
 /**
- * Entry point for using the DynamoDB feature store.
+ * Deprecated entry point for the DynamoDB data store. This is for use with the older feature store API
+ * in Java SDK 4.11.x and below. For Java SDK 4.12 and above, use {@link com.launchdarkly.client.integrations.DynamoDb}.
+ * 
+ * @deprecated Use {@link com.launchdarkly.client.integrations.DynamoDb}.
  */
+@Deprecated
 public abstract class DynamoDbComponents {
   /**
    * Creates a builder for a DynamoDB feature store. You can modify any of the store's properties with
@@ -12,7 +16,9 @@ public abstract class DynamoDbComponents {
    * @param tableName The table name in DynamoDB. This table must already exist (see package
    * documentation).
    * @return the builder
+   * @deprecated Use {@link com.launchdarkly.client.integrations.DynamoDb#dataStore(String)}
    */
+  @Deprecated
   public static DynamoDbFeatureStoreBuilder dynamoDbFeatureStore(String tableName) {
     return new DynamoDbFeatureStoreBuilder(tableName);
   }

src/main/java/com/launchdarkly/client/dynamodb/DynamoDbFeatureStoreBuilder.java

@@ -1,50 +1,44 @@
 package com.launchdarkly.client.dynamodb;
 
+import com.launchdarkly.client.Components;
 import com.launchdarkly.client.FeatureStore;
 import com.launchdarkly.client.FeatureStoreCacheConfig;
 import com.launchdarkly.client.FeatureStoreFactory;
-import com.launchdarkly.client.utils.CachingStoreWrapper;
+import com.launchdarkly.client.LDConfig;
+import com.launchdarkly.client.integrations.DynamoDbDataStoreBuilder;
+import com.launchdarkly.client.integrations.PersistentDataStoreBuilder;
+import com.launchdarkly.client.interfaces.DiagnosticDescription;
+import com.launchdarkly.client.value.LDValue;
 
 import java.net.URI;
 
 import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
 import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
-import software.amazon.awssdk.services.dynamodb.DynamoDbClientBuilder;
 
 /**
- * Builder/factory class for the DynamoDB feature store.
+ * Deprecated builder class for the DynamoDB-based persistent data store.
  * <p>
- * Create this builder by calling {@link DynamoDbComponents#dynamoDbFeatureStore(String)}, then
- * optionally modify its properties with builder methods, and then include it in your client
- * configuration with {@link com.launchdarkly.client.LDConfig.Builder#featureStoreFactory(FeatureStoreFactory)}.
- * <p>
- * The AWS SDK provides many configuration options for a DynamoDB client. This class has
- * corresponding methods for some of the most commonly used ones. If you need more sophisticated
- * control over the DynamoDB client, you can construct one of your own and pass it in with the
- * {@link #existingClient(DynamoDbClient)} method.
+ * The replacement for this class is {@link com.launchdarkly.client.integrations.DynamoDb}.
+ * This class is retained for backward compatibility with older Java SDK versions and will be removed in a
+ * future version. 
+ * 
+ * @deprecated Use {@link com.launchdarkly.client.integrations.DynamoDb#dataStore(String)}
  */
-public class DynamoDbFeatureStoreBuilder implements FeatureStoreFactory {
-  private final String tableName;
-  
-  private String prefix;
-  private DynamoDbClient existingClient;
-  private DynamoDbClientBuilder clientBuilder;
-  
-  private FeatureStoreCacheConfig caching = FeatureStoreCacheConfig.DEFAULT;
+@Deprecated
+public class DynamoDbFeatureStoreBuilder implements FeatureStoreFactory, DiagnosticDescription {
+  private final PersistentDataStoreBuilder wrappedOuterBuilder;
+  private final DynamoDbDataStoreBuilder wrappedBuilder;
 
   DynamoDbFeatureStoreBuilder(String tableName) {
-    this.tableName = tableName;
-    clientBuilder = DynamoDbClient.builder();
+    wrappedBuilder = com.launchdarkly.client.integrations.DynamoDb.dataStore(tableName);
+    wrappedOuterBuilder = Components.persistentDataStore(wrappedBuilder);
   }
 
   @Override
-  public FeatureStore createFeatureStore() {  
-    DynamoDbClient client = (existingClient != null) ? existingClient : clientBuilder.build();
-    DynamoDbFeatureStoreCore core = new DynamoDbFeatureStoreCore(client, tableName, prefix);
-    CachingStoreWrapper wrapper = CachingStoreWrapper.builder(core).caching(caching).build();
-    return wrapper;
+  public FeatureStore createFeatureStore() {
+    return wrappedOuterBuilder.createFeatureStore();
   }
 
   /**
@@ -54,7 +48,7 @@ public FeatureStore createFeatureStore() {
    * @return the builder
    */
   public DynamoDbFeatureStoreBuilder clientOverrideConfiguration(ClientOverrideConfiguration config) {
-    clientBuilder.overrideConfiguration(config);
+    wrappedBuilder.clientOverrideConfiguration(config);
     return this;
   }
 
@@ -66,7 +60,7 @@ public DynamoDbFeatureStoreBuilder clientOverrideConfiguration(ClientOverrideCon
    * @return the builder
    */
   public DynamoDbFeatureStoreBuilder credentials(AwsCredentialsProvider credentialsProvider) {
-    clientBuilder.credentialsProvider(credentialsProvider);
+    wrappedBuilder.credentials(credentialsProvider);
     return this;
   }
 
@@ -79,7 +73,7 @@ public DynamoDbFeatureStoreBuilder credentials(AwsCredentialsProvider credential
    * @return the builder
    */
   public DynamoDbFeatureStoreBuilder endpoint(URI endpointUri) {
-    clientBuilder.endpointOverride(endpointUri);
+    wrappedBuilder.endpoint(endpointUri);
     return this;
   }
 
@@ -91,7 +85,7 @@ public DynamoDbFeatureStoreBuilder endpoint(URI endpointUri) {
    * @return the builder
    */
   public DynamoDbFeatureStoreBuilder region(Region region) {
-    clientBuilder.region(region);
+    wrappedBuilder.region(region);
     return this;
   }
 
@@ -104,7 +98,7 @@ public DynamoDbFeatureStoreBuilder region(Region region) {
    * @return the builder
    */
   public DynamoDbFeatureStoreBuilder prefix(String prefix) {
-    this.prefix = prefix;
+    wrappedBuilder.prefix(prefix);
     return this;
   }
 
@@ -117,7 +111,7 @@ public DynamoDbFeatureStoreBuilder prefix(String prefix) {
    * @return the builder
    */
   public DynamoDbFeatureStoreBuilder existingClient(DynamoDbClient existingClient) {
-    this.existingClient = existingClient;
+    wrappedBuilder.existingClient(existingClient);
     return this;
   }
 
@@ -130,7 +124,13 @@ public DynamoDbFeatureStoreBuilder existingClient(DynamoDbClient existingClient)
    * @return the builder
    */
   public DynamoDbFeatureStoreBuilder caching(FeatureStoreCacheConfig caching) {
-    this.caching = caching;
+    wrappedOuterBuilder.cacheTime(caching.getCacheTime(), caching.getCacheTimeUnit());
+    wrappedOuterBuilder.staleValuesPolicy(caching.getStaleValuesPolicy().toNewEnum());
     return this;
   }
+
+  @Override
+  public LDValue describeConfiguration(LDConfig config) {
+    return LDValue.of("DynamoDB");
+  }
 }

src/main/java/com/launchdarkly/client/dynamodb/package-info.java

@@ -1,36 +1,4 @@
 /**
- * This package provides a DynamoDB-backed feature store for the LaunchDarkly Java SDK.
- * <p>
- * For more details about how and why you can use a persistent feature store, see:
- * https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store
- * <p>
- * To use the DynamoDB feature store with the LaunchDarkly client, you will first obtain a
- * builder by calling {@link com.launchdarkly.client.dynamodb.DynamoDbComponents#dynamoDbFeatureStore(String)}, then optionally
- * modify its properties, and then include it in your client configuration. For example:
- * 
- * <pre>
- * import com.launchdarkly.client.*;
- * import com.launchdarkly.client.dynamodb.*;
-
- * DynamoDbFeatureStoreBuilder store = DatabaseComponents.dynamoDbFeatureStore("my-table-name")
- *     .caching(FeatureStoreCacheConfig.enabled().ttlSeconds(30));
- * LDConfig config = new LDConfig.Builder()
- *     .featureStoreFactory(store)
- *     .build();
- * </pre>
- * 
- * Note that the specified table must already exist in DynamoDB. It must have a partition key
- * of "namespace", and a sort key of "key".
- * <p>
- * By default, the feature store uses a basic DynamoDB client configuration that takes its
- * AWS credentials and region from AWS environment variables and/or local configuration files.
- * There are options in the builder for changing some configuration options, or you can
- * configure the DynamoDB client yourself and pass it to the builder with
- * {@link com.launchdarkly.client.dynamodb.DynamoDbFeatureStoreBuilder#existingClient(software.amazon.awssdk.services.dynamodb.DynamoDbClient)}.
- * <p>
- * If you are using the same DynamoDB table as a feature store for multiple LaunchDarkly
- * environments, use the {@link com.launchdarkly.client.dynamodb.DynamoDbFeatureStoreBuilder#prefix(String)}
- * option and choose a different prefix string for each, so they will not interfere with each
- * other's data. 
+ * Deprecated package replaced by {@link com.launchdarkly.client.integrations.DynamoDb}. 
  */
 package com.launchdarkly.client.dynamodb;

src/main/java/com/launchdarkly/client/integrations/DynamoDb.java

@@ -0,0 +1,51 @@
+package com.launchdarkly.client.integrations;
+
+/**
+ * Integration between the LaunchDarkly SDK and DynamoDB.
+ * <p>
+ * This API uses the persistent data store model that was introduced in version 4.12.0 of the LaunchDarkly Java SDK.
+ * If you are using an older Java SDK version, use {@link com.launchdarkly.client.dynamodb.DynamoDbComponents}.
+ *
+ * @since 2.1.0
+ */
+public abstract class DynamoDb {
+  /**
+   * Returns a builder object for creating a DynamoDB-backed data store.
+   * <p>
+   * This object can be modified with {@link DynamoDbDataStoreBuilder} methods for any desired
+   * custom DynamoDB options. Then, pass it to
+   * {@link com.launchdarkly.client.Components#persistentDataStore(com.launchdarkly.client.interfaces.PersistentDataStoreFactory)}
+   * and set any desired caching options. Finally, pass the result to
+   * {@link com.launchdarkly.client.LDConfig.Builder#dataStore(com.launchdarkly.client.FeatureStoreFactory)}.
+   * For example:
+   * 
+   * <pre><code>
+   *     LDConfig config = new LDConfig.Builder()
+   *         .dataStore(
+   *             Components.persistentDataStore(
+   *                 DynamoDb.dataStore("my-table-name")
+   *             ).cacheSeconds(15)
+   *         )
+   *         .build();
+   * </code></pre>
+   * 
+   * Note that the specified table must already exist in DynamoDB. It must have a partition key
+   * of "namespace", and a sort key of "key".
+   * <p>
+   * By default, the data store uses a basic DynamoDB client configuration that takes its
+   * AWS credentials and region from AWS environment variables and/or local configuration files.
+   * There are options in the builder for changing some configuration options, or you can
+   * configure the DynamoDB client yourself and pass it to the builder with
+   * {@link DynamoDbDataStoreBuilder#existingClient(software.amazon.awssdk.services.dynamodb.DynamoDbClient)}.
+   * <p>
+   * If you are using the same DynamoDB table as a feature store for multiple LaunchDarkly
+   * environments, use the {@link DynamoDbDataStoreBuilder#prefix(String)} option and choose a 
+   * different prefix string for each, so they will not interfere with each other's data.
+   *  
+   * @param tableName the table name in DynamoDB (must already exist)
+   * @return a data store configuration object
+   */
+  public static DynamoDbDataStoreBuilder dataStore(String tableName) {
+    return new DynamoDbDataStoreBuilder(tableName);
+  }
+}