com.amazonaws.services.kinesis.clientlibrary.interfaces

Interface IRecordProcessor

public interface IRecordProcessor

The Amazon Kinesis Client Library will instantiate record processors to process data records fetched from Amazon Kinesis.

Method Summary

Modifier and Type	Method and Description
void	initialize(String shardId) Invoked by the Amazon Kinesis Client Library before data records are delivered to the RecordProcessor instance (via processRecords).
void	processRecords(List<com.amazonaws.services.kinesis.model.Record> records, IRecordProcessorCheckpointer checkpointer) Process data records.
void	shutdown(IRecordProcessorCheckpointer checkpointer, ShutdownReason reason) Invoked by the Amazon Kinesis Client Library to indicate it will no longer send data records to this RecordProcessor instance.

Method Detail

initialize

void initialize(String shardId)

Invoked by the Amazon Kinesis Client Library before data records are delivered to the RecordProcessor instance (via processRecords).

Parameters:

shardId - The record processor will be responsible for processing records of this shard.

processRecords

void processRecords(List<com.amazonaws.services.kinesis.model.Record> records,
                    IRecordProcessorCheckpointer checkpointer)

Process data records. The Amazon Kinesis Client Library will invoke this method to deliver data records to the application. Upon fail over, the new instance will get records with sequence number > checkpoint position for each partition key.

Parameters:

records - Data records to be processed

checkpointer - RecordProcessor should use this instance to checkpoint their progress.

shutdown

void shutdown(IRecordProcessorCheckpointer checkpointer,
              ShutdownReason reason)

Invoked by the Amazon Kinesis Client Library to indicate it will no longer send data records to this RecordProcessor instance. The reason parameter indicates: a/ ShutdownReason.TERMINATE - The shard has been closed and there will not be any more records to process. The record processor should checkpoint (after doing any housekeeping) to acknowledge that it has successfully completed processing all records in this shard. b/ ShutdownReason.ZOMBIE: A fail over has occurred and a different record processor is (or will be) responsible for processing records.

Parameters:

checkpointer - RecordProcessor should use this instance to checkpoint.

reason - Reason for the shutdown (ShutdownReason.TERMINATE indicates the shard is closed and there are no more records to process. Shutdown.ZOMBIE indicates a fail over has occurred).