com.seeyon.ctp.common.lock.manager

接口 LockManager

所有已知子接口:

DatabaseLockManager, MemoryLockManager

public interface LockManager

锁管理，只提供加锁解锁释放锁的管理，锁由应用自己解释和控制。 每一个模块有一个独立的锁管理器。
模块：需要加锁的应用。如协同、公文、表单，可以自行指定一个字符串，如ColLock、FormLock作为标识。
资源：被锁定对象。可以是协同、公文、表单，甚至是人员。
操作：被锁定对象的行为。对于流程，可以是处理、加签减签等。

作者:

wangwy

方法概要

限定符和类型	方法和说明
boolean	check(long userId, long resourceId) 判断指定人员是否可以访问资源。
boolean	check(long userId, long resourceId, int action) 判断指定人员是否可以访问资源。
Lock	createDefaultLock(long owner, long resourceId, int action, String from, String param0, String param1, boolean useNowexpirationTime)
List<Lock>	getAllLock()
Lock	getLock(long resourceId, int action) 取得资源的指定操作的锁。
List<Lock>	getLocks(long resourceId) 取得资源的所有锁。
String	getModule() 取得当前锁管理器所属模块。
String	getOwnerName(Lock lock) 取得加锁人信息。
LockState	isValid(Lock lock) 判断锁是否有效。
boolean	lock(Lock lock) 对资源的操作加锁(高级使用，谨慎，lock参数需使用lockManager.createDefaultLock创建此对象才行)。
boolean	lock(long owner, long resourceId) 加锁。
boolean	lock(long owner, long resourceId, int action) 对资源的操作加锁。
boolean	lock(long owner, long resourceId, int action, String from)
boolean	lock(long owner, long resourceId, int action, String from, boolean useNowexpirationTime)
boolean	lock(long owner, long resourceId, String from)
void	unlock(long resourceId) 解锁。
void	unlock(long resourceId, int action) 解锁。
void	unlock(long owner, long resourceId, int action) 解锁。
void	updateLockExpirationTime(long rd, int action, long time)

方法详细资料

lock

boolean lock(long owner,
             long resourceId)

加锁。加锁后指定资源只允许加锁者独占使用。
这里会有一定歧义：对资源加锁是锁定了资源的所有操作，还是操作为空本身就是一种操作。
在这里不做处理，由应用自己解释。如果有特定的解释，请不要使用check方法，调用getLocks方法自己判断。

参数:

owner - 加锁人Id。

resourceId - 资源Id，如协同的affairId

返回:

如果指定资源锁不存在，并成功上锁，返回true，如果指定资源锁已存在返回false 。

lock

boolean lock(long owner,
             long resourceId,
             int action)

对资源的操作加锁。

参数:

owner - 加锁人Id。

resourceId - 资源Id。

action - 资源操作。

返回:

如果指定资源操作锁不存在，并成功上锁，返回true，如果指定资源操作锁已存在返回false 。

lock

boolean lock(long owner,
             long resourceId,
             int action,
             String from)

参数:

owner -

resourceId -

action -

from - 来自哪个端，目前只有WXT用到，WXT表示微协同

返回:

lock

boolean lock(long owner,
             long resourceId,
             int action,
             String from,
             boolean useNowexpirationTime)

参数:

owner -

resourceId -

action -

from - 来自哪个端，目前只有WXT用到，WXT表示微协同

返回:

lock

boolean lock(long owner,
             long resourceId,
             String from)

参数:

owner -

resourceId -

from - 来自哪个端，目前只有WXT用到，WXT表示微协同

返回:

lock

boolean lock(Lock lock)

对资源的操作加锁(高级使用，谨慎，lock参数需使用lockManager.createDefaultLock创建此对象才行)。

参数:

lock -

返回:

createDefaultLock

Lock createDefaultLock(long owner,
                       long resourceId,
                       int action,
                       String from,
                       String param0,
                       String param1,
                       boolean useNowexpirationTime)

返回:

getLocks

List<Lock> getLocks(long resourceId)

取得资源的所有锁。用于扩展，取得锁以后可以对check做别的解释。

参数:

resourceId - 资源Id

返回:

锁存在则返回资源的有效锁列表，否则返回size为0的List。

getLock

Lock getLock(long resourceId,
             int action)

取得资源的指定操作的锁。

参数:

resourceId - 资源Id。

action - 操作。

返回:

锁存在且有效则返回，否则返回null。

unlock

void unlock(long resourceId)

解锁。释放所有指定资源的锁，锁不存在则无操作。

参数:

resourceId - 资源Id。

unlock

void unlock(long resourceId,
            int action)

解锁。释放资源的指定操作的锁，锁不存在则无操作，不释放资源其他操作的锁。

参数:

resourceId - 资源Id。

action - 资源操作。

unlock

void unlock(long owner,
            long resourceId,
            int action)

解锁。释放资源的指定操作的锁，锁不存在则无操作，不释放资源其他操作的锁。

参数:

owner - 加锁人Id

resourceId - 资源Id。

action - 资源操作。

check

boolean check(long userId,
              long resourceId)

判断指定人员是否可以访问资源。
注意：check和lock是成对使用的，即使调用了lock(aUserId,aResourceId,aAction)，check(aUserId, aResourceId)的返回值也是false。

参数:

userId - 人员Id

resourceId - 资源Id。

返回:

如果指定资源不存在锁，或有锁但锁属于指定用户，返回true，否则返回false 。

check

boolean check(long userId,
              long resourceId,
              int action)

判断指定人员是否可以访问资源。

参数:

userId -

resourceId -

action -

返回:

getModule

String getModule()

取得当前锁管理器所属模块。

返回:

所属模块。

isValid

LockState isValid(Lock lock)

判断锁是否有效。以下情况的锁无效：

1. 过期 ；
2. 加锁用户不在线；
3. 加锁用户在线但不是加锁那次登录。

返回:

有效返回true，否则返回false

getOwnerName

String getOwnerName(Lock lock)

取得加锁人信息。

参数:

lock - 锁对象

返回:

加锁人员实体。

updateLockExpirationTime

void updateLockExpirationTime(long rd,
                              int action,
                              long time)

getAllLock

List<Lock> getAllLock()