com.haulmont.cuba.core.app

Class LockManager

java.lang.Object

com.haulmont.cuba.core.app.LockManager

All Implemented Interfaces:

ClusterListener<LockInfo>, LockManagerAPI

@Component(value="cuba_LockManager")
public class LockManager
extends java.lang.Object
implements LockManagerAPI, ClusterListener<LockInfo>

Field Summary

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

NAME

Constructor Summary

Constructors

Constructor and Description
LockManager()

Method Summary

Modifier and Type	Method and Description
void	expireLocks() Process locks expiring.
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
byte[]	getState() Get state of this cluster node to send it to other nodes.
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	receive(LockInfo message) Receive a message from other cluster nodes.
void	reloadConfiguration()
void	setClusterManager(ClusterManagerAPI clusterManager)
void	setState(byte[] state) Set state of this cluster node receiving it from other active node.
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

LockManager

public LockManager()

Method Detail

setClusterManager

@Inject
public void setClusterManager(ClusterManagerAPI clusterManager)

lock

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

Description copied from interface: LockManagerAPI

Try to lock an arbitrary object.

Specified by:

lock in interface LockManagerAPI

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: LockManagerAPI

Try to lock an entity.

Specified by:

lock in interface LockManagerAPI

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: LockManagerAPI

Unlock an arbitrary object.

Specified by:

unlock in interface LockManagerAPI

Parameters:

name - locking object name

id - locking object ID

unlock

public void unlock(Entity entity)

Description copied from interface: LockManagerAPI

Unlock an entity.

Specified by:

unlock in interface LockManagerAPI

Parameters:

entity - entity instance

getLockInfo

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

Description copied from interface: LockManagerAPI

Get locking status for particular object

Specified by:

getLockInfo in interface LockManagerAPI

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: LockManagerAPI

List of current locks

Specified by:

getCurrentLocks in interface LockManagerAPI

expireLocks

public void expireLocks()

Description copied from interface: LockManagerAPI

Process locks expiring. All expired locks will be removed.

Specified by:

expireLocks in interface LockManagerAPI

reloadConfiguration

public void reloadConfiguration()

Specified by:

reloadConfiguration in interface LockManagerAPI

receive

public void receive(LockInfo message)

Description copied from interface: ClusterListener

Receive a message from other cluster nodes.

Specified by:

receive in interface ClusterListener<LockInfo>

Parameters:

message - message instance

getState

public byte[] getState()

Description copied from interface: ClusterListener

Get state of this cluster node to send it to other nodes. "State" here means data that must be shared between cluster nodes.

This method is invoked by clustering implementation when a new node joins the cluster and wants to receive the state from this active node.

Specified by:

getState in interface ClusterListener<LockInfo>

Returns:

byte array containing the state

setState

public void setState(byte[] state)

Description copied from interface: ClusterListener

Set state of this cluster node receiving it from other active node. "State" here means data that must be shared between cluster nodes.

This method is invoked by clustering implementation once when this node joins the cluster.

Specified by:

setState in interface ClusterListener<LockInfo>

Parameters:

state - byte array containing the state