org.nuxeo.ecm.core.redis.contribs

Class RedisLockManager

java.lang.Object

org.nuxeo.ecm.core.redis.contribs.RedisLockManager

All Implemented Interfaces:

LockManager

public class RedisLockManager
extends Object
implements LockManager

Redis-based lock manager.

Since:

6.0

Field Summary

Fields

Modifier and Type	Field and Description
protected String	prefix
protected RedisAdmin	redisAdmin
protected RedisExecutor	redisExecutor
protected String	redisNamespace
protected String	repositoryName
protected String	scriptRemoveSha
protected String	scriptSetSha

Constructor Summary

Constructors

Constructor and Description
RedisLockManager(String repositoryName) Creates a lock manager for the given repository.

Method Summary

Modifier and Type	Method and Description
void	clearLockManagerCaches() Clears any cache held by the lock manager.
void	closeLockManager() Closes the lock manager and releases resources.
Lock	getLock(String id) Gets the lock on a document.
void	loadScripts()
protected Lock	lockFromString(String lockString)
Lock	removeLock(String id, String owner) Removes the lock from a document.
Lock	setLock(String id, Lock lock) Sets a lock on a document.
protected String	stringFromLock(Lock lock)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.model.LockManager

canLockBeRemoved

Field Detail

redisNamespace

protected final String redisNamespace

repositoryName

protected final String repositoryName

redisExecutor

protected RedisExecutor redisExecutor

prefix

protected String prefix

scriptSetSha

protected String scriptSetSha

scriptRemoveSha

protected String scriptRemoveSha

redisAdmin

protected RedisAdmin redisAdmin

Constructor Detail

RedisLockManager

public RedisLockManager(String repositoryName)

Creates a lock manager for the given repository.

#close must be called when done with the lock manager.

Method Detail

loadScripts

public void loadScripts()

stringFromLock

protected String stringFromLock(Lock lock)

lockFromString

protected Lock lockFromString(String lockString)

getLock

public Lock getLock(String id)

Description copied from interface: LockManager

Gets the lock on a document.

If the document does not exist, null is returned.

Specified by:

getLock in interface LockManager

Parameters:

id - the document id

Returns:

the existing lock, or null when there is no lock

setLock

public Lock setLock(String id,
                    Lock lock)

Description copied from interface: LockManager

Sets a lock on a document.

If the document is already locked, returns its existing lock status (there is no re-locking, LockManager.removeLock(java.lang.String, java.lang.String) must be called first).

Specified by:

setLock in interface LockManager

Parameters:

id - the document id

lock - the lock to set

Returns:

null if locking succeeded, or the existing lock if locking failed

removeLock

public Lock removeLock(String id,
                       String owner)

Description copied from interface: LockManager

Removes the lock from a document.

The previous lock is returned.

If owner is null then the lock is unconditionally removed.

If owner is not null, it must match the existing lock owner for the lock to be removed. If it doesn't match, the returned lock will return true for Lock.getFailed().

Specified by:

removeLock in interface LockManager

Parameters:

id - the document id

Returns:

the previous lock (may be null), with a failed flag if locking failed

closeLockManager

public void closeLockManager()

Description copied from interface: LockManager

Closes the lock manager and releases resources.

Specified by:

closeLockManager in interface LockManager

clearLockManagerCaches

public void clearLockManagerCaches()

Description copied from interface: LockManager

Clears any cache held by the lock manager.

Specified by:

clearLockManagerCaches in interface LockManager

toString

public String toString()

Overrides:

toString in class Object