software.amazon.kinesis.coordinator

Class CoordinatorStateDAO

java.lang.Object

software.amazon.kinesis.coordinator.CoordinatorStateDAO

public class CoordinatorStateDAO
extends Object

Data Access Object to abstract accessing CoordinatorState from the CoordinatorState DDB table.

Constructor Summary

Constructors

Constructor and Description
CoordinatorStateDAO(software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDbAsyncClient, CoordinatorConfig.CoordinatorStateTableConfig config)

Method Summary

Modifier and Type	Method and Description
boolean	createCoordinatorStateIfNotExists(CoordinatorState state) Create a new CoordinatorState if it does not exist.
CoordinatorState	getCoordinatorState(@NonNull String key)
com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder	getDDBLockClientOptionsBuilder()
void	initialize()
List<CoordinatorState>	listCoordinatorState() List all the CoordinatorState from the DDB table synchronously
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

CoordinatorStateDAO

public CoordinatorStateDAO(software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDbAsyncClient,
                           CoordinatorConfig.CoordinatorStateTableConfig config)

Method Detail

initialize

public 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

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

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