Class SubdomainExtensionBasedMapper

Extends the functionality of an ExtensionBasedMapper to support identifiers containing subdomains. This is mostly only relevant in case you want to support multiple pods with subdomain identifiers in a single ResourceStore.

When converting to/from file paths, the subdomain is interpreted as a folder in the rootFilePath. The rest of the path is then interpreted relative to that folder. E.g. http://alice.test.com/foo results in the relative path /alice/foo.

In case there is no subdomain in the URL, the baseSubdomain parameter is used instead. E.g., if the baseSubdomain is "www", http://test.com/foo would result in the relative path /www/foo. This means that there is no identifier that maps to the rootFilePath itself. To prevent the possibility of 2 identifiers linking to the same file, identifiers containing the default subdomain are rejected. E.g., http://www.test.com/foo would result in a 403, even if http://test.com/foo exists.

Hierarchy

Constructors

constructor

Properties

baseParts baseRequestURI baseSubdomain logger regex rootFilepath unknownMediaTypeExtension

Methods

getAbsolutePath getContainerUrl getContentTypeFromPath getContentTypeFromUrl getDocumentUrl getRelativePath isMetadataPath mapFilePathToUrl mapUrlToContainerPath mapUrlToDocumentPath mapUrlToFilePath relativeToUrl stripExtension validateRelativePath

Constructors

constructor

Properties

Private Readonly baseParts

baseParts: {
    rest: string;
    scheme: string;
}

Type declaration

  • rest: string
  • scheme: string

Protected Readonly baseRequestURI

baseRequestURI: string

Private Readonly baseSubdomain

baseSubdomain: string

Protected Readonly logger

logger: Logger = ...

Private Readonly regex

regex: RegExp

Protected Readonly rootFilepath

rootFilepath: string

Protected Readonly unknownMediaTypeExtension

unknownMediaTypeExtension: "unknown" = 'unknown'

Methods

Protected getAbsolutePath

Protected getContainerUrl

Protected getContentTypeFromPath

Protected getContentTypeFromUrl

Protected getDocumentUrl

Protected getRelativePath

Protected isMetadataPath

mapFilePathToUrl

Protected mapUrlToContainerPath

Protected mapUrlToDocumentPath

  • 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.

mapUrlToFilePath

Protected relativeToUrl

Protected stripExtension

Protected validateRelativePath

Settings

Member Visibility

Theme

On This Page