com.github.cloudyrock.mongock.driver.api.lock

Interface LockManager

All Superinterfaces:

AutoCloseable, Closeable

public interface LockManager
extends Closeable

Method Summary

Modifier and Type	Method and Description
void	acquireLockDefault() Tries to acquire the default lock regardless who is the current owner.
void	clean() force to delete all the locks in the database.
void	close()
void	ensureLockDefault() Tries to refresh the default lock when the current LockChecker has the lock or , when the lock is expired, is the last owner
default String	getDefaultKey()
int	getLockMaxTries()
String	getOwner()
boolean	isLockHeld()
void	releaseLockDefault() Release the default lock when is acquired by the current LockChecker.
LockManager	setLockAcquiredForMillis(long lockAcquiredForMillis) Indicates the number of milliseconds the lock will be acquired for
LockManager	setLockMaxTries(int lockMaxTries) Updates the maximum number of tries to acquire the lock, if the flag 'waitForLog' is set
LockManager	setLockMaxWaitMillis(long lockMaxWaitMillis) If the flag 'waitForLog' is set, indicates the maximum time it will wait for the lock in each try.

Method Detail

getDefaultKey

default String getDefaultKey()

Returns:

lock's key

acquireLockDefault

void acquireLockDefault()
                 throws LockCheckException

Tries to acquire the default lock regardless who is the current owner.

If the lock is already acquired by the current LockChecker or is expired, will be updated

In case the lock is acquired by another LockChecker, it will wait until the current lock is expired and will try to acquire it again. This will be repeated as many times as (maxTries - 1)

Throws:

LockCheckException - if the lock cannot be acquired

ensureLockDefault

void ensureLockDefault()
                throws LockCheckException

Tries to refresh the default lock when the current LockChecker has the lock or , when the lock is expired, is the last owner

Notice that it does not try to acquire when is acquired by another LockChecker

Throws:

LockCheckException - if, in case of needed, the lock cannot be refreshed

releaseLockDefault

void releaseLockDefault()

Release the default lock when is acquired by the current LockChecker.

When the lock is not acquired by the current LockChecker, it won't make any change. Does not throw any exception neither.

Idempotent operation.

setLockMaxWaitMillis

LockManager setLockMaxWaitMillis(long lockMaxWaitMillis)

If the flag 'waitForLog' is set, indicates the maximum time it will wait for the lock in each try.

Default 3 minutes

Parameters:

lockMaxWaitMillis - max waiting time for lock. Must be greater than 0

Returns:

LockChecker object for fluent interface

getLockMaxTries

int getLockMaxTries()

Returns:

max tries

setLockMaxTries

LockManager setLockMaxTries(int lockMaxTries)

Updates the maximum number of tries to acquire the lock, if the flag 'waitForLog' is set

Default 1

Parameters:

lockMaxTries - number of tries

Returns:

LockChecker object for fluent interface

setLockAcquiredForMillis

LockManager setLockAcquiredForMillis(long lockAcquiredForMillis)

Indicates the number of milliseconds the lock will be acquired for

Default 3 minutes

Parameters:

lockAcquiredForMillis - milliseconds the lock will be acquired for

Returns:

LockChecker object for fluent interface

getOwner

String getOwner()

Returns:

Lock's owner

isLockHeld

boolean isLockHeld()

Returns:

if lock is held

clean

void clean()

force to delete all the locks in the database. Mainly for test environment. Not recommended production use

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable