Interface DistributedConfigSetLockFactory
-
- All Known Implementing Classes:
ZkDistributedConfigSetLockFactory
public interface DistributedConfigSetLockFactory
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DistributedLock
createLock(boolean isWriteLock, String configSetName)
Create a new lock of the specified type (read or write) entering the "competition" for actually getting the lock for theconfigSetName
-
-
-
Method Detail
-
createLock
DistributedLock createLock(boolean isWriteLock, String configSetName)
Create a new lock of the specified type (read or write) entering the "competition" for actually getting the lock for theconfigSetName
Upon return from this call, the lock has not been acquired but the it had entered the lock acquiring "competition", and the caller can decide to wait until the lock is granted by calling
DistributedLock.waitUntilAcquired()
.
Separating the lock creation from lock acquisition allows a more deterministic release of the locks when/if they can't be acquired.Locks at different paths are independent of each other, multiple
DistributedLock
are therefore requested for a single operation and are packaged together and returned as anDistributedMultiLock
, seeCollectionApiLockFactory.createCollectionApiLock(org.apache.solr.common.params.CollectionParams.LockLevel, java.lang.String, java.lang.String, java.lang.String)
orConfigSetApiLockFactory.createConfigSetApiLock(java.lang.String, java.lang.String)
.- Parameters:
isWriteLock
-true
if requesting a write lock,false
for a read lock.configSetName
- the config set name, can never benull
.- Returns:
- a lock instance that must be
DistributedLock.release()
'ed in afinally
, regardless of the lock having been acquired or not.
-
-