com.amazonaws.services.kinesis.leases.impl

Class KinesisClientLeaseManager

java.lang.Object

com.amazonaws.services.kinesis.leases.impl.LeaseManager<KinesisClientLease>

com.amazonaws.services.kinesis.leases.impl.KinesisClientLeaseManager

All Implemented Interfaces:

IKinesisClientLeaseManager, ILeaseManager<KinesisClientLease>

public class KinesisClientLeaseManager
extends LeaseManager<KinesisClientLease>
implements IKinesisClientLeaseManager

An implementation of LeaseManager for the KinesisClientLibrary - takeLease updates the ownerSwitchesSinceCheckpoint field.

Field Summary

Fields inherited from class com.amazonaws.services.kinesis.leases.impl.LeaseManager

consistentReads, dynamoDBClient, serializer, table

Constructor Summary

Constructors

Constructor and Description
KinesisClientLeaseManager(String table, com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDBClient) Deprecated.
KinesisClientLeaseManager(String table, com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDBClient, com.amazonaws.services.dynamodbv2.model.BillingMode billingMode) Constructor.
KinesisClientLeaseManager(String table, com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDBClient, boolean consistentReads) Deprecated.
KinesisClientLeaseManager(String table, com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDBClient, boolean consistentReads, com.amazonaws.services.dynamodbv2.model.BillingMode billingMode) Constructor for integration tests - see comment on superclass for documentation on setting the consistentReads flag.

Method Summary

Modifier and Type	Method and Description
ExtendedSequenceNumber	getCheckpoint(String shardId) Gets the current checkpoint of the shard.
boolean	takeLease(KinesisClientLease lease, String newOwner) Take a lease for the given owner by incrementing its leaseCounter and setting its owner field.

Methods inherited from class com.amazonaws.services.kinesis.leases.impl.LeaseManager

convertAndRethrowExceptions, createLeaseIfNotExists, createLeaseTableIfNotExists, deleteAll, deleteLease, evictLease, getLease, isLeaseTableEmpty, leaseTableExists, listLeases, renewLease, updateLease, updateLeaseWithMetaInfo, waitUntilLeaseTableExists

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.kinesis.leases.interfaces.ILeaseManager

createLeaseIfNotExists, createLeaseTableIfNotExists, deleteAll, deleteLease, evictLease, getLease, isLeaseTableEmpty, leaseTableExists, listLeases, renewLease, updateLease, updateLeaseWithMetaInfo, waitUntilLeaseTableExists

Constructor Detail

KinesisClientLeaseManager

@Deprecated
public KinesisClientLeaseManager(String table,
                                             com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDBClient)

Deprecated.

Constructor.

Parameters:

table - Leases table

dynamoDBClient - DynamoDB client to use

KinesisClientLeaseManager

public KinesisClientLeaseManager(String table,
                                 com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDBClient,
                                 com.amazonaws.services.dynamodbv2.model.BillingMode billingMode)

Constructor.

Parameters:

table - Leases table

dynamoDBClient - DynamoDB client to use

KinesisClientLeaseManager

@Deprecated
public KinesisClientLeaseManager(String table,
                                             com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDBClient,
                                             boolean consistentReads)

Deprecated.

Constructor for integration tests - see comment on superclass for documentation on setting the consistentReads flag.

Parameters:

table - leases table

dynamoDBClient - DynamoDB client to use

consistentReads - true if we want consistent reads for testing purposes.

KinesisClientLeaseManager

public KinesisClientLeaseManager(String table,
                                 com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDBClient,
                                 boolean consistentReads,
                                 com.amazonaws.services.dynamodbv2.model.BillingMode billingMode)

Constructor for integration tests - see comment on superclass for documentation on setting the consistentReads flag.

Parameters:

table - leases table

dynamoDBClient - DynamoDB client to use

consistentReads - true if we want consistent reads for testing purposes.

Method Detail

takeLease

public boolean takeLease(KinesisClientLease lease,
                         String newOwner)
                  throws DependencyException,
                         InvalidStateException,
                         ProvisionedThroughputException

Take a lease for the given owner by incrementing its leaseCounter and setting its owner field. Conditional on the leaseCounter in DynamoDB matching the leaseCounter of the input. Mutates the leaseCounter and owner of the passed-in lease object after updating DynamoDB.

Specified by:

takeLease in interface ILeaseManager<KinesisClientLease>

Overrides:

takeLease in class LeaseManager<KinesisClientLease>

Parameters:

lease - the lease to take

newOwner - the new owner

Returns:

true if lease was successfully taken, 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

getCheckpoint

public ExtendedSequenceNumber getCheckpoint(String shardId)
                                     throws ProvisionedThroughputException,
                                            InvalidStateException,
                                            DependencyException

Gets the current checkpoint of the shard. This is useful in the resharding use case where we will wait for the parent shard to complete before starting on the records from a child shard.

Specified by:

getCheckpoint in interface IKinesisClientLeaseManager

Parameters:

shardId - Checkpoint of this shard will be returned

Returns:

Checkpoint of this shard, or null if the shard record doesn't exist.

Throws:

ProvisionedThroughputException - if DynamoDB update fails due to lack of capacity

InvalidStateException - if lease table does not exist

DependencyException - if DynamoDB update fails in an unexpected way