Class BaseFileIdentifierMapper

Protected Readonly baseRequestURI

Protected Readonly logger

Protected Readonly rootFilepath

Protected Readonly unknownMediaTypeExtension

Protected getAbsolutePath

• getAbsolutePath(path): string

• Get the absolute file path based on the rootFilepath.

  Parameters

  • path: string

    The relative file path.

  Returns string

  Absolute path of the file.

Protected getContainerUrl

• getContainerUrl(relative): Promise<string>

• 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): Promise<string>

• Determines the content type from the relative path.

  Parameters

  • filePath: string

    The file path of the document.

  Returns Promise<string>

  The content type of the document.

Protected getContentTypeFromUrl

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

• 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): Promise<string>

• Maps the given document path to a URL and determines its content type.

  Parameters

  • relative: string

    The relative document path.

  Returns Promise<string>

  A ResourceLink with all the necessary metadata.

Protected getRelativePath

• getRelativePath(identifier): string

• Strips the baseRequestURI from the identifier.

  Throws

  NotFoundHttpError If the identifier does not match the baseRequestURI.

  Parameters

  • identifier: ResourceIdentifier

    Incoming identifier.

  Returns string

  A string representing the relative path.

Protected isMetadataPath

• isMetadataPath(path): boolean

• Checks if the given path is a metadata path.

  Parameters

  • path: string

  Returns boolean

Protected mapUrlToContainerPath

• mapUrlToContainerPath(identifier, filePath): Promise<ResourceLink>

• 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, filePath, contentType?): 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.

  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>

  A ResourceLink with all the necessary metadata.

Protected validateRelativePath

• validateRelativePath(path, identifier): 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