io.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	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
String	getDefaultKey()
long	getLockTryFrequency()
String	getOwner()
boolean	isLockHeld()
boolean	isReleaseStarted()
void	releaseLockDefault() Release the default lock when is acquired by the current LockChecker.

Method Detail

getDefaultKey

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.

isReleaseStarted

boolean isReleaseStarted()

Returns:

if the lockManager has been told to release the lock. It may still hold it.

getLockTryFrequency

long getLockTryFrequency()

Returns:

lock try frequency

getOwner

String getOwner()

Returns:

Lock's owner

isLockHeld

boolean isLockHeld()

Returns:

if lock is held

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable