software.amazon.kinesis.checkpoint.dynamodb

Class DynamoDBCheckpointer

java.lang.Object

software.amazon.kinesis.checkpoint.dynamodb.DynamoDBCheckpointer

All Implemented Interfaces:

Checkpointer

public class DynamoDBCheckpointer
extends Object
implements Checkpointer

Constructor Summary

Constructors

Constructor and Description
DynamoDBCheckpointer()

Method Summary

Modifier and Type	Method and Description
ExtendedSequenceNumber	getCheckpoint(String leaseKey) Get the current checkpoint stored for the specified shard.
Checkpoint	getCheckpointObject(String leaseKey) Get the current checkpoint stored for the specified shard, which holds the sequence numbers for the checkpoint and pending checkpoint.
String	operation()
void	operation(@NonNull String operation)
void	prepareCheckpoint(String leaseKey, ExtendedSequenceNumber pendingCheckpoint, String concurrencyToken) Record intent to checkpoint for a shard.
void	prepareCheckpoint(String leaseKey, ExtendedSequenceNumber pendingCheckpoint, String concurrencyToken, byte[] pendingCheckpointState) Record intent to checkpoint for a shard.
void	setCheckpoint(String leaseKey, ExtendedSequenceNumber checkpointValue, String concurrencyToken) Record a checkpoint for a shard (e.g.
boolean	setCheckpoint(String leaseKey, ExtendedSequenceNumber checkpoint, UUID concurrencyToken)

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamoDBCheckpointer

public DynamoDBCheckpointer()

Method Detail

setCheckpoint

public void setCheckpoint(String leaseKey,
                          ExtendedSequenceNumber checkpointValue,
                          String concurrencyToken)
                   throws KinesisClientLibException

Description copied from interface: Checkpointer

Record a checkpoint for a shard (e.g. sequence and subsequence numbers of last record processed by application). Upon failover, record processing is resumed from this point.

Specified by:

setCheckpoint in interface Checkpointer

Parameters:

leaseKey - Checkpoint is specified for this shard.

checkpointValue - Value of the checkpoint (e.g. Kinesis sequence number and subsequence number)

concurrencyToken - Used with conditional writes to prevent stale updates (e.g. if there was a fail over to a different record processor, we don't want to overwrite it's checkpoint)

Throws:

KinesisClientLibException - Thrown if we were unable to save the checkpoint

getCheckpoint

public ExtendedSequenceNumber getCheckpoint(String leaseKey)
                                     throws KinesisClientLibException

Description copied from interface: Checkpointer

Get the current checkpoint stored for the specified shard. Useful for checking that the parent shard has been completely processed before we start processing the child shard.

Specified by:

getCheckpoint in interface Checkpointer

Parameters:

leaseKey - Current checkpoint for this shard is fetched

Returns:

Current checkpoint for this shard, null if there is no record for this shard.

Throws:

KinesisClientLibException - Thrown if we are unable to fetch the checkpoint

getCheckpointObject

public Checkpoint getCheckpointObject(String leaseKey)
                               throws KinesisClientLibException

Description copied from interface: Checkpointer

Get the current checkpoint stored for the specified shard, which holds the sequence numbers for the checkpoint and pending checkpoint. Useful for checking that the parent shard has been completely processed before we start processing the child shard.

Specified by:

getCheckpointObject in interface Checkpointer

Parameters:

leaseKey - Current checkpoint for this shard is fetched

Returns:

Current checkpoint object for this shard, null if there is no record for this shard.

Throws:

KinesisClientLibException - Thrown if we are unable to fetch the checkpoint

prepareCheckpoint

public void prepareCheckpoint(String leaseKey,
                              ExtendedSequenceNumber pendingCheckpoint,
                              String concurrencyToken)
                       throws KinesisClientLibException

Description copied from interface: Checkpointer

Record intent to checkpoint for a shard. Upon failover, the pendingCheckpointValue will be passed to the new ShardRecordProcessor's initialize() method.

Specified by:

prepareCheckpoint in interface Checkpointer

Parameters:

leaseKey - Checkpoint is specified for this shard.

pendingCheckpoint - Value of the pending checkpoint (e.g. Kinesis sequence number and subsequence number)

concurrencyToken - Used with conditional writes to prevent stale updates (e.g. if there was a fail over to a different record processor, we don't want to overwrite it's checkpoint)

Throws:

KinesisClientLibException - Thrown if we were unable to save the checkpoint

prepareCheckpoint

public void prepareCheckpoint(String leaseKey,
                              ExtendedSequenceNumber pendingCheckpoint,
                              String concurrencyToken,
                              byte[] pendingCheckpointState)
                       throws KinesisClientLibException

Description copied from interface: Checkpointer

Record intent to checkpoint for a shard. Upon failover, the pendingCheckpoint and pendingCheckpointState will be passed to the new ShardRecordProcessor's initialize() method.

Specified by:

prepareCheckpoint in interface Checkpointer

Parameters:

leaseKey - Checkpoint is specified for this shard.

pendingCheckpoint - Value of the pending checkpoint (e.g. Kinesis sequence number and subsequence number)

concurrencyToken - Used with conditional writes to prevent stale updates (e.g. if there was a fail over to a different record processor, we don't want to overwrite it's checkpoint)

pendingCheckpointState - Serialized application state at the pending checkpoint.

Throws:

KinesisClientLibException - Thrown if we were unable to save the checkpoint

setCheckpoint

public boolean setCheckpoint(String leaseKey,
                             ExtendedSequenceNumber checkpoint,
                             UUID concurrencyToken)
                      throws DependencyException,
                             InvalidStateException,
                             ProvisionedThroughputException

Throws:

DependencyException

InvalidStateException

ProvisionedThroughputException

operation

public void operation(@NonNull
                      @NonNull String operation)

Specified by:

operation in interface Checkpointer

operation

public String operation()

Specified by:

operation in interface Checkpointer