com.amazonaws.mobileconnectors.kinesis.kinesisrecorder

Class KinesisRecorder

java.lang.Object

com.amazonaws.mobileconnectors.kinesis.kinesisrecorder.AbstractKinesisRecorder

com.amazonaws.mobileconnectors.kinesis.kinesisrecorder.KinesisRecorder

public class KinesisRecorder
extends AbstractKinesisRecorder

The KinesisRecorder is a high level client meant for storing records on the users Android device. This allows developers to retain requests when the device is offline. It can also increase performance and battery efficiency since the wi-fi or cell network does not need to be woken up as frequently.

Note: KinesisRecorder uses all synchronous calls regardless of the AmazonKinesisClient passed in. Therefore you should not call KinesisRecorder methods on the main thread.

To use KinesisRecorder create an AmazonKinesisClient and an directory that is private to your application. The directory passed should be empty the first time you instantiate KinesisRecorder, and should only be used for KinesisRecorder to prevent collision. Additionally you may pass an instance of KinesisRecorderConfig in order to set parameters on KinesisRecorder (Such as the maximum amount of storage KinesisRecorder may use).

Warning: You should not create multiple KinesisRecorders given the same directory. Doing so is an error and behavior is undefined.

Note: KinesisRecorder stores the requests in plain-text, and does not perform additional security measures outside of what the Android OS offers by default. Therefore it is recommended you pass a directory that is only visible to your application, and additionally do not store highly sensitive information using Kinesis Recorder.

KinesisRecorder requires an IAM policy that allows PutRecords action on the target stream. Here is an example:

 {
   "Version": "2012-10-17",
   "Statement": [{
     "Effect": "Allow",
     "Action": [ "kinesis:PutRecords" ],
     "Resource": [
       "arn:aws:kinesis:us-east-1:123456789012:stream/my_stream"
     ]
   }]
 }
 

Field Summary

Fields inherited from class com.amazonaws.mobileconnectors.kinesis.kinesisrecorder.AbstractKinesisRecorder

config, recordStore

Constructor Summary

Constructors

Constructor and Description
KinesisRecorder(File directory, Regions region, AWSCredentialsProvider credentialsProvider) Constructs a new Kinesis Recorder specifying a directory that Kinesis Recorder has exclusive access to for storing requests.
KinesisRecorder(File directory, Regions region, AWSCredentialsProvider credentialsProvider, KinesisRecorderConfig config) Constructs a new Kinesis Recorder specifying a directory that Kinesis Recorder has exclusive access to for storing requests.

Method Summary

Modifier and Type	Method and Description
protected com.amazonaws.mobileconnectors.kinesis.kinesisrecorder.RecordSender	getRecordSender() Gets the sender to send saved records.
void	saveRecord(byte[] data, String streamName) Saves a record to local storage to be sent later.

Methods inherited from class com.amazonaws.mobileconnectors.kinesis.kinesisrecorder.AbstractKinesisRecorder

deleteAllRecords, getDiskByteLimit, getDiskBytesUsed, getKinesisRecorderConfig, nextBatch, saveRecord, submitAllRecords

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisRecorder

public KinesisRecorder(File directory,
                       Regions region,
                       AWSCredentialsProvider credentialsProvider)

Constructs a new Kinesis Recorder specifying a directory that Kinesis Recorder has exclusive access to for storing requests.

Note: Kinesis Recorder is synchronous, and it's methods should not be called on the main thread.

Note: Kinesis Recorder stores requests in plain-text, we recommend using a directory that is only readable by your application and not storing highly sensitive information in requests stored by Kinesis Recorder.

Parameters:

credentialsProvider - The credentials provider to use when making requests to AWS

region - The region of Amazon Kinesis this Recorder should save and send requests to.

directory - An empty directory KinesisRecorder can use for storing requests.

KinesisRecorder

public KinesisRecorder(File directory,
                       Regions region,
                       AWSCredentialsProvider credentialsProvider,
                       KinesisRecorderConfig config)

Constructs a new Kinesis Recorder specifying a directory that Kinesis Recorder has exclusive access to for storing requests. Allows specifying various aspects of Kinesis Recorder through the KinesisRecorderConfig parameter. Note: Kinesis Recorder is synchronous, and it's methods should not be called on the main thread. Note: Kinesis Recorder stores requests in plain-text, we recommend using a directory that is only readable by your application and not storing highly sensitive information in requests stored by Kinesis Recorder.

Parameters:

credentialsProvider - The credentials provider to use when making requests to AWS

region - The region of Amazon Kinesis this Recorder should save and send requests to.

directory - An empty directory KinesisRecorder can use for storing requests.

config - Allows configuring various parameters of the recorder

Method Detail

getRecordSender

protected com.amazonaws.mobileconnectors.kinesis.kinesisrecorder.RecordSender getRecordSender()

Description copied from class: AbstractKinesisRecorder

Gets the sender to send saved records.

Specified by:

getRecordSender in class AbstractKinesisRecorder

Returns:

a RecordSender

saveRecord

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

Description copied from class: AbstractKinesisRecorder

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.

Overrides:

saveRecord in class AbstractKinesisRecorder

Parameters:

data - The data to submit to the stream

streamName - The stream to submit the data to.