com.seeyon.ctp.common.lock.manager

类 AbstractLockManager

java.lang.Object

com.seeyon.ctp.common.lock.manager.AbstractLockManager

所有已实现的接口:

com.seeyon.ctp.common.lock.manager.LockManager

直接已知子类:

DatabaseLockManagerImpl, LockManagerImpl, MemoryLockManagerImpl, RedisLockManagerImpl

public class AbstractLockManager
extends java.lang.Object
implements com.seeyon.ctp.common.lock.manager.LockManager

字段概要

字段

限定符和类型	字段和说明
protected static long	EXPIRE_MILLIS
protected static org.apache.commons.logging.Log	lockLogger
protected static int	READ_ACTIOM

构造器概要

构造器

构造器和说明
AbstractLockManager()

方法概要

限定符和类型	方法和说明
void	activeReadLock(long owner, long resourceId) 激活读锁，保证锁有效，若30秒未激活，锁会被回收。
void	activeWriteLock(long owner, long resourceId) 激活写锁，保证锁有效，若30秒未激活，锁会被回收。
void	addReleaseLockListener(com.seeyon.ctp.common.lock.manager.ReleaseLockListener listener) 注册锁释放监听器，每个应用智能注册一个监听器
boolean	check(long userId, long resourceId) 判断指定人员是否可以访问资源。
protected boolean	check(long userId, long resourceId, boolean unlockSelfLock)
boolean	check(long userId, long resourceId, int action) 判断指定人员是否可以访问资源。
protected boolean	check(long userId, long resourceId, int action, boolean unlockSelfLock)
com.seeyon.ctp.common.po.lock.Lock	createDefaultLock(long owner, long resourceId, int action, java.lang.String from, java.lang.String param0, java.lang.String param1, boolean useNowexpirationTime)
java.util.List<com.seeyon.ctp.common.po.lock.Lock>	getAllLock() 该方法存在性能问题，并且使用场景不合理，废弃不再维护
com.seeyon.ctp.common.po.lock.Lock	getLock(long resourceId, int action) 取得资源的指定操作的锁。
java.util.List<com.seeyon.ctp.common.po.lock.Lock>	getLocks(long resourceId) 取得资源的所有锁。
long	getLoginTime(java.lang.Long id, java.lang.String from)
com.seeyon.ctp.organization.bo.V3xOrgMember	getMember(java.lang.Long id)
java.lang.String	getModule() 取得当前锁管理器所属模块。
com.seeyon.ctp.login.online.OnlineManager	getOnLineManager()
com.seeyon.ctp.organization.manager.OrgManager	getOrgManager()
java.lang.String	getOwnerName(com.seeyon.ctp.common.po.lock.Lock lock) 取得加锁人信息。
int	getSortOrder()
com.seeyon.ctp.common.lock.manager.LockValidatable	getValidator()
void	init()
void	initialize()
com.seeyon.ctp.common.lock.manager.LockState	isValid(com.seeyon.ctp.common.po.lock.Lock lock) 判断锁是否有效。
boolean	lock(com.seeyon.ctp.common.po.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, boolean ignoreOnlineStatus) 对资源的操作加锁。
boolean	lock(long owner, long resourceId, int action, java.lang.String from)
boolean	lock(long owner, long resourceId, int action, java.lang.String from, boolean useNowexpirationTime)
boolean	lock(long owner, long resourceId, int action, java.lang.String from, boolean useNowexpirationTime, boolean unlockSelfLock)
boolean	lock(long owner, long resourceId, int action, java.lang.String from, boolean useNowexpirationTime, boolean unlockSelfLock, boolean ignoreOnlineStatus)
boolean	lock(long owner, long resourceId, java.lang.String from)
boolean	lock(long owner, long resourceId, java.lang.String from, boolean ignoreOnlineStatus)
boolean	lockForRead(long owner, long resourceId) 资源加读锁
boolean	lockForWrite(long owner, long resourceId) 解锁写锁
void	releaseCurrentLock(com.seeyon.ctp.common.po.lock.Lock lock) 释放锁
void	releaseOutDateLock(int beforeSeconds)
void	setModule(java.lang.String module)
void	setOnLineManager(com.seeyon.ctp.login.online.OnlineManager onLineManager)
void	setOrgManager(com.seeyon.ctp.organization.manager.OrgManager orgManager)
void	setValidator(com.seeyon.ctp.common.lock.manager.LockValidatable validator)
void	unlock(long resourceId) 解锁。
void	unlock(long resourceId, int action) 解锁。
void	unlock(long owner, long resourceId, int action) 解锁。
void	unlockForRead(long owner, long resourceId) 解锁读锁
void	unlockForWrite(long resourceId) 解锁写锁
void	updateLockExpirationTime(long rd, int action, long time)

从类继承的方法 java.lang.Object

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

字段详细资料

lockLogger

protected static final org.apache.commons.logging.Log lockLogger

READ_ACTIOM

protected static final int READ_ACTIOM

另请参阅:

常量字段值

EXPIRE_MILLIS

protected static final long EXPIRE_MILLIS

另请参阅:

常量字段值

构造器详细资料

AbstractLockManager

public AbstractLockManager()

方法详细资料

getSortOrder

public int getSortOrder()

initialize

public void initialize()

init

public void init()

getOrgManager

public com.seeyon.ctp.organization.manager.OrgManager getOrgManager()

setOrgManager

public void setOrgManager(com.seeyon.ctp.organization.manager.OrgManager orgManager)

getOnLineManager

public com.seeyon.ctp.login.online.OnlineManager getOnLineManager()

setOnLineManager

public void setOnLineManager(com.seeyon.ctp.login.online.OnlineManager onLineManager)

setModule

public void setModule(java.lang.String module)

getModule

public java.lang.String getModule()

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

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

指定者:

getModule 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

返回:

所属模块。

isValid

public com.seeyon.ctp.common.lock.manager.LockState isValid(com.seeyon.ctp.common.po.lock.Lock lock)

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

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

指定者:

isValid 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

返回:

枚举

getValidator

public com.seeyon.ctp.common.lock.manager.LockValidatable getValidator()

setValidator

public void setValidator(com.seeyon.ctp.common.lock.manager.LockValidatable validator)

getOwnerName

public java.lang.String getOwnerName(com.seeyon.ctp.common.po.lock.Lock lock)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

取得加锁人信息。

指定者:

getOwnerName 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

lock - 锁对象

返回:

加锁人员实体。

getMember

public com.seeyon.ctp.organization.bo.V3xOrgMember getMember(java.lang.Long id)

getLoginTime

public long getLoginTime(java.lang.Long id,
                         java.lang.String from)

check

public boolean check(long userId,
                     long resourceId)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

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

指定者:

check 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

userId - 人员Id

resourceId - 资源Id。

返回:

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

check

protected boolean check(long userId,
                        long resourceId,
                        boolean unlockSelfLock)

check

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

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

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

指定者:

check 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

返回:

check

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

getLock

public com.seeyon.ctp.common.po.lock.Lock getLock(long resourceId,
                                                  int action)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

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

指定者:

getLock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

resourceId - 资源Id。

action - 操作。

返回:

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

getLocks

public java.util.List<com.seeyon.ctp.common.po.lock.Lock> getLocks(long resourceId)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

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

指定者:

getLocks 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

resourceId - 资源Id

返回:

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

lock

public boolean lock(long owner,
                    long resourceId)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

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

指定者:

lock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

owner - 加锁人Id。

resourceId - 资源Id，如协同的affairId

返回:

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

lock

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

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

对资源的操作加锁。

指定者:

lock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

owner - 加锁人Id。

resourceId - 资源Id。

action - 资源操作。

返回:

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

lock

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

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

对资源的操作加锁。

指定者:

lock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

owner - 加锁人Id。

resourceId - 资源Id。

action - 资源操作。

ignoreOnlineStatus - 是否忽略加锁人在线状态的校验,存在一些后台线程需要不校验用户状态的情形

返回:

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

lock

public boolean lock(long owner,
                    long resourceId,
                    int action,
                    java.lang.String from)

指定者:

lock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

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

返回:

lock

public boolean lock(long owner,
                    long resourceId,
                    int action,
                    java.lang.String from,
                    boolean useNowexpirationTime)

指定者:

lock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

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

返回:

lock

public boolean lock(long owner,
                    long resourceId,
                    java.lang.String from,
                    boolean ignoreOnlineStatus)

指定者:

lock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

owner - 加锁人Id。

resourceId - 资源Id。

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

ignoreOnlineStatus - 是否忽略加锁人在线状态的校验,存在一些后台线程需要不校验用户状态的情形

返回:

lock

public boolean lock(long owner,
                    long resourceId,
                    int action,
                    java.lang.String from,
                    boolean useNowexpirationTime,
                    boolean unlockSelfLock,
                    boolean ignoreOnlineStatus)

指定者:

lock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

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

unlockSelfLock - 是否释放已持有锁

返回:

lock

public boolean lock(long owner,
                    long resourceId,
                    int action,
                    java.lang.String from,
                    boolean useNowexpirationTime,
                    boolean unlockSelfLock)

指定者:

lock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

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

unlockSelfLock - 是否释放已持有锁

返回:

lock

public boolean lock(long owner,
                    long resourceId,
                    java.lang.String from)

指定者:

lock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

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

返回:

unlock

public void unlock(long resourceId)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

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

指定者:

unlock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

resourceId - 资源Id。

unlock

public void unlock(long resourceId,
                   int action)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

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

指定者:

unlock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

resourceId - 资源Id。

action - 资源操作。

unlock

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

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

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

指定者:

unlock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

owner - 加锁人Id

resourceId - 资源Id。

action - 资源操作。

releaseCurrentLock

public void releaseCurrentLock(com.seeyon.ctp.common.po.lock.Lock lock)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

释放锁

指定者:

releaseCurrentLock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

lock

public boolean lock(com.seeyon.ctp.common.po.lock.Lock lock)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

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

指定者:

lock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

返回:

createDefaultLock

public com.seeyon.ctp.common.po.lock.Lock createDefaultLock(long owner,
                                                            long resourceId,
                                                            int action,
                                                            java.lang.String from,
                                                            java.lang.String param0,
                                                            java.lang.String param1,
                                                            boolean useNowexpirationTime)

指定者:

createDefaultLock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

返回:

getAllLock

public java.util.List<com.seeyon.ctp.common.po.lock.Lock> getAllLock()

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

该方法存在性能问题，并且使用场景不合理，废弃不再维护

指定者:

getAllLock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

返回:

updateLockExpirationTime

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

指定者:

updateLockExpirationTime 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

lockForRead

public boolean lockForRead(long owner,
                           long resourceId)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

资源加读锁

指定者:

lockForRead 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

resourceId - 加锁资源对象ID

返回:

activeReadLock

public void activeReadLock(long owner,
                           long resourceId)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

激活读锁，保证锁有效，若30秒未激活，锁会被回收。

指定者:

activeReadLock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

resourceId - 加锁资源对象ID

unlockForRead

public void unlockForRead(long owner,
                          long resourceId)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

解锁读锁

指定者:

unlockForRead 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

owner - 加锁人员ID

resourceId - 资源对象ID

lockForWrite

public boolean lockForWrite(long owner,
                            long resourceId)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

解锁写锁

指定者:

lockForWrite 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

owner - 加锁人员ID

resourceId - 加锁资源对象ID

返回:

activeWriteLock

public void activeWriteLock(long owner,
                            long resourceId)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

激活写锁，保证锁有效，若30秒未激活，锁会被回收。

指定者:

activeWriteLock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

resourceId - 加锁资源对象ID

unlockForWrite

public void unlockForWrite(long resourceId)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

解锁写锁

指定者:

unlockForWrite 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

resourceId - 资源对象ID

addReleaseLockListener

public void addReleaseLockListener(com.seeyon.ctp.common.lock.manager.ReleaseLockListener listener)

从接口复制的说明: com.seeyon.ctp.common.lock.manager.LockManager

注册锁释放监听器，每个应用智能注册一个监听器

指定者:

addReleaseLockListener 在接口中 com.seeyon.ctp.common.lock.manager.LockManager

参数:

listener - 监听器

releaseOutDateLock

public void releaseOutDateLock(int beforeSeconds)

指定者:

releaseOutDateLock 在接口中 com.seeyon.ctp.common.lock.manager.LockManager