Package io.jmix.pessimisticlock.impl

Class LockManagerImpl

java.lang.Object

io.jmix.pessimisticlock.impl.LockManagerImpl

All Implemented Interfaces:

LockManager

@Component("pslock_LockManagerImpl")
public class LockManagerImpl
extends Object
implements LockManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LockManagerImpl.LockKey

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.springframework.cache.CacheManager	cacheManager
protected final CacheOperations	cacheOperations
protected Map<String,LockDescriptor>	config
protected final CurrentAuthentication	currentAuthentication
protected final ExtendedEntities	extendedEntities
protected List<LockDescriptorProvider>	lockDescriptorProviders
protected org.springframework.cache.Cache	locks
protected static final org.slf4j.Logger	log
protected final Metadata	metadata
protected final MetadataTools	metadataTools
protected final TimeSource	timeSource

Fields inherited from interface io.jmix.pessimisticlock.LockManager

LOCKS_CACHE_NAME

Constructor Summary

Constructors

Constructor	Description
LockManagerImpl(ExtendedEntities extendedEntities, Metadata metadata, MetadataTools metadataTools, TimeSource timeSource, CurrentAuthentication currentAuthentication, org.springframework.cache.CacheManager cacheManager, CacheOperations cacheOperations, List<LockDescriptorProvider> lockDescriptorProviders)

Method Summary

Modifier and Type	Method	Description
void	expireLocks()	Process locks expiring.
protected Map<String,LockDescriptor>	getConfig()
Collection<LockInfo>	getCurrentLocks()	Collection of current locks
LockInfo	getLockInfo(String name, String id)	Get locking status for particular object
protected void	init()
protected boolean	isCurrentUserLock(LockInfo lockInfo)
LockInfo	lock(Object entity)	Try to lock an entity.
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.
void	unlock(String name, String id, boolean force)	Unlock an arbitrary object.

Methods inherited from class java.lang.Object

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

Field Details

log

protected static final org.slf4j.Logger log

extendedEntities

protected final ExtendedEntities extendedEntities

metadata

protected final Metadata metadata

metadataTools

protected final MetadataTools metadataTools

timeSource

protected final TimeSource timeSource

currentAuthentication

protected final CurrentAuthentication currentAuthentication

cacheManager

protected final org.springframework.cache.CacheManager cacheManager

cacheOperations

protected final CacheOperations cacheOperations

lockDescriptorProviders

protected List<LockDescriptorProvider> lockDescriptorProviders

config

protected volatile Map<String,LockDescriptor> config

locks

protected org.springframework.cache.Cache locks

Constructor Details

LockManagerImpl

public LockManagerImpl(ExtendedEntities extendedEntities,
 Metadata metadata,
 MetadataTools metadataTools,
 TimeSource timeSource,
 CurrentAuthentication currentAuthentication,
 org.springframework.cache.CacheManager cacheManager,
 CacheOperations cacheOperations,
 List<LockDescriptorProvider> lockDescriptorProviders)

Method Details

init

@PostConstruct
protected void init()

getConfig

protected Map<String,LockDescriptor> getConfig()

lock

public LockInfo lock(String name,
 String id)

Description copied from interface: LockManager

Try to lock an arbitrary object.

Specified by:

lock in interface LockManager

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
public LockInfo lock(Object entity)

Description copied from interface: LockManager

Try to lock an entity.

Specified by:

lock in interface LockManager

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

public void unlock(String name,
 String id)

Description copied from interface: LockManager

Unlock an arbitrary object.

Specified by:

unlock in interface LockManager

Parameters:

name - locking object name

id - locking object ID

unlock

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

Description copied from interface: LockManager

Unlock an arbitrary object.

Specified by:

unlock in interface LockManager

Parameters:

name - locking object name

id - locking object ID

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

unlock

public void unlock(Object entity)

Description copied from interface: LockManager

Unlock an entity.

Specified by:

unlock in interface LockManager

Parameters:

entity - entity instance

getLockInfo

public LockInfo getLockInfo(String name,
 String id)

Description copied from interface: LockManager

Get locking status for particular object

Specified by:

getLockInfo in interface LockManager

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

public Collection<LockInfo> getCurrentLocks()

Description copied from interface: LockManager

Collection of current locks

Specified by:

getCurrentLocks in interface LockManager

expireLocks

public void expireLocks()

Description copied from interface: LockManager

Process locks expiring. All expired locks will be removed.

Specified by:

expireLocks in interface LockManager

reloadConfiguration

public void reloadConfiguration()

Specified by:

reloadConfiguration in interface LockManager

isCurrentUserLock

protected boolean isCurrentUserLock(@Nullable
 LockInfo lockInfo)