software.amazon.kinesis.processor

Interface Checkpointer

All Known Implementing Classes:

DynamoDBCheckpointer

public interface Checkpointer

Interface for checkpoint trackers.

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(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.

Method Detail

setCheckpoint

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

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.

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

ExtendedSequenceNumber getCheckpoint(String leaseKey)
                              throws KinesisClientLibException

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.

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

Checkpoint getCheckpointObject(String leaseKey)
                        throws KinesisClientLibException

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.

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

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

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

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

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

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

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

operation

void operation(String operation)

operation

String operation()