software.amazon.kinesis.leases.dynamodb

Class DynamoDBLeaseRenewer

java.lang.Object

software.amazon.kinesis.leases.dynamodb.DynamoDBLeaseRenewer

All Implemented Interfaces:

LeaseRenewer

public class DynamoDBLeaseRenewer
extends Object
implements LeaseRenewer

An implementation of LeaseRenewer that uses DynamoDB via LeaseRefresher.

Constructor Summary

Constructors

Constructor and Description
DynamoDBLeaseRenewer(LeaseRefresher leaseRefresher, String workerIdentifier, long leaseDurationMillis, ExecutorService executorService, MetricsFactory metricsFactory) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addLeasesToRenew(Collection<Lease> newLeases) Adds leases to this LeaseRenewer's set of currently held leases.
void	clearCurrentlyHeldLeases() Clears this LeaseRenewer's set of currently held leases.
void	dropLease(Lease lease) Stops the lease renewer from continunig to maintain the given lease.
Lease	getCurrentlyHeldLease(String leaseKey)
Map<String,Lease>	getCurrentlyHeldLeases()
void	initialize() Bootstrap initial set of leases from the LeaseRefresher (e.g.
void	renewLeases() Attempt to renew all currently held leases.
boolean	updateLease(Lease lease, UUID concurrencyToken, @NonNull String operation, String singleStreamShardId) Update application-specific fields in a currently held lease.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamoDBLeaseRenewer

public DynamoDBLeaseRenewer(LeaseRefresher leaseRefresher,
                            String workerIdentifier,
                            long leaseDurationMillis,
                            ExecutorService executorService,
                            MetricsFactory metricsFactory)

Constructor.

Parameters:

leaseRefresher - LeaseRefresher to use

workerIdentifier - identifier of this worker

leaseDurationMillis - duration of a lease in milliseconds

executorService - ExecutorService to use for renewing leases in parallel

Method Detail

renewLeases

public void renewLeases()
                 throws DependencyException,
                        InvalidStateException

Attempt to renew all currently held leases.

Specified by:

renewLeases in interface LeaseRenewer

Throws:

DependencyException - on unexpected DynamoDB failures

InvalidStateException - if lease table does not exist

getCurrentlyHeldLeases

public Map<String,Lease> getCurrentlyHeldLeases()

Specified by:

getCurrentlyHeldLeases in interface LeaseRenewer

Returns:

currently held leases. Key is shardId, value is corresponding Lease object. A lease is currently held if we successfully renewed it on the last run of renewLeases(). Lease objects returned are deep copies - their lease counters will not tick.

getCurrentlyHeldLease

public Lease getCurrentlyHeldLease(String leaseKey)

Specified by:

getCurrentlyHeldLease in interface LeaseRenewer

Parameters:

leaseKey - key of the lease to retrieve

Returns:

a deep copy of a currently held lease, or null if we don't hold the lease

updateLease

public boolean updateLease(Lease lease,
                           UUID concurrencyToken,
                           @NonNull
                           @NonNull String operation,
                           String singleStreamShardId)
                    throws DependencyException,
                           InvalidStateException,
                           ProvisionedThroughputException

Update application-specific fields in a currently held lease. Cannot be used to update internal fields such as leaseCounter, leaseOwner, etc. Fails if we do not hold the lease, or if the concurrency token does not match the concurrency token on the internal authoritative copy of the lease (ie, if we lost and re-acquired the lease).

Specified by:

updateLease in interface LeaseRenewer

Parameters:

lease - lease object containing updated data

concurrencyToken - obtained by calling Lease.concurrencyToken for a currently held lease

operation - that performs updateLease

singleStreamShardId - shardId for metrics emission in single stream mode. MultiStream mode will get the shardId from the lease object

Returns:

true if update succeeds, false otherwise

Throws:

DependencyException - if DynamoDB update fails in an unexpected way

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB update fails due to lack of capacity

addLeasesToRenew

public void addLeasesToRenew(Collection<Lease> newLeases)

Adds leases to this LeaseRenewer's set of currently held leases. Leases must have lastRenewalNanos set to the last time the lease counter was incremented before being passed to this method.

Specified by:

addLeasesToRenew in interface LeaseRenewer

Parameters:

newLeases - new leases.

clearCurrentlyHeldLeases

public void clearCurrentlyHeldLeases()

Clears this LeaseRenewer's set of currently held leases.

Specified by:

clearCurrentlyHeldLeases in interface LeaseRenewer

dropLease

public void dropLease(Lease lease)

Stops the lease renewer from continunig to maintain the given lease.

Specified by:

dropLease in interface LeaseRenewer

Parameters:

lease - the lease to drop.

initialize

public void initialize()
                throws DependencyException,
                       InvalidStateException,
                       ProvisionedThroughputException

Bootstrap initial set of leases from the LeaseRefresher (e.g. upon process restart, pick up leases we own)

Specified by:

initialize in interface LeaseRenewer

Throws:

DependencyException - on unexpected DynamoDB failures

InvalidStateException - if lease table doesn't exist

ProvisionedThroughputException - if DynamoDB reads fail due to insufficient capacity