org.nuxeo.ecm.core.storage.sql

Class VCSLockManager

java.lang.Object

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

org.nuxeo.ecm.core.storage.sql.VCSLockManager

All Implemented Interfaces:

LockManager

public class VCSLockManager
extends AbstractLockManager

Manager of locks that serializes access to them.

The public methods called by the session are setLock(java.lang.String, org.nuxeo.ecm.core.api.Lock), removeLock(java.lang.String, java.lang.String) and getLock(java.lang.String). Method #shutdown must be called when done with the lock manager.

In cluster mode, changes are executed in a begin/commit so that tests/updates can be atomic.

Transaction management can be done by hand because we're dealing with a low-level Mapper and not something wrapped by a JCA pool.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOCK_RETRIES
static long	LOCK_SLEEP_DELAY
static long	LOCK_SLEEP_INCREMENT

Constructor Summary

Constructors

Constructor and Description
VCSLockManager(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.
Lock	removeLock(String id, String owner) Removes the lock from a document.
Lock	setLock(String id, Lock lock) Sets a lock on a document.
String	toString()

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, wait, wait, wait

Field Detail

LOCK_RETRIES

public static final int LOCK_RETRIES

See Also:

Constant Field Values

LOCK_SLEEP_DELAY

public static final long LOCK_SLEEP_DELAY

See Also:

Constant Field Values

LOCK_SLEEP_INCREMENT

public static final long LOCK_SLEEP_INCREMENT

See Also:

Constant Field Values

Constructor Detail

VCSLockManager

public VCSLockManager(String repositoryName)
               throws StorageException

Creates a lock manager for the given repository.

The mapper will from then on be only used and closed by the lock manager.

close() must be called when done with the lock manager.

Throws:

StorageException

Method Detail

close

public void close()

Description copied from interface: LockManager

Closes the lock manager and releases resources.

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

clearCaches

public void clearCaches()

Description copied from interface: LockManager

Clears any cache held by the lock manager.

toString

public String toString()

Overrides:

toString in class Object