VCSLockManager (Nuxeo ECM Projects 10.10 API)

java.lang.Object
- org.nuxeo.ecm.core.storage.sql.VCSLockManager

All Implemented Interfaces:

LockManager
```
public class VCSLockManager
extends Object
implements LockManager
```
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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class VCSLockManager.LRUCache<K,V>

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`VCSLockManager.LRUCache<K,V>`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`CACHE_SIZE`
`protected boolean`	`caching`
`protected boolean`	`clusteringEnabled` If clustering is enabled then we have to wrap test/set and test/remove in a transaction.
`static int`	`LOCK_RETRIES`
`static long`	`LOCK_SLEEP_DELAY`
`static long`	`LOCK_SLEEP_INCREMENT`
`protected VCSLockManager.LRUCache<Serializable,Lock>`	`lockCache` A cache of locks, used only in non-cluster mode, when this lock manager is the only one dealing with locks.
`protected Mapper`	`mapper` The mapper to use.
`protected static Lock`	`NULL_LOCK`
`protected RepositoryImpl`	`repository`
`protected ReentrantLock`	`serializationLock` Lock serializing access to the mapper.

Constructor Summary

Constructors
Constructor and Description
`VCSLockManager(RepositoryImpl repository)` Creates a lock manager for the given repository.
`VCSLockManager(String repositoryName)` Creates a lock manager for the given repository.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`protected Mapper`	`getMapper()` Delay mapper acquisition until the repository has been fully initialized.
`protected Serializable`	`idFromString(String id)`
`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 Lock`	`setLockInternal(String id, Lock lock)`
`protected boolean`	`shouldRetry(Exception e)` Does the exception mean that we should retry the transaction?
`protected boolean`	`shouldRetry(SQLException e)`
`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
  - 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
  - repository
```
protected final RepositoryImpl repository
```
  - mapper
```
protected Mapper mapper
```
    The mapper to use. In this mapper we only ever touch the lock table, so no need to deal with fulltext and complex saves, and we don't do prefetch.
  - clusteringEnabled
```
protected final boolean clusteringEnabled
```
    If clustering is enabled then we have to wrap test/set and test/remove in a transaction.
  - serializationLock
```
protected final ReentrantLock serializationLock
```
    Lock serializing access to the mapper.
  - NULL_LOCK
```
protected static final Lock NULL_LOCK
```
  - caching
```
protected final boolean caching
```
  - lockCache
```
protected final VCSLockManager.LRUCache<Serializable,Lock> lockCache
```
    A cache of locks, used only in non-cluster mode, when this lock manager is the only one dealing with locks.
    Used under serializationLock.
  - CACHE_SIZE
```
protected static final int CACHE_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VCSLockManager
```
public VCSLockManager(String repositoryName)
```
    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.
  - VCSLockManager
```
public VCSLockManager(RepositoryImpl repository)
```
    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.
    
    Since:
    
    9.3
- Method Detail
  - getMapper
```
protected Mapper getMapper()
```
    Delay mapper acquisition until the repository has been fully initialized.
  - idFromString
```
protected Serializable idFromString(String id)
```
  - closeLockManager
```
public void closeLockManager()
```
    Description copied from interface: LockManager
    
    Closes the lock manager and releases resources.
    
    Specified by:
    
    closeLockManager in interface LockManager
  - 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
  - shouldRetry
```
protected boolean shouldRetry(Exception e)
```
    Does the exception mean that we should retry the transaction?
  - shouldRetry
```
protected boolean shouldRetry(SQLException e)
```
  - setLockInternal
```
protected Lock setLockInternal(String id,
                               Lock lock)
```
  - 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
  - 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

Class VCSLockManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

LOCK_RETRIES

LOCK_SLEEP_DELAY

LOCK_SLEEP_INCREMENT

repository

mapper

clusteringEnabled

serializationLock

NULL_LOCK

caching

lockCache

CACHE_SIZE

Constructor Detail

VCSLockManager

VCSLockManager

Method Detail

getMapper

idFromString

closeLockManager

getLock

setLock

shouldRetry

shouldRetry

setLockInternal

removeLock

clearLockManagerCaches

toString