mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
325 lines
19 KiB
HTML
325 lines
19 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>ConfigPodManager | Community Solid Server - v1.0.0-beta.2</title>
|
|
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.2">
|
|
<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>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<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 - v1.0.0-beta.2</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules.html">Community Solid Server - v1.0.0-beta.2</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/pods_configpodmanager.html">pods/ConfigPodManager</a>
|
|
</li>
|
|
<li>
|
|
<a href="pods_configpodmanager.configpodmanager.html">ConfigPodManager</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class ConfigPodManager</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Pod manager that creates a store for the pod with a <a href="../interfaces/pods_generate_podgenerator.podgenerator.html">PodGenerator</a>
|
|
and fills it with resources from a <a href="../interfaces/pods_generate_resourcesgenerator.resourcesgenerator.html">ResourcesGenerator</a>.</p>
|
|
</div>
|
|
<p>Part of the dynamic pod creation.</p>
|
|
<ol>
|
|
<li>Calls a PodGenerator to instantiate a new resource store for the pod.</li>
|
|
<li>Generates the pod resources based on the templates as usual.</li>
|
|
<li>Adds the created pod to the routing storage, which is used for linking pod identifiers to their resource stores.</li>
|
|
</ol>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="pods_generate_templatedpodgenerator.templatedpodgenerator.html">TemplatedPodGenerator</a>, <a href="init_configpodinitializer.configpodinitializer.html">ConfigPodInitializer</a>, <a href="storage_routing_baseurlrouterrule.baseurlrouterrule.html">BaseUrlRouterRule</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">ConfigPodManager</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implements</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="../interfaces/pods_podmanager.podmanager.html" class="tsd-signature-type" data-tsd-kind="Interface">PodManager</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="pods_configpodmanager.configpodmanager.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-private-protected">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="pods_configpodmanager.configpodmanager.html#logger" class="tsd-kind-icon">logger</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="pods_configpodmanager.configpodmanager.html#podgenerator" class="tsd-kind-icon">pod<wbr>Generator</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="pods_configpodmanager.configpodmanager.html#resourcesgenerator" class="tsd-kind-icon">resources<wbr>Generator</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="pods_configpodmanager.configpodmanager.html#routingstorage" class="tsd-kind-icon">routing<wbr>Storage</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="pods_configpodmanager.configpodmanager.html#createpod" class="tsd-kind-icon">create<wbr>Pod</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Config<wbr>Pod<wbr>Manager<span class="tsd-signature-symbol">(</span>podGenerator<span class="tsd-signature-symbol">: </span><a href="../interfaces/pods_generate_podgenerator.podgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">PodGenerator</a>, resourcesGenerator<span class="tsd-signature-symbol">: </span><a href="../interfaces/pods_generate_resourcesgenerator.resourcesgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourcesGenerator</a>, routingStorage<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_keyvalue_keyvaluestorage.keyvaluestorage.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyValueStorage</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/storage_resourcestore.resourcestore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="pods_configpodmanager.configpodmanager.html" class="tsd-signature-type" data-tsd-kind="Class">ConfigPodManager</a></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/fdd1a37/src/pods/ConfigPodManager.ts#L26">src/pods/ConfigPodManager.ts:26</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>podGenerator: <a href="../interfaces/pods_generate_podgenerator.podgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">PodGenerator</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Generator for the pod stores.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>resourcesGenerator: <a href="../interfaces/pods_generate_resourcesgenerator.resourcesgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourcesGenerator</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Generator for the pod resources.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>routingStorage: <a href="../interfaces/storage_keyvalue_keyvaluestorage.keyvaluestorage.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyValueStorage</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/storage_resourcestore.resourcestore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a><span class="tsd-signature-symbol">></span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Where to store the generated pods so they can be routed to.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="pods_configpodmanager.configpodmanager.html" class="tsd-signature-type" data-tsd-kind="Class">ConfigPodManager</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
<a name="logger" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> logger</h3>
|
|
<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/fdd1a37/src/pods/ConfigPodManager.ts#L23">src/pods/ConfigPodManager.ts:23</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="podgenerator" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> pod<wbr>Generator</h3>
|
|
<div class="tsd-signature tsd-kind-icon">pod<wbr>Generator<span class="tsd-signature-symbol">:</span> <a href="../interfaces/pods_generate_podgenerator.podgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">PodGenerator</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/pods/ConfigPodManager.ts#L24">src/pods/ConfigPodManager.ts:24</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="resourcesgenerator" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> resources<wbr>Generator</h3>
|
|
<div class="tsd-signature tsd-kind-icon">resources<wbr>Generator<span class="tsd-signature-symbol">:</span> <a href="../interfaces/pods_generate_resourcesgenerator.resourcesgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourcesGenerator</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/pods/ConfigPodManager.ts#L26">src/pods/ConfigPodManager.ts:26</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="routingstorage" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> routing<wbr>Storage</h3>
|
|
<div class="tsd-signature tsd-kind-icon">routing<wbr>Storage<span class="tsd-signature-symbol">:</span> <a href="../interfaces/storage_keyvalue_keyvaluestorage.keyvaluestorage.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyValueStorage</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/storage_resourcestore.resourcestore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</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/fdd1a37/src/pods/ConfigPodManager.ts#L25">src/pods/ConfigPodManager.ts:25</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">
|
|
<a name="createpod" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Pod</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Pod<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>, settings<span class="tsd-signature-symbol">: </span><a href="../interfaces/pods_settings_podsettings.podsettings.html" class="tsd-signature-type" data-tsd-kind="Interface">PodSettings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Implementation of PodManager.createPod</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/pods/ConfigPodManager.ts#L40">src/pods/ConfigPodManager.ts:40</a></li>
|
|
</ul>
|
|
</aside>
|
|
<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>
|
|
</li>
|
|
<li>
|
|
<h5>settings: <a href="../interfaces/pods_settings_podsettings.podsettings.html" class="tsd-signature-type" data-tsd-kind="Interface">PodSettings</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Modules</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="../modules/pods_configpodmanager.html">pods/<wbr>Config<wbr>Pod<wbr>Manager</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
<a href="pods_configpodmanager.configpodmanager.html" class="tsd-kind-icon">Config<wbr>Pod<wbr>Manager</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="pods_configpodmanager.configpodmanager.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
<a href="pods_configpodmanager.configpodmanager.html#logger" class="tsd-kind-icon">logger</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="pods_configpodmanager.configpodmanager.html#podgenerator" class="tsd-kind-icon">pod<wbr>Generator</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="pods_configpodmanager.configpodmanager.html#resourcesgenerator" class="tsd-kind-icon">resources<wbr>Generator</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="pods_configpodmanager.configpodmanager.html#routingstorage" class="tsd-kind-icon">routing<wbr>Storage</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="pods_configpodmanager.configpodmanager.html#createpod" class="tsd-kind-icon">create<wbr>Pod</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |