sirius.biz.locks

Class JavaLockManager

java.lang.Object

sirius.biz.locks.BasicLockManager

sirius.biz.locks.JavaLockManager

All Implemented Interfaces:

LockManager, sirius.kernel.di.std.Named

public class JavaLockManager
extends BasicLockManager

Provides a fast implementation which is based on internal JVM locks.

Note that this managed is not suitable for clusters, as locks are only held locally.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Contains the name of this lock manager

Constructor Summary

Constructors

Constructor and Description
JavaLockManager()

Method Summary

Modifier and Type	Method and Description
protected boolean	acquireLock(String lockName) Actually obtains a lock and returns immediatelly.
protected int	getInitialWait() If the lock is already aquired, this returns the initial amount of milliseconds to wait.
List<LockInfo>	getLocks() Returns the list of known locks.
protected int	getMaxWait() Returns the maximal interval in millis which is spent until a new attempt is made to acquire a lock.
String	getName()
protected int	getWaitIncrement() If the lock is still acquired, this returns the amount of milliseconds to increase the wait interval.
boolean	isLocked(String lock) Determines if the lock is currently being locked.
void	unlock(String lock, boolean force) Unlocks the given lock.

Methods inherited from class sirius.biz.locks.BasicLockManager

tryLock

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Contains the name of this lock manager

See Also:

Constant Field Values

Constructor Detail

JavaLockManager

public JavaLockManager()

Method Detail

getName

@Nonnull
public String getName()

getMaxWait

protected int getMaxWait()

Description copied from class: BasicLockManager

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

Specified by:

getMaxWait in class BasicLockManager

Returns:

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

getWaitIncrement

protected int getWaitIncrement()

Description copied from class: BasicLockManager

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

Specified by:

getWaitIncrement in class BasicLockManager

Returns:

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

getInitialWait

protected int getInitialWait()

Description copied from class: BasicLockManager

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

Specified by:

getInitialWait in class BasicLockManager

Returns:

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

acquireLock

protected boolean acquireLock(String lockName)

Description copied from class: BasicLockManager

Actually obtains a lock and returns immediatelly.

Specified by:

acquireLock in class BasicLockManager

Parameters:

lockName - the name of the lock to acquire.

Returns:

true if the lock was obtained, false otherwise

isLocked

public boolean isLocked(@Nonnull
                        String lock)

Description copied from interface: LockManager

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

public void unlock(String lock,
                   boolean force)

Description copied from interface: LockManager

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

public List<LockInfo> getLocks()

Description copied from interface: LockManager

Returns the list of known locks.

Returns:

a list of all available locks