updates for Java SDK 6.0.0 (#19)

Author: eli-darkly

README.md

@@ -5,11 +5,7 @@
 
 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 5.10.0 of the LaunchDarkly Java SDK, and at least version 2.1 of the AWS SDK for Java. The minimum Java version is 8.
-
-For Java SDK 5.0 through 5.9, use the latest 3.x version of this library. For Java SDK 4.x, use the latest 2.x version.
-
-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 6.0.0 of the LaunchDarkly Java SDK, and at least version 2.1 of the AWS SDK for Java. For versions of the library to use with earlier SDK versions, see the changelog. The minimum Java version is 8.
 
 See the [API documentation](https://launchdarkly.github.io/java-server-sdk-dynamodb) for details on classes and methods.
 
@@ -26,7 +22,7 @@ This assumes that you have already installed the LaunchDarkly Java SDK.
         <dependency>
           <groupId>com.launchdarkly</groupId>
           <artifactId>launchdarkly-java-server-sdk-dynamodb-store</artifactId>
-          <version>3.0.0</version>
+          <version>5.0.0</version>
         </dependency>
 
 3. If you do not already have the AWS SDK in your project, add the DynamoDB part of it. (This needs to be added separately, rather than being included in the LaunchDarkly jar, because AWS classes are exposed in the public interface.)

build.gradle

@@ -38,7 +38,7 @@ allprojects {
 }
 
 ext.versions = [
-    "sdk": "5.10.0", // the *lowest* version we're compatible with
+    "sdk": "6.0.0-SNAPSHOT", // the *lowest* version we're compatible with
     "dynamodb": "2.10.32"
 ]
 

gradle.properties

@@ -1,4 +1,4 @@
-version=4.0.0
+version=5.0.0-SNAPSHOT
 ossrhUsername=
 ossrhPassword=
 

src/main/java/com/launchdarkly/sdk/server/integrations/DynamoDb.java

@@ -1,7 +1,9 @@
 package com.launchdarkly.sdk.server.integrations;
 
-import com.launchdarkly.sdk.server.interfaces.BigSegmentStoreFactory;
-import com.launchdarkly.sdk.server.interfaces.PersistentDataStoreFactory;
+import com.launchdarkly.sdk.server.Components;
+import com.launchdarkly.sdk.server.subsystems.BigSegmentStore;
+import com.launchdarkly.sdk.server.subsystems.ComponentConfigurer;
+import com.launchdarkly.sdk.server.subsystems.PersistentDataStore;
 
 /**
  * Integration between the LaunchDarkly SDK and DynamoDB.
@@ -12,33 +14,27 @@ public abstract class DynamoDb {
   /**
    * Returns a builder object for creating a DynamoDB-backed data store.
    * <p>
-   * This can be used either for the main data store that holds feature flag data, or for the Big
-   * Segment store, or both. If you are using both, they do not have to have the same parameters.
-   * For instance, in this example the main data store uses a table called "table1" and the Big
-   * Segment store uses a table called "table2":
+   * This is for the main data store that holds feature flag data. To configure a
+   * Big Segment store, use {@link #bigSegmentStore(String)} instead.
+   * <p>
+   * You can use methods of the builder to specify any non-default DynamoDB options
+   * you may want, before passing the builder to {@link Components#persistentDataStore(ComponentConfigurer)}.
+   * In this example, the data store uses a table called "table1" and a namespace prefix of "prefix1":
    *
    * <pre><code>
    *   LDConfig config = new LDConfig.Builder()
    *       .dataStore(
    *           Components.persistentDataStore(
-   *               DynamoDb.dataStore("table1")
-   *           )
-   *       )
-   *       .bigSegments(
-   *           Components.bigSegments(
-   *               DynamoDb.dataStore("table2")
+   *               DynamoDb.dataStore("table1").prefix("prefix1")
    *           )
    *       )
    *       .build();
    * </code></pre>
    *
-   * Note that the builder is passed to one of two methods,
-   * {@link com.launchdarkly.sdk.server.Components#persistentDataStore(PersistentDataStoreFactory)} or
-   * {@link com.launchdarkly.sdk.server.Components#bigSegments(BigSegmentStoreFactory)}, depending on
-   * the context in which it is being used. This is because each of those contexts has its own
-   * additional configuration options that are unrelated to the DynamoDb options. For instance, the
-   * {@link com.launchdarkly.sdk.server.Components#persistentDataStore(PersistentDataStoreFactory)}
-   * builder has options for caching:
+   * 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 {@link Components#persistentDataStore(ComponentConfigurer)}
+   * has options for caching:
    *
    * <pre><code>
    *     LDConfig config = new LDConfig.Builder()
@@ -57,16 +53,58 @@ public abstract class DynamoDb {
    * 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)}.
+   * {@link DynamoDbStoreBuilder#existingClient(software.amazon.awssdk.services.dynamodb.DynamoDbClient)}.
    * <p>
    * If you are using the same DynamoDB table as a data store for multiple LaunchDarkly
-   * environments, use the {@link DynamoDbDataStoreBuilder#prefix(String)} option and choose a 
+   * environments, use the {@link DynamoDbStoreBuilder#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);
+  public static DynamoDbStoreBuilder<PersistentDataStore> dataStore(String tableName) {
+    return new DynamoDbStoreBuilder.ForDataStore(tableName);
+  }
+
+  /**
+   * Returns a builder object for creating a DynamoDB-backed Big Segment store.
+   * <p>
+   * You can use methods of the builder to specify any non-default DynamoDB options
+   * you may want, before passing the builder to {@link Components#bigSegments(ComponentConfigurer)}.
+   * In this example, the store is configured to use a table called "table2" and a
+   * namespace prefix of "prefix2":
+   * <pre><code>
+   *     LDConfig config = new LDConfig.Builder()
+   *         .bigSegments(
+   *             Components.bigSegments(
+   *                 DynamoDb.bigSegmentStore("table2").prefix("prefix2")
+   *             )
+   *         )
+   *         .build();
+   * </code></pre>
+   * <p>
+   * Note that the SDK also has its own options related to Big Segments that are configured
+   * at a different level, because they are independent of what database is being used. For
+   * instance, the builder returned by {@link Components#bigSegments(ComponentConfigurer)}
+   * has an option for the status polling interval: 
+   * <pre><code>
+   *     LDConfig config = new LDConfig.Builder()
+   *         .dataStore(
+   *             Components.bigSegments(
+   *                 DynamoDb.bigSegmentStore("table2")
+   *             ).statusPollInterval(Duration.ofSeconds(30))
+   *         )
+   *         .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".
+   * 
+   * @param tableName the table name in DynamoDB (must already exist)
+   * @return a Big Segment store configuration object
+   * @since 3.0.0
+   */
+  public static DynamoDbStoreBuilder<BigSegmentStore> bigSegmentStore(String tableName) {
+    return new DynamoDbStoreBuilder.ForBigSegments(tableName);
   }
 }

src/main/java/com/launchdarkly/sdk/server/integrations/DynamoDbBigSegmentStoreImpl.java

@@ -1,18 +1,18 @@
 package com.launchdarkly.sdk.server.integrations;
 
-import static com.launchdarkly.sdk.server.interfaces.BigSegmentStoreTypes.createMembershipFromSegmentRefs;
+import static com.launchdarkly.sdk.server.subsystems.BigSegmentStoreTypes.createMembershipFromSegmentRefs;
 
 import com.launchdarkly.logging.LDLogger;
-import com.launchdarkly.sdk.server.interfaces.BigSegmentStore;
-import com.launchdarkly.sdk.server.interfaces.BigSegmentStoreTypes;
+import com.launchdarkly.sdk.server.subsystems.BigSegmentStore;
+import com.launchdarkly.sdk.server.subsystems.BigSegmentStoreTypes;
 
 import java.util.List;
 
 import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 import software.amazon.awssdk.services.dynamodb.model.GetItemResponse;
 
-public class DynamoDbBigSegmentStoreImpl extends DynamoDbStoreImplBase implements BigSegmentStore {
+final class DynamoDbBigSegmentStoreImpl extends DynamoDbStoreImplBase implements BigSegmentStore {
   private final static String MEMBERSHIP_KEY = "big_segments_user";
   private final static String INCLUDED_ATTR = "included";
   private final static String EXCLUDED_ATTR = "excluded";

src/main/java/com/launchdarkly/sdk/server/integrations/DynamoDbDataStoreBuilder.java

@@ -1,11 +1,11 @@
 package com.launchdarkly.sdk.server.integrations;
 
 import com.launchdarkly.logging.LDLogger;
-import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.DataKind;
-import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.FullDataSet;
-import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.KeyedItems;
-import com.launchdarkly.sdk.server.interfaces.DataStoreTypes.SerializedItemDescriptor;
-import com.launchdarkly.sdk.server.interfaces.PersistentDataStore;
+import com.launchdarkly.sdk.server.subsystems.DataStoreTypes.DataKind;
+import com.launchdarkly.sdk.server.subsystems.DataStoreTypes.FullDataSet;
+import com.launchdarkly.sdk.server.subsystems.DataStoreTypes.KeyedItems;
+import com.launchdarkly.sdk.server.subsystems.DataStoreTypes.SerializedItemDescriptor;
+import com.launchdarkly.sdk.server.subsystems.PersistentDataStore;
 
 import java.util.AbstractMap;
 import java.util.ArrayList;