sirius.biz.locks

Interface LockManager

All Superinterfaces:

sirius.kernel.di.std.Named

All Known Implementing Classes:

BasicLockManager, JavaLockManager, RedisLockManager, SmartLockManager, SQLLockManager

public interface LockManager
extends sirius.kernel.di.std.Named

Provides an actual implementation to manage locks.

Method Summary

Modifier and Type	Method and Description
List<LockInfo>	getLocks() Returns the list of known locks.
boolean	isLocked(String lock) Determines if the lock is currently being locked.
boolean	tryLock(String lockName, Duration acquireTimeout) Tries to acquire the lock with the given name within the given interval.
void	unlock(String lock, boolean force) Unlocks the given lock.

Methods inherited from interface sirius.kernel.di.std.Named

getName

Method Detail

tryLock

boolean tryLock(@Nonnull
                String lockName,
                @Nullable
                Duration acquireTimeout)

Tries to acquire the lock with the given name within the given interval.

Parameters:

lockName - the name of the lock to acquire.

acquireTimeout - the max time to wait for a lock. Used null to immediatelly return if a lock cannot be obtained.

Returns:

true if the lock was acquired, false otherwise

isLocked

boolean isLocked(@Nonnull
                 String lock)

Determines if the lock is currently being locked.

Parameters:

lock - the name of the lock to check

Returns:

true if the lock is locked, false otherwise

unlock

void unlock(String lock,
            boolean force)

Unlocks the given lock.

Parameters:

lock - the name of the lock

force - true if the lock should be removed, even if it is acquired by another node

getLocks

List<LockInfo> getLocks()

Returns the list of known locks.

Returns:

a list of all available locks