Class InMemoryDataAccessor

A DataAccessor is the building block closest to the actual data storage. It should not worry about most Solid logic, most of that will be handled before it is called. There are a few things it still needs to do, and it is very important every implementation does this:

If the input identifier ends with a slash, it should be assumed the identifier is targeting a container.
Similarly, if there is no trailing slash it should assume a document.
It should always throw a NotFoundHttpError if it does not have data matching the input identifier.
DataAccessors should not generate containment triples. This will be done externally using getChildren.

Implements

Index

Constructors

constructor

Methods

canHandle deleteResource getChildren getData getMetadata writeContainer writeDocument writeMetadata

Constructors

constructor

new InMemoryDataAccessor(identifierStrategy): InMemoryDataAccessor
Parameters
- identifierStrategy: IdentifierStrategy
Returns InMemoryDataAccessor
- Defined in src/storage/accessors/InMemoryDataAccessor.ts:30

Methods

canHandle

canHandle(): Promise<void>
Should throw a NotImplementedHttpError if the DataAccessor does not support storing the given Representation.

Returns Promise<void>
Throws
BadRequestHttpError If it does not support the incoming data.
Implementation of DataAccessor.canHandle
- Defined in src/storage/accessors/InMemoryDataAccessor.ts:36

deleteResource

deleteResource(identifier): Promise<void>
Deletes the resource and its corresponding metadata.

Solid, §5.4: "When a contained resource is deleted, the server MUST also remove the corresponding containment triple, which has the effect of removing the deleted resource from the containing container." https://solid.github.io/specification/protocol#deleting-resources
Parameters
- identifier: ResourceIdentifier
  Resource to delete.
Returns Promise<void>
Implementation of DataAccessor.deleteResource
- Defined in src/storage/accessors/InMemoryDataAccessor.ts:103

getChildren

getChildren(identifier): AsyncIterableIterator<RepresentationMetadata>
Returns metadata for all resources in the requested container. This should not be all metadata of those resources (but it can be), but instead the main metadata you want to show in situations where all these resources are presented simultaneously. Generally this would be metadata that is present for all of these resources, such as resource type or last modified date.

It can be safely assumed that the incoming identifier will always correspond to a container.
Parameters
- identifier: ResourceIdentifier
  Identifier of the parent container.
Returns AsyncIterableIterator<RepresentationMetadata>
Implementation of DataAccessor.getChildren
- Defined in src/storage/accessors/InMemoryDataAccessor.ts:53

getData

getData(identifier): Promise<Guarded<Readable>>
Returns a data stream stored for the given identifier. It can be assumed that the incoming identifier will always correspond to a document.
Parameters
- identifier: ResourceIdentifier
  Identifier for which the data is requested.
Returns Promise<Guarded<Readable>>
Implementation of DataAccessor.getData
- Defined in src/storage/accessors/InMemoryDataAccessor.ts:40

getMetadata

getMetadata(identifier): Promise<RepresentationMetadata>
Returns the metadata corresponding to the identifier. If possible, it is suggested to add a posix:size triple to the metadata indicating the binary size. This is necessary for range requests.
Parameters
- identifier: ResourceIdentifier
  Identifier for which the metadata is requested.
Returns Promise<RepresentationMetadata>
Implementation of DataAccessor.getMetadata
- Defined in src/storage/accessors/InMemoryDataAccessor.ts:48

writeContainer

writeContainer(identifier, metadata): Promise<void>
Writes metadata for a container. If the container does not exist yet it should be created, if it does its metadata should be overwritten, except for the containment triples.
Parameters
- identifier: ResourceIdentifier
  Identifier of the container.
- metadata: RepresentationMetadata
  Metadata to store.
Returns Promise<void>
Implementation of DataAccessor.writeContainer
- Defined in src/storage/accessors/InMemoryDataAccessor.ts:79

writeDocument

writeDocument(identifier, data, metadata): Promise<void>
Writes data and metadata for a document. If any data and/or metadata exist for the given identifier, it should be overwritten.
Parameters
- identifier: ResourceIdentifier
  Identifier of the resource.
- data: Guarded<Readable>
  Data to store.
- metadata: RepresentationMetadata
  Metadata to store.
Returns Promise<void>
Implementation of DataAccessor.writeDocument
- Defined in src/storage/accessors/InMemoryDataAccessor.ts:61

writeMetadata

writeMetadata(identifier, metadata): Promise<void>
Writes metadata for a resource. It can safely be assumed that the subject resource already exists.
Parameters
- identifier: ResourceIdentifier
  Identifier of the subject resource.
- metadata: RepresentationMetadata
  Metadata to store.
Returns Promise<void>
Implementation of DataAccessor.writeMetadata
- Defined in src/storage/accessors/InMemoryDataAccessor.ts:98

Class InMemoryDataAccessor

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns InMemoryDataAccessor

Methods

canHandle

Returns Promise<void>

Throws

deleteResource

Parameters

Returns Promise<void>

getChildren

Parameters

Returns AsyncIterableIterator<RepresentationMetadata>

getData

Parameters

Returns Promise<Guarded<Readable>>

getMetadata

Parameters

Returns Promise<RepresentationMetadata>

writeContainer

Parameters

Returns Promise<void>

writeDocument

Parameters

Returns Promise<void>

writeMetadata

Parameters

Returns Promise<void>

Settings

On This Page