Class ExtensionBasedMapper

Supports the behaviour described in https://www.w3.org/DesignIssues/HTTPFilenameMapping.html Determines content-type based on the file extension. In case an identifier does not end on an extension matching its content-type, the corresponding file will be appended with the correct extension, preceded by $.

Hierarchy

BaseFileIdentifierMapper
- ExtensionBasedMapper
  - SubdomainExtensionBasedMapper

Constructors

constructor

new ExtensionBasedMapper(base: string, rootFilepath: string, customTypes?: Record<string, string>): ExtensionBasedMapper
Parameters
- base: string
- rootFilepath: string
- Optional customTypes: Record<string, string>
Returns ExtensionBasedMapper
Overrides BaseFileIdentifierMapper.constructor
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:20

Properties

`Protected` `Readonly` baseRequestURI

baseRequestURI: string

`Private` `Readonly` customExtensions

customExtensions: Record<string, string>

`Private` `Readonly` customTypes

customTypes: Record<string, string>

`Protected` `Readonly` logger

logger: Logger = ...

`Protected` `Readonly` rootFilepath

rootFilepath: string

`Protected` `Readonly` unknownMediaTypeExtension

unknownMediaTypeExtension: "unknown" = 'unknown'

Methods

`Protected` getAbsolutePath

getAbsolutePath(path: string): string
Get the absolute file path based on the rootFilepath.

Returns
Absolute path of the file.
Parameters
- path: string
  
  The relative file path.
Returns string
Inherited from BaseFileIdentifierMapper.getAbsolutePath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:170

`Protected` getContainerUrl

getContainerUrl(relative: string): Promise<string>
Maps the given container path to a URL and determines its content type.

Returns
A ResourceLink with all the necessary metadata.
Parameters
- relative: string
  
  The relative container path.
Returns Promise<string>
Inherited from BaseFileIdentifierMapper.getContainerUrl
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:139

`Protected` getContentTypeFromPath

getContentTypeFromPath(filePath: string): Promise<string>
Determines the content type from the relative path.

Returns
The content type of the document.
Parameters
- filePath: string
  
  The file path of the document.
Returns Promise<string>
Overrides BaseFileIdentifierMapper.getContentTypeFromPath
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:83

`Protected` getContentTypeFromUrl

getContentTypeFromUrl(identifier: ResourceIdentifier, contentType?: string): Promise<string>
Determines the content type from the document identifier.

Returns
The content type of the document.
Parameters
- identifier: ResourceIdentifier
  
  The input identifier.
- Optional contentType: string
  
  The content-type provided with the request.
Returns Promise<string>
Inherited from BaseFileIdentifierMapper.getContentTypeFromUrl
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:98

`Protected` getDocumentUrl

getDocumentUrl(relative: string): Promise<string>
Maps the given document path to a URL and determines its content type.

Returns
A ResourceLink with all the necessary metadata.
Parameters
- relative: string
  
  The relative document path.
Returns Promise<string>
Overrides BaseFileIdentifierMapper.getDocumentUrl
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:79

`Protected` getRelativePath

getRelativePath(identifier: ResourceIdentifier): string
Strips the baseRequestURI from the identifier.

Throws
NotFoundHttpError If the identifier does not match the baseRequestURI.

Returns
A string representing the relative path.
Parameters
- identifier: ResourceIdentifier
  
  Incoming identifier.
Returns string
Inherited from BaseFileIdentifierMapper.getRelativePath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:183

`Protected` isMetadataPath

isMetadataPath(path: string): boolean
Checks if the given path is a metadata path.
Parameters
- path: string
Returns boolean
Inherited from BaseFileIdentifierMapper.isMetadataPath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:215

mapFilePathToUrl

mapFilePathToUrl(filePath: string, isContainer: boolean): Promise<ResourceLink>
Maps the given file path to a URL and determines its content type.

Returns
A ResourceLink with all the necessary metadata.
Parameters
- filePath: string
  
  The input file path.
- isContainer: boolean
  
  If the path corresponds to a file.
Returns Promise<ResourceLink>
Inherited from BaseFileIdentifierMapper.mapFilePathToUrl
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:109

`Protected` mapUrlToContainerPath

mapUrlToContainerPath(identifier: ResourceIdentifier, filePath: string): Promise<ResourceLink>
Maps the given container identifier to a file path, possibly making alterations to the direct translation.

Returns
A ResourceLink with all the necessary metadata.
Parameters
- identifier: ResourceIdentifier
  
  The input identifier.
- filePath: string
  
  The direct translation of the identifier onto the file path.
Returns Promise<ResourceLink>
Inherited from BaseFileIdentifierMapper.mapUrlToContainerPath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:65

`Protected` mapUrlToDocumentPath

mapUrlToDocumentPath(identifier: ResourceIdentifier, filePath: string, contentType?: string): Promise<ResourceLink>
Maps the given document identifier to a file path, possibly making alterations to the direct translation (for instance, based on its content type)). Determines the content type if none was provided.

Returns
A ResourceLink with all the necessary metadata.
Parameters
- identifier: ResourceIdentifier
  
  The input identifier.
- filePath: string
  
  The direct translation of the identifier onto the file path.
- Optional contentType: string
  
  The content-type provided with the request.
Returns Promise<ResourceLink>
Overrides BaseFileIdentifierMapper.mapUrlToDocumentPath
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:40

mapUrlToFilePath

mapUrlToFilePath(identifier: ResourceIdentifier, isMetadata: boolean, contentType?: string): Promise<ResourceLink>
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.

Returns
A ResourceLink with all the necessary metadata.
Parameters
- identifier: ResourceIdentifier
  
  The input identifier.
- isMetadata: boolean
  
  If we need the data or metadata file path.
- Optional contentType: string
  
  The content-type provided with the request.
Returns Promise<ResourceLink>
Inherited from BaseFileIdentifierMapper.mapUrlToFilePath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:43

`Protected` stripExtension

stripExtension(path: string): string
Helper function that removes the internal extension, one starting with $., from the given path. Nothing happens if no such extension is present.
Parameters
- path: string
Returns string
- Defined in src/storage/mapping/ExtensionBasedMapper.ts:94

`Protected` validateRelativePath

validateRelativePath(path: string, identifier: ResourceIdentifier): void
Check if the given relative path is valid.

Throws
BadRequestHttpError If the relative path is invalid.
Parameters
- path: string
  
  A relative path, as generated by getRelativePath.
- identifier: ResourceIdentifier
  
  A resource identifier.
Returns void
Inherited from BaseFileIdentifierMapper.validateRelativePath
- Defined in src/storage/mapping/BaseFileIdentifierMapper.ts:200

Class ExtensionBasedMapper

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

base: string

rootFilepath: string

Optional customTypes: Record<string, string>

Returns ExtensionBasedMapper

Properties

Protected Readonly baseRequestURI

Private Readonly customExtensions

Private Readonly customTypes

Protected Readonly logger

Protected Readonly rootFilepath

Protected Readonly unknownMediaTypeExtension

Methods

Protected getAbsolutePath

Returns

Parameters

path: string

Returns string

Protected getContainerUrl

Returns

Parameters

relative: string

Returns Promise<string>

Protected getContentTypeFromPath

Returns

Parameters

filePath: string

Returns Promise<string>

Protected getContentTypeFromUrl

Returns

Parameters

identifier: ResourceIdentifier

Optional contentType: string

Returns Promise<string>

Protected getDocumentUrl

Returns

Parameters

relative: string

Returns Promise<string>

Protected getRelativePath

Throws

Returns

Parameters

identifier: ResourceIdentifier

Returns string

Protected isMetadataPath

Parameters

path: string

Returns boolean

mapFilePathToUrl

Returns

Parameters

filePath: string

isContainer: boolean

Returns Promise<ResourceLink>

Protected mapUrlToContainerPath

Returns

Parameters

identifier: ResourceIdentifier

filePath: string

Returns Promise<ResourceLink>

Protected mapUrlToDocumentPath

Returns

Parameters

identifier: ResourceIdentifier

filePath: string

Optional contentType: string

Returns Promise<ResourceLink>

mapUrlToFilePath

Returns

Parameters

identifier: ResourceIdentifier

`Optional` customTypes: Record<string, string>

`Protected` `Readonly` baseRequestURI

`Private` `Readonly` customExtensions

`Private` `Readonly` customTypes

`Protected` `Readonly` logger

`Protected` `Readonly` rootFilepath

`Protected` `Readonly` unknownMediaTypeExtension

`Protected` getAbsolutePath

`Protected` getContainerUrl

`Protected` getContentTypeFromPath

`Protected` getContentTypeFromUrl

`Optional` contentType: string

`Protected` getDocumentUrl

`Protected` getRelativePath

`Protected` isMetadataPath

`Protected` mapUrlToContainerPath

`Protected` mapUrlToDocumentPath

`Optional` contentType: string

`Optional` contentType: string

`Protected` stripExtension

`Protected` validateRelativePath