AuthBackend

internal

Allows to easily create high-performance full featured HTTP APIs from R
functions. Provides high-level classes such as 'Request', 'Response',
'Application', 'Middleware' in order to streamline server side
application development. Out of the box allows to serve requests using
'Rserve' package, but flexible enough to integrate with other HTTP servers
such as 'httpuv'.

Dmitriy Selivanov

RestRserve

A Framework for Building HTTP API

Dmitry Selivanov

Artem Klevtsov

David Zimmermann

rexy.ai 

AuthBackend function

<p><div class="r6-fields"></div></p><dl>
<dt><code>HTTPError</code></dt>
<dd><p>Class which raises HTTP errors.</p></dd><p></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/AuthBackend%24new()?package=RestRserve&version=1.2.3" data-mini-rdoc="RestRserve::AuthBackend$new()"><code>AuthBackend$new()</code></a></p></li>
<li><p><a href="/link/AuthBackend%24authenticate()?package=RestRserve&version=1.2.3" data-mini-rdoc="RestRserve::AuthBackend$authenticate()"><code>AuthBackend$authenticate()</code></a></p></li>
<li><p><a href="/link/AuthBackend%24clone()?package=RestRserve&version=1.2.3" data-mini-rdoc="RestRserve::AuthBackend$clone()"><code>AuthBackend$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-AuthBackend-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Creates AuthBackend class object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>AuthBackend$new(FUN, auth_header_prefix)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>FUN</code></dt>
<dd><p>Authentication handler function.</p></dd></dl></div></p><p>
<dt><code>auth_header_prefix</code></dt>
<dd><p>Authentication HTTP header prefix.</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-AuthBackend-authenticate"></a></p><div class="section" id="method-authenticate-">
<h3>Method <code>authenticate()</code></h3>
<p>This placeholder. It must be implemented in the subclass.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>AuthBackend$authenticate()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-AuthBackend-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>AuthBackend$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

Create AuthBackend — AuthBackend

<p><div class="r6-fields"></p><dl>
<dt><code>HTTPError</code></dt>
<dd><p>Class which raises HTTP errors.</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-AuthBackend-new'><code>AuthBackend$new()</code></a></p></li>
<li><p><a href='#method-AuthBackend-authenticate'><code>AuthBackend$authenticate()</code></a></p></li>
<li><p><a href='#method-AuthBackend-clone'><code>AuthBackend$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-AuthBackend-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Creates AuthBackend class object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>AuthBackend$new(FUN, auth_header_prefix)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>FUN</code></dt>
<dd><p>Authentication handler function.</p></dd>


<dt><code>auth_header_prefix</code></dt>
<dd><p>Authentication HTTP header prefix.</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-AuthBackend-authenticate"></a></p><div class='section' id='method-authenticate-'>
<h3>Method <code>authenticate()</code></h3>
<p>This placeholder. It must be implemented in the subclass.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>AuthBackend$authenticate()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-AuthBackend-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>AuthBackend$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


AuthBackend: Create AuthBackend

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `authenticate()`

Usage

Method `clone()`

Usage

Arguments

References

See Also

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method authenticate()

Usage

Method clone()

Usage

Arguments

References

See Also

Method `new()`

Method `authenticate()`

Method `clone()`