com.haulmont.cuba.core.app

Class LockServiceBean

java.lang.Object

com.haulmont.cuba.core.app.LockServiceBean

All Implemented Interfaces:

LockService

@Service(value="cuba_LockService")
public class LockServiceBean
extends java.lang.Object
implements LockService

Field Summary

Fields inherited from interface com.haulmont.cuba.core.app.LockService

NAME

Constructor Summary

Constructors

Constructor and Description
LockServiceBean()

Method Summary

Modifier and Type	Method and Description
java.util.List<LockInfo>	getCurrentLocks() List of current locks
LockInfo	getLockInfo(java.lang.String name, java.lang.String id) Get locking status for particular object
LockInfo	lock(Entity 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(Entity entity) Unlock an entity.
void	unlock(java.lang.String name, java.lang.String id) Unlock an arbitrary object.

Methods inherited from class java.lang.Object

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

Constructor Detail

LockServiceBean

public LockServiceBean()

Method Detail

lock

public LockInfo lock(java.lang.String name,
                     java.lang.String id)

Description copied from interface: LockService

Try to lock an arbitrary object.

Specified by:

lock in interface LockService

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(Entity entity)

Description copied from interface: LockService

Try to lock an entity.

Specified by:

lock in interface LockService

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

Description copied from interface: LockService

Unlock an arbitrary object.

Specified by:

unlock in interface LockService

Parameters:

name - locking object name

id - locking object ID

unlock

public void unlock(Entity entity)

Description copied from interface: LockService

Unlock an entity.

Specified by:

unlock in interface LockService

Parameters:

entity - entity instance

getLockInfo

public LockInfo getLockInfo(java.lang.String name,
                            java.lang.String id)

Description copied from interface: LockService

Get locking status for particular object

Specified by:

getLockInfo in interface LockService

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 java.util.List<LockInfo> getCurrentLocks()

Description copied from interface: LockService

List of current locks

Specified by:

getCurrentLocks in interface LockService

reloadConfiguration

public void reloadConfiguration()

Specified by:

reloadConfiguration in interface LockService