This commit is contained in:
RubenVerborgh
2021-03-04 12:04:40 +00:00
parent f9182a6c94
commit fe4663945a
628 changed files with 41549 additions and 6824 deletions

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BaseFileIdentifierMapper | Community Solid Server - v0.7.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.7.0">
<title>BaseFileIdentifierMapper | Community Solid Server - v0.8.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.8.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Community Solid Server - v0.7.0</a>
<a href="../index.html" class="title">Community Solid Server - v0.8.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Community Solid Server - v0.7.0</a>
<a href="../modules.html">Community Solid Server - v0.8.0</a>
</li>
<li>
<a href="../modules/storage_mapping_basefileidentifiermapper.html">storage/mapping/BaseFileIdentifierMapper</a>
@@ -124,14 +124,17 @@
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getabsolutepath" class="tsd-kind-icon">get<wbr>Absolute<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getcontainerurl" class="tsd-kind-icon">get<wbr>Container<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getcontenttypefrompath" class="tsd-kind-icon">get<wbr>Content<wbr>Type<wbr>From<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getcontenttypefromurl" class="tsd-kind-icon">get<wbr>Content<wbr>Type<wbr>From<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getdocumenturl" class="tsd-kind-icon">get<wbr>Document<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getrelativepath" class="tsd-kind-icon">get<wbr>Relative<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#mapfilepathtourl" class="tsd-kind-icon">map<wbr>File<wbr>Path<wbr>ToUrl</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#mapurltocontainerpath" class="tsd-kind-icon">map<wbr>Url<wbr>ToContainer<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#mapurltodocumentpath" class="tsd-kind-icon">map<wbr>Url<wbr>ToDocument<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#mapurltofilepath" class="tsd-kind-icon">map<wbr>Url<wbr>ToFile<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#validaterelativepath" class="tsd-kind-icon">validate<wbr>Relative<wbr>Path</a></li>
</ul>
</section>
</div>
@@ -149,7 +152,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L20">src/storage/mapping/BaseFileIdentifierMapper.ts:20</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L23">src/storage/mapping/BaseFileIdentifierMapper.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -174,7 +177,7 @@
<div class="tsd-signature tsd-kind-icon">base<wbr>RequestURI<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L19">src/storage/mapping/BaseFileIdentifierMapper.ts:19</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L22">src/storage/mapping/BaseFileIdentifierMapper.ts:22</a></li>
</ul>
</aside>
</section>
@@ -184,7 +187,7 @@
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="logging_logger.logger.html" class="tsd-signature-type" data-tsd-kind="Class">Logger</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L18">src/storage/mapping/BaseFileIdentifierMapper.ts:18</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L21">src/storage/mapping/BaseFileIdentifierMapper.ts:21</a></li>
</ul>
</aside>
</section>
@@ -194,13 +197,45 @@
<div class="tsd-signature tsd-kind-icon">root<wbr>Filepath<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L20">src/storage/mapping/BaseFileIdentifierMapper.ts:20</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L23">src/storage/mapping/BaseFileIdentifierMapper.ts:23</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="getabsolutepath" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Absolute<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">get<wbr>Absolute<wbr>Path<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L155">src/storage/mapping/BaseFileIdentifierMapper.ts:155</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the absolute file path based on the rootFilepath.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The relative file path.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>Absolute path of the file.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="getcontainerurl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Container<wbr>Url</h3>
@@ -211,7 +246,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L121">src/storage/mapping/BaseFileIdentifierMapper.ts:121</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L124">src/storage/mapping/BaseFileIdentifierMapper.ts:124</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -243,7 +278,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L142">src/storage/mapping/BaseFileIdentifierMapper.ts:142</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L145">src/storage/mapping/BaseFileIdentifierMapper.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -275,7 +310,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L84">src/storage/mapping/BaseFileIdentifierMapper.ts:84</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L87">src/storage/mapping/BaseFileIdentifierMapper.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -313,7 +348,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L131">src/storage/mapping/BaseFileIdentifierMapper.ts:131</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L134">src/storage/mapping/BaseFileIdentifierMapper.ts:134</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -335,6 +370,44 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="getrelativepath" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Relative<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">get<wbr>Relative<wbr>Path<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L168">src/storage/mapping/BaseFileIdentifierMapper.ts:168</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Strips the baseRequestURI from the identifier.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p><a href="util_errors_notfoundhttperror.notfoundhttperror.html">NotFoundHttpError</a>
If the identifier does not match the baseRequestURI.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>identifier: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
<div class="tsd-comment tsd-typography">
<p>Incoming identifier.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>A string representing the relative path.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="mapfilepathtourl" class="tsd-anchor"></a>
<h3>map<wbr>File<wbr>Path<wbr>ToUrl</h3>
@@ -345,7 +418,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L95">src/storage/mapping/BaseFileIdentifierMapper.ts:95</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L98">src/storage/mapping/BaseFileIdentifierMapper.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -383,7 +456,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L54">src/storage/mapping/BaseFileIdentifierMapper.ts:54</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L57">src/storage/mapping/BaseFileIdentifierMapper.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -422,7 +495,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L70">src/storage/mapping/BaseFileIdentifierMapper.ts:70</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L73">src/storage/mapping/BaseFileIdentifierMapper.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -469,7 +542,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/storage/mapping/BaseFileIdentifierMapper.ts#L36">src/storage/mapping/BaseFileIdentifierMapper.ts:36</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L39">src/storage/mapping/BaseFileIdentifierMapper.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -499,6 +572,49 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="validaterelativepath" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> validate<wbr>Relative<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">validate<wbr>Relative<wbr>Path<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/storage/mapping/BaseFileIdentifierMapper.ts#L185">src/storage/mapping/BaseFileIdentifierMapper.ts:185</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if the given relative path is valid.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p><a href="util_errors_badrequesthttperror.badrequesthttperror.html">BadRequestHttpError</a>
If the relative path is invalid.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A relative path, as generated by <a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getrelativepath">getRelativePath</a>.</p>
</div>
</li>
<li>
<h5>identifier: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
<div class="tsd-comment tsd-typography">
<p>A resource identifier.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -531,6 +647,9 @@
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#rootfilepath" class="tsd-kind-icon">root<wbr>Filepath</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getabsolutepath" class="tsd-kind-icon">get<wbr>Absolute<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getcontainerurl" class="tsd-kind-icon">get<wbr>Container<wbr>Url</a>
</li>
@@ -543,6 +662,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getdocumenturl" class="tsd-kind-icon">get<wbr>Document<wbr>Url</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getrelativepath" class="tsd-kind-icon">get<wbr>Relative<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#mapfilepathtourl" class="tsd-kind-icon">map<wbr>File<wbr>Path<wbr>ToUrl</a>
</li>
@@ -555,6 +677,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#mapurltofilepath" class="tsd-kind-icon">map<wbr>Url<wbr>ToFile<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#validaterelativepath" class="tsd-kind-icon">validate<wbr>Relative<wbr>Path</a>
</li>
</ul>
</li>
</ul>