com.amazonaws.services.kinesis.connectors

Class KinesisClientLibraryPipelinedRecordProcessorFactory

java.lang.Object

com.amazonaws.services.kinesis.connectors.KinesisClientLibraryPipelinedRecordProcessorFactory

All Implemented Interfaces:

com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessorFactory

public class KinesisClientLibraryPipelinedRecordProcessorFactory
extends Object
implements com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessorFactory

Wraps an IRecordProcessorFactory to decouple fetching records and processing records in the created IRecordProcessor. The IRecordProcessor must checkpoint using the IRecordProcessorCheckpointer.checkpoint(String) method with a specific sequence number. Checkpointing using IRecordProcessorCheckpointer.checkpoint() may only be used in IRecordProcessor.shutdown(IRecordProcessorCheckpointer, ShutdownReason). Using IRecordProcessorCheckpointer.checkpoint() in processRecords will result in an UnsupportedOperationException.

Constructor Summary

Constructors

Constructor and Description
KinesisClientLibraryPipelinedRecordProcessorFactory(com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessorFactory factory, int maxQueueSize) Constructor to wrap an IRecordProcessorFactory as a pipelined record processor factory.
KinesisClientLibraryPipelinedRecordProcessorFactory(com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessorFactory factory, int maxQueueSize, Long maxQueueWaitTimeMs, Long maxProcessRecordsWaitTimeMs) Constructor to wrap an IRecordProcessorFactory as a pipelined record processor factory.

Method Summary

Modifier and Type	Method and Description
com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessor	createProcessor()

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisClientLibraryPipelinedRecordProcessorFactory

public KinesisClientLibraryPipelinedRecordProcessorFactory(com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessorFactory factory,
                                                           int maxQueueSize)

Constructor to wrap an IRecordProcessorFactory as a pipelined record processor factory. Default values are used for maximum queue wait time and maximum process records wait time.

Parameters:

factory - The IRecordProcessorFactory to wrap

maxQueueSize - The maximum number of records to retrieve and buffer in memory

KinesisClientLibraryPipelinedRecordProcessorFactory

public KinesisClientLibraryPipelinedRecordProcessorFactory(com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessorFactory factory,
                                                           int maxQueueSize,
                                                           Long maxQueueWaitTimeMs,
                                                           Long maxProcessRecordsWaitTimeMs)

Constructor to wrap an IRecordProcessorFactory as a pipelined record processor factory. If null values are passed for maxQueueWaitTimeMs or maxProcessRecordsWaitTimeMs, default values are used.

Parameters:

factory - The IRecordProcessorFactory to wrap

maxQueueSize - The maximum number of records to retrieve and buffer in memory

maxQueueWaitTimeMs - Maximum time to block on the queue waiting for GetRecords result in milliseconds

maxProcessRecordsWaitTimeMs - Maximum time to wait for the queue consumer to shutdown (finish ProcessRecords call) in milliseconds

Method Detail

createProcessor

public com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessor createProcessor()

Specified by:

createProcessor in interface com.amazonaws.services.kinesis.clientlibrary.interfaces.IRecordProcessorFactory