Class FileDataAccessor

DataAccessor that uses the file system to store documents as files and containers as folders.

Hierarchy

FileDataAccessor

Implements

DataAccessor

Index

Constructors

constructor

Properties

resourceMapper

Methods

Constructors

constructor

new FileDataAccessor(resourceMapper: FileIdentifierMapper): FileDataAccessor

- Defined in src/storage/accessors/FileDataAccessor.ts:30
Parameters
- resourceMapper: FileIdentifierMapper
Returns FileDataAccessor

Properties

Private Readonly resourceMapper

resourceMapper: FileIdentifierMapper

Methods

canHandle

canHandle(representation: Representation): Promise<void>

- Defined in src/storage/accessors/FileDataAccessor.ts:39
Only binary data can be directly stored as files so will error on non-binary data.

Parameters
- representation: Representation
Returns Promise<void>

deleteResource

deleteResource(identifier: ResourceIdentifier): Promise<void>

- Defined in src/storage/accessors/FileDataAccessor.ts:123
Removes the corresponding file/folder (and metadata file).

Parameters
- identifier: ResourceIdentifier
Returns Promise<void>

Private generatePosixQuads

generatePosixQuads(subject: NamedNode<string>, stats: Stats): Quad[]

- Defined in src/storage/accessors/FileDataAccessor.ts:330
Helper function to add file system related metadata.

Parameters
- subject: NamedNode<string>
  
  Subject for the new quads.
- stats: Stats
  
  Stats of the file/directory corresponding to the resource.
Returns Quad[]

Private getBaseMetadata

getBaseMetadata(link: ResourceLink, stats: Stats, isContainer: boolean): Promise<RepresentationMetadata>

- Defined in src/storage/accessors/FileDataAccessor.ts:249
Generates metadata relevant for any resources stored by this accessor.

Parameters
- link: ResourceLink
  
  Path related metadata.
- stats: Stats
  
  Stats objects of the corresponding directory.
- isContainer: boolean
  
  If the path points to a container (directory) or not.
Returns Promise<RepresentationMetadata>

Private getChildMetadataQuads

getChildMetadataQuads(link: ResourceLink): Promise<Quad[]>

- Defined in src/storage/accessors/FileDataAccessor.ts:288
Generate all containment related triples for a container. These include the actual containment triples and specific triples for every child resource.

Parameters
- link: ResourceLink
  
  Path related metadata.
Returns Promise<Quad[]>

getData

getData(identifier: ResourceIdentifier): Promise<Guarded<Readable>>

- Defined in src/storage/accessors/FileDataAccessor.ts:49
Will return data stream directly to the file corresponding to the resource. Will throw NotFoundHttpError if the input is a container.

Parameters
- identifier: ResourceIdentifier
Returns Promise<Guarded<Readable>>

Private getDirectoryMetadata

getDirectoryMetadata(link: ResourceLink, stats: Stats): Promise<RepresentationMetadata>

- Defined in src/storage/accessors/FileDataAccessor.ts:198
Reads and generates all metadata relevant for the given directory, ingesting it into a RepresentationMetadata object.

Parameters
- link: ResourceLink
  
  Path related metadata.
- stats: Stats
  
  Stats object of the corresponding directory.
Returns Promise<RepresentationMetadata>

Private getFileMetadata

getFileMetadata(link: ResourceLink, stats: Stats): Promise<RepresentationMetadata>

- Defined in src/storage/accessors/FileDataAccessor.ts:185
Reads and generates all metadata relevant for the given file, ingesting it into a RepresentationMetadata object.

Parameters
- link: ResourceLink
  
  Path related metadata.
- stats: Stats
  
  Stats object of the corresponding file.
Returns Promise<RepresentationMetadata>

getMetadata

getMetadata(identifier: ResourceIdentifier): Promise<RepresentationMetadata>

- Defined in src/storage/accessors/FileDataAccessor.ts:64
Will return corresponding metadata by reading the metadata file (if it exists) and adding file system specific metadata elements.

Parameters
- identifier: ResourceIdentifier
Returns Promise<RepresentationMetadata>

Private getMetadataLink

getMetadataLink(identifier: ResourceIdentifier): Promise<ResourceLink>

- Defined in src/storage/accessors/FileDataAccessor.ts:166
Generates ResourceLink that corresponds to the metadata resource of the given identifier.

Parameters
- identifier: ResourceIdentifier
Returns Promise<ResourceLink>

Private getRawMetadata

getRawMetadata(identifier: ResourceIdentifier): Promise<Quad[]>

- Defined in src/storage/accessors/FileDataAccessor.ts:264
Reads the metadata from the corresponding metadata file. Returns an empty array if there is no metadata file.

Parameters
- identifier: ResourceIdentifier
  
  Identifier of the resource (not the metadata!).
Returns Promise<Quad[]>

Private getStats

getStats(path: string): Promise<Stats>

- Defined in src/storage/accessors/FileDataAccessor.ts:152
Gets the Stats object corresponding to the given file path.

throws

NotFoundHttpError If the file/folder doesn't exist.

Parameters
- path: string
  
  File path to get info from.
Returns Promise<Stats>

Private isMetadataPath

isMetadataPath(path: string): boolean

- Defined in src/storage/accessors/FileDataAccessor.ts:174
Checks if the given path is a metadata path.

Parameters
- path: string
Returns boolean

Private verifyExistingExtension

verifyExistingExtension(link: ResourceLink): Promise<void>

- Defined in src/storage/accessors/FileDataAccessor.ts:347
Verifies if there already is a file corresponding to the given resource. If yes, that file is removed if it does not match the path given in the input ResourceLink. This can happen if the content-type differs from the one that was stored.

Parameters
- link: ResourceLink
  
  ResourceLink corresponding to the new resource data.
Returns Promise<void>

writeContainer

writeContainer(identifier: ResourceIdentifier, metadata: RepresentationMetadata): Promise<void>

- Defined in src/storage/accessors/FileDataAccessor.ts:106
Creates corresponding folder if necessary and writes metadata to metadata file if necessary.

Parameters
- identifier: ResourceIdentifier
- metadata: RepresentationMetadata
Returns Promise<void>

Private writeDataFile

writeDataFile(path: string, data: Readable): Promise<void>

- Defined in src/storage/accessors/FileDataAccessor.ts:367
Helper function without extra validation checking to create a data file.

Parameters
- path: string
  
  The filepath of the file to be created.
- data: Readable
  
  The data to be put in the file.
Returns Promise<void>

writeDocument

writeDocument(identifier: ResourceIdentifier, data: Guarded<Readable>, metadata: RepresentationMetadata): Promise<void>

- Defined in src/storage/accessors/FileDataAccessor.ts:80
Writes the given data as a file (and potential metadata as additional file). The metadata file will be written first and will be deleted if something goes wrong writing the actual data.

Parameters
- identifier: ResourceIdentifier
- data: Guarded<Readable>
- metadata: RepresentationMetadata
Returns Promise<void>

Private writeMetadata

writeMetadata(link: ResourceLink, metadata: RepresentationMetadata): Promise<boolean>

- Defined in src/storage/accessors/FileDataAccessor.ts:211
Writes the metadata of the resource to a meta file.

Parameters
- link: ResourceLink
  
  Path related metadata of the resource.
- metadata: RepresentationMetadata
  
  Metadata to write.
Returns Promise<boolean>

True if data was written to a file.