io.jmix.core.pessimisticlocking

Interface LockManager

All Known Implementing Classes:

LockManagerImpl

public interface LockManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCKS_CACHE_NAME

Method Summary

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

Field Detail

LOCKS_CACHE_NAME

static final java.lang.String LOCKS_CACHE_NAME

See Also:

Constant Field Values

Method Detail

lock

@Nullable
LockInfo lock(java.lang.String name,
                        java.lang.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(java.lang.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(java.lang.String name,
            java.lang.String id)

Unlock an arbitrary object.

Parameters:

name - locking object name

id - locking object ID

unlock

void unlock(java.lang.Object entity)

Unlock an entity.

Parameters:

entity - entity instance

getLockInfo

@Nullable
LockInfo getLockInfo(java.lang.String name,
                               java.lang.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

java.util.Collection<LockInfo> getCurrentLocks()

Collection of current locks

expireLocks

void expireLocks()

Process locks expiring. All expired locks will be removed.

reloadConfiguration

void reloadConfiguration()