software.amazon.kinesis.lifecycle

Class LeaseGracefulShutdownHandler

java.lang.Object

software.amazon.kinesis.lifecycle.LeaseGracefulShutdownHandler

public class LeaseGracefulShutdownHandler
extends Object

This class handles the graceful shutdown of shard consumers. When a lease is requested for shutdown, it will be enqueued from the lease renewal thread which will call the shard consumer of the lease to enqueue a shutdown request. The class monitors those leases and check if the shutdown is properly completed. If the shard consumer doesn't shut down within the given timeout, it will trigger a lease transfer.

Constructor Summary

Constructors

Constructor and Description
LeaseGracefulShutdownHandler()

Method Summary

Modifier and Type	Method and Description
static LeaseGracefulShutdownHandler	create(long shutdownTimeoutMillis, ConcurrentMap<ShardInfo,ShardConsumer> shardInfoShardConsumerMap, LeaseCoordinator leaseCoordinator) Factory method to create a new instance of LeaseGracefulShutdownHandler.
void	enqueueShutdown(Lease lease) Enqueue a shutdown request for the given lease if the lease has requested shutdown and the shard consumer is not already shutdown.
void	start() Starts the shard consumer shutdown handler thread.
void	stop() Stops the shard consumer shutdown handler thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

LeaseGracefulShutdownHandler

public LeaseGracefulShutdownHandler()

Method Detail

create

public static LeaseGracefulShutdownHandler create(long shutdownTimeoutMillis,
                                                  ConcurrentMap<ShardInfo,ShardConsumer> shardInfoShardConsumerMap,
                                                  LeaseCoordinator leaseCoordinator)

Factory method to create a new instance of LeaseGracefulShutdownHandler.

Parameters:

shutdownTimeoutMillis - Timeout for graceful shutdown of shard consumers.

shardInfoShardConsumerMap - Map of shard info to shard consumer instances.

leaseCoordinator - Lease coordinator instance to access lease information.

Returns:

A new instance of LeaseGracefulShutdownHandler.

start

public void start()

Starts the shard consumer shutdown handler thread.

stop

public void stop()

Stops the shard consumer shutdown handler thread.

enqueueShutdown

public void enqueueShutdown(Lease lease)

Enqueue a shutdown request for the given lease if the lease has requested shutdown and the shard consumer is not already shutdown.

Parameters:

lease - The lease to enqueue a shutdown request for.