mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
33 lines
37 KiB
HTML
33 lines
37 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 - v2.0.0</title><meta name="description" content="Documentation for Community Solid Server - v2.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/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-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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 - v2.0.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 - v2.0.0</a></li><li><a href="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 a matching <a href="../interfaces/InteractionRoute.html">InteractionRoute</a>,
|
|
or the generated Provider from the <a href="../interfaces/ProviderFactory.html">ProviderFactory</a> if there is no match.</p>
|
|
</div><div><p>The InteractionRoutes 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="RouterHandler.html">RouterHandler</a> should be used to filter out other requests.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="OperationHttpHandler.html" class="tsd-signature-type" data-tsd-kind="Class">OperationHttpHandler</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="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="IdentityProviderHttpHandler.html#baseUrl" class="tsd-kind-icon">base<wbr/>Url</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#controls" class="tsd-kind-icon">controls</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#converter" class="tsd-kind-icon">converter</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#errorHandler" class="tsd-kind-icon">error<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#interactionCompleter" class="tsd-kind-icon">interaction<wbr/>Completer</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#interactionRoutes" class="tsd-kind-icon">interaction<wbr/>Routes</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="IdentityProviderHttpHandler.html#logger" class="tsd-kind-icon">logger</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="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="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="IdentityProviderHttpHandler.html#findRoute" class="tsd-kind-icon">find<wbr/>Route</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#getRouteControls" class="tsd-kind-icon">get<wbr/>Route<wbr/>Controls</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="IdentityProviderHttpHandler.html#handle" class="tsd-kind-icon">handle</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#handleInteractionResult" class="tsd-kind-icon">handle<wbr/>Interaction<wbr/>Result</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#handleResponseResult" class="tsd-kind-icon">handle<wbr/>Response<wbr/>Result</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="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>args<span class="tsd-signature-symbol">: </span><a href="../interfaces/IdentityProviderHttpHandlerArgs.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentityProviderHttpHandlerArgs</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="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="OperationHttpHandler.html">OperationHttpHandler</a>.<a href="OperationHttpHandler.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L79">src/identity/IdentityProviderHttpHandler.ts:79</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <a href="../interfaces/IdentityProviderHttpHandlerArgs.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentityProviderHttpHandlerArgs</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="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="baseUrl" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> base<wbr/>Url</h3><div class="tsd-signature tsd-kind-icon">base<wbr/>Url<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/216788e/src/identity/IdentityProviderHttpHandler.ts#L70">src/identity/IdentityProviderHttpHandler.ts:70</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="controls" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> controls</h3><div class="tsd-signature tsd-kind-icon">controls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L77">src/identity/IdentityProviderHttpHandler.ts:77</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="converter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> converter</h3><div class="tsd-signature tsd-kind-icon">converter<span class="tsd-signature-symbol">:</span> <a href="RepresentationConverter.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationConverter</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L73">src/identity/IdentityProviderHttpHandler.ts:73</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="errorHandler" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> error<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">error<wbr/>Handler<span class="tsd-signature-symbol">:</span> <a href="ErrorHandler.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorHandler</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L75">src/identity/IdentityProviderHttpHandler.ts:75</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="interactionCompleter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> interaction<wbr/>Completer</h3><div class="tsd-signature tsd-kind-icon">interaction<wbr/>Completer<span class="tsd-signature-symbol">:</span> <a href="InteractionCompleter.html" class="tsd-signature-type" data-tsd-kind="Class">InteractionCompleter</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L74">src/identity/IdentityProviderHttpHandler.ts:74</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="interactionRoutes" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> interaction<wbr/>Routes</h3><div class="tsd-signature tsd-kind-icon">interaction<wbr/>Routes<span class="tsd-signature-symbol">:</span> <a href="../interfaces/InteractionRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionRoute</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/216788e/src/identity/IdentityProviderHttpHandler.ts#L72">src/identity/IdentityProviderHttpHandler.ts:72</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="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/216788e/src/identity/IdentityProviderHttpHandler.ts#L68">src/identity/IdentityProviderHttpHandler.ts:68</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="../interfaces/ProviderFactory.html" class="tsd-signature-type" data-tsd-kind="Interface">ProviderFactory</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L71">src/identity/IdentityProviderHttpHandler.ts:71</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/OperationHttpHandlerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationHttpHandlerInput</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="OperationHttpHandler.html">OperationHttpHandler</a>.<a href="OperationHttpHandler.html#canHandle">canHandle</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/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 can be handled by this class.
|
|
If it cannot handle the input, rejects with an error explaining why.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="../interfaces/OperationHttpHandlerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationHttpHandlerInput</a></h5><div class="tsd-comment tsd-typography"><div><p>Input that could potentially be handled.</p>
|
|
</div></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><div><p>A promise resolving if the input can be handled, rejecting with an Error if not.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a name="findRoute" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> find<wbr/>Route</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">find<wbr/>Route<span class="tsd-signature-symbol">(</span>operation<span class="tsd-signature-symbol">: </span><a href="../interfaces/Operation.html" class="tsd-signature-type" data-tsd-kind="Interface">Operation</a>, oidcInteraction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Interaction</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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/InteractionRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionRoute</a><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/216788e/src/identity/IdentityProviderHttpHandler.ts#L150">src/identity/IdentityProviderHttpHandler.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Finds a route that supports the given request.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>operation: <a href="../interfaces/Operation.html" class="tsd-signature-type" data-tsd-kind="Interface">Operation</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> oidcInteraction: <span class="tsd-signature-type">Interaction</span></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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/InteractionRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionRoute</a><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-private"><a name="getRouteControls" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr/>Route<wbr/>Controls</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">get<wbr/>Route<wbr/>Controls<span class="tsd-signature-symbol">(</span>route<span class="tsd-signature-symbol">: </span><a href="../interfaces/InteractionRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionRoute</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</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/216788e/src/identity/IdentityProviderHttpHandler.ts#L238">src/identity/IdentityProviderHttpHandler.ts:238</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Converts the controls object of a route to one with full URLs.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>route: <a href="../interfaces/InteractionRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionRoute</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</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>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/OperationHttpHandlerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationHttpHandlerInput</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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="ResponseDescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="OperationHttpHandler.html">OperationHttpHandler</a>.<a href="OperationHttpHandler.html#handle">handle</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L100">src/identity/IdentityProviderHttpHandler.ts:100</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Finds the matching route and resolves the operation.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>__namedParameters: <a href="../interfaces/OperationHttpHandlerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationHttpHandlerInput</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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="ResponseDescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><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-private"><a name="handleInteractionResult" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> handle<wbr/>Interaction<wbr/>Result</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">handle<wbr/>Interaction<wbr/>Result<span class="tsd-signature-symbol">(</span>operation<span class="tsd-signature-symbol">: </span><a href="../interfaces/Operation.html" class="tsd-signature-type" data-tsd-kind="Interface">Operation</a>, request<span class="tsd-signature-symbol">: </span><a href="../modules.html#HttpRequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a>, result<span class="tsd-signature-symbol">: </span><a href="../modules.html#TemplatedInteractionResult" class="tsd-signature-type" data-tsd-kind="Type alias">TemplatedInteractionResult</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#InteractionHandlerResult" class="tsd-signature-type" data-tsd-kind="Type alias">InteractionHandlerResult</a><span class="tsd-signature-symbol">></span>, oidcInteraction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Interaction</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><a href="ResponseDescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><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/216788e/src/identity/IdentityProviderHttpHandler.ts#L168">src/identity/IdentityProviderHttpHandler.ts:168</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates a ResponseDescription based on the InteractionHandlerResult.
|
|
This will either be a redirect if type is "complete" or a data stream if the type is "response".</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>operation: <a href="../interfaces/Operation.html" class="tsd-signature-type" data-tsd-kind="Interface">Operation</a></h5></li><li><h5>request: <a href="../modules.html#HttpRequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a></h5></li><li><h5>result: <a href="../modules.html#TemplatedInteractionResult" class="tsd-signature-type" data-tsd-kind="Type alias">TemplatedInteractionResult</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#InteractionHandlerResult" class="tsd-signature-type" data-tsd-kind="Type alias">InteractionHandlerResult</a><span class="tsd-signature-symbol">></span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> oidcInteraction: <span class="tsd-signature-type">Interaction</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ResponseDescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><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-private"><a name="handleResponseResult" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> handle<wbr/>Response<wbr/>Result</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">handle<wbr/>Response<wbr/>Result<span class="tsd-signature-symbol">(</span>details<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, operation<span class="tsd-signature-symbol">: </span><a href="../interfaces/Operation.html" class="tsd-signature-type" data-tsd-kind="Interface">Operation</a>, templateFiles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span>, oidcInteraction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Interaction</span>, statusCode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</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><a href="ResponseDescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><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/216788e/src/identity/IdentityProviderHttpHandler.ts#L212">src/identity/IdentityProviderHttpHandler.ts:212</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Converts an InteractionResponseResult to a ResponseDescription by first converting to a Representation
|
|
and applying necessary conversions.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>details: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li><li><h5>operation: <a href="../interfaces/Operation.html" class="tsd-signature-type" data-tsd-kind="Interface">Operation</a></h5></li><li><h5>templateFiles: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> oidcInteraction: <span class="tsd-signature-type">Interaction</span></h5></li><li><h5>statusCode: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 200</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ResponseDescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><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/OperationHttpHandlerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationHttpHandlerInput</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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="ResponseDescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><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="OperationHttpHandler.html">OperationHttpHandler</a>.<a href="OperationHttpHandler.html#handleSafe">handleSafe</a></p><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/util/handlers/AsyncHandler.ts#L34">src/util/handlers/AsyncHandler.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Helper function that first runs <a href="IdentityProviderHttpHandler.html#canHandle">canHandle</a> followed by <a href="IdentityProviderHttpHandler.html#handle">handle</a>.
|
|
Throws the error of <a href="IdentityProviderHttpHandler.html#canHandle">canHandle</a> if the data cannot be handled,
|
|
or returns the result of <a href="IdentityProviderHttpHandler.html#handle">handle</a> otherwise.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <a href="../interfaces/OperationHttpHandlerInput.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationHttpHandlerInput</a></h5><div class="tsd-comment tsd-typography"><div><p>Input data that will be handled if it can be handled.</p>
|
|
</div></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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="ResponseDescription.html" class="tsd-signature-type" data-tsd-kind="Class">ResponseDescription</a><span class="tsd-signature-symbol">></span></h4><div><p>A promise resolving if the input can be handled, rejecting with an Error if not.</p>
|
|
</div></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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="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="IdentityProviderHttpHandler.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#baseUrl" class="tsd-kind-icon">base<wbr/>Url</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#controls" class="tsd-kind-icon">controls</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#converter" class="tsd-kind-icon">converter</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#errorHandler" class="tsd-kind-icon">error<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#interactionCompleter" class="tsd-kind-icon">interaction<wbr/>Completer</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#interactionRoutes" class="tsd-kind-icon">interaction<wbr/>Routes</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="IdentityProviderHttpHandler.html#logger" class="tsd-kind-icon">logger</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="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="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="IdentityProviderHttpHandler.html#findRoute" class="tsd-kind-icon">find<wbr/>Route</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#getRouteControls" class="tsd-kind-icon">get<wbr/>Route<wbr/>Controls</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="IdentityProviderHttpHandler.html#handle" class="tsd-kind-icon">handle</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#handleInteractionResult" class="tsd-kind-icon">handle<wbr/>Interaction<wbr/>Result</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="IdentityProviderHttpHandler.html#handleResponseResult" class="tsd-kind-icon">handle<wbr/>Response<wbr/>Result</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="IdentityProviderHttpHandler.html#handleSafe" class="tsd-kind-icon">handle<wbr/>Safe</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><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-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">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><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</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-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |