Package io.jmix.pessimisticlock

Interface LockManager

All Known Implementing Classes:

LockManagerImpl

@NullMarked
public interface LockManager

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOCKS_CACHE_NAME

Method Summary

Modifier and Type	Method	Description
void	expireLocks()	Process locks expiring.
Collection<LockInfo>	getCurrentLocks()	Collection of current locks
@Nullable LockInfo	getLockInfo(String name, String id)	Get locking status for particular object
@Nullable LockInfo	lock(Object entity)	Try to lock an entity.
@Nullable LockInfo	lock(String name, String id)	Try to lock an arbitrary object.
void	reloadConfiguration()
void	unlock(Object entity)	Unlock an entity.
void	unlock(String name, String id)	Unlock an arbitrary object.
default void	unlock(String name, String id, boolean force)	Unlock an arbitrary object.

Field Details

LOCKS_CACHE_NAME

static final String LOCKS_CACHE_NAME

See Also:

• Constant Field Values

Method Details

lock

@Nullable LockInfo lock(String name,
 String id)

Try to lock an arbitrary object.

Parameters:

name - locking object name

id - locking object ID

Returns:

- null in case of successful lock,
- LockNotSupported instance in case of locking is not configured for this object,
- LockInfo instance in case of this object is already locked by someone

lock

@Nullable LockInfo lock(Object entity)

Try to lock an entity.

Parameters:

entity - entity instance

Returns:

- null in case of successful lock,
- LockNotSupported instance in case of locking is not configured for this entity,
- LockInfo instance in case of this entity is already locked by someone

unlock

void unlock(String name,
 String id)

Unlock an arbitrary object.

Parameters:

name - locking object name

id - locking object ID

unlock

default void unlock(String name,
 String id,
 boolean force)

Unlock an arbitrary object.

Parameters:

name - locking object name

id - locking object ID

force - force unlock even if the lock is not owned by the current owner

unlock

void unlock(Object entity)

Unlock an entity.

Parameters:

entity - entity instance

getLockInfo

@Nullable LockInfo getLockInfo(String name,
 String id)

Get locking status for particular object

Parameters:

name - locking object name

id - locking object ID

Returns:

- null in case of no lock,
- LockNotSupported instance in case of locking is not configured for this object,
- LockInfo instance in case of this object is locked by someone

getCurrentLocks

Collection<LockInfo> getCurrentLocks()

Collection of current locks

expireLocks

void expireLocks()

Process locks expiring. All expired locks will be removed.

reloadConfiguration

void reloadConfiguration()