com.nimbusds.infinispan.persistence.dynamodb.config.DynamoDBStoreConfiguration Maven / Gradle / Ivy
Show all versions of infinispan-cachestore-dynamodb Show documentation
package com.nimbusds.infinispan.persistence.dynamodb.config;
import java.util.Properties;
import java.util.Set;
import com.amazonaws.regions.Regions;
import com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput;
import com.codahale.metrics.MetricRegistry;
import net.jcip.annotations.Immutable;
import org.infinispan.commons.configuration.BuiltBy;
import org.infinispan.commons.configuration.ConfigurationFor;
import org.infinispan.commons.configuration.attributes.Attribute;
import org.infinispan.commons.configuration.attributes.AttributeDefinition;
import org.infinispan.commons.configuration.attributes.AttributeSet;
import org.infinispan.commons.util.StringPropertyReplacer;
import org.infinispan.configuration.cache.AbstractStoreConfiguration;
import org.infinispan.configuration.cache.AsyncStoreConfiguration;
import org.infinispan.configuration.cache.SingletonStoreConfiguration;
import com.nimbusds.common.config.LoggableConfiguration;
import com.nimbusds.infinispan.persistence.dynamodb.DynamoDBItemTransformer;
import com.nimbusds.infinispan.persistence.dynamodb.DynamoDBStore;
import com.nimbusds.infinispan.persistence.dynamodb.logging.Loggers;
/**
* DynamoDB store configuration.
*/
@Immutable
@BuiltBy(DynamoDBStoreConfigurationBuilder.class)
@ConfigurationFor(DynamoDBStore.class)
public class DynamoDBStoreConfiguration extends AbstractStoreConfiguration implements LoggableConfiguration {
/**
* The attribute definition for the DynamoDB endpoint.
*/
static final AttributeDefinition ENDPOINT = AttributeDefinition.builder("endpoint", null, String.class).build();
/**
* The attribute definition for the AWS region.
*/
static final AttributeDefinition REGION = AttributeDefinition.builder("region", Regions.DEFAULT_REGION, Regions.class).build();
/**
* The attribute definition for the item transformer class.
*/
static final AttributeDefinition ITEM_TRANSFORMER = AttributeDefinition.builder("recordTransformer", null, Class.class).build();
/**
* The attribute definition for the query executor class.
*/
static final AttributeDefinition QUERY_EXECUTOR = AttributeDefinition.builder("queryExecutor", null, Class.class).build();
/**
* The attribute definition for the indexed DynamoDB table attributes.
*/
static final AttributeDefinition INDEXED_ATTRIBUTES = AttributeDefinition.builder("indexedAttributes", null, Set.class).build();
/**
* The attribute definition for making consistent reads.
*/
static final AttributeDefinition CONSISTENT_READS = AttributeDefinition.builder("consistentReads", false, Boolean.class).build();
/**
* The attribute definition for the read capacity to provision when
* creating a new DynamoDB table and indices.
*/
static final AttributeDefinition READ_CAPACITY = AttributeDefinition.builder("readCapacity", 1L, Long.class).build();
/**
* The attribute definition for the write capacity to provision when
* creating a new DynamoDB table and indices.
*/
static final AttributeDefinition WRITE_CAPACITY = AttributeDefinition.builder("writeCapacity", 1L, Long.class).build();
/**
* The attribute definition for creating the DynamoDB table with
* encryption at rest.
*/
static final AttributeDefinition ENCRYPTION_AT_REST = AttributeDefinition.builder("encryptionAtRest", false, Boolean.class).build();
/**
* The attribute definition for the optional DynamoDB table prefix.
*/
static final AttributeDefinition TABLE_PREFIX = AttributeDefinition.builder("tablePrefix", "", String.class).build();
/**
* The attribute definition for an explicit metric registry to use
* (other than {@link com.nimbusds.common.monitor.MonitorRegistries}
* singleton).
*/
static final AttributeDefinition METRIC_REGISTRY = AttributeDefinition.builder("metricRegistry", null, MetricRegistry.class).build();
/**
* The attribute definition for the optional range key to apply to all
* DynamoDB operations.
*/
static final AttributeDefinition APPLY_RANGE_KEY = AttributeDefinition.builder("applyRangeKey", null, String.class).build();
/**
* The attribute definition for the value of the optional range key.
*/
static final AttributeDefinition RANGE_KEY_VALUE = AttributeDefinition.builder("rangeKeyValue", null, String.class).build();
/**
* The attribute definition for the enable stream flag.
*/
static final AttributeDefinition ENABLE_STREAM = AttributeDefinition.builder("enableStream", false, Boolean.class).build();
/**
* The attribute definition for the continuous backups flag.
*/
static final AttributeDefinition ENABLE_CONTINUOUS_BACKUPS = AttributeDefinition.builder("enableContinuousBackups", false, Boolean.class).build();
/**
* The attribute definition for the enable TTL flag.
*/
static final AttributeDefinition ENABLE_TTL = AttributeDefinition.builder("enableTTL", false, Boolean.class).build();
/**
* The attribute definition for the expired entries purge limit.
*/
static final AttributeDefinition PURGE_LIMIT = AttributeDefinition.builder("purgeLimit", -1, Integer.class).build();
/**
* The attribute definition for the HTTP proxy host.
*/
static final AttributeDefinition HTTP_PROXY_HOST = AttributeDefinition.builder("httpProxyHost", null, String.class).build();
/**
* The attribute definition for the HTTP proxy port.
*/
static final AttributeDefinition HTTP_PROXY_PORT = AttributeDefinition.builder("httpProxyPort", -1, Integer.class).build();
/**
* The attribute definition for the HMAC SHA-256 key.
*/
static final AttributeDefinition HMAC_SHA_256_KEY = AttributeDefinition.builder("hmacSHA256Key", null, String.class).build();
/**
* Returns the attribute definitions for the DynamoDB store configuration.
*
* @return The attribute definitions.
*/
public static AttributeSet attributeDefinitionSet() {
return new AttributeSet(DynamoDBStoreConfiguration.class,
AbstractStoreConfiguration.attributeDefinitionSet(),
ENDPOINT,
REGION,
ITEM_TRANSFORMER,
QUERY_EXECUTOR,
INDEXED_ATTRIBUTES,
CONSISTENT_READS,
READ_CAPACITY,
WRITE_CAPACITY,
ENCRYPTION_AT_REST,
TABLE_PREFIX,
APPLY_RANGE_KEY,
RANGE_KEY_VALUE,
ENABLE_STREAM,
METRIC_REGISTRY,
ENABLE_CONTINUOUS_BACKUPS,
ENABLE_TTL,
PURGE_LIMIT,
HTTP_PROXY_HOST,
HTTP_PROXY_PORT,
HMAC_SHA_256_KEY);
}
/**
* The DynamoDB endpoint. If set region is overridden (ignored).
*/
private final Attribute endpoint;
/**
* The AWS region.
*/
private final Attribute region;
/**
* The class for transforming between Infinispan entries (key / value
* pair and optional metadata) and a corresponding DynamoDB item.
*
* See {@link DynamoDBItemTransformer}.
*/
private final Attribute itemTransformerClass;
/**
* Optional class for executing direct DynamoDB queries against
* DynamoDB.
*
* See {@link com.nimbusds.infinispan.persistence.common.query.QueryExecutor}
*/
private final Attribute queryExecutorClass;
/**
* Optional set of the indexed DynamoDB attributes.
*/
private final Attribute indexedAttributes;
/**
* The consistent read flag.
*/
private final Attribute consistentRead;
/**
* The optional DynamoDB table prefix.
*/
private final Attribute tablePrefix;
/**
* The read capacity to provision when creating a new DynamoDB table
* and indices.
*/
private final Attribute readCapacity;
/**
* The write capacity to provision when creating a new DynamoDB table
* and indices.
*/
private final Attribute writeCapacity;
/**
* To create the DynamoDB table with encryption at rest.
*/
private final Attribute encryptionAtRest;
/**
* The optional range key to apply to all DynamoDB operations.
*/
private final Attribute applyRangeKey;
/**
* The value of the optional range key.
*/
private final Attribute rangeKeyValue;
/**
* The stream enable flag.
*/
private final Attribute enableStream;
/**
* The explicit metric registry to use.
*/
private final Attribute metricRegistry;
/**
* The continuous backups / point in time recovery flag.
*/
private final Attribute enableContinuousBackups;
/**
* The enable TTL flag.
*/
private final Attribute enableTTL;
/**
* The expired entries purge limit.
*/
private final Attribute purgeLimit;
/**
* The HTTP proxy host.
*/
private final Attribute httpProxyHost;
/**
* The HTTP proxy port.
*/
private final Attribute httpProxyPort;
/**
* The HMAC SHA-256 key (BASE 64 encoded).
*/
private final Attribute hmacSHA256Key;
/**
* Creates a new DynamoDB store configuration.
*
* @param attributes The configuration attributes. Must not
* be {@code null}.
* @param asyncConfig Configuration for the async cache
* loader.
* @param singletonStoreConfig Configuration for a singleton store.
*/
public DynamoDBStoreConfiguration(final AttributeSet attributes,
final AsyncStoreConfiguration asyncConfig,
final SingletonStoreConfiguration singletonStoreConfig) {
super(attributes, asyncConfig, singletonStoreConfig);
endpoint = attributes.attribute(ENDPOINT);
assert endpoint != null;
region = attributes.attribute(REGION);
assert region != null;
itemTransformerClass = attributes.attribute(ITEM_TRANSFORMER);
assert itemTransformerClass != null;
queryExecutorClass = attributes.attribute(QUERY_EXECUTOR);
indexedAttributes = attributes.attribute(INDEXED_ATTRIBUTES);
consistentRead = attributes.attribute(CONSISTENT_READS);
readCapacity = attributes.attribute(READ_CAPACITY);
assert readCapacity != null;
writeCapacity = attributes.attribute(WRITE_CAPACITY);
assert writeCapacity != null;
encryptionAtRest = attributes.attribute(ENCRYPTION_AT_REST);
tablePrefix = attributes.attribute(TABLE_PREFIX);
assert tablePrefix != null;
applyRangeKey = attributes.attribute(APPLY_RANGE_KEY);
assert applyRangeKey != null;
rangeKeyValue = attributes.attribute(RANGE_KEY_VALUE);
assert rangeKeyValue != null;
enableStream = attributes.attribute(ENABLE_STREAM);
assert enableStream != null;
enableContinuousBackups = attributes.attribute(ENABLE_CONTINUOUS_BACKUPS);
assert enableContinuousBackups != null;
enableTTL = attributes.attribute(ENABLE_TTL);
assert enableTTL != null;
purgeLimit = attributes.attribute(PURGE_LIMIT);
httpProxyHost = attributes.attribute(HTTP_PROXY_HOST);
httpProxyPort = attributes.attribute(HTTP_PROXY_PORT);
hmacSHA256Key = attributes.attribute(HMAC_SHA_256_KEY);
metricRegistry = attributes.attribute(METRIC_REGISTRY);
}
/**
* Returns the DynamoDB endpoint.
*
* @return The DynamoDB endpoint, {@code null} if not set.
*/
public String getEndpoint() {
return endpoint.get();
}
/**
* Returns the AWS region.
*
* @return The AWS region.
*/
public Regions getRegion() {
return region.get();
}
/**
* Returns the class for transforming between Infinispan entries (key /
* value pairs and optional metadata) and a corresponding DynamoDB
* item.
*
* See {@link DynamoDBItemTransformer}.
*
* @return The item transformer class.
*/
public Class getItemTransformerClass() {
return itemTransformerClass.get();
}
/**
* Returns the optional class for executing direct queries against
* DynamoDB.
*
*
See {@link com.nimbusds.infinispan.persistence.common.query.QueryExecutor}
*
* @return The query executor class, {@code null} if not specified.
*/
public Class getQueryExecutorClass() {
return queryExecutorClass.get();
}
/**
* Returns the optional indexed DynamoDB attributes.
*
*
See {@link #getQueryExecutorClass}
*
* @return The indexed attributes, {@code null} if no specified.
*/
@SuppressWarnings("unchecked")
public Set getIndexedAttributes() {
return (Set) indexedAttributes.get();
}
/**
* Returns the consistent reads flag.
*
* @return {@code true} for strong consistent reads, {@code false} for
* eventually consistent.
*/
public boolean isConsistentReads() {
return consistentRead.get();
}
/**
* Returns the read and write capacity to provision when creating a new
* DynamoDB table.
*
* @return The read and write capacity.
*/
public ProvisionedThroughput getProvisionedThroughput() {
return new ProvisionedThroughput(readCapacity.get(), writeCapacity.get());
}
/**
* Returns the setting for creating the DynamoDB table with encryption
* at rest.
*
* @return {@code true} to create the table with encryption at rest,
* {@code false} with no encryption.
*/
public boolean isTableWithEncryptionAtRest() {
return encryptionAtRest.get();
}
/**
* Returns the optional DynamoDB table prefix.
*
* @return The DynamoDB table prefix, empty string if not set.
*/
public String getTablePrefix() {
return tablePrefix.get();
}
/**
* Returns the name of the optional range key to apply to all DynamoDB
* operations.
*
* @return The range key name, {@code null} if not specified.
*/
public String getApplyRangeKey() {
String keyName = applyRangeKey.get();
if (keyName == null || keyName.trim().isEmpty()) {
return null;
}
return keyName;
}
/**
* Returns the value of the optional range key.
*
* @return The range key value, {@code null} if not specified.
*/
public String getRangeKeyValue() {
String keyValue = rangeKeyValue.get();
if (keyValue == null || keyValue.trim().isEmpty()) {
return null;
}
return keyValue;
}
/**
* Returns the value of the enable stream flag.
*
* @return The enable stream flag.
*/
public boolean isEnableStream() {
return enableStream.get();
}
/**
* Returns the value of the enable continuous backups / point in time
* recovery flag.
*
* @return The continuous backups flag.
*/
public boolean isEnableContinuousBackups() {
return enableContinuousBackups.get();
}
/**
* Returns the values of the enable TTL flag.
*
* @return The enable TTL flag.
*/
public boolean isEnableTTL() {
return enableTTL.get();
}
/**
* Returns the expired items purge limit.
*
* @return The expired items purge limit, -1 for no limit.
*/
public int getPurgeLimit() {
return purgeLimit.get();
}
/**
* Returns the HTTP proxy host.
*
* @return The host, {@code null} if none.
*/
public String getHTTPProxyHost() {
return httpProxyHost.get();
}
/**
* Returns the HTTP proxy port.
*
* @return The port, -1 if not specified.
*/
public int getHTTPProxyPort() {
return httpProxyPort.get();
}
/**
* Returns the HMAC SHA-256 key.
*
* @return The HMAC SHA-256 key (BASE 64 encoded), {@code null} if not
* specified.
*/
public String getHMACSHA256Key() {
return hmacSHA256Key.get();
}
/**
* Returns the explicit metric registry to use.
*
* @return The metric registry instance.
*/
public MetricRegistry getMetricRegistry() {
return metricRegistry.get();
}
@Override
public Properties properties() {
// Interpolate with system properties where ${sysPropName} is found
Properties interpolatedProps = new Properties();
for (String name : super.properties().stringPropertyNames()) {
interpolatedProps.setProperty(name, StringPropertyReplacer.replaceProperties(super.properties().getProperty(name)));
}
return interpolatedProps;
}
@Override
public void log() {
Loggers.MAIN_LOG.info("[DS0000] Infinispan DynamoDB store: Endpoint (overrides region): {}", getEndpoint() != null ? getEndpoint() : "not set");
Loggers.MAIN_LOG.info("[DS0001] Infinispan DynamoDB store: Region: {}", getRegion());
Loggers.MAIN_LOG.info("[DS0002] Infinispan DynamoDB store: Item transformer class: {}", getItemTransformerClass().getCanonicalName());
Loggers.MAIN_LOG.info("[DS0009] Infinispan DynamoDB store: Query executor class: {}", getQueryExecutorClass() != null ? getQueryExecutorClass().getCanonicalName() : "none");
Loggers.MAIN_LOG.info("[DS0010] Infinispan DynamoDB store: Indexed attributes: {}", getIndexedAttributes() != null ? getIndexedAttributes() : "none");
Loggers.MAIN_LOG.info("[DS0015] Infinispan DynamoDB store: Consistent reads: {}", isConsistentReads());
Loggers.MAIN_LOG.info("[DS0005] Infinispan DynamoDB store: Capacity to provision: read={} write={}", getProvisionedThroughput().getReadCapacityUnits(), getProvisionedThroughput().getWriteCapacityUnits());
Loggers.MAIN_LOG.info("[DS0011] Infinispan DynamoDB store: Table encryption at rest: {}", isTableWithEncryptionAtRest());
Loggers.MAIN_LOG.info("[DS0006] Infinispan DynamoDB store: Table prefix: {}", getTablePrefix().isEmpty() ? "none" : getTablePrefix());
Loggers.MAIN_LOG.info("[DS0007] Infinispan DynamoDB store: Apply range key: {}", getApplyRangeKey() != null ? getApplyRangeKey() : "none");
Loggers.MAIN_LOG.info("[DS0008] Infinispan DynamoDB store: Range key value: {}", getRangeKeyValue() != null ? getRangeKeyValue() : "none");
Loggers.MAIN_LOG.info("[DS0003] Infinispan DynamoDB store: Enable stream: {}", isEnableStream());
Loggers.MAIN_LOG.info("[DS0012] Infinispan DynamoDB store: Enable continuous backups: {}", isEnableContinuousBackups());
Loggers.MAIN_LOG.info("[DS0014] Infinispan DynamoDB store: Enable TTL: {}", isEnableTTL());
Loggers.MAIN_LOG.info("[DS0016] Infinispan DynamoDB store: Expired entries purge limit: {}", this::getPurgeLimit);
Loggers.MAIN_LOG.info("[DS0017] Infinispan DynamoDB store: HTTP proxy host: {}", getHTTPProxyHost() != null ? getHTTPProxyHost() : "none");
Loggers.MAIN_LOG.info("[DS0018] Infinispan DynamoDB store: HTTP proxy port: {}", getHTTPProxyPort());
Loggers.MAIN_LOG.info("[DS0019] Infinispan DynamoDB store: HMAC SHA-256 key: {}", getHMACSHA256Key() != null ? "configured" : "none");
Loggers.MAIN_LOG.info("[DS0013] Infinispan DynamoDB store: Explicit metric registry: {}", getMetricRegistry() != null);
}
}