com.amazonaws.services.kinesis.clientlibrary.lib.worker

Class ShardSyncTask

java.lang.Object

com.amazonaws.services.kinesis.clientlibrary.lib.worker.ShardSyncTask

All Implemented Interfaces:

ITask, Callable<TaskResult>

public class ShardSyncTask
extends Object
implements ITask

This task syncs leases/activies with shards of the stream. It will create new leases/activites when it discovers new shards (e.g. setup/resharding). It will clean up leases/activities for shards that have been completely processed (if cleanupLeasesUponShardCompletion is true).

Constructor Summary

Constructors

Constructor and Description
ShardSyncTask(IKinesisProxy kinesisProxy, ILeaseManager<KinesisClientLease> leaseManager, InitialPositionInStreamExtended initialPositionInStream, boolean cleanupLeasesUponShardCompletion, boolean ignoreUnexpectedChildShards, long shardSyncTaskIdleTimeMillis, ShardSyncer shardSyncer, List<com.amazonaws.services.kinesis.model.Shard> latestShards)

Method Summary

Modifier and Type	Method and Description
TaskResult	call() Perform task logic.
TaskType	getTaskType()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShardSyncTask

public ShardSyncTask(IKinesisProxy kinesisProxy,
                     ILeaseManager<KinesisClientLease> leaseManager,
                     InitialPositionInStreamExtended initialPositionInStream,
                     boolean cleanupLeasesUponShardCompletion,
                     boolean ignoreUnexpectedChildShards,
                     long shardSyncTaskIdleTimeMillis,
                     ShardSyncer shardSyncer,
                     List<com.amazonaws.services.kinesis.model.Shard> latestShards)

Parameters:

kinesisProxy - Used to fetch information about the stream (e.g. shard list)

leaseManager - Used to fetch and create leases

initialPositionInStream - One of LATEST, TRIM_HORIZON or AT_TIMESTAMP. Amazon Kinesis Client Library will start processing records from this point in the stream (when an application starts up for the first time) except for shards that already have a checkpoint (and their descendant shards).

cleanupLeasesUponShardCompletion - Clean up shards we've finished processing (don't wait for expiration in Kinesis)

shardSyncTaskIdleTimeMillis - shardSync task idle time in millis

shardSyncer - shardSyncer instance used to check and create new leases

latestShards - latest snapshot of shards to reuse

Method Detail

call

public TaskResult call()

Description copied from interface: ITask

Perform task logic. E.g. perform set up (e.g. fetch records) and invoke a callback (e.g. processRecords() API).

Specified by:

call in interface ITask

Specified by:

call in interface Callable<TaskResult>

Returns:

TaskResult (captures any exceptions encountered during execution of the task)

getTaskType

public TaskType getTaskType()

Specified by:

getTaskType in interface ITask

Returns:

TaskType