mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
447 lines
29 KiB
HTML
447 lines
29 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>IdentityProviderHttpHandler | Community Solid Server - v0.9.0</title>
|
|
<meta name="description" content="Documentation for Community Solid Server - v0.9.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>
|
|
</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 - v0.9.0</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 - v0.9.0</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/identity_identityproviderhttphandler.html">identity/IdentityProviderHttpHandler</a>
|
|
</li>
|
|
<li>
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html">IdentityProviderHttpHandler</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class IdentityProviderHttpHandler</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>Handles all requests relevant for the entire IDP interaction,
|
|
by sending them to either the stored <a href="identity_interaction_interactionhttphandler.interactionhttphandler.html">InteractionHttpHandler</a>,
|
|
or the generated {@link Provider} if the first does not support the request.</p>
|
|
</div>
|
|
<p>The InteractionHttpHandler would handle all requests where we need custom behaviour,
|
|
such as everything related to generating and validating an account.
|
|
The Provider handles all the default request such as the initial handshake.</p>
|
|
<p>This handler handles all requests since it assumes all those requests are relevant for the IDP interaction.
|
|
A <a href="server_util_routerhandler.routerhandler.html">RouterHandler</a> should be used to filter out other requests.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="server_httphandler.httphandler.html" class="tsd-signature-type" data-tsd-kind="Class">HttpHandler</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">IdentityProviderHttpHandler</span>
|
|
</li>
|
|
</ul>
|
|
</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 tsd-is-overwrite"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.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-private"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#errorresponsewriter" class="tsd-kind-icon">error<wbr>Response<wbr>Writer</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#interactionhttphandler" class="tsd-kind-icon">interaction<wbr>Http<wbr>Handler</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#interactionpolicy" class="tsd-kind-icon">interaction<wbr>Policy</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#logger" class="tsd-kind-icon">logger</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#provider" class="tsd-kind-icon">provider</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#providerfactory" class="tsd-kind-icon">provider<wbr>Factory</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 tsd-is-inherited"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#getprovider" class="tsd-kind-icon">get<wbr>Provider</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#handle" class="tsd-kind-icon">handle</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#handlesafe" class="tsd-kind-icon">handle<wbr>Safe</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 tsd-is-overwrite">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Identity<wbr>Provider<wbr>Http<wbr>Handler<span class="tsd-signature-symbol">(</span>providerFactory<span class="tsd-signature-symbol">: </span><a href="identity_identityproviderfactory.identityproviderfactory.html" class="tsd-signature-type" data-tsd-kind="Class">IdentityProviderFactory</a>, interactionPolicy<span class="tsd-signature-symbol">: </span><a href="../interfaces/identity_interaction_interactionpolicy.interactionpolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionPolicy</a>, interactionHttpHandler<span class="tsd-signature-symbol">: </span><a href="identity_interaction_interactionhttphandler.interactionhttphandler.html" class="tsd-signature-type" data-tsd-kind="Class">InteractionHttpHandler</a>, errorResponseWriter<span class="tsd-signature-symbol">: </span><a href="ldp_http_responsewriter.responsewriter.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseWriter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="identity_identityproviderhttphandler.identityproviderhttphandler.html" class="tsd-signature-type" data-tsd-kind="Class">IdentityProviderHttpHandler</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Overrides <a href="server_httphandler.httphandler.html">HttpHandler</a>.<a href="server_httphandler.httphandler.html#constructor">constructor</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/identity/IdentityProviderHttpHandler.ts#L30">src/identity/IdentityProviderHttpHandler.ts:30</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>providerFactory: <a href="identity_identityproviderfactory.identityproviderfactory.html" class="tsd-signature-type" data-tsd-kind="Class">IdentityProviderFactory</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>interactionPolicy: <a href="../interfaces/identity_interaction_interactionpolicy.interactionpolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionPolicy</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>interactionHttpHandler: <a href="identity_interaction_interactionhttphandler.interactionhttphandler.html" class="tsd-signature-type" data-tsd-kind="Class">InteractionHttpHandler</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>errorResponseWriter: <a href="ldp_http_responsewriter.responsewriter.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseWriter</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="identity_identityproviderhttphandler.identityproviderhttphandler.html" class="tsd-signature-type" data-tsd-kind="Class">IdentityProviderHttpHandler</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-private">
|
|
<a name="errorresponsewriter" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> error<wbr>Response<wbr>Writer</h3>
|
|
<div class="tsd-signature tsd-kind-icon">error<wbr>Response<wbr>Writer<span class="tsd-signature-symbol">:</span> <a href="ldp_http_responsewriter.responsewriter.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseWriter</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/identity/IdentityProviderHttpHandler.ts#L29">src/identity/IdentityProviderHttpHandler.ts:29</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="interactionhttphandler" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> interaction<wbr>Http<wbr>Handler</h3>
|
|
<div class="tsd-signature tsd-kind-icon">interaction<wbr>Http<wbr>Handler<span class="tsd-signature-symbol">:</span> <a href="identity_interaction_interactionhttphandler.interactionhttphandler.html" class="tsd-signature-type" data-tsd-kind="Class">InteractionHttpHandler</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/identity/IdentityProviderHttpHandler.ts#L28">src/identity/IdentityProviderHttpHandler.ts:28</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="interactionpolicy" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> interaction<wbr>Policy</h3>
|
|
<div class="tsd-signature tsd-kind-icon">interaction<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="../interfaces/identity_interaction_interactionpolicy.interactionpolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionPolicy</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/identity/IdentityProviderHttpHandler.ts#L27">src/identity/IdentityProviderHttpHandler.ts:27</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<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/0a68fbf/src/identity/IdentityProviderHttpHandler.ts#L24">src/identity/IdentityProviderHttpHandler.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="provider" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagOptional">Optional</span> provider</h3>
|
|
<div class="tsd-signature tsd-kind-icon">provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Provider</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/identity/IdentityProviderHttpHandler.ts#L30">src/identity/IdentityProviderHttpHandler.ts:30</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="providerfactory" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> provider<wbr>Factory</h3>
|
|
<div class="tsd-signature tsd-kind-icon">provider<wbr>Factory<span class="tsd-signature-symbol">:</span> <a href="identity_identityproviderfactory.identityproviderfactory.html" class="tsd-signature-type" data-tsd-kind="Class">IdentityProviderFactory</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/identity/IdentityProviderHttpHandler.ts#L26">src/identity/IdentityProviderHttpHandler.ts:26</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-inherited">
|
|
<a name="canhandle" class="tsd-anchor"></a>
|
|
<h3>can<wbr>Handle</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">can<wbr>Handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/server_httphandler.httphandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpHandlerInput</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>Inherited from <a href="server_httphandler.httphandler.html">HttpHandler</a>.<a href="server_httphandler.httphandler.html#canhandle">canHandle</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/handlers/AsyncHandler.ts#L13">src/util/handlers/AsyncHandler.ts:13</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks if the input data can be handled by this class.
|
|
Throws an error if it can't handle the data.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>input: <a href="../interfaces/server_httphandler.httphandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpHandlerInput</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Input data that could potentially be handled.</p>
|
|
</div>
|
|
</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>
|
|
<p>A promise resolving if the input can be handled, rejecting with an Error if not.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="getprovider" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Provider</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Provider<span class="tsd-signature-symbol">(</span><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">Provider</span><span class="tsd-signature-symbol">></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/0a68fbf/src/identity/IdentityProviderHttpHandler.ts#L48">src/identity/IdentityProviderHttpHandler.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Create the provider or retrieve it if it has already been created.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Provider</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
|
|
<a name="handle" class="tsd-anchor"></a>
|
|
<h3>handle</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
|
|
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/server_httphandler.httphandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpHandlerInput</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>Overrides <a href="server_httphandler.httphandler.html">HttpHandler</a>.<a href="server_httphandler.httphandler.html#handle">handle</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/identity/IdentityProviderHttpHandler.ts#L60">src/identity/IdentityProviderHttpHandler.ts:60</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>input: <a href="../interfaces/server_httphandler.httphandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpHandlerInput</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 class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a name="handlesafe" class="tsd-anchor"></a>
|
|
<h3>handle<wbr>Safe</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<li class="tsd-signature tsd-kind-icon">handle<wbr>Safe<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/server_httphandler.httphandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpHandlerInput</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>Inherited from <a href="server_httphandler.httphandler.html">HttpHandler</a>.<a href="server_httphandler.httphandler.html#handlesafe">handleSafe</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/handlers/AsyncHandler.ts#L35">src/util/handlers/AsyncHandler.ts:35</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Helper function that first runs the canHandle function followed by the handle function.
|
|
Throws the error of the <a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#canhandle">canHandle</a> function if the data can't be handled,
|
|
or returns the result of the <a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#handle">handle</a> function otherwise.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>input: <a href="../interfaces/server_httphandler.httphandlerinput.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpHandlerInput</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Input data that will be handled if it can be handled.</p>
|
|
</div>
|
|
</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>
|
|
<p>A promise resolving if the input can be handled, rejecting with an Error if not.
|
|
Return value depends on the given type.</p>
|
|
</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">Exports</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="../modules/identity_identityproviderhttphandler.html">identity/<wbr>Identity<wbr>Provider<wbr>Http<wbr>Handler</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="identity_identityproviderhttphandler.identityproviderhttphandler.html" class="tsd-kind-icon">Identity<wbr>Provider<wbr>Http<wbr>Handler</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#errorresponsewriter" class="tsd-kind-icon">error<wbr>Response<wbr>Writer</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#interactionhttphandler" class="tsd-kind-icon">interaction<wbr>Http<wbr>Handler</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#interactionpolicy" class="tsd-kind-icon">interaction<wbr>Policy</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#logger" class="tsd-kind-icon">logger</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#provider" class="tsd-kind-icon">provider</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#providerfactory" class="tsd-kind-icon">provider<wbr>Factory</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#getprovider" class="tsd-kind-icon">get<wbr>Provider</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#handle" class="tsd-kind-icon">handle</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
<a href="identity_identityproviderhttphandler.identityproviderhttphandler.html#handlesafe" class="tsd-kind-icon">handle<wbr>Safe</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-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</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>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |