org.olat.system.coordinate

接口 Locker

所有已知子接口:

LockingService

所有已知实现类:

ClusterLocker, LockingServiceImpl, SingleVMLocker

public interface Locker

Description:
Interface to acquire Locks (short time locks for gui locking (e.g. i am currently administrating this group) and long term locks for resource locking (e.g. i am editing a qti test)

Initial Date: 19.09.2007

作者:

Felix Jost, http://www.goodsolutions.ch

方法概要

方法

限定符和类型	方法和说明
LockResult	acquireLock(OLATResourceable ores, OLATPrincipal principal, java.lang.String locksubkey)
java.util.List<LockEntry>	adminOnlyGetLockEntries() for admin purposes only.
LockResult	aquirePersistentLock(OLATResourceable ores, OLATPrincipal principal, java.lang.String locksubkey) acquires a persistent lock.
PersistentLockManager	getPersistentLockManager() [spring] object is not ready on startup due to circular reference so access is done via method lookup where spring is creating an instance and also an implementation for this abstract method
boolean	isLocked(OLATResourceable ores, java.lang.String locksubkey)
void	releaseAllLocksForPrincipal(OLATPrincipal principal) Delete any locks hold by this principal.
void	releaseLock(LockResult le) releases the lock. can also be called if the lock was not sucessfully acquired
void	releaseLockEntry(LockEntry lock) for admin purposes only.
void	releasePersistentLock(LockResult le) releases a persistent lock.

方法详细资料

acquireLock

LockResult acquireLock(OLATResourceable ores,
                     OLATPrincipal principal,
                     java.lang.String locksubkey)

参数:

ores - the OLATResourceable to lock upon, e.g a repositoryentry or such

identity - the identity who tries to acquire the lock, not null

locksubkey - null or any string to lock finer upon the resource (e.g. "authors", or "write", ...)

返回:

lock result

releaseLock

void releaseLock(LockResult le)

releases the lock. can also be called if the lock was not sucessfully acquired

参数:

le - the LockResult received when locking

isLocked

boolean isLocked(OLATResourceable ores,
               java.lang.String locksubkey)

参数:

ores -

locksubkey -

返回:

if the olatresourceable with the subkey is already locked by someone (returns true even if locked by "myself")

aquirePersistentLock

LockResult aquirePersistentLock(OLATResourceable ores,
                              OLATPrincipal principal,
                              java.lang.String locksubkey)

acquires a persistent lock.

参数:

ores -

ident -

locksubkey - may not be longer than 30 chars

返回:

the LockResult of this lock trial.

releasePersistentLock

void releasePersistentLock(LockResult le)

releases a persistent lock.

参数:

le - the LockResult which stems from the lock acquired previously

adminOnlyGetLockEntries

java.util.List<LockEntry> adminOnlyGetLockEntries()

for admin purposes only.

返回:

a list of lockentries.

getPersistentLockManager

PersistentLockManager getPersistentLockManager()

[spring] object is not ready on startup due to circular reference so access is done via method lookup where spring is creating an instance and also an implementation for this abstract method

返回:

releaseLockEntry

void releaseLockEntry(LockEntry lock)

for admin purposes only. Release a lockentry.

参数:

lock - release this lockentry

releaseAllLocksForPrincipal

void releaseAllLocksForPrincipal(OLATPrincipal principal)

Delete any locks hold by this principal.

参数:

principal -