software.amazon.kinesis.leases

Class HierarchicalShardSyncer

java.lang.Object

software.amazon.kinesis.leases.HierarchicalShardSyncer

public class HierarchicalShardSyncer
extends Object

Helper class to sync leases with shards of the Kinesis stream. It will create new leases/activities when it discovers new Kinesis shards (bootstrap/resharding). It deletes leases for shards that have been trimmed from Kinesis, or if we've completed processing it and begun processing its child shards.

Constructor Summary

Constructors

Constructor and Description
HierarchicalShardSyncer()
HierarchicalShardSyncer(boolean isMultiStreamMode, String streamIdentifier)
HierarchicalShardSyncer(boolean isMultiStreamMode, String streamIdentifier, DeletedStreamListProvider deletedStreamListProvider)

Method Summary

Modifier and Type	Method and Description
boolean	checkAndCreateLeaseForNewShards(@NonNull ShardDetector shardDetector, LeaseRefresher leaseRefresher, InitialPositionInStreamExtended initialPosition, List<software.amazon.awssdk.services.kinesis.model.Shard> latestShards, boolean ignoreUnexpectedChildShards, MetricsScope scope, boolean isLeaseTableEmpty) Provide a pre-collected list of shards to avoid calling ListShards API
boolean	checkAndCreateLeaseForNewShards(@NonNull ShardDetector shardDetector, LeaseRefresher leaseRefresher, InitialPositionInStreamExtended initialPosition, MetricsScope scope, boolean ignoreUnexpectedChildShards, boolean isLeaseTableEmpty) Check and create leases for any new shards (e.g.
Lease	createLeaseForChildShard(software.amazon.awssdk.services.kinesis.model.ChildShard childShard, StreamIdentifier streamIdentifier)

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchicalShardSyncer

public HierarchicalShardSyncer()

HierarchicalShardSyncer

public HierarchicalShardSyncer(boolean isMultiStreamMode,
                               String streamIdentifier)

HierarchicalShardSyncer

public HierarchicalShardSyncer(boolean isMultiStreamMode,
                               String streamIdentifier,
                               DeletedStreamListProvider deletedStreamListProvider)

Method Detail

checkAndCreateLeaseForNewShards

public boolean checkAndCreateLeaseForNewShards(@NonNull
                                               @NonNull ShardDetector shardDetector,
                                               LeaseRefresher leaseRefresher,
                                               InitialPositionInStreamExtended initialPosition,
                                               MetricsScope scope,
                                               boolean ignoreUnexpectedChildShards,
                                               boolean isLeaseTableEmpty)
                                        throws DependencyException,
                                               InvalidStateException,
                                               ProvisionedThroughputException,
                                               KinesisClientLibIOException,
                                               InterruptedException

Check and create leases for any new shards (e.g. following a reshard operation). Sync leases with Kinesis shards (e.g. at startup, or when we reach end of a shard). Return true, if shard sync was performed. Return false, if shard sync is skipped.

Parameters:

shardDetector -

leaseRefresher -

initialPosition -

scope -

ignoreUnexpectedChildShards -

Throws:

DependencyException

InvalidStateException

ProvisionedThroughputException

KinesisClientLibIOException

InterruptedException

checkAndCreateLeaseForNewShards

public boolean checkAndCreateLeaseForNewShards(@NonNull
                                               @NonNull ShardDetector shardDetector,
                                               LeaseRefresher leaseRefresher,
                                               InitialPositionInStreamExtended initialPosition,
                                               List<software.amazon.awssdk.services.kinesis.model.Shard> latestShards,
                                               boolean ignoreUnexpectedChildShards,
                                               MetricsScope scope,
                                               boolean isLeaseTableEmpty)
                                        throws DependencyException,
                                               InvalidStateException,
                                               ProvisionedThroughputException,
                                               KinesisClientLibIOException

Provide a pre-collected list of shards to avoid calling ListShards API

Throws:

DependencyException

InvalidStateException

ProvisionedThroughputException

KinesisClientLibIOException

createLeaseForChildShard

public Lease createLeaseForChildShard(software.amazon.awssdk.services.kinesis.model.ChildShard childShard,
                                      StreamIdentifier streamIdentifier)
                               throws InvalidStateException

Throws:

InvalidStateException