software.amazon.kinesis.coordinator.delegate

Class LegacyTableCoordinatorStateDAODelegate

java.lang.Object

software.amazon.kinesis.coordinator.delegate.CoordinatorStateDAODelegate

software.amazon.kinesis.coordinator.delegate.LegacyTableCoordinatorStateDAODelegate

public class LegacyTableCoordinatorStateDAODelegate
extends CoordinatorStateDAODelegate

Delegate for the legacy (separate) CoordinatorState DDB table.

On initialize(), checks if the legacy table exists. If it does not exist, the delegate is marked as not enabled and all read operations become no-ops (returning null or empty collections). Write operations on a non-enabled delegate will throw InvalidStateException.

The legacy table should only be deleted after the table migration status moves to COMPLETE, at which point no read/write calls should be routed to this delegate. However, if the table existed at initialization but was deleted later (e.g., by the migration tool after COMPLETE), the underlying DDB calls will throw ResourceNotFoundException which surfaces as a DependencyException to the caller.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COORDINATOR_STATE_TABLE_HASH_KEY_ATTRIBUTE_NAME Key value for the item in the CoordinatorState table

Constructor Summary

Constructors

Constructor and Description
LegacyTableCoordinatorStateDAODelegate(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.
boolean	deleteCoordinatorState(String key) Create a new CoordinatorState if it does not exist.
CoordinatorState	getCoordinatorState(String key)
void	initialize() Check if the legacy table exists.
boolean	isEnabled()
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
boolean	updateCoordinatorStateWithExpectation(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 software.amazon.kinesis.coordinator.delegate.CoordinatorStateDAODelegate

createTransactDelete, createTransactPut, fromDynamoRecord, getDDBLockClientOptionsBuilder, getPartitionKeyAttributeName, getTableName, toTransactRecord

Methods inherited from class java.lang.Object

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

Field Detail

COORDINATOR_STATE_TABLE_HASH_KEY_ATTRIBUTE_NAME

public static final String COORDINATOR_STATE_TABLE_HASH_KEY_ATTRIBUTE_NAME

Key value for the item in the CoordinatorState table

See Also:

Constant Field Values

Constructor Detail

LegacyTableCoordinatorStateDAODelegate

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

Method Detail

initialize

public void initialize()
                throws DependencyException

Check if the legacy table exists. If it does not, mark this delegate as not enabled so all read operations return null/empty without making DDB calls.

Specified by:

initialize in class CoordinatorStateDAODelegate

Throws:

DependencyException - if unable to determine table existence due to unexpected errors

isEnabled

public boolean isEnabled()

Returns:

true if the legacy table exists and this delegate is enabled for operations

getCoordinatorState

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

Overrides:

getCoordinatorState in class CoordinatorStateDAODelegate

Parameters:

key - Get the CoordinatorState for this key

Returns:

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

Throws:

DependencyException - if DynamoDB get fails in an unexpected way

InvalidStateException - if ddb table does not exist

ProvisionedThroughputException - if DynamoDB get fails due to lack of capacity

listCoordinatorState

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

Description copied from class: CoordinatorStateDAODelegate

List all the CoordinatorState from the DDB table synchronously

Overrides:

listCoordinatorState in class CoordinatorStateDAODelegate

Returns:

list of state

Throws:

ProvisionedThroughputException - if DynamoDB scan fails due to lack of capacity

DependencyException - if DynamoDB scan fails in an unexpected way

InvalidStateException - if ddb table does not exist

listCoordinatorStateByEntityType

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

Description copied from class: CoordinatorStateDAODelegate

List all the CoordinatorState from the DDB table synchronously

Overrides:

listCoordinatorStateByEntityType in class CoordinatorStateDAODelegate

Returns:

list of state

Throws:

ProvisionedThroughputException - if DynamoDB scan fails due to lack of capacity

DependencyException - if DynamoDB scan fails in an unexpected way

InvalidStateException - if ddb table does not exist

createCoordinatorStateIfNotExists

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

Description copied from class: CoordinatorStateDAODelegate

Create a new CoordinatorState if it does not exist.

Overrides:

createCoordinatorStateIfNotExists in class CoordinatorStateDAODelegate

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

updateCoordinatorStateWithExpectation

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

Description copied from class: CoordinatorStateDAODelegate

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

Overrides:

updateCoordinatorStateWithExpectation in class CoordinatorStateDAODelegate

Returns:

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

Throws:

DependencyException - if DynamoDB update fails in an unexpected way

InvalidStateException - if table does not exist

ProvisionedThroughputException - if DynamoDB update fails due to lack of capacity

deleteCoordinatorState

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

Description copied from class: CoordinatorStateDAODelegate

Create a new CoordinatorState if it does not exist.

Overrides:

deleteCoordinatorState in class CoordinatorStateDAODelegate

Parameters:

key - the key to delete

Returns:

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

Throws:

ProvisionedThroughputException - if DynamoDB delete fails due to lack of capacity

InvalidStateException - if lease table does not exist

DependencyException - if DynamoDB delete fails in an unexpected way