Class LockStoreImpl

java.lang.Object

org.aksw.commons.lock.db.impl.LockStoreImpl

All Implemented Interfaces:

LockStore<String[],String>

public class LockStoreImpl
extends Object
implements LockStore<String[],String>

File System based implementation of a LockStore. For each resource subject to locking a folder is created in the lock repository. Each read/write lock is represented as a file which then links to a path that represents the owner. Typically the owner-path is the folder where transaction resources are managed.

Author:

Claus Stadler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LockStoreImpl.ResourceLockImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected ResourceRepository<String>	lockRepo	Root folder of the lock db
protected String	mgmtLockFilename
protected Function<String,Path>	ownerRepoFactory	The owner of locks are usually transactions
protected String	readLockFilenamePattern
protected ResourceRepository<String>	storeRepo	Mapping of resources to store folders which enables creation of lock files that are link to other folders that contain the data being locked
protected SymbolicLinkStrategy	symbolicLinkStrategy
protected String	writeLockFilename

Constructor Summary

Constructors

Constructor	Description
LockStoreImpl(SymbolicLinkStrategy symbolicLinkStrategy, ResourceRepository<String> lockRepo, ResourceRepository<String> storeRepo, Function<String,Path> ownerRepoFactory)

Method Summary

Modifier and Type	Method	Description
ResourceLock<String>	getLockByKey(Path<String> lockKey)
ResourceLock<String>	getLockForResource(String resource)	Get the API to manage read/write locks for a given resource
Stream<ResourceLock<String>>	streamResourceLocks()	Get a stream of all existing resource locks The resulting stream should be weakly consistent (See invalid input: '{@link Files#list(java.nio.file.Path)). The result stream should always be used in a try-with-resources block in order to ensure release of resources.'

Methods inherited from class Object

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

Field Details

readLockFilenamePattern

protected String readLockFilenamePattern

writeLockFilename

protected String writeLockFilename

mgmtLockFilename

protected String mgmtLockFilename

symbolicLinkStrategy

protected SymbolicLinkStrategy symbolicLinkStrategy

lockRepo

protected ResourceRepository<String> lockRepo

Root folder of the lock db

ownerRepoFactory

protected Function<String,Path> ownerRepoFactory

The owner of locks are usually transactions

storeRepo

protected ResourceRepository<String> storeRepo

Mapping of resources to store folders which enables creation of lock files that are link to other folders that contain the data being locked

Constructor Details

LockStoreImpl

public LockStoreImpl(SymbolicLinkStrategy symbolicLinkStrategy,
 ResourceRepository<String> lockRepo,
 ResourceRepository<String> storeRepo,
 Function<String,Path> ownerRepoFactory)

Method Details

getLockForResource

public ResourceLock<String> getLockForResource(String resource)

Description copied from interface: LockStore

Get the API to manage read/write locks for a given resource

Specified by:

getLockForResource in interface LockStore<String[],String>

Parameters:

resource -

Returns:

getLockByKey

public ResourceLock<String> getLockByKey(Path<String> lockKey)

Specified by:

getLockByKey in interface LockStore<String[],String>

streamResourceLocks

public Stream<ResourceLock<String>> streamResourceLocks()
                                                 throws IOException

Description copied from interface: LockStore

Get a stream of all existing resource locks The resulting stream should be weakly consistent (See invalid input: '{@link Files#list(java.nio.file.Path)). The result stream should always be used in a try-with-resources block in order to ensure release of resources.'

Specified by:

streamResourceLocks in interface LockStore<String[],String>

Returns:

Throws:

IOException