software.amazon.kinesis.checkpoint

Class ShardPreparedCheckpointer

java.lang.Object

software.amazon.kinesis.checkpoint.ShardPreparedCheckpointer

All Implemented Interfaces:

PreparedCheckpointer

public class ShardPreparedCheckpointer
extends Object
implements PreparedCheckpointer

Objects of this class are prepared to checkpoint at a specific sequence number. They use an RecordProcessorCheckpointer to do the actual checkpointing, so their checkpoint is subject to the same 'didn't go backwards' validation as a normal checkpoint.

Constructor Summary

Constructors

Constructor and Description
ShardPreparedCheckpointer(ExtendedSequenceNumber pendingCheckpointSequenceNumber, RecordProcessorCheckpointer checkpointer) Constructor.

Method Summary

Modifier and Type	Method and Description
void	checkpoint() This method will record a pending checkpoint.
ExtendedSequenceNumber	pendingCheckpoint()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShardPreparedCheckpointer

public ShardPreparedCheckpointer(ExtendedSequenceNumber pendingCheckpointSequenceNumber,
                                 RecordProcessorCheckpointer checkpointer)

Constructor.

Parameters:

pendingCheckpointSequenceNumber - sequence number to checkpoint at

checkpointer - checkpointer to use

Method Detail

pendingCheckpoint

public ExtendedSequenceNumber pendingCheckpoint()

Specified by:

pendingCheckpoint in interface PreparedCheckpointer

Returns:

sequence number of pending checkpoint

checkpoint

public void checkpoint()
                throws KinesisClientLibDependencyException,
                       InvalidStateException,
                       ThrottlingException,
                       ShutdownException,
                       IllegalArgumentException

This method will record a pending checkpoint.

Specified by:

checkpoint in interface PreparedCheckpointer

Throws:

KinesisClientLibDependencyException - Encountered an issue when storing the checkpoint. The application can backoff and retry.

InvalidStateException - Can't store checkpoint. Unable to store the checkpoint in the DynamoDB table (e.g. table doesn't exist).

ThrottlingException - Can't store checkpoint. Can be caused by checkpointing too frequently. Consider increasing the throughput/capacity of the checkpoint store or reducing checkpoint frequency.

ShutdownException - The record processor instance has been shutdown. Another instance may have started processing some of these records already. The application should abort processing via this ShardRecordProcessor instance.

IllegalArgumentException - The sequence number being checkpointed is invalid because it is out of range, i.e. it is smaller than the last check point value (prepared or committed), or larger than the greatest sequence number seen by the associated record processor.