Class LockingResourceStore

Store that for every call acquires a lock before executing it on the requested resource, and releases it afterwards. In case the request returns a Representation the lock will only be released when the data stream is finished. Similarly, for write operations the lock will be maintained as long as the incoming data stream is being read.

For auxiliary resources the lock will be applied to the subject resource. The actual operation is still executed on the auxiliary resource.

Implements

AtomicResourceStore

Index

Constructors

constructor

new LockingResourceStore(source, locks, auxiliaryStrategy): LockingResourceStore
Parameters
- source: ResourceStore
- locks: ExpiringReadWriteLocker
- auxiliaryStrategy: AuxiliaryIdentifierStrategy
Returns LockingResourceStore
- Defined in src/storage/LockingResourceStore.ts:31

Properties

`Protected` `Readonly`logger

logger: Logger = ...

Methods

addResource

addResource(container, representation, conditions?): Promise<ChangeMap>
Creates a new resource in the container.
Parameters
- container: ResourceIdentifier
  Container in which to create a resource.
- representation: Representation
  Representation of the new resource
- Optionalconditions: Conditions
  Optional conditions under which to proceed.
Returns Promise<ChangeMap>
A ChangeMap.
Implementation of AtomicResourceStore.addResource
- Defined in src/storage/LockingResourceStore.ts:59

`Protected`createExpiringRepresentation

createExpiringRepresentation<T>(representation, maintainLock): T
Wraps a representation to make it reset the timeout timer every time data is read.
Type Parameters
- T extends Representation
Parameters
- representation: T
  The representation to wrap
- maintainLock: (() => void)
  Function to call to reset the timer.
  - - (): void
    - Returns void
Returns T
- Defined in src/storage/LockingResourceStore.ts:191

deleteResource

deleteResource(identifier, conditions?): Promise<ChangeMap>
Deletes a resource.
Parameters
- identifier: ResourceIdentifier
  Identifier of resource to delete.
- Optionalconditions: Conditions
  Optional conditions under which to proceed.
Returns Promise<ChangeMap>
A ChangeMap.
Implementation of AtomicResourceStore.deleteResource
- Defined in src/storage/LockingResourceStore.ts:85

`Protected`getLockIdentifier

getLockIdentifier(identifier): ResourceIdentifier
Acquires the correct identifier to lock this resource. For auxiliary resources this means the subject identifier.
Parameters
- identifier: ResourceIdentifier
Returns ResourceIdentifier
- Defined in src/storage/LockingResourceStore.ts:109

getRepresentation

getRepresentation(identifier, preferences, conditions?): Promise<Representation>
Retrieves a representation of a resource.
Parameters
- identifier: ResourceIdentifier
  Identifier of the resource to read.
- preferences: RepresentationPreferences
  Preferences indicating desired representations.
- Optionalconditions: Conditions
  Optional conditions under which to proceed.
Returns Promise<Representation>
A representation corresponding to the identifier.
Implementation of AtomicResourceStore.getRepresentation
- Defined in src/storage/LockingResourceStore.ts:48

hasResource

hasResource(identifier): Promise<boolean>
Checks whether a resource exists in this ResourceSet.
Parameters
- identifier: ResourceIdentifier
  Identifier of resource to check.
Returns Promise<boolean>
A promise resolving if the resource already exists.
Implementation of AtomicResourceStore.hasResource
- Defined in src/storage/LockingResourceStore.ts:41

`Protected`lockedRepresentationRun

lockedRepresentationRun(identifier, whileLocked): Promise<Representation>
Acquires a lock that is only released when all data of the resulting representation data has been read, an error occurs, or the timeout has been triggered. The resulting data stream will be adapted to reset the timer every time data is read.

In case the data of the resulting stream is not needed it should be closed to prevent a timeout error.
Parameters
- identifier: ResourceIdentifier
  Identifier that should be locked.
- whileLocked: (() => Promise<Representation>)
  Function to be executed while the resource is locked.
  - - (): Promise<Representation>
    - Returns Promise<Representation>
Returns Promise<Representation>
- Defined in src/storage/LockingResourceStore.ts:125

`Protected`lockedWriteRepresentationRun

lockedWriteRepresentationRun<T, TResult>(identifier, inputRepresentation, whileLocked): Promise<TResult>
Acquires a write lock that is held until the operation completes. The input representation is adapted to reset the timer every time data is read.
Type Parameters
- T extends Representation
- TResult
Parameters
- identifier: ResourceIdentifier
  Identifier that should be locked.
- inputRepresentation: T
  Representation to pass to the write operation.
- whileLocked: ((representation: T) => Promise<TResult>)
  Function to be executed while the resource is locked.
  - - (representation): Promise<TResult>
    - Parameters
      representation: T
      Returns Promise<TResult>
Returns Promise<TResult>
- Defined in src/storage/LockingResourceStore.ts:161

modifyResource

modifyResource(identifier, patch, conditions?): Promise<ChangeMap>
Sets or updates the representation of a resource, creating a new resource and intermediary containers as needed.
Parameters
- identifier: ResourceIdentifier
  Identifier of resource to update.
- patch: Patch
  Description of which parts to update.
- Optionalconditions: Conditions
  Optional conditions under which to proceed.
Returns Promise<ChangeMap>
A ChangeMap.
Implementation of AtomicResourceStore.modifyResource
- Defined in src/storage/LockingResourceStore.ts:92

setRepresentation

setRepresentation(identifier, representation, conditions?): Promise<ChangeMap>
Sets or replaces the representation of a resource, creating a new resource and intermediary containers as needed.
Parameters
- identifier: ResourceIdentifier
  Identifier of resource to update.
- representation: Representation
  New representation of the resource.
- Optionalconditions: Conditions
  Optional conditions under which to proceed.
Returns Promise<ChangeMap>
A ChangeMap.
Implementation of AtomicResourceStore.setRepresentation
- Defined in src/storage/LockingResourceStore.ts:72

`Protected`waitForStreamToEnd

waitForStreamToEnd(source): Promise<void>
Returns a promise that resolve when the source stream is finished, either by ending or emitting an error. In the case of an error the stream will be destroyed if it hasn't been already.
Parameters
- source: Readable
  The input stream.
Returns Promise<void>
- Defined in src/storage/LockingResourceStore.ts:219

Class LockingResourceStore

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LockingResourceStore

Properties

Protected Readonlylogger

Methods

addResource

Parameters

Returns Promise<ChangeMap>

ProtectedcreateExpiringRepresentation

Type Parameters

Parameters

Returns void

Returns T

deleteResource

Parameters

Returns Promise<ChangeMap>

ProtectedgetLockIdentifier

Parameters

Returns ResourceIdentifier

getRepresentation

Parameters

Returns Promise<Representation>

hasResource

Parameters

Returns Promise<boolean>

ProtectedlockedRepresentationRun

Parameters

Returns Promise<Representation>

Returns Promise<Representation>

ProtectedlockedWriteRepresentationRun

Type Parameters

Parameters

Parameters

Returns Promise<TResult>

Returns Promise<TResult>

modifyResource

Parameters

Returns Promise<ChangeMap>

setRepresentation

Parameters

Returns Promise<ChangeMap>

ProtectedwaitForStreamToEnd

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`logger

`Protected`createExpiringRepresentation

`Protected`getLockIdentifier

`Protected`lockedRepresentationRun

`Protected`lockedWriteRepresentationRun

`Protected`waitForStreamToEnd