A B C D E G H I L M N O P R S T U V W

A

ACQUIRE_LOCK_THAT_DOESNT_EXIST_OR_IS_RELEASED_CONDITION - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

acquireLock(AcquireLockOptions) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Attempts to acquire a lock until it either acquires the lock, or a specified additionalTimeToWaitForLock is reached.

AcquireLockOptions - Class in com.amazonaws.services.dynamodbv2

Provides options for acquiring a lock when calling the acquireLock() method.

AcquireLockOptions.AcquireLockOptionsBuilder - Class in com.amazonaws.services.dynamodbv2

A builder for setting up an AcquireLockOptions object.

AmazonDynamoDBLockClient - Class in com.amazonaws.services.dynamodbv2

Provides a simple library for using DynamoDB's consistent read/write feature to use it for managing distributed locks.

AmazonDynamoDBLockClient(AmazonDynamoDBLockClientOptions) - Constructor for class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Initializes an AmazonDynamoDBLockClient using the lock client options specified in the AmazonDynamoDBLockClientOptions object.

AmazonDynamoDBLockClientOptions - Class in com.amazonaws.services.dynamodbv2

An options class for setting up a lock client with various overrides to the defaults.

AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder - Class in com.amazonaws.services.dynamodbv2

A builder for setting up an AmazonDynamoDBLockClientOptions object.

amIAboutToExpire() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns whether or not the lock is entering the "danger zone" time period.

assertLockTableExists() - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Asserts that the lock table exists in DynamoDB.

B

build() - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

build() - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder

Builds an AmazonDynamoDBLockClientOptions.

build() - Method in class com.amazonaws.services.dynamodbv2.CreateDynamoDBTableOptions.CreateDynamoDBTableOptionsBuilder

build() - Method in class com.amazonaws.services.dynamodbv2.GetLockOptions.GetLockOptionsBuilder

build() - Method in class com.amazonaws.services.dynamodbv2.ReleaseLockOptions.ReleaseLockOptionsBuilder

build() - Method in class com.amazonaws.services.dynamodbv2.SendHeartbeatOptions.SendHeartbeatOptionsBuilder

builder(String) - Static method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions

Creates a new version of AcquireLockOptionsBuilder using the only required parameter, which is a specific partition key.

builder(AmazonDynamoDB, String) - Static method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions

Creates an AmazonDynamoDBLockClientOptions builder object, which can be used to create an AmazonDynamoDBLockClient.

builder(AmazonDynamoDB, ProvisionedThroughput, String) - Static method in class com.amazonaws.services.dynamodbv2.CreateDynamoDBTableOptions

Creates a builder for a CreateDynamoDBTableOptions object.

builder(String) - Static method in class com.amazonaws.services.dynamodbv2.GetLockOptions

Creates a GetLockOptionsBuilder, which lets the caller specify arguments to getLock().

builder(LockItem) - Static method in class com.amazonaws.services.dynamodbv2.ReleaseLockOptions

Creates a builder for the ReleaseLockOptions object.

builder(LockItem) - Static method in class com.amazonaws.services.dynamodbv2.SendHeartbeatOptions

Creates a SendHeartbeatOptionsBuilder, which can be used for setting options for the sendHeartbeat() method in the lock client.

C

close() - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Releases all of the locks by calling releaseAllLocks()

close() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Releases the lock for others to use.

com.amazonaws.services.dynamodbv2 - package com.amazonaws.services.dynamodbv2

com.amazonaws.services.dynamodbv2.model - package com.amazonaws.services.dynamodbv2.model

com.amazonaws.services.dynamodbv2.util - package com.amazonaws.services.dynamodbv2.util

CreateDynamoDBTableOptions - Class in com.amazonaws.services.dynamodbv2

An options class for the createDynamoDBTable method in the lock client.

CreateDynamoDBTableOptions.CreateDynamoDBTableOptionsBuilder - Class in com.amazonaws.services.dynamodbv2

createLockTableInDynamoDB(CreateDynamoDBTableOptions) - Static method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Creates a DynamoDB table with the right schema for it to be used by this locking library.

D

DATA - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

DATA_PATH_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

DATA_VALUE_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

DEFAULT_CREATE_HEARTBEAT_BACKGROUND_THREAD - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions

DEFAULT_HEARTBEAT_PERIOD - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions

DEFAULT_LEASE_DURATION - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions

DEFAULT_PARTITION_KEY_NAME - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions

DEFAULT_TIME_UNIT - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions

dynamoDB - Variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

E

ensure(long, TimeUnit) - Method in class com.amazonaws.services.dynamodbv2.LockItem

Ensures that this owner has the lock for a specified period of time.

equals(Object) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions

equals(Object) - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns if two locks have the same (key, ownerName)

G

getAdditionalAttributes() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns the additional attributes that can optionally be stored alongside the lock.

getAllLocksFromDynamoDB(boolean) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Retrieves all the lock items from DynamoDB.

getData() - Method in class com.amazonaws.services.dynamodbv2.LockItem

getDeleteLockItemOnClose() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns a boolean indicating whether the lock should be deleted from DynamoDB after release.

getLeaseDuration() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns the amount of time that the client has this lock for, which can be kept up to date by calling sendHeartbeat.

getLock(String, Optional<String>) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Finds out who owns the given lock, but does not acquire the lock.

getLockFromDynamoDB(GetLockOptions) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Retrieves the lock item from DynamoDB.

GetLockOptions - Class in com.amazonaws.services.dynamodbv2

Provides options for getting a lock when calling the getLock() method.

GetLockOptions.GetLockOptionsBuilder - Class in com.amazonaws.services.dynamodbv2

getLookupTime() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns the last time this lock was updated.

getOwnerName() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns the name of the owner that owns this lock.

getPartitionKey() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns the key associated with this lock, which is unique for every lock (unless the lock has a sort key, in which case key + sortKey is unique.)

getRecordVersionNumber() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns the current record version number of the lock in DynamoDB.

getSortKey() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns the sort key associated with the lock, if there is one.

H

hashCode() - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions

hashCode() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Hash code of just the (key, ownerName) as that is what uniquely identifies this lock.

I

IS_RELEASED - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

IS_RELEASED_ATTRIBUTE_VALUE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

IS_RELEASED_PATH_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

IS_RELEASED_VALUE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

IS_RELEASED_VALUE_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

isExpired() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns whether or not the lock is expired, based on the lease duration and when the last heartbeat was sent.

L

LEASE_DURATION - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

LEASE_DURATION_PATH_VALUE_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

LEASE_DURATION_VALUE_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

lockClientId - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

LockClientUtils - Enum in com.amazonaws.services.dynamodbv2.util

A class containing static utility functions.

LockItem - Class in com.amazonaws.services.dynamodbv2

A lock that has been successfully acquired.

LockNotGrantedException - Exception in com.amazonaws.services.dynamodbv2.model

Thrown to indicate that a caller was not granted a lock that it requested.

LockNotGrantedException() - Constructor for exception com.amazonaws.services.dynamodbv2.model.LockNotGrantedException

LockNotGrantedException(String) - Constructor for exception com.amazonaws.services.dynamodbv2.model.LockNotGrantedException

LockNotGrantedException(String, Throwable) - Constructor for exception com.amazonaws.services.dynamodbv2.model.LockNotGrantedException

LockTableDoesNotExistException - Exception in com.amazonaws.services.dynamodbv2.model

Exception indicating that the lock table doesn't exist.

LockTableDoesNotExistException(String) - Constructor for exception com.amazonaws.services.dynamodbv2.model.LockTableDoesNotExistException

LockTableDoesNotExistException(String, Throwable) - Constructor for exception com.amazonaws.services.dynamodbv2.model.LockTableDoesNotExistException

lockTableExists() - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Checks whether the lock table exists in DynamoDB.

M

millisecondTime() - Method in enum com.amazonaws.services.dynamodbv2.util.LockClientUtils

Calls System.nanoTime() and converts it to milliseconds.

N

NEW_RVN_VALUE_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

O

OWNER_NAME - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

OWNER_NAME_PATH_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

OWNER_NAME_VALUE_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

P

PK_EXISTS_AND_OWNER_NAME_SAME_AND_RVN_SAME_CONDITION - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

PK_EXISTS_AND_RVN_IS_THE_SAME_CONDITION - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

PK_EXISTS_AND_SK_EXISTS_AND_OWNER_NAME_SAME_AND_RVN_SAME_CONDITION - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

PK_EXISTS_AND_SK_EXISTS_AND_RVN_IS_THE_SAME_CONDITION - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

PK_PATH_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

R

RECORD_VERSION_NUMBER - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

releaseLock(LockItem) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Releases the given lock if the current user still has it, returning true if the lock was successfully released, and false if someone else already stole the lock.

releaseLock(ReleaseLockOptions) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

ReleaseLockOptions - Class in com.amazonaws.services.dynamodbv2

Provides options for releasing a lock when calling the releaseLock() method.

ReleaseLockOptions.ReleaseLockOptionsBuilder - Class in com.amazonaws.services.dynamodbv2

run() - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Loops forever, sending hearbeats for all the locks this thread needs to keep track of.

RVN_PATH_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

RVN_VALUE_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

S

sendHeartbeat(LockItem) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Sends a heartbeat to indicate that the given lock is still being worked on.

sendHeartbeat(SendHeartbeatOptions) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Sends a heartbeat to indicate that the given lock is still being worked on.

sendHeartBeat() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Sends a heartbeat to indicate that the given lock is still being worked on.

SendHeartbeatOptions - Class in com.amazonaws.services.dynamodbv2

A simple bean for sending lock heartbeats or updating the lock data with various combinations of overrides of the default behavior.

SendHeartbeatOptions.SendHeartbeatOptionsBuilder - Class in com.amazonaws.services.dynamodbv2

SessionMonitorNotSetException - Exception in com.amazonaws.services.dynamodbv2.model

Thrown to indicate that SessionMonitor is not set.

SessionMonitorNotSetException(String) - Constructor for exception com.amazonaws.services.dynamodbv2.model.SessionMonitorNotSetException

Basic constructor.

SessionMonitorNotSetException(String, Throwable) - Constructor for exception com.amazonaws.services.dynamodbv2.model.SessionMonitorNotSetException

Full constructor.

SK_PATH_EXPRESSION_VARIABLE - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

T

tableName - Variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

toString() - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

toString() - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder

toString() - Method in class com.amazonaws.services.dynamodbv2.CreateDynamoDBTableOptions.CreateDynamoDBTableOptionsBuilder

toString() - Method in class com.amazonaws.services.dynamodbv2.GetLockOptions.GetLockOptionsBuilder

toString() - Method in class com.amazonaws.services.dynamodbv2.LockItem

Returns a string representation of this lock.

toString() - Method in class com.amazonaws.services.dynamodbv2.ReleaseLockOptions.ReleaseLockOptionsBuilder

toString() - Method in class com.amazonaws.services.dynamodbv2.SendHeartbeatOptions.SendHeartbeatOptionsBuilder

tryAcquireLock(AcquireLockOptions) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

Attempts to acquire lock.

U

UPDATE_IS_RELEASED - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

UPDATE_IS_RELEASED_AND_DATA - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

UPDATE_LEASE_DURATION_AND_RVN - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

UPDATE_LEASE_DURATION_AND_RVN_AND_DATA - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

UPDATE_LEASE_DURATION_AND_RVN_AND_REMOVE_DATA - Static variable in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClient

V

valueOf(String) - Static method in enum com.amazonaws.services.dynamodbv2.util.LockClientUtils

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.amazonaws.services.dynamodbv2.util.LockClientUtils

Returns an array containing the constants of this enum type, in the order they are declared.

W

withAdditionalAttributes(Map<String, AttributeValue>) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

Stores some additional attributes with each lock.

withAdditionalTimeToWaitForLock(Long) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

withBestEffort(boolean) - Method in class com.amazonaws.services.dynamodbv2.ReleaseLockOptions.ReleaseLockOptionsBuilder

Whether or not to ignore AmazonClientException when releasing the lock.

withCreateHeartbeatBackgroundThread(Boolean) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder

withData(ByteBuffer) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

Sets data to be stored alongside the lock

withData(ByteBuffer) - Method in class com.amazonaws.services.dynamodbv2.ReleaseLockOptions.ReleaseLockOptionsBuilder

New data to persist to the lock (only used if deleteLock=false.) If the data is null, then the lock client will keep the data as-is and not change it.

withData(ByteBuffer) - Method in class com.amazonaws.services.dynamodbv2.SendHeartbeatOptions.SendHeartbeatOptionsBuilder

withDeleteData(Boolean) - Method in class com.amazonaws.services.dynamodbv2.SendHeartbeatOptions.SendHeartbeatOptionsBuilder

withDeleteLock(boolean) - Method in class com.amazonaws.services.dynamodbv2.ReleaseLockOptions.ReleaseLockOptionsBuilder

Whether or not to delete the lock when releasing it.

withDeleteLockOnRelease(Boolean) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

withDeleteLockOnRelease(boolean) - Method in class com.amazonaws.services.dynamodbv2.GetLockOptions.GetLockOptionsBuilder

withHeartbeatPeriod(Long) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder

withLeaseDuration(Long) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder

withLeaseDurationToEnsure(Long) - Method in class com.amazonaws.services.dynamodbv2.SendHeartbeatOptions.SendHeartbeatOptionsBuilder

withOwnerName(String) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder

withPartitionKeyName(String) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder

withPartitionKeyName(String) - Method in class com.amazonaws.services.dynamodbv2.CreateDynamoDBTableOptions.CreateDynamoDBTableOptionsBuilder

withRefreshPeriod(Long) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

withReplaceData(Boolean) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

Sets whether or not to replace any existing lock data with the data parameter.

withRequestMetricCollector(RequestMetricCollector) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

withRequestMetricCollector(RequestMetricCollector) - Method in class com.amazonaws.services.dynamodbv2.CreateDynamoDBTableOptions.CreateDynamoDBTableOptionsBuilder

withRequestMetricCollector(RequestMetricCollector) - Method in class com.amazonaws.services.dynamodbv2.GetLockOptions.GetLockOptionsBuilder

withRequestMetricCollector(RequestMetricCollector) - Method in class com.amazonaws.services.dynamodbv2.ReleaseLockOptions.ReleaseLockOptionsBuilder

withRequestMetricCollector(RequestMetricCollector) - Method in class com.amazonaws.services.dynamodbv2.SendHeartbeatOptions.SendHeartbeatOptionsBuilder

withSessionMonitor(long, Optional<Runnable>) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

Registers a "SessionMonitor."

withSortKey(String) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

withSortKey(String) - Method in class com.amazonaws.services.dynamodbv2.GetLockOptions.GetLockOptionsBuilder

withSortKeyName(String) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder

withSortKeyName(String) - Method in class com.amazonaws.services.dynamodbv2.CreateDynamoDBTableOptions.CreateDynamoDBTableOptionsBuilder

withTimeUnit(TimeUnit) - Method in class com.amazonaws.services.dynamodbv2.AcquireLockOptions.AcquireLockOptionsBuilder

withTimeUnit(TimeUnit) - Method in class com.amazonaws.services.dynamodbv2.AmazonDynamoDBLockClientOptions.AmazonDynamoDBLockClientOptionsBuilder

withTimeUnit(TimeUnit) - Method in class com.amazonaws.services.dynamodbv2.SendHeartbeatOptions.SendHeartbeatOptionsBuilder

A B C D E G H I L M N O P R S T U V W