com.amazonaws.services.kinesis.clientlibrary.lib.worker

Class DoesNothingPreparedCheckpointer

java.lang.Object

com.amazonaws.services.kinesis.clientlibrary.lib.worker.DoesNothingPreparedCheckpointer

All Implemented Interfaces:

IPreparedCheckpointer

public class DoesNothingPreparedCheckpointer
extends Object
implements IPreparedCheckpointer

A special IPreparedCheckpointer that does nothing, which can be used when preparing a checkpoint at the current checkpoint sequence number where it is never necessary to do another checkpoint. This simplifies programming by preventing application developers from having to reason about whether their application has processed records before calling prepareCheckpoint Here's why it's safe to do nothing: The only way to checkpoint at current checkpoint value is to have a record processor that gets initialized, processes 0 records, then calls prepareCheckpoint(). The value in the table is the same, so there's no reason to overwrite it with another copy of itself.

Constructor Summary

Constructors

Constructor and Description
DoesNothingPreparedCheckpointer(ExtendedSequenceNumber sequenceNumber) Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DoesNothingPreparedCheckpointer

public DoesNothingPreparedCheckpointer(ExtendedSequenceNumber sequenceNumber)

Constructor.

Parameters:

sequenceNumber - the sequence number value

Method Detail

getPendingCheckpoint

public ExtendedSequenceNumber getPendingCheckpoint()

Specified by:

getPendingCheckpoint in interface IPreparedCheckpointer

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 IPreparedCheckpointer

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