momento.lock.client

Class MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder

java.lang.Object

momento.lock.client.MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder

Enclosing class:

MomentoDynamoDBLockClientOptions

public static class MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
MomentoDynamoDBLockClientOptions	build()
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withConfiguration(momento.sdk.config.Configuration configuration)
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withCreateHeartbeatBackgroundThread(java.lang.Boolean createHeartbeatBackgroundThread)
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withCredentialProvider(momento.sdk.auth.CredentialProvider credentialProvider)
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withHeartbeatPeriod(java.lang.Long heartbeatPeriod)
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withHoldLockOnServiceUnavailable(java.lang.Boolean holdLockOnServiceUnavailable) This parameter should be set to true only in the applications which do not have strict locking requirements.
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withLeaseDuration(java.lang.Long leaseDuration)
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withOwnerName(java.lang.String ownerName)
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withPartitionKeyName(java.lang.String partitionKeyName)
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withSortKeyName(java.lang.String sortKeyName)
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withTimeUnit(java.util.concurrent.TimeUnit timeUnit)
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withTotalNumBackgroundThreadsForHeartbeating(int totalNumBackgroundThreadsForHeartbeating) If you expect each client to own tens or hundreds of locks, you can configure the thread pool size of MomentoLockClientHeartbeatHandler so that individual locks heartbeat in parallel.
MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder	withTotalNumThreadsForAcquiringLocks(int totalNumThreadsForAcquiringLocks) This library uses a lightweight executor to submit tasks for acquiring locks and to schedule any retries if applicable for locks that are acquired to achieve a blocking behavior.

Methods inherited from class java.lang.Object

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

Method Detail

withConfiguration

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withConfiguration(momento.sdk.config.Configuration configuration)

withCredentialProvider

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withCredentialProvider(momento.sdk.auth.CredentialProvider credentialProvider)

withTotalNumBackgroundThreadsForHeartbeating

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withTotalNumBackgroundThreadsForHeartbeating(int totalNumBackgroundThreadsForHeartbeating)

If you expect each client to own tens or hundreds of locks, you can configure the thread pool size of MomentoLockClientHeartbeatHandler so that individual locks heartbeat in parallel. This might be important as you don't want one thread to play catchup while heartbeating, eventually leading to locks being released. The default value for this is 1.

Parameters:

totalNumBackgroundThreadsForHeartbeating -

Returns:

a reference to this builder for fluent method chaining

withTotalNumThreadsForAcquiringLocks

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withTotalNumThreadsForAcquiringLocks(int totalNumThreadsForAcquiringLocks)

This library uses a lightweight executor to submit tasks for acquiring locks and to schedule any retries if applicable for locks that are acquired to achieve a blocking behavior. The default value is 8 and can be overriden through this option.

Parameters:

totalNumThreadsForAcquiringLocks -

Returns:

a reference to this builder for fluent method chaining

withPartitionKeyName

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withPartitionKeyName(java.lang.String partitionKeyName)

Parameters:

partitionKeyName - The partition key name. If not specified, the default partition key name of "key" is used.

Returns:

a reference to this builder for fluent method chaining

withSortKeyName

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withSortKeyName(java.lang.String sortKeyName)

Parameters:

sortKeyName - The sort key name. If not specified, we assume that the cache keys do not have a sort key defined. Sort keys in Momento only play the role of concatenating with the partition key to form a unique cache key. This will stay true until Momento has query and scan semantics available.

Returns:

a reference to this builder for fluent method chaining

withOwnerName

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withOwnerName(java.lang.String ownerName)

Parameters:

ownerName - The person that is acquiring the lock (for example, hostname.ec2.aws)

Returns:

a reference to this builder for fluent method chaining

withLeaseDuration

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withLeaseDuration(java.lang.Long leaseDuration)

Parameters:

leaseDuration - The length of time that the lease for the lock will be granted for. If this is set to, for example, 30 seconds, then the lock will expire if the heartbeat is not sent for at least 30 seconds (which would happen if the box or the heartbeat thread dies, for example.)

Returns:

a reference to this builder for fluent method chaining

withHeartbeatPeriod

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withHeartbeatPeriod(java.lang.Long heartbeatPeriod)

Parameters:

heartbeatPeriod - How often to update Momento to note that the instance is still running (recommendation is to make this at least 3 times smaller than the leaseDuration -- for example heartBeatPeriod=1 second, leaseDuration=10 seconds could be a reasonable configuration, make sure to include a buffer for network latency.)

Returns:

a reference to this builder for fluent method chaining

withTimeUnit

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withTimeUnit(java.util.concurrent.TimeUnit timeUnit)

Parameters:

timeUnit - What time unit to use for all times in this object, including heartbeatPeriod and leaseDuration.

Returns:

a reference to this builder for fluent method chaining

withCreateHeartbeatBackgroundThread

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withCreateHeartbeatBackgroundThread(java.lang.Boolean createHeartbeatBackgroundThread)

Parameters:

createHeartbeatBackgroundThread - Whether or not to create a thread to automatically heartbeat (if false, you must call sendHeartbeat manually)

Returns:

a reference to this builder for fluent method chaining

withHoldLockOnServiceUnavailable

public MomentoDynamoDBLockClientOptions.MomentoDynamoDBLockClientOptionsBuilder withHoldLockOnServiceUnavailable(java.lang.Boolean holdLockOnServiceUnavailable)

This parameter should be set to true only in the applications which do not have strict locking requirements. When this is set to true, on Momento service unavailable errors it is possible that two different clients can hold the lock. When heartbeat fails for lease duration period, the lock expires. If this parameter is set to true, and if a heartbeat receives Momento server side exceptions, the lock client will assume that the heartbeat was a success and update the local state accordingly and it will keep holding the lock.

Parameters:

holdLockOnServiceUnavailable - Whether or not to hold the lock if Momento Service is unavailable

Returns:

a reference to this builder for fluent method chaining

build

public MomentoDynamoDBLockClientOptions build()