com.nimbusds.infinispan.persistence.dynamodb.config

Class DynamoDBStoreConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder

org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<DynamoDBStoreConfiguration,DynamoDBStoreConfigurationBuilder>

com.nimbusds.infinispan.persistence.dynamodb.config.DynamoDBStoreConfigurationBuilder

All Implemented Interfaces:

DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>, org.infinispan.commons.configuration.Builder<DynamoDBStoreConfiguration>, org.infinispan.commons.configuration.Self<DynamoDBStoreConfigurationBuilder>, org.infinispan.configuration.cache.ConfigurationChildBuilder, org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder, org.infinispan.configuration.cache.StoreConfigurationBuilder<DynamoDBStoreConfiguration,DynamoDBStoreConfigurationBuilder>, org.infinispan.configuration.cache.StoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

public class DynamoDBStoreConfigurationBuilder
extends org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<DynamoDBStoreConfiguration,DynamoDBStoreConfigurationBuilder>
implements DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

DynamoDB store configuration builder.

Used by the Infinispan ConfigurationBuilder to implement fluent configuration for the DynamoDB CacheLoader / CacheWriter. Methods should use the fluent style, rather than the setter/getter style and should return an instance of this object.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.infinispan.configuration.cache.ConfigurationBuilder	builder

Fields inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder

async, attributes, fetchPersistentState, ignoreModifications, preload, properties, purgeOnStartup, shared, singletonStore

Constructor Summary

Constructors

Constructor and Description
DynamoDBStoreConfigurationBuilder(org.infinispan.configuration.cache.PersistenceConfigurationBuilder builder) Creates a new DynamoDB store configuration builder.

Method Summary

Modifier and Type	Method and Description
DynamoDBStoreConfigurationBuilder	applyRangeKey(String rangeKeyName) Sets the name of the optional range key to apply to all DynamoDB operations.
DynamoDBStoreConfiguration	create()
DynamoDBStoreConfigurationBuilder	endpoint(String endpoint) Sets the DynamoDB endpoint.
protected org.infinispan.configuration.cache.ConfigurationBuilder	getBuilder()
DynamoDBStoreConfigurationBuilder	indexedAttributes(Set<String> indexAttributes) Sets the optional indexed DynamoDB table attributes.
DynamoDBStoreConfigurationBuilder	itemTransformerClass(Class itemTransformerClass) Sets the class for transforming between Infinispan entries (key / value pair and optional metadata) and a corresponding DynamoDB item.
DynamoDBStoreConfigurationBuilder	queryExecutorClass(Class queryExecutorClass) Sets the optional class for executing direct queries against DynamoDB.
DynamoDBStoreConfigurationBuilder	rangeKeyValue(String rangeKeyValue) Sets the value of the optional range key.
DynamoDBStoreConfigurationChildBuilder	readCapacity(long readCapacity) Sets the read capacity to provision when creating a new DynamoDB table.
DynamoDBStoreConfigurationBuilder	region(com.amazonaws.regions.Regions region) Sets the DynamoDB region.
DynamoDBStoreConfigurationBuilder	self()
DynamoDBStoreConfigurationBuilder	tablePrefix(String tablePrefix) Sets the DynamoDB table prefix.
void	validate()
DynamoDBStoreConfigurationBuilder	withProperties(Properties properties)
DynamoDBStoreConfigurationChildBuilder	writeCapacity(long writeCapacity) Sets the write capacity to provision when creating a new DynamoDB table.

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder

addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, properties, purgeOnStartup, read, shared, singleton, toString, transactional, validate, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder

addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, purgeOnStartup, shared, singleton, transactional

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

build, clustering, compatibility, customInterceptors, dataContainer, deadlockDetection, encoding, eviction, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, storeAsBinary, template, transaction, unsafe, validate, versioning

Field Detail

builder

protected final org.infinispan.configuration.cache.ConfigurationBuilder builder

Constructor Detail

DynamoDBStoreConfigurationBuilder

public DynamoDBStoreConfigurationBuilder(org.infinispan.configuration.cache.PersistenceConfigurationBuilder builder)

Creates a new DynamoDB store configuration builder.

Parameters:

builder - The general persistence configuration builder.

Method Detail

create

public DynamoDBStoreConfiguration create()

Specified by:

create in interface org.infinispan.commons.configuration.Builder<DynamoDBStoreConfiguration>

endpoint

public DynamoDBStoreConfigurationBuilder endpoint(String endpoint)

Description copied from interface: DynamoDBStoreConfigurationChildBuilder

Sets the DynamoDB endpoint.

Specified by:

endpoint in interface DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Parameters:

endpoint - The endpoint, null if not specified.

Returns:

The builder.

region

public DynamoDBStoreConfigurationBuilder region(com.amazonaws.regions.Regions region)

Description copied from interface: DynamoDBStoreConfigurationChildBuilder

Sets the DynamoDB region.

Specified by:

region in interface DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Parameters:

region - The region, null if not specified.

Returns:

The builder.

itemTransformerClass

public DynamoDBStoreConfigurationBuilder itemTransformerClass(Class itemTransformerClass)

Description copied from interface: DynamoDBStoreConfigurationChildBuilder

Sets the class for transforming between Infinispan entries (key / value pair and optional metadata) and a corresponding DynamoDB item.

Specified by:

itemTransformerClass in interface DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Parameters:

itemTransformerClass - The item transformer class. Must not be null.

Returns:

The builder.

queryExecutorClass

public DynamoDBStoreConfigurationBuilder queryExecutorClass(Class queryExecutorClass)

Description copied from interface: DynamoDBStoreConfigurationChildBuilder

Sets the optional class for executing direct queries against DynamoDB. If set DynamoDBStoreConfigurationChildBuilder.indexedAttributes(java.util.Set<java.lang.String>) must also be specified.

Specified by:

queryExecutorClass in interface DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Parameters:

queryExecutorClass - The query executor class, null if not required.

Returns:

The builder.

indexedAttributes

public DynamoDBStoreConfigurationBuilder indexedAttributes(Set<String> indexAttributes)

Description copied from interface: DynamoDBStoreConfigurationChildBuilder

Sets the optional indexed DynamoDB table attributes. If set DynamoDBStoreConfigurationChildBuilder.queryExecutorClass(java.lang.Class) must also be specified.

Specified by:

indexedAttributes in interface DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Parameters:

indexAttributes - The indexed attributes, null if not required.

Returns:

The builder.

readCapacity

public DynamoDBStoreConfigurationChildBuilder readCapacity(long readCapacity)

Description copied from interface: DynamoDBStoreConfigurationChildBuilder

Sets the read capacity to provision when creating a new DynamoDB table.

Specified by:

readCapacity in interface DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Parameters:

readCapacity - The read capacity. Must be equal or larger than one.

Returns:

The builder.

writeCapacity

public DynamoDBStoreConfigurationChildBuilder writeCapacity(long writeCapacity)

Description copied from interface: DynamoDBStoreConfigurationChildBuilder

Sets the write capacity to provision when creating a new DynamoDB table.

Specified by:

writeCapacity in interface DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Parameters:

writeCapacity - The write capacity. Must be equal or larger than one.

Returns:

The builder.

tablePrefix

public DynamoDBStoreConfigurationBuilder tablePrefix(String tablePrefix)

Description copied from interface: DynamoDBStoreConfigurationChildBuilder

Sets the DynamoDB table prefix.

Specified by:

tablePrefix in interface DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Parameters:

tablePrefix - The table prefix, null if not specified.

Returns:

The builder.

applyRangeKey

public DynamoDBStoreConfigurationBuilder applyRangeKey(String rangeKeyName)

Description copied from interface: DynamoDBStoreConfigurationChildBuilder

Sets the name of the optional range key to apply to all DynamoDB operations.

Specified by:

applyRangeKey in interface DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Parameters:

rangeKeyName - The range key name, null if not specified.

Returns:

The builder.

rangeKeyValue

public DynamoDBStoreConfigurationBuilder rangeKeyValue(String rangeKeyValue)

Description copied from interface: DynamoDBStoreConfigurationChildBuilder

Sets the value of the optional range key.

Specified by:

rangeKeyValue in interface DynamoDBStoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Parameters:

rangeKeyValue - The range key value, null if not specified.

Returns:

The builder.

withProperties

public DynamoDBStoreConfigurationBuilder withProperties(Properties properties)

Specified by:

withProperties in interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder<DynamoDBStoreConfigurationBuilder>

Overrides:

withProperties in class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<DynamoDBStoreConfiguration,DynamoDBStoreConfigurationBuilder>

validate

public void validate()

Specified by:

validate in interface org.infinispan.commons.configuration.Builder<DynamoDBStoreConfiguration>

Overrides:

validate in class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<DynamoDBStoreConfiguration,DynamoDBStoreConfigurationBuilder>

self

public DynamoDBStoreConfigurationBuilder self()

Specified by:

self in interface org.infinispan.commons.configuration.Self<DynamoDBStoreConfigurationBuilder>

getBuilder

protected org.infinispan.configuration.cache.ConfigurationBuilder getBuilder()