org.nuxeo.ecm.core.redis.contribs

Class RedisLockManager

java.lang.Object

org.nuxeo.ecm.core.storage.lock.AbstractLockManager

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

All Implemented Interfaces:

LockManager

public class RedisLockManager
extends AbstractLockManager

Redis-based lock manager.

Since:

6.0

Constructor Summary

Constructors

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

Method Summary

Methods

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

Methods inherited from class org.nuxeo.ecm.core.storage.lock.AbstractLockManager

canLockBeRemoved, canLockBeRemovedStatic

Methods inherited from class java.lang.Object

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

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()

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.

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).

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().

Parameters:

id - the document id

Returns:

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

close

public void close()

Description copied from interface: LockManager

Closes the lock manager and releases resources.

clearCaches

public void clearCaches()

Description copied from interface: LockManager

Clears any cache held by the lock manager.