com.amazonaws.services.kinesis.connectors.impl

Class BasicMemoryBuffer<T>

java.lang.Object

com.amazonaws.services.kinesis.connectors.impl.BasicMemoryBuffer<T>

Type Parameters:

T -

All Implemented Interfaces:

IBuffer<T>

public class BasicMemoryBuffer<T>
extends Object
implements IBuffer<T>

This class is a basic implementation of the IBuffer interface. It is a wrapper on a buffer of records that are periodically flushed. It is configured with an implementation of IFilter that decides whether a record will be added to the buffer to be emitted.

Constructor Summary

Constructors

Constructor and Description
BasicMemoryBuffer(KinesisConnectorConfiguration configuration)
BasicMemoryBuffer(KinesisConnectorConfiguration configuration, List<T> buffer)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the buffer
void	consumeRecord(T record, int recordSize, String sequenceNumber) Stores the record in the buffer
long	getBytesToBuffer() Get the byte size limit of data stored in the buffer before the records are flushed to the emitter
protected long	getCurrentTimeMilliseconds()
String	getFirstSequenceNumber() Get the sequence number of the first record stored in the buffer.
String	getLastSequenceNumber() Get the sequence number of the last record stored in the buffer.
long	getMillisecondsToBuffer() Get the time limit in milliseconds before the records are flushed to the emitter
long	getNumRecordsToBuffer() Get the record number limit of data stored in the buffer before the records are flushed to the emitter
List<T>	getRecords() Get the records stored in the buffer
boolean	shouldFlush() By default, we flush once we have exceeded the number of messages or maximum bytes to buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicMemoryBuffer

public BasicMemoryBuffer(KinesisConnectorConfiguration configuration,
                         List<T> buffer)

BasicMemoryBuffer

public BasicMemoryBuffer(KinesisConnectorConfiguration configuration)

Method Detail

getBytesToBuffer

public long getBytesToBuffer()

Description copied from interface: IBuffer

Get the byte size limit of data stored in the buffer before the records are flushed to the emitter

Specified by:

getBytesToBuffer in interface IBuffer<T>

Returns:

byte size limit of buffer

getNumRecordsToBuffer

public long getNumRecordsToBuffer()

Description copied from interface: IBuffer

Get the record number limit of data stored in the buffer before the records are flushed to the emitter

Specified by:

getNumRecordsToBuffer in interface IBuffer<T>

Returns:

record number limit of buffer

getMillisecondsToBuffer

public long getMillisecondsToBuffer()

Description copied from interface: IBuffer

Get the time limit in milliseconds before the records are flushed to the emitter

Specified by:

getMillisecondsToBuffer in interface IBuffer<T>

Returns:

time limit in milleseconds

consumeRecord

public void consumeRecord(T record,
                          int recordSize,
                          String sequenceNumber)

Description copied from interface: IBuffer

Stores the record in the buffer

Specified by:

consumeRecord in interface IBuffer<T>

Parameters:

record - record to be processed

recordSize - size of the record data in bytes

sequenceNumber - Amazon Kinesis sequence identifier

clear

public void clear()

Description copied from interface: IBuffer

Clears the buffer

Specified by:

clear in interface IBuffer<T>

getFirstSequenceNumber

public String getFirstSequenceNumber()

Description copied from interface: IBuffer

Get the sequence number of the first record stored in the buffer. Used for bookkeeping and uniquely identifying items in the buffer.

Specified by:

getFirstSequenceNumber in interface IBuffer<T>

Returns:

the sequence number of the first record stored in the buffer

getLastSequenceNumber

public String getLastSequenceNumber()

Description copied from interface: IBuffer

Get the sequence number of the last record stored in the buffer. Used for bookkeeping and uniquely identifying items in the buffer.

Specified by:

getLastSequenceNumber in interface IBuffer<T>

Returns:

the sequence number of the last record stored in the buffer

shouldFlush

public boolean shouldFlush()

By default, we flush once we have exceeded the number of messages or maximum bytes to buffer. However, subclasses can use their own means to determine if they should flush.

Specified by:

shouldFlush in interface IBuffer<T>

Returns:

true if either the number of records in the buffer exceeds max number of records or the size of the buffer exceeds the max number of bytes in the buffer.

getRecords

public List<T> getRecords()

Description copied from interface: IBuffer

Get the records stored in the buffer

Specified by:

getRecords in interface IBuffer<T>

Returns:

the records stored in the buffer

getCurrentTimeMilliseconds

protected long getCurrentTimeMilliseconds()