sirius.biz.locks

Class SmartLockManager

java.lang.Object

sirius.biz.locks.SmartLockManager

All Implemented Interfaces:

LockManager, sirius.kernel.di.std.Named

public class SmartLockManager
extends Object
implements LockManager

Provides a "cluster aware" lock manager.

Uses RedisLockManager is Redis is configured or otherwise JavaLockManager

Constructor Summary

Constructors

Constructor and Description
SmartLockManager()

Method Summary

Modifier and Type	Method and Description
List<LockInfo>	getLocks() Returns the list of known locks.
String	getName()
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 class java.lang.Object

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

Constructor Detail

SmartLockManager

public SmartLockManager()

Method Detail

getName

@Nonnull
public String getName()

Specified by:

getName in interface sirius.kernel.di.std.Named

tryLock

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

Description copied from interface: LockManager

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

Specified by:

tryLock in interface LockManager

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

public boolean isLocked(@Nonnull
                        String lock)

Description copied from interface: LockManager

Determines if the lock is currently being locked.

Specified by:

isLocked in interface LockManager

Parameters:

lock - the name of the lock to check

Returns:

true if the lock is locked, false otherwise

unlock

public void unlock(String lock,
                   boolean force)

Description copied from interface: LockManager

Unlocks the given lock.

Specified by:

unlock in interface LockManager

Parameters:

lock - the name of the lock

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

getLocks

public List<LockInfo> getLocks()

Description copied from interface: LockManager

Returns the list of known locks.

Specified by:

getLocks in interface LockManager

Returns:

a list of all available locks