com.amazonaws.services.kinesis.leases.impl

Class LeaseCleanupManager

java.lang.Object

com.amazonaws.services.kinesis.leases.impl.LeaseCleanupManager

public class LeaseCleanupManager
extends Object

Helper class to cleanup of any expired/closed shard leases. It will cleanup leases periodically as defined by KinesisClientLibConfiguration.leaseCleanupIntervalMillis() upon worker shutdown, following a re-shard event or a shard expiring from the service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LeaseCleanupManager.LeaseCleanupResult

Constructor Summary

Constructors

Constructor and Description
LeaseCleanupManager()

Method Summary

Modifier and Type	Method and Description
LeaseCleanupManager.LeaseCleanupResult	cleanupLease(LeasePendingDeletion leasePendingDeletion, boolean timeToCheckForCompletedShard, boolean timeToCheckForGarbageShard)
void	enqueueForDeletion(LeasePendingDeletion leasePendingDeletion) Enqueues a lease for deletion without check for duplicate entry.
boolean	isEnqueuedForDeletion(LeasePendingDeletion leasePendingDeletion) Check if lease was already enqueued for deletion.
static LeaseCleanupManager	newInstance(IKinesisProxy kinesisProxy, ILeaseManager leaseManager, ScheduledExecutorService deletionThreadPool, IMetricsFactory metricsFactory, boolean cleanupLeasesUponShardCompletion, long leaseCleanupIntervalMillis, long completedLeaseCleanupIntervalMillis, long garbageLeaseCleanupIntervalMillis, int maxRecords) Method to return a new instance of LeaseCleanupManager.
void	shutdown() Stops the lease cleanup thread, which is scheduled periodically as specified by leaseCleanupIntervalMillis
void	start() Starts the lease cleanup thread, which is scheduled periodically as specified by leaseCleanupIntervalMillis

Methods inherited from class java.lang.Object

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

Constructor Detail

LeaseCleanupManager

public LeaseCleanupManager()

Method Detail

newInstance

public static LeaseCleanupManager newInstance(IKinesisProxy kinesisProxy,
                                              ILeaseManager leaseManager,
                                              ScheduledExecutorService deletionThreadPool,
                                              IMetricsFactory metricsFactory,
                                              boolean cleanupLeasesUponShardCompletion,
                                              long leaseCleanupIntervalMillis,
                                              long completedLeaseCleanupIntervalMillis,
                                              long garbageLeaseCleanupIntervalMillis,
                                              int maxRecords)

Method to return a new instance of LeaseCleanupManager.

Parameters:

kinesisProxy -

leaseManager -

deletionThreadPool -

metricsFactory -

cleanupLeasesUponShardCompletion -

leaseCleanupIntervalMillis -

completedLeaseCleanupIntervalMillis -

garbageLeaseCleanupIntervalMillis -

maxRecords -

Returns:

start

public void start()

Starts the lease cleanup thread, which is scheduled periodically as specified by leaseCleanupIntervalMillis

shutdown

public void shutdown()

Stops the lease cleanup thread, which is scheduled periodically as specified by leaseCleanupIntervalMillis

enqueueForDeletion

public void enqueueForDeletion(LeasePendingDeletion leasePendingDeletion)

Enqueues a lease for deletion without check for duplicate entry. Use isEnqueuedForDeletion(com.amazonaws.services.kinesis.leases.LeasePendingDeletion) for checking the duplicate entries.

Parameters:

leasePendingDeletion -

isEnqueuedForDeletion

public boolean isEnqueuedForDeletion(LeasePendingDeletion leasePendingDeletion)

Check if lease was already enqueued for deletion. //TODO: Optimize verifying duplicate entries https://sim.amazon.com/issues/KinesisLTR-597.

Parameters:

leasePendingDeletion -

Returns:

true if enqueued for deletion; false otherwise.

cleanupLease

public LeaseCleanupManager.LeaseCleanupResult cleanupLease(LeasePendingDeletion leasePendingDeletion,
                                                           boolean timeToCheckForCompletedShard,
                                                           boolean timeToCheckForGarbageShard)
                                                    throws DependencyException,
                                                           ProvisionedThroughputException,
                                                           InvalidStateException

Throws:

DependencyException

ProvisionedThroughputException

InvalidStateException