com.amazonaws.mobileconnectors.kinesis.kinesisrecorder

Class AbstractKinesisRecorder

java.lang.Object

com.amazonaws.mobileconnectors.kinesis.kinesisrecorder.AbstractKinesisRecorder

Direct Known Subclasses:

KinesisFirehoseRecorder, KinesisRecorder

public abstract class AbstractKinesisRecorder
extends java.lang.Object

An abstract class for Amazon Kinesis recorders. It manages local file store that temporarily saves records and sends these records later.

Method Summary

Modifier and Type	Method and Description
void	deleteAllRecords() Removes all requests saved to disk in the directory provided this KinesisRecorder.
long	getDiskByteLimit() Returns the max number of bytes that this Kinesis Recorder will store on disk.
long	getDiskBytesUsed() Returns the number of bytes KinesisRecorder currently has stored in the directory passed in the constructor.
KinesisRecorderConfig	getKinesisRecorderConfig() Returns the KinesisRecorderConfig this Kinesis Recorder is using.
void	saveRecord(byte[] data, java.lang.String streamName) Saves a record to local storage to be sent later.
void	saveRecord(java.lang.String data, java.lang.String streamName) Saves a string to local storage to be sent later.
void	submitAllRecords() Submits all requests saved to Amazon Kinesis.

Methods inherited from class java.lang.Object

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

Method Detail

saveRecord

public void saveRecord(java.lang.String data,
                       java.lang.String streamName)

Saves a string to local storage to be sent later. It's a convenient method to save the UTF-8 encoded bytes of the string.

Parameters:

data - A string to submit to the stream

streamName - The stream to submit the data to.

saveRecord

public void saveRecord(byte[] data,
                       java.lang.String streamName)

Saves a record to local storage to be sent later. The record will be submitted to the streamName provided with a randomly generated partition key to ensure equal distribution across shards. Note: Since operation involves file I/O it is recommended not to call this method on the main thread to ensure responsive applications.

Parameters:

data - The data to submit to the stream

streamName - The stream to submit the data to.

submitAllRecords

public void submitAllRecords()

Submits all requests saved to Amazon Kinesis. Requests that are successfully sent will be deleted from the device. Requests that fail due to the device being offline will stop the submission process and be kept. Requests that fail due to other reasons (such as the request being invalid) will be deleted. Note: Since KinesisRecorder uses synchronous methods to make calls to Amazon Kinesis, do not call submitAll() on the main thread of your application.

Throws:

AmazonClientException - Thrown if there was an unrecoverable error during submission. Note: If the request appears to be invalid, the record will be deleted. If the request appears to be valid, it will be kept.

getKinesisRecorderConfig

public KinesisRecorderConfig getKinesisRecorderConfig()

Returns the KinesisRecorderConfig this Kinesis Recorder is using. This is either the config passed into the constructor or the default one if one was not specified.

Returns:

The KinesisRecorderConfig

getDiskBytesUsed

public long getDiskBytesUsed()

Returns the number of bytes KinesisRecorder currently has stored in the directory passed in the constructor.

Returns:

long The number of bytes used

getDiskByteLimit

public long getDiskByteLimit()

Returns the max number of bytes that this Kinesis Recorder will store on disk. This is the same as specified in getMaxStorageSize() in the KinesisRecorderConfig, either the one passed into the constructor or the default one that was constructed.

Returns:

The number of bytes allowed

deleteAllRecords

public void deleteAllRecords()

Removes all requests saved to disk in the directory provided this KinesisRecorder.