Package com.nimbusds.infinispan.persistence.dynamodb.config

Class DynamoDBStoreConfiguration

  • All Implemented Interfaces:
    com.nimbusds.common.config.LoggableConfiguration, org.infinispan.configuration.cache.StoreConfiguration
    @Immutable
public class DynamoDBStoreConfiguration
extends org.infinispan.configuration.cache.AbstractStoreConfiguration
implements com.nimbusds.common.config.LoggableConfiguration
    DynamoDB store configuration.

    • Field Summary

      • Fields inherited from class org.infinispan.configuration.cache.AbstractStoreConfiguration

        attributes, MAX_BATCH_SIZE, PRELOAD, PROPERTIES, PURGE_ON_STARTUP, READ_ONLY, SEGMENTED, SHARED, TRANSACTIONAL, WRITE_ONLY

      • Fields inherited from interface com.nimbusds.common.config.LoggableConfiguration

        LOG_CATEGORY

    • Constructor Summary

      Constructors 
      Constructor Description
      DynamoDBStoreConfiguration​(org.infinispan.commons.configuration.attributes.AttributeSet attributes, org.infinispan.configuration.cache.AsyncStoreConfiguration asyncConfig)
      Creates a new DynamoDB store configuration.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static org.infinispan.commons.configuration.attributes.AttributeSet attributeDefinitionSet()
      Returns the attribute definitions for the DynamoDB store configuration.
      java.lang.String getApplyRangeKey()
      Returns the name of the optional range key to apply to all DynamoDB operations.
      java.lang.String getEndpoint()
      Returns the DynamoDB endpoint.
      java.lang.String getHMACSHA256Key()
      Returns the HMAC SHA-256 key.
      java.lang.String getHTTPProxyHost()
      Returns the HTTP proxy host.
      int getHTTPProxyPort()
      Returns the HTTP proxy port.
      java.util.Set<java.lang.String> getIndexedAttributes()
      Returns the optional indexed DynamoDB attributes.
      java.lang.Class getItemTransformerClass()
      Returns the class for transforming between Infinispan entries (key / value pairs and optional metadata) and a corresponding DynamoDB item.
      com.codahale.metrics.MetricRegistry getMetricRegistry()
      Returns the explicit metric registry to use.
      com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput getProvisionedThroughput()
      Returns the read and write capacity to provision when creating a new DynamoDB table.
      int getPurgeLimit()
      Returns the expired items purge limit.
      java.lang.Class getQueryExecutorClass()
      Returns the optional class for executing direct queries against DynamoDB.
      java.lang.String getRangeKeyValue()
      Returns the value of the optional range key.
      com.amazonaws.regions.Regions getRegion()
      Returns the AWS region.
      java.lang.String getTablePrefix()
      Returns the optional DynamoDB table prefix.
      boolean isConsistentReads()
      Returns the consistent reads flag.
      boolean isEnableContinuousBackups()
      Returns the value of the enable continuous backups / point in time recovery flag.
      boolean isEnableStream()
      Returns the value of the enable stream flag.
      boolean isEnableTTL()
      Returns the values of the enable TTL flag.
      boolean isTableWithEncryptionAtRest()
      Returns the setting for creating the DynamoDB table with encryption at rest.
      void log()  
      java.util.Properties properties()  
      boolean segmented()  

      • Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfiguration

        async, attributes, equals, fetchPersistentState, hashCode, ignoreModifications, maxBatchSize, preload, purgeOnStartup, shared, toString, transactional, writeOnly

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • DynamoDBStoreConfiguration

        public DynamoDBStoreConfiguration​(org.infinispan.commons.configuration.attributes.AttributeSet attributes,
                                  org.infinispan.configuration.cache.AsyncStoreConfiguration asyncConfig)
        Creates a new DynamoDB store configuration.
        Parameters:
        attributes - The configuration attributes. Must not be null.
        asyncConfig - Configuration for the async cache loader.

    • Method Detail

      • attributeDefinitionSet

        public static org.infinispan.commons.configuration.attributes.AttributeSet attributeDefinitionSet()
        Returns the attribute definitions for the DynamoDB store configuration.
        Returns:
        The attribute definitions.

      • segmented

        public boolean segmented()
        Specified by:
        segmented in interface org.infinispan.configuration.cache.StoreConfiguration
        Overrides:
        segmented in class org.infinispan.configuration.cache.AbstractStoreConfiguration

      • getEndpoint

        public java.lang.String getEndpoint()
        Returns the DynamoDB endpoint.
        Returns:
        The DynamoDB endpoint, null if not set.

      • getRegion

        public com.amazonaws.regions.Regions getRegion()
        Returns the AWS region.
        Returns:
        The AWS region.

      • getItemTransformerClass

        public java.lang.Class getItemTransformerClass()
        Returns the class for transforming between Infinispan entries (key / value pairs and optional metadata) and a corresponding DynamoDB item.

        See DynamoDBItemTransformer.

        Returns:
        The item transformer class.

      • getQueryExecutorClass

        public java.lang.Class getQueryExecutorClass()
        Returns the optional class for executing direct queries against DynamoDB.

        See QueryExecutor

        Returns:
        The query executor class, null if not specified.

      • getIndexedAttributes

        public java.util.Set<java.lang.String> getIndexedAttributes()
        Returns the optional indexed DynamoDB attributes.

        See getQueryExecutorClass()

        Returns:
        The indexed attributes, null if no specified.

      • isConsistentReads

        public boolean isConsistentReads()
        Returns the consistent reads flag.
        Returns:
        true for strong consistent reads, false for eventually consistent.

      • getProvisionedThroughput

        public com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput getProvisionedThroughput()
        Returns the read and write capacity to provision when creating a new DynamoDB table.
        Returns:
        The read and write capacity.

      • isTableWithEncryptionAtRest

        public boolean isTableWithEncryptionAtRest()
        Returns the setting for creating the DynamoDB table with encryption at rest.
        Returns:
        true to create the table with encryption at rest, false with no encryption.

      • getTablePrefix

        public java.lang.String getTablePrefix()
        Returns the optional DynamoDB table prefix.
        Returns:
        The DynamoDB table prefix, empty string if not set.

      • getApplyRangeKey

        public java.lang.String getApplyRangeKey()
        Returns the name of the optional range key to apply to all DynamoDB operations.
        Returns:
        The range key name, null if not specified.

      • getRangeKeyValue

        public java.lang.String getRangeKeyValue()
        Returns the value of the optional range key.
        Returns:
        The range key value, null if not specified.

      • isEnableStream

        public boolean isEnableStream()
        Returns the value of the enable stream flag.
        Returns:
        The enable stream flag.

      • isEnableContinuousBackups

        public boolean isEnableContinuousBackups()
        Returns the value of the enable continuous backups / point in time recovery flag.
        Returns:
        The continuous backups flag.

      • isEnableTTL

        public boolean isEnableTTL()
        Returns the values of the enable TTL flag.
        Returns:
        The enable TTL flag.

      • getPurgeLimit

        public int getPurgeLimit()
        Returns the expired items purge limit.
        Returns:
        The expired items purge limit, -1 for no limit.

      • getHTTPProxyHost

        public java.lang.String getHTTPProxyHost()
        Returns the HTTP proxy host.
        Returns:
        The host, null if none.

      • getHTTPProxyPort

        public int getHTTPProxyPort()
        Returns the HTTP proxy port.
        Returns:
        The port, -1 if not specified.

      • getHMACSHA256Key

        public java.lang.String getHMACSHA256Key()
        Returns the HMAC SHA-256 key.
        Returns:
        The HMAC SHA-256 key (BASE 64 encoded), null if not specified.

      • getMetricRegistry

        public com.codahale.metrics.MetricRegistry getMetricRegistry()
        Returns the explicit metric registry to use.
        Returns:
        The metric registry instance.

      • properties

        public java.util.Properties properties()
        Specified by:
        properties in interface org.infinispan.configuration.cache.StoreConfiguration
        Overrides:
        properties in class org.infinispan.configuration.cache.AbstractStoreConfiguration

      • log

        public void log()
        Specified by:
        log in interface com.nimbusds.common.config.LoggableConfiguration