introduced RootAttribute and RootAttributeConfig

Author: dnltsk

src/main/java/com/dasburo/spring/cache/dynamo/DefaultDynamoCacheWriter.java

@@ -16,8 +16,23 @@
 package com.dasburo.spring.cache.dynamo;
 
 import com.amazonaws.services.dynamodbv2.AmazonDynamoDB;
-import com.amazonaws.services.dynamodbv2.model.*;
+import com.amazonaws.services.dynamodbv2.model.AttributeDefinition;
+import com.amazonaws.services.dynamodbv2.model.AttributeValue;
+import com.amazonaws.services.dynamodbv2.model.CreateTableRequest;
+import com.amazonaws.services.dynamodbv2.model.DeleteItemRequest;
+import com.amazonaws.services.dynamodbv2.model.GetItemRequest;
+import com.amazonaws.services.dynamodbv2.model.GetItemResult;
+import com.amazonaws.services.dynamodbv2.model.KeySchemaElement;
+import com.amazonaws.services.dynamodbv2.model.KeyType;
+import com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput;
+import com.amazonaws.services.dynamodbv2.model.PutItemRequest;
+import com.amazonaws.services.dynamodbv2.model.ResourceNotFoundException;
+import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType;
+import com.amazonaws.services.dynamodbv2.model.ScanRequest;
+import com.amazonaws.services.dynamodbv2.model.TimeToLiveSpecification;
+import com.amazonaws.services.dynamodbv2.model.UpdateTimeToLiveRequest;
 import com.amazonaws.services.dynamodbv2.util.TableUtils;
+import com.dasburo.spring.cache.dynamo.rootattribute.RootAttribute;
 import com.dasburo.spring.cache.dynamo.util.ByteUtils;
 import org.springframework.dao.PessimisticLockingFailureException;
 import org.springframework.lang.Nullable;
@@ -26,7 +41,12 @@
 import java.nio.ByteBuffer;
 import java.time.Duration;
 import java.time.Instant;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.NoSuchElementException;
 import java.util.function.Function;
 
 /**
@@ -43,11 +63,11 @@
  *
  * @author Georg Zimmermann
  */
-class DefaultDynamoCacheWriter implements DynamoCacheWriter {
+public class DefaultDynamoCacheWriter implements DynamoCacheWriter {
 
-  private static final String ATTRIBUTE_KEY = "key";
-  private static final String ATTRIBUTE_VALUE = "value";
-  private static final String ATTRIBUTE_TTL = "ttl";
+  public static final String ATTRIBUTE_KEY = "key";
+  public static final String ATTRIBUTE_VALUE = "value";
+  public static final String ATTRIBUTE_TTL = "ttl";
 
   private final AmazonDynamoDB dynamoTemplate;
   private final Duration sleepTime;
@@ -78,12 +98,12 @@ public AmazonDynamoDB getNativeCacheWriter() {
   }
 
   @Override
-  public void put(String name, String key, byte[] value, @Nullable Duration ttl) {
+  public void put(String name, String key, byte[] value, @Nullable Duration ttl, @Nullable List<RootAttribute> rootAttributes) {
     Assert.notNull(name, "Name must not be null!");
     Assert.notNull(key, "Key must not be null!");
 
     execute(name, connection -> {
-      putInternal(name, key, value, ttl);
+      putInternal(name, key, value, ttl, rootAttributes);
 
       return "OK";
     });
@@ -98,7 +118,7 @@ public byte[] get(String name, String key) {
   }
 
   @Override
-  public byte[] putIfAbsent(String name, String key, @Nullable byte[] value, @Nullable Duration ttl) {
+  public byte[] putIfAbsent(String name, String key, @Nullable byte[] value, @Nullable Duration ttl, @Nullable List<RootAttribute> rootAttributes) {
     Assert.notNull(name, "Name must not be null!");
     Assert.notNull(key, "Key must not be null!");
 
@@ -111,7 +131,7 @@ public byte[] putIfAbsent(String name, String key, @Nullable byte[] value, @Null
       try {
         return getInternal(name, key);
       } catch (NoSuchElementException e) {
-        putInternal(name, key, value, ttl);
+        putInternal(name, key, value, ttl, rootAttributes);
       } finally {
         if (isLockingCacheWriter()) {
           doUnlock(name);
@@ -205,7 +225,7 @@ private byte[] getAttributeValue(GetItemResult result) {
     }
   }
 
-  private void putInternal(String name, String key, @Nullable byte[] value, @Nullable Duration ttl) {
+  private void putInternal(String name, String key, @Nullable byte[] value, @Nullable Duration ttl, @Nullable List<RootAttribute> rootAttributes) {
     Map<String, AttributeValue> attributeValues = new HashMap<>();
     attributeValues.put(ATTRIBUTE_KEY, new AttributeValue().withS(key));
 
@@ -219,6 +239,12 @@ private void putInternal(String name, String key, @Nullable byte[] value, @Nulla
       attributeValues.put(ATTRIBUTE_TTL, new AttributeValue().withN(String.valueOf(Instant.now().plus(ttl).getEpochSecond())));
     }
 
+    if (rootAttributes != null) {
+      rootAttributes.forEach(rootAttribute -> {
+        attributeValues.put(rootAttribute.getName(), rootAttribute.getAttributeValue());
+      });
+    }
+
     PutItemRequest putItemRequest = new PutItemRequest()
       .withTableName(name)
       .withItem(attributeValues);
@@ -233,7 +259,7 @@ private void removeInternal(String name, String key) {
 
   private void doLock(String name) {
     // TODO should a ttl be provided for locking?
-    putInternal(name, createCacheLockKey(name), "1".getBytes(), null);
+    putInternal(name, createCacheLockKey(name), "1".getBytes(), null, null);
   }
 
   private void doUnlock(String name) {

src/main/java/com/dasburo/spring/cache/dynamo/DynamoCache.java

@@ -15,18 +15,24 @@
  */
 package com.dasburo.spring.cache.dynamo;
 
+import com.dasburo.spring.cache.dynamo.rootattribute.RootAttribute;
+import com.dasburo.spring.cache.dynamo.rootattribute.RootAttributeConfig;
+import com.dasburo.spring.cache.dynamo.rootattribute.RootAttributeReader;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.cache.Cache;
 import org.springframework.cache.support.SimpleValueWrapper;
 import org.springframework.util.Assert;
 
 import java.time.Duration;
+import java.util.List;
 import java.util.NoSuchElementException;
+import java.util.Objects;
 import java.util.concurrent.Callable;
+import java.util.stream.Collectors;
 
 /**
- * Spring {@link org.springframework.cache.Cache} adapter implementation
+ * Spring {@link Cache} adapter implementation
  * on top of Amazons DynamoDB.
  *
  * @author Georg Zimmermann
@@ -39,6 +45,8 @@ public class DynamoCache implements Cache {
   private final DynamoCacheWriter writer;
   private final DynamoCacheConfiguration cacheConfig;
 
+  private RootAttributeReader rootAttributeReader = new RootAttributeReader();
+
   /**
    * Constructor.
    *
@@ -152,14 +160,14 @@ public final Duration getTtl() {
   @Override
   public void put(Object key, Object value) {
     Assert.isTrue(key instanceof String, "'key' must be an instance of 'java.lang.String'.");
-    writer.put(cacheName, (String) key, serialize(value), cacheConfig.getTtl());
+    writer.put(cacheName, (String) key, serialize(value), cacheConfig.getTtl(), readRootAttributes(cacheConfig.getRootAttributeConfigs(), value));
   }
 
   @Override
   public ValueWrapper putIfAbsent(Object key, Object value) {
     Assert.isTrue(key instanceof String, "'key' must be an instance of 'java.lang.String'.");
 
-    byte[] result = writer.putIfAbsent(cacheName, (String) key, serialize(value), cacheConfig.getTtl());
+    byte[] result = writer.putIfAbsent(cacheName, (String) key, serialize(value), cacheConfig.getTtl(), readRootAttributes(cacheConfig.getRootAttributeConfigs(), value));
     if (result != null) {
       LOGGER.debug(String.format("Key: %s already exists in the cache. Element will not be replaced.", key));
       return new SimpleValueWrapper(deserialize(result));
@@ -190,4 +198,11 @@ private Object deserialize(byte[] value) {
   private byte[] serialize(Object value) {
     return cacheConfig.getSerializer().serialize(value);
   }
+
+  private List<RootAttribute> readRootAttributes(List<RootAttributeConfig> rootAttributeConfigs, Object value) {
+    return rootAttributeConfigs.stream()
+        .map(rootAttributeConfig -> rootAttributeReader.readRootAttribute(rootAttributeConfig, value))
+        .filter(Objects::nonNull)
+        .collect(Collectors.toList());
+  }
 }

src/main/java/com/dasburo/spring/cache/dynamo/DynamoCacheBuilder.java

@@ -16,10 +16,12 @@
 package com.dasburo.spring.cache.dynamo;
 
 import com.amazonaws.services.dynamodbv2.AmazonDynamoDB;
+import com.dasburo.spring.cache.dynamo.rootattribute.RootAttributeConfig;
 import com.dasburo.spring.cache.dynamo.serializer.DynamoSerializer;
 import org.springframework.util.Assert;
 
 import java.time.Duration;
+import java.util.List;
 
 /**
  * A builder for {@link DynamoCache} instance.
@@ -124,12 +126,24 @@ public DynamoCacheBuilder withSerializer(DynamoSerializer serializer) {
     return this;
   }
 
+  /**
+   * Give a {@link RootAttributeConfig} to the cache to be built.
+   * Defaults to empty {@link List}.
+   *
+   * @param rootAttributeConfigs additional attributes written into the root level
+   * @return this builder for chaining.
+   */
+  public DynamoCacheBuilder withRootAttributes(List<RootAttributeConfig> rootAttributeConfigs) {
+    this.cacheConfig.setRootAttributeConfigs(rootAttributeConfigs);
+    return this;
+  }
+
   /**
    * Give a {@link DynamoCacheWriter} to the cache to be built.
    * Defaults to {@link DefaultDynamoCacheWriter}.
    *
    * @param writer a writer doing the actual cache operations.
-   * @return this buzilder for chaining.
+   * @return this builder for chaining.
    */
   public DynamoCacheBuilder withWriter(DynamoCacheWriter writer) {
     this.writer = writer;

src/main/java/com/dasburo/spring/cache/dynamo/DynamoCacheConfiguration.java

@@ -14,10 +14,14 @@
  */
 package com.dasburo.spring.cache.dynamo;
 
+import com.dasburo.spring.cache.dynamo.rootattribute.RootAttributeConfig;
 import com.dasburo.spring.cache.dynamo.serializer.DynamoSerializer;
 import com.dasburo.spring.cache.dynamo.serializer.StringSerializer;
 
 import java.time.Duration;
+import java.util.List;
+
+import static java.util.Collections.emptyList;
 
 /**
  * A configuration container for a {@link DynamoCache} instance.
@@ -31,17 +35,19 @@ public class DynamoCacheConfiguration {
   private Long readCapacityUnits;
   private Long writeCapacityUnits;
   private DynamoSerializer serializer;
+  private List<RootAttributeConfig> rootAttributeConfigs;
 
-  private DynamoCacheConfiguration(Duration ttl, boolean flushOnBoot, Long readCapacityUnits, Long writeCapacityUnits, DynamoSerializer serializer) {
+  private DynamoCacheConfiguration(Duration ttl, boolean flushOnBoot, Long readCapacityUnits, Long writeCapacityUnits, DynamoSerializer serializer, List<RootAttributeConfig> rootAttributeConfigs) {
     this.ttl = ttl;
     this.flushOnBoot = flushOnBoot;
     this.readCapacityUnits = readCapacityUnits;
     this.writeCapacityUnits = writeCapacityUnits;
     this.serializer = serializer;
+    this.rootAttributeConfigs = rootAttributeConfigs;
   }
 
   public static DynamoCacheConfiguration defaultCacheConfig() {
-    return new DynamoCacheConfiguration(Duration.ZERO, false, 1L, 1L, new StringSerializer());
+    return new DynamoCacheConfiguration(Duration.ZERO, false, 1L, 1L, new StringSerializer(), emptyList());
   }
 
   public Duration getTtl() {
@@ -83,4 +89,12 @@ public DynamoSerializer getSerializer() {
   public void setSerializer(DynamoSerializer serializer) {
     this.serializer = serializer;
   }
+
+  public List<RootAttributeConfig> getRootAttributeConfigs() {
+    return rootAttributeConfigs;
+  }
+
+  public void setRootAttributeConfigs(List<RootAttributeConfig> rootAttributeConfigs) {
+    this.rootAttributeConfigs = rootAttributeConfigs;
+  }
 }

src/main/java/com/dasburo/spring/cache/dynamo/DynamoCacheWriter.java

@@ -16,10 +16,12 @@
 package com.dasburo.spring.cache.dynamo;
 
 import com.amazonaws.services.dynamodbv2.AmazonDynamoDB;
+import com.dasburo.spring.cache.dynamo.rootattribute.RootAttribute;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 import java.time.Duration;
+import java.util.List;
 
 /**
  * {@link DynamoCacheWriter} provides low level access to DynamoDB commands ({@code PUT, GET, ...}) used for
@@ -79,12 +81,13 @@ static DynamoCacheWriter lockingDynamoCacheWriter(AmazonDynamoDB dynamoTemplate)
    * <br><b>Note:</b> The values size must be less than 400 KB.
    * As this is the maximum element size of a binary in Amazons DynamoDB.
    *
-   * @param name  The cache name must not be {@literal null}.
-   * @param key   The key for the cache entry. Must not be {@literal null}.
-   * @param value The value stored for the key. Must not be {@literal null}.
-   * @param ttl   Optional expiration time. Can be {@literal null}.
+   * @param name           The cache name must not be {@literal null}.
+   * @param key            The key for the cache entry. Must not be {@literal null}.
+   * @param value          The value stored for the key. Must not be {@literal null}.
+   * @param ttl            Optional expiration time. Can be {@literal null}.
+   * @param rootAttributes Optional additional root attributes. Can be {@literal null}.
    */
-  void put(String name, String key, byte[] value, @Nullable Duration ttl);
+  void put(String name, String key, byte[] value, @Nullable Duration ttl, @Nullable List<RootAttribute> rootAttributes);
 
   /**
    * Get the binary value representation from Dynamo stored for the given key.
@@ -101,14 +104,15 @@ static DynamoCacheWriter lockingDynamoCacheWriter(AmazonDynamoDB dynamoTemplate)
    * <br><b>Note:</b> The values size must be less than 400 KB.
    * As this is the maximum element size of a binary in Amazons DynamoDB.
    *
-   * @param name  The cache name must not be {@literal null}.
-   * @param key   The key for the cache entry. Must not be {@literal null}.
-   * @param value The value stored for the key. Must not be {@literal null}.
-   * @param ttl   Optional expiration time. Can be {@literal null}.
+   * @param name           The cache name must not be {@literal null}.
+   * @param key            The key for the cache entry. Must not be {@literal null}.
+   * @param value          The value stored for the key. Must not be {@literal null}.
+   * @param ttl            Optional expiration time. Can be {@literal null}.
+   * @param rootAttributes Optional additional root attributes. Can be {@literal null}.
    * @return {@literal null} if the value has been written, the value stored for the key if it already exists.
    */
   @Nullable
-  byte[] putIfAbsent(String name, String key, byte[] value, @Nullable Duration ttl);
+  byte[] putIfAbsent(String name, String key, byte[] value, @Nullable Duration ttl, @Nullable List<RootAttribute> rootAttributes);
 
   /**
    * Remove the given key from Dynamo.

src/main/java/com/dasburo/spring/cache/dynamo/rootattribute/RootAttribute.java

@@ -0,0 +1,23 @@
+package com.dasburo.spring.cache.dynamo.rootattribute;
+
+import com.amazonaws.services.dynamodbv2.model.AttributeValue;
+
+public class RootAttribute {
+
+  private String name;
+  private AttributeValue value;
+
+  public RootAttribute(String name, AttributeValue value) {
+    this.name = name;
+    this.value = value;
+  }
+
+  public String getName() {
+    return name;
+  }
+
+  public AttributeValue getAttributeValue() {
+    return value;
+  }
+
+}

src/main/java/com/dasburo/spring/cache/dynamo/rootattribute/RootAttributeConfig.java

@@ -0,0 +1,33 @@
+package com.dasburo.spring.cache.dynamo.rootattribute;
+
+import com.amazonaws.services.dynamodbv2.model.ScalarAttributeType;
+import org.springframework.util.Assert;
+
+import static com.dasburo.spring.cache.dynamo.DefaultDynamoCacheWriter.ATTRIBUTE_KEY;
+import static com.dasburo.spring.cache.dynamo.DefaultDynamoCacheWriter.ATTRIBUTE_TTL;
+import static com.dasburo.spring.cache.dynamo.DefaultDynamoCacheWriter.ATTRIBUTE_VALUE;
+
+public class RootAttributeConfig {
+
+  private String name;
+  private ScalarAttributeType type;
+
+  public RootAttributeConfig(String name, ScalarAttributeType type) {
+    Assert.notNull(type, "type must not be null!");
+    Assert.notNull(name, "name must not be null!");
+    Assert.isTrue(name.length() > 0, "name must not be empty!");
+    Assert.isTrue(!ATTRIBUTE_KEY.equalsIgnoreCase(name), "name must not equal '" + ATTRIBUTE_KEY+"'");
+    Assert.isTrue(!ATTRIBUTE_VALUE.equalsIgnoreCase(name), "name must not equal '" + ATTRIBUTE_VALUE+"'");
+    Assert.isTrue(!ATTRIBUTE_TTL.equalsIgnoreCase(name), "name must not equal '" + ATTRIBUTE_TTL+"'");
+    this.name = name;
+    this.type = type;
+  }
+
+  public String getName() {
+    return name;
+  }
+
+  public ScalarAttributeType getType() {
+    return type;
+  }
+}