ExtensionBasedMapper | Community Solid Server

Hierarchy

BaseFileIdentifierMapper
- ExtensionBasedMapper

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ExtensionBasedMapper(base: string, rootFilepath: string, overrideTypes?: { acl: string; meta: string }): ExtensionBasedMapper

Inherited from BaseFileIdentifierMapper.constructor
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:11
Parameters
- base: string
- rootFilepath: string
- overrideTypes: { acl: string; meta: string } = ...
  - acl: string
  - meta: string
Returns ExtensionBasedMapper

Properties

Protected Readonly baseRequestURI

baseRequestURI: string

Protected Readonly logger

logger: Logger = ...

Protected Readonly rootFilepath

rootFilepath: string

Private Readonly types

types: Record<string, any>

Methods

Protected getContainerUrl

getContainerUrl(relative: string): Promise<string>

Inherited from BaseFileIdentifierMapper.getContainerUrl
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:121
Maps the given container path to a URL and determines its content type.

Parameters
- relative: string
  
  The relative container path.
Returns Promise<string>

A ResourceLink with all the necessary metadata.

Protected getContentTypeFromPath

getContentTypeFromPath(filePath: string): Promise<string>

Overrides BaseFileIdentifierMapper.getContentTypeFromPath
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:63
Parameters
- filePath: string
Returns Promise<string>

Protected getContentTypeFromUrl

getContentTypeFromUrl(identifier: ResourceIdentifier, contentType?: string): Promise<string>

Inherited from BaseFileIdentifierMapper.getContentTypeFromUrl
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:84
Determines the content type from the document identifier.

Parameters
- identifier: ResourceIdentifier
  
  The input identifier.
- Optional contentType: string
  
  The content-type provided with the request.
Returns Promise<string>

The content type of the document.

Protected getDocumentUrl

getDocumentUrl(relative: string): Promise<string>

Overrides BaseFileIdentifierMapper.getDocumentUrl
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:55
Parameters
- relative: string
Returns Promise<string>

mapFilePathToUrl

mapFilePathToUrl(filePath: string, isContainer: boolean): Promise<ResourceLink>

Inherited from BaseFileIdentifierMapper.mapFilePathToUrl
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:95
Maps the given file path to a URL and determines its content type.

Parameters
- filePath: string
  
  The input file path.
- isContainer: boolean
  
  If the path corresponds to a file.
Returns Promise<ResourceLink>

A ResourceLink with all the necessary metadata.

Protected mapUrlToContainerPath

mapUrlToContainerPath(identifier: ResourceIdentifier, filePath: string): Promise<ResourceLink>

Inherited from BaseFileIdentifierMapper.mapUrlToContainerPath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:54
Maps the given container identifier to a file path, possibly making alterations to the direct translation.

Parameters
- identifier: ResourceIdentifier
  
  The input identifier.
- filePath: string
  
  The direct translation of the identifier onto the file path.
Returns Promise<ResourceLink>

A ResourceLink with all the necessary metadata.

Protected mapUrlToDocumentPath

mapUrlToDocumentPath(identifier: ResourceIdentifier, filePath: string, contentType?: string): Promise<ResourceLink>

Overrides BaseFileIdentifierMapper.mapUrlToDocumentPath
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:18
Parameters
- identifier: ResourceIdentifier
- filePath: string
- Optional contentType: string
Returns Promise<ResourceLink>

mapUrlToFilePath

mapUrlToFilePath(identifier: ResourceIdentifier, contentType?: string): Promise<ResourceLink>

Inherited from BaseFileIdentifierMapper.mapUrlToFilePath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:36
Maps the given resource identifier / URL to a file path. Determines the content type if none was provided. For containers the content-type input is ignored.

Parameters
- identifier: ResourceIdentifier
  
  The input identifier.
- Optional contentType: string
  
  The content-type provided with the request.
Returns Promise<ResourceLink>

A ResourceLink with all the necessary metadata.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

base: string

rootFilepath: string

overrideTypes: { acl: string; meta: string } = ...

acl: string

meta: string

Returns ExtensionBasedMapper

Properties

Protected Readonly baseRequestURI

Protected Readonly logger

Protected Readonly rootFilepath

Private Readonly types

Methods

Protected getContainerUrl

Parameters

relative: string

Returns Promise<string>

Protected getContentTypeFromPath

Parameters

filePath: string

Returns Promise<string>

Protected getContentTypeFromUrl

Parameters

identifier: ResourceIdentifier

Optional contentType: string

Returns Promise<string>

Protected getDocumentUrl

Parameters

relative: string

Returns Promise<string>

mapFilePathToUrl

Parameters

filePath: string

isContainer: boolean

Returns Promise<ResourceLink>

Protected mapUrlToContainerPath

Parameters

identifier: ResourceIdentifier

filePath: string

Returns Promise<ResourceLink>

Protected mapUrlToDocumentPath

Parameters

identifier: ResourceIdentifier

filePath: string

Optional contentType: string

Returns Promise<ResourceLink>

mapUrlToFilePath

Parameters

identifier: ResourceIdentifier

Optional contentType: string

Returns Promise<ResourceLink>