software.amazon.kinesis.processor

Interface ShardRecordProcessor

public interface ShardRecordProcessor

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(InitializationInput initializationInput) Invoked by the Amazon Kinesis Client Library before data records are delivered to the ShardRecordProcessor instance (via processRecords).
void	leaseLost(LeaseLostInput leaseLostInput) Called when the lease that tied to this record processor has been lost.
void	processRecords(ProcessRecordsInput processRecordsInput) Process data records.
void	shardEnded(ShardEndedInput shardEndedInput) Called when the shard that this record process is handling has been completed.
void	shutdownRequested(ShutdownRequestedInput shutdownRequestedInput) Called when the Scheduler has been requested to shutdown.

Method Detail

initialize

void initialize(InitializationInput initializationInput)

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

Parameters:

initializationInput - Provides information related to initialization

processRecords

void processRecords(ProcessRecordsInput processRecordsInput)

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:

processRecordsInput - Provides the records to be processed as well as information and capabilities related to them (eg checkpointing).

leaseLost

void leaseLost(LeaseLostInput leaseLostInput)

Called when the lease that tied to this record processor has been lost. Once the lease has been lost the record processor can no longer checkpoint.

Parameters:

leaseLostInput - access to functions and data related to the loss of the lease. Currently this has no functionality.

shardEnded

void shardEnded(ShardEndedInput shardEndedInput)

Called when the shard that this record process is handling has been completed. Once a shard has been completed no further records will ever arrive on that shard. When this is called the record processor must call RecordProcessorCheckpointer.checkpoint(), otherwise an exception will be thrown and the all child shards of this shard will not make progress.

Parameters:

shardEndedInput - provides access to a checkpointer method for completing processing of the shard.

shutdownRequested

void shutdownRequested(ShutdownRequestedInput shutdownRequestedInput)

Called when the Scheduler has been requested to shutdown. This is called while the record processor still holds the lease so checkpointing is possible. Once this method has completed the lease for the record processor is released, and leaseLost(LeaseLostInput) will be called at a later time.

Parameters:

shutdownRequestedInput - provides access to a checkpointer allowing a record processor to checkpoint before the shutdown is completed.