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 it's child shards.

Constructor Summary

Constructors

Constructor and Description
HierarchicalShardSyncer()

Method Summary

Modifier and Type	Method and Description
void	checkAndCreateLeaseForNewShards(ShardDetector shardDetector, LeaseRefresher leaseRefresher, InitialPositionInStreamExtended initialPosition, boolean cleanupLeasesOfCompletedShards, boolean ignoreUnexpectedChildShards, MetricsScope scope) Check and create leases for any new shards (e.g.
void	checkAndCreateLeaseForNewShards(ShardDetector shardDetector, LeaseRefresher leaseRefresher, InitialPositionInStreamExtended initialPosition, boolean cleanupLeasesOfCompletedShards, boolean ignoreUnexpectedChildShards, MetricsScope scope, List<software.amazon.awssdk.services.kinesis.model.Shard> latestShards)

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchicalShardSyncer

public HierarchicalShardSyncer()

Method Detail

checkAndCreateLeaseForNewShards

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

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).

Parameters:

shardDetector -

leaseRefresher -

initialPosition -

cleanupLeasesOfCompletedShards -

ignoreUnexpectedChildShards -

scope -

Throws:

DependencyException

InvalidStateException

ProvisionedThroughputException

KinesisClientLibIOException

checkAndCreateLeaseForNewShards

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

Throws:

DependencyException

InvalidStateException

ProvisionedThroughputException

KinesisClientLibIOException