mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
274 lines
13 KiB
HTML
274 lines
13 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>AuthenticatedLdpHandlerArgs | Community Solid Server</title>
|
|
<meta name="description" content="Documentation for Community Solid Server">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</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</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>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/_ldp_authenticatedldphandler_.html">"ldp/AuthenticatedLdpHandler"</a>
|
|
</li>
|
|
<li>
|
|
<a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html">AuthenticatedLdpHandlerArgs</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface AuthenticatedLdpHandlerArgs</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>Collection of handlers needed for <a href="../classes/_ldp_authenticatedldphandler_.authenticatedldphandler.html">AuthenticatedLdpHandler</a> to function.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">AuthenticatedLdpHandlerArgs</span>
|
|
</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>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#authorizer" class="tsd-kind-icon">authorizer</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#credentialsextractor" class="tsd-kind-icon">credentials<wbr>Extractor</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#operationhandler" class="tsd-kind-icon">operation<wbr>Handler</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#permissionsextractor" class="tsd-kind-icon">permissions<wbr>Extractor</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#requestparser" class="tsd-kind-icon">request<wbr>Parser</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#responsewriter" class="tsd-kind-icon">response<wbr>Writer</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="authorizer" class="tsd-anchor"></a>
|
|
<h3>authorizer</h3>
|
|
<div class="tsd-signature tsd-kind-icon">authorizer<span class="tsd-signature-symbol">:</span> <a href="../classes/_authorization_authorizer_.authorizer.html" class="tsd-signature-type">Authorizer</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/bd7e493/src/ldp/AuthenticatedLdpHandler.ts#L35">src/ldp/AuthenticatedLdpHandler.ts:35</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Verifies if the requested operation is allowed.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="credentialsextractor" class="tsd-anchor"></a>
|
|
<h3>credentials<wbr>Extractor</h3>
|
|
<div class="tsd-signature tsd-kind-icon">credentials<wbr>Extractor<span class="tsd-signature-symbol">:</span> <a href="../classes/_authentication_credentialsextractor_.credentialsextractor.html" class="tsd-signature-type">CredentialsExtractor</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/bd7e493/src/ldp/AuthenticatedLdpHandler.ts#L27">src/ldp/AuthenticatedLdpHandler.ts:27</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Extracts the credentials from the incoming request.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="operationhandler" class="tsd-anchor"></a>
|
|
<h3>operation<wbr>Handler</h3>
|
|
<div class="tsd-signature tsd-kind-icon">operation<wbr>Handler<span class="tsd-signature-symbol">:</span> <a href="../classes/_ldp_operations_operationhandler_.operationhandler.html" class="tsd-signature-type">OperationHandler</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/bd7e493/src/ldp/AuthenticatedLdpHandler.ts#L39">src/ldp/AuthenticatedLdpHandler.ts:39</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Executed the operation.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="permissionsextractor" class="tsd-anchor"></a>
|
|
<h3>permissions<wbr>Extractor</h3>
|
|
<div class="tsd-signature tsd-kind-icon">permissions<wbr>Extractor<span class="tsd-signature-symbol">:</span> <a href="../classes/_ldp_permissions_permissionsextractor_.permissionsextractor.html" class="tsd-signature-type">PermissionsExtractor</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/bd7e493/src/ldp/AuthenticatedLdpHandler.ts#L31">src/ldp/AuthenticatedLdpHandler.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Extracts the required permissions from the generated Operation.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="requestparser" class="tsd-anchor"></a>
|
|
<h3>request<wbr>Parser</h3>
|
|
<div class="tsd-signature tsd-kind-icon">request<wbr>Parser<span class="tsd-signature-symbol">:</span> <a href="../classes/_ldp_http_requestparser_.requestparser.html" class="tsd-signature-type">RequestParser</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/bd7e493/src/ldp/AuthenticatedLdpHandler.ts#L23">src/ldp/AuthenticatedLdpHandler.ts:23</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Parses the incoming requests.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="responsewriter" class="tsd-anchor"></a>
|
|
<h3>response<wbr>Writer</h3>
|
|
<div class="tsd-signature tsd-kind-icon">response<wbr>Writer<span class="tsd-signature-symbol">:</span> <a href="../classes/_ldp_http_responsewriter_.responsewriter.html" class="tsd-signature-type">ResponseWriter</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/bd7e493/src/ldp/AuthenticatedLdpHandler.ts#L43">src/ldp/AuthenticatedLdpHandler.ts:43</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Writes out the response of the operation.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals ">
|
|
<a href="../globals.html"><em>Globals</em></a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="../modules/_ldp_authenticatedldphandler_.html">"ldp/<wbr>Authenticated<wbr>Ldp<wbr>Handler"</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
<a href="../classes/_ldp_authenticatedldphandler_.authenticatedldphandler.html" class="tsd-kind-icon">Authenticated<wbr>Ldp<wbr>Handler</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
<a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html" class="tsd-kind-icon">Authenticated<wbr>Ldp<wbr>Handler<wbr>Args</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#authorizer" class="tsd-kind-icon">authorizer</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#credentialsextractor" class="tsd-kind-icon">credentials<wbr>Extractor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#operationhandler" class="tsd-kind-icon">operation<wbr>Handler</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#permissionsextractor" class="tsd-kind-icon">permissions<wbr>Extractor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#requestparser" class="tsd-kind-icon">request<wbr>Parser</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="_ldp_authenticatedldphandler_.authenticatedldphandlerargs.html#responsewriter" class="tsd-kind-icon">response<wbr>Writer</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-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
<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-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>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |