sirius.biz.locks

Class BasicLockManager

java.lang.Object

sirius.biz.locks.BasicLockManager

All Implemented Interfaces:

LockManager, sirius.kernel.di.std.Named

Direct Known Subclasses:

JavaLockManager, SQLLockManager

public abstract class BasicLockManager
extends Object
implements LockManager

Provides a basic implementation which tries to obtain a lock in increasing intervals.

Constructor Summary

Constructors

Constructor and Description
BasicLockManager()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	acquireLock(String lockName) Actually obtains a lock and returns immediatelly.
protected abstract int	getInitialWait() If the lock is already aquired, this returns the initial amount of milliseconds to wait.
protected abstract int	getMaxWait() Returns the maximal interval in millis which is spent until a new attempt is made to acquire a lock.
protected abstract int	getWaitIncrement() If the lock is still acquired, this returns the amount of milliseconds to increase the wait interval.
boolean	tryLock(String lockName, Duration acquireTimeout) Tries to acquire the lock with the given name within the given interval.

Methods inherited from class java.lang.Object

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

Methods inherited from interface sirius.biz.locks.LockManager

getLocks, isLocked, unlock

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

getName

Constructor Detail

BasicLockManager

public BasicLockManager()

Method Detail

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

getInitialWait

protected abstract int getInitialWait()

If the lock is already aquired, this returns the initial amount of milliseconds to wait.

Returns:

the duration of the first interval until a new attempt is made to acquire a lock

getWaitIncrement

protected abstract int getWaitIncrement()

If the lock is still acquired, this returns the amount of milliseconds to increase the wait interval.

Returns:

the number of milliseconds to add to the current wait interval until a new attempt is made to acquire a lock

getMaxWait

protected abstract int getMaxWait()

Returns the maximal interval in millis which is spent until a new attempt is made to acquire a lock.

Returns:

the max interval until a new attempt is made to acquire a lock

acquireLock

protected abstract boolean acquireLock(String lockName)

Actually obtains a lock and returns immediatelly.

Parameters:

lockName - the name of the lock to acquire.

Returns:

true if the lock was obtained, false otherwise