com.amazonaws.services.kinesis.multilang

Class MultiLangRecordProcessor

java.lang.Object

com.amazonaws.services.kinesis.multilang.MultiLangRecordProcessor

All Implemented Interfaces:

IRecordProcessor, IShutdownNotificationAware

public class MultiLangRecordProcessor
extends Object
implements IRecordProcessor, IShutdownNotificationAware

A record processor that manages creating a child process that implements the multi language protocol and connecting that child process's input and outputs to a MultiLangProtocol object and calling the appropriate methods on that object when its corresponding initialize(com.amazonaws.services.kinesis.clientlibrary.types.InitializationInput), processRecords(com.amazonaws.services.kinesis.clientlibrary.types.ProcessRecordsInput), and shutdown(com.amazonaws.services.kinesis.clientlibrary.types.ShutdownInput) methods are called.

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 RecordProcessor instance (via processRecords).
void	processRecords(ProcessRecordsInput processRecordsInput) Process data records.
void	shutdown(ShutdownInput shutdownInput) Invoked by the Amazon Kinesis Client Library to indicate it will no longer send data records to this RecordProcessor instance.
void	shutdownRequested(IRecordProcessorCheckpointer checkpointer) Called when the worker has been requested to shutdown, and gives the record processor a chance to checkpoint.

Methods inherited from class java.lang.Object

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

Method Detail

initialize

public void initialize(InitializationInput initializationInput)

Description copied from interface: IRecordProcessor

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

Specified by:

initialize in interface IRecordProcessor

Parameters:

initializationInput - Provides information related to initialization

processRecords

public void processRecords(ProcessRecordsInput processRecordsInput)

Description copied from interface: IRecordProcessor

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.

Specified by:

processRecords in interface IRecordProcessor

Parameters:

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

shutdown

public void shutdown(ShutdownInput shutdownInput)

Description copied from interface: IRecordProcessor

Invoked by the Amazon Kinesis Client Library to indicate it will no longer send data records to this RecordProcessor instance.

Warning

When the value of ShutdownInput.getShutdownReason() is ShutdownReason.TERMINATE it is required that you checkpoint. Failure to do so will result in an IllegalArgumentException, and the KCL no longer making progress.

Specified by:

shutdown in interface IRecordProcessor

Parameters:

shutdownInput - Provides information and capabilities (eg checkpointing) related to shutdown of this record processor.

shutdownRequested

public void shutdownRequested(IRecordProcessorCheckpointer checkpointer)

Description copied from interface: IShutdownNotificationAware

Called when the worker has been requested to shutdown, and gives the record processor a chance to checkpoint. The record processor will still have shutdown called.

Specified by:

shutdownRequested in interface IShutdownNotificationAware

Parameters:

checkpointer - the checkpointer that can be used to save progress.