software.amazon.kinesis.coordinator.delegate

Class CoordinatorStateDAODelegate

java.lang.Object

software.amazon.kinesis.coordinator.delegate.CoordinatorStateDAODelegate

Direct Known Subclasses:

LeaseTableCoordinatorStateDAODelegate, LegacyTableCoordinatorStateDAODelegate

public abstract class CoordinatorStateDAODelegate
extends Object

Data Access Object to abstract accessing CoordinatorState from the DDB table it is stored in.

Constructor Summary

Constructors

Constructor and Description
CoordinatorStateDAODelegate(software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDbAsyncClient, String tableName, String partitionKeyAttributeName)

Method Summary

Modifier and Type	Method and Description
boolean	createCoordinatorStateIfNotExists(CoordinatorState state) Create a new CoordinatorState if it does not exist.
software.amazon.awssdk.services.dynamodb.model.TransactWriteItem	createTransactDelete(@NonNull String key) Creates a TransactWriteItem that deletes the entry with the given key from this delegate's table.
software.amazon.awssdk.services.dynamodb.model.TransactWriteItem	createTransactPut(CoordinatorState state) Creates a TransactWriteItem that performs a conditional Put (item must not exist) for the given coordinator state into this delegate's table.
boolean	deleteCoordinatorState(@NonNull String key) Create a new CoordinatorState if it does not exist.
CoordinatorState	fromDynamoRecord(Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> dynamoRecord)
CoordinatorState	getCoordinatorState(@NonNull String key)
com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder	getDDBLockClientOptionsBuilder()
String	getPartitionKeyAttributeName()
String	getTableName()
abstract void	initialize()
List<CoordinatorState>	listCoordinatorState() List all the CoordinatorState from the DDB table synchronously
List<CoordinatorState>	listCoordinatorStateByEntityType(EntityType.CoordinatorStateType entityType) List all the CoordinatorState from the DDB table synchronously
Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue>	toTransactRecord(CoordinatorState state) Converts a CoordinatorState to its full DDB item representation including the partition key.
boolean	updateCoordinatorStateWithExpectation(@NonNull CoordinatorState state, Map<String,software.amazon.awssdk.services.dynamodb.model.ExpectedAttributeValue> expectations) Update fields of the given coordinator state in DynamoDB.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoordinatorStateDAODelegate

public CoordinatorStateDAODelegate(software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDbAsyncClient,
                                   String tableName,
                                   String partitionKeyAttributeName)

Method Detail

getTableName

public String getTableName()

getPartitionKeyAttributeName

public String getPartitionKeyAttributeName()

initialize

public abstract void initialize()
                         throws DependencyException

Throws:

DependencyException

getDDBLockClientOptionsBuilder

public com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder getDDBLockClientOptionsBuilder()

listCoordinatorState

public List<CoordinatorState> listCoordinatorState()
                                            throws ProvisionedThroughputException,
                                                   DependencyException,
                                                   InvalidStateException

List all the CoordinatorState from the DDB table synchronously

Returns:

list of state

Throws:

DependencyException - if DynamoDB scan fails in an unexpected way

InvalidStateException - if ddb table does not exist

ProvisionedThroughputException - if DynamoDB scan fails due to lack of capacity

listCoordinatorStateByEntityType

public List<CoordinatorState> listCoordinatorStateByEntityType(EntityType.CoordinatorStateType entityType)
                                                        throws ProvisionedThroughputException,
                                                               DependencyException,
                                                               InvalidStateException

List all the CoordinatorState from the DDB table synchronously

Returns:

list of state

Throws:

DependencyException - if DynamoDB scan fails in an unexpected way

InvalidStateException - if ddb table does not exist

ProvisionedThroughputException - if DynamoDB scan fails due to lack of capacity

createCoordinatorStateIfNotExists

public boolean createCoordinatorStateIfNotExists(CoordinatorState state)
                                          throws DependencyException,
                                                 InvalidStateException,
                                                 ProvisionedThroughputException

Create a new CoordinatorState if it does not exist.

Parameters:

state - the state to create

Returns:

true if state was created, false if it already exists

Throws:

DependencyException - if DynamoDB put fails in an unexpected way

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB put fails due to lack of capacity

getCoordinatorState

public CoordinatorState getCoordinatorState(@NonNull
                                            @NonNull String key)
                                     throws DependencyException,
                                            InvalidStateException,
                                            ProvisionedThroughputException

Parameters:

key - Get the CoordinatorState for this key

Returns:

state for the specified key, or null if one doesn't exist

Throws:

InvalidStateException - if ddb table does not exist

ProvisionedThroughputException - if DynamoDB get fails due to lack of capacity

DependencyException - if DynamoDB get fails in an unexpected way

deleteCoordinatorState

public boolean deleteCoordinatorState(@NonNull
                                      @NonNull String key)
                               throws ProvisionedThroughputException,
                                      InvalidStateException,
                                      DependencyException

Create a new CoordinatorState if it does not exist.

Parameters:

key - the key to delete

Returns:

true if state was deleted, false if you cannot be deleted

Throws:

DependencyException - if DynamoDB delete fails in an unexpected way

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB delete fails due to lack of capacity

updateCoordinatorStateWithExpectation

public boolean updateCoordinatorStateWithExpectation(@NonNull
                                                     @NonNull CoordinatorState state,
                                                     Map<String,software.amazon.awssdk.services.dynamodb.model.ExpectedAttributeValue> expectations)
                                              throws DependencyException,
                                                     InvalidStateException,
                                                     ProvisionedThroughputException

Update fields of the given coordinator state in DynamoDB. Conditional on the provided expectation.

Returns:

true if update succeeded, false otherwise when expectations are not met

Throws:

InvalidStateException - if table does not exist

ProvisionedThroughputException - if DynamoDB update fails due to lack of capacity

DependencyException - if DynamoDB update fails in an unexpected way

fromDynamoRecord

public CoordinatorState fromDynamoRecord(Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> dynamoRecord)

toTransactRecord

public Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> toTransactRecord(CoordinatorState state)

Converts a CoordinatorState to its full DDB item representation including the partition key. Public variant of toDynamoRecord(software.amazon.kinesis.coordinator.CoordinatorState) for use in transactional writes built externally (e.g., conditional Puts with custom condition expressions).

createTransactPut

public software.amazon.awssdk.services.dynamodb.model.TransactWriteItem createTransactPut(CoordinatorState state)

Creates a TransactWriteItem that performs a conditional Put (item must not exist) for the given coordinator state into this delegate's table.

Parameters:

state - the coordinator state to put

Returns:

a TransactWriteItem for use in a DynamoDB TransactWriteItems call

createTransactDelete

public software.amazon.awssdk.services.dynamodb.model.TransactWriteItem createTransactDelete(@NonNull
                                                                                             @NonNull String key)

Creates a TransactWriteItem that deletes the entry with the given key from this delegate's table.

Parameters:

key - the partition key of the entry to delete

Returns:

a TransactWriteItem for use in a DynamoDB TransactWriteItems call