com.amazonaws.services.kinesis.leases.interfaces

Interface ILeaseManager<T extends Lease>

Type Parameters:

T - Lease subclass, possibly Lease itself.

All Known Subinterfaces:

IKinesisClientLeaseManager

All Known Implementing Classes:

KinesisClientLeaseManager, LeaseManager

public interface ILeaseManager<T extends Lease>

Supports basic CRUD operations for Leases.

Method Summary

Modifier and Type	Method and Description
boolean	createLeaseIfNotExists(T lease) Create a new lease.
boolean	createLeaseTableIfNotExists(Long readCapacity, Long writeCapacity) Creates the table that will store leases.
void	deleteAll() Delete all leases from DynamoDB.
void	deleteLease(T lease) Delete the given lease from DynamoDB.
boolean	evictLease(T lease) Evict the current owner of lease by setting owner to null.
T	getLease(String shardId)
boolean	isLeaseTableEmpty() Check (synchronously) if there are any leases in the lease table.
boolean	leaseTableExists()
List<T>	listLeases() List all objects in table synchronously.
boolean	renewLease(T lease) Renew a lease by incrementing the lease counter.
boolean	takeLease(T lease, String owner) Take a lease for the given owner by incrementing its leaseCounter and setting its owner field.
boolean	updateLease(T lease) Update application-specific fields of the given lease in DynamoDB.
default void	updateLeaseWithMetaInfo(T lease, UpdateField updateField) Update application-specific fields of the given lease in DynamoDB.
boolean	waitUntilLeaseTableExists(long secondsBetweenPolls, long timeoutSeconds) Blocks until the lease table exists by polling leaseTableExists.

Method Detail

createLeaseTableIfNotExists

boolean createLeaseTableIfNotExists(Long readCapacity,
                                    Long writeCapacity)
                             throws ProvisionedThroughputException,
                                    DependencyException

Creates the table that will store leases. Succeeds if table already exists.

Parameters:

readCapacity -

writeCapacity -

Returns:

true if we created a new table (table didn't exist before)

Throws:

ProvisionedThroughputException - if we cannot create the lease table due to per-AWS-account capacity restrictions.

DependencyException - if DynamoDB createTable fails in an unexpected way

leaseTableExists

boolean leaseTableExists()
                  throws DependencyException

Returns:

true if the lease table already exists.

Throws:

DependencyException - if DynamoDB describeTable fails in an unexpected way

waitUntilLeaseTableExists

boolean waitUntilLeaseTableExists(long secondsBetweenPolls,
                                  long timeoutSeconds)
                           throws DependencyException

Blocks until the lease table exists by polling leaseTableExists.

Parameters:

secondsBetweenPolls - time to wait between polls in seconds

timeoutSeconds - total time to wait in seconds

Returns:

true if table exists, false if timeout was reached

Throws:

DependencyException - if DynamoDB describeTable fails in an unexpected way

listLeases

List<T> listLeases()
            throws DependencyException,
                   InvalidStateException,
                   ProvisionedThroughputException

List all objects in table synchronously.

Returns:

list of leases

Throws:

DependencyException - if DynamoDB scan fails in an unexpected way

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB scan fails due to lack of capacity

createLeaseIfNotExists

boolean createLeaseIfNotExists(T lease)
                        throws DependencyException,
                               InvalidStateException,
                               ProvisionedThroughputException

Create a new lease. Conditional on a lease not already existing with this shardId.

Parameters:

lease - the lease to create

Returns:

true if lease was created, false if lease already exists

Throws:

DependencyException - if DynamoDB put fails in an unexpected way

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB put fails due to lack of capacity

getLease

T getLease(String shardId)
    throws DependencyException,
           InvalidStateException,
           ProvisionedThroughputException

Parameters:

shardId - Get the lease for this shardId

Returns:

lease for the specified shardId, or null if one doesn't exist

Throws:

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB get fails due to lack of capacity

DependencyException - if DynamoDB get fails in an unexpected way

renewLease

boolean renewLease(T lease)
            throws DependencyException,
                   InvalidStateException,
                   ProvisionedThroughputException

Renew a lease by incrementing the lease counter. Conditional on the leaseCounter in DynamoDB matching the leaseCounter of the input. Mutates the leaseCounter of the passed-in lease object after updating the record in DynamoDB.

Parameters:

lease - the lease to renew

Returns:

true if renewal succeeded, false otherwise

Throws:

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB update fails due to lack of capacity

DependencyException - if DynamoDB update fails in an unexpected way

takeLease

boolean takeLease(T lease,
                  String owner)
           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.

Parameters:

lease - the lease to take

owner - the new owner

Returns:

true if lease was successfully taken, false otherwise

Throws:

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB update fails due to lack of capacity

DependencyException - if DynamoDB update fails in an unexpected way

evictLease

boolean evictLease(T lease)
            throws DependencyException,
                   InvalidStateException,
                   ProvisionedThroughputException

Evict the current owner of lease by setting owner to null. Conditional on the owner in DynamoDB matching the owner of the input. Mutates the lease counter and owner of the passed-in lease object after updating the record in DynamoDB.

Parameters:

lease - the lease to void

Returns:

true if eviction succeeded, false otherwise

Throws:

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB update fails due to lack of capacity

DependencyException - if DynamoDB update fails in an unexpected way

deleteLease

void deleteLease(T lease)
          throws DependencyException,
                 InvalidStateException,
                 ProvisionedThroughputException

Delete the given lease from DynamoDB. Does nothing when passed a lease that does not exist in DynamoDB.

Parameters:

lease - the lease to delete

Throws:

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB delete fails due to lack of capacity

DependencyException - if DynamoDB delete fails in an unexpected way

deleteAll

void deleteAll()
        throws DependencyException,
               InvalidStateException,
               ProvisionedThroughputException

Delete all leases from DynamoDB. Useful for tools/utils and testing.

Throws:

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB scan or delete fail due to lack of capacity

DependencyException - if DynamoDB scan or delete fail in an unexpected way

updateLease

boolean updateLease(T lease)
             throws DependencyException,
                    InvalidStateException,
                    ProvisionedThroughputException

Update application-specific fields of the given lease in DynamoDB. Does not update fields managed by the leasing library such as leaseCounter, leaseOwner, or leaseKey. Conditional on the leaseCounter in DynamoDB matching the leaseCounter of the input. Increments the lease counter in DynamoDB so that updates can be contingent on other updates. Mutates the lease counter of the passed-in lease object.

Returns:

true if update succeeded, false otherwise

Throws:

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB update fails due to lack of capacity

DependencyException - if DynamoDB update fails in an unexpected way

updateLeaseWithMetaInfo

default void updateLeaseWithMetaInfo(T lease,
                                     UpdateField updateField)
                              throws DependencyException,
                                     InvalidStateException,
                                     ProvisionedThroughputException

Update application-specific fields of the given lease in DynamoDB. Does not update fields managed by the leasing library such as leaseCounter, leaseOwner, or leaseKey.

Throws:

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB update fails due to lack of capacity

DependencyException - if DynamoDB update fails in an unexpected way

isLeaseTableEmpty

boolean isLeaseTableEmpty()
                   throws DependencyException,
                          InvalidStateException,
                          ProvisionedThroughputException

Check (synchronously) if there are any leases in the lease table.

Returns:

true if there are no leases in the lease table

Throws:

DependencyException - if DynamoDB scan fails in an unexpected way

InvalidStateException - if lease table does not exist

ProvisionedThroughputException - if DynamoDB scan fails due to lack of capacity