%PDF- %PDF-
Direktori : /opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.10/rdoc/Rack/Auth/ |
Current File : //opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.10/rdoc/Rack/Auth/AbstractHandler.html |
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>class Rack::Auth::AbstractHandler - rack-2.2.10 Documentation</title> <script type="text/javascript"> var rdoc_rel_prefix = "../../"; var index_rel_prefix = "../../"; </script> <script src="../../js/navigation.js" defer></script> <script src="../../js/search.js" defer></script> <script src="../../js/search_index.js" defer></script> <script src="../../js/searcher.js" defer></script> <script src="../../js/darkfish.js" defer></script> <link href="../../css/fonts.css" rel="stylesheet"> <link href="../../css/rdoc.css" rel="stylesheet"> <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> <div id="home-section" role="region" title="Quick navigation" class="nav-section"> <h2> <a href="../../index.html" rel="home">Home</a> </h2> <div id="table-of-contents-navigation"> <a href="../../table_of_contents.html#pages">Pages</a> <a href="../../table_of_contents.html#classes">Classes</a> <a href="../../table_of_contents.html#methods">Methods</a> </div> </div> <div id="search-section" role="search" class="project-section initially-hidden"> <form action="#" method="get" accept-charset="utf-8"> <div id="search-field-wrapper"> <input id="search-field" role="combobox" aria-label="Search" aria-autocomplete="list" aria-controls="search-results" type="text" name="search" placeholder="Search" spellcheck="false" title="Type to search, Up and Down to navigate, Enter to load"> </div> <ul id="search-results" aria-label="Search Results" aria-busy="false" aria-expanded="false" aria-atomic="false" class="initially-hidden"></ul> </form> </div> </div> <div id="class-metadata"> <div id="parent-class-section" class="nav-section"> <h3>Parent</h3> <p class="link">Object </div> <!-- Method Quickref --> <div id="method-list-section" class="nav-section"> <h3>Methods</h3> <ul class="link-list" role="directory"> <li ><a href="#method-c-new">::new</a> <li ><a href="#method-i-bad_request">#bad_request</a> <li ><a href="#method-i-unauthorized">#unauthorized</a> </ul> </div> </div> </nav> <main role="main" aria-labelledby="class-Rack::Auth::AbstractHandler"> <h1 id="class-Rack::Auth::AbstractHandler" class="class"> class Rack::Auth::AbstractHandler </h1> <section class="description"> <p><a href="AbstractHandler.html"><code>Rack::Auth::AbstractHandler</code></a> implements common authentication functionality.</p> <p><code>realm</code> should be set for all handlers.</p> </section> <section id="5Buntitled-5D" class="documentation-section"> <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> <div id="attribute-i-realm" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">realm</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> </div> </div> </section> <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> <div id="method-c-new" class="method-detail "> <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(app, realm = nil, &authenticator)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/rack/auth/abstract/handler.rb, line 13</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">app</span>, <span class="ruby-identifier">realm</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">authenticator</span>) <span class="ruby-ivar">@app</span>, <span class="ruby-ivar">@realm</span>, <span class="ruby-ivar">@authenticator</span> = <span class="ruby-identifier">app</span>, <span class="ruby-identifier">realm</span>, <span class="ruby-identifier">authenticator</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> </section> <section id="private-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Private Instance Methods</h3> </header> <div id="method-i-bad_request" class="method-detail "> <div class="method-heading"> <span class="method-name">bad_request</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="bad_request-source"> <pre><span class="ruby-comment"># File lib/rack/auth/abstract/handler.rb, line 29</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bad_request</span> <span class="ruby-keyword">return</span> [ <span class="ruby-value">400</span>, { <span class="ruby-constant">CONTENT_TYPE</span> <span class="ruby-operator">=></span> <span class="ruby-string">'text/plain'</span>, <span class="ruby-constant">CONTENT_LENGTH</span> <span class="ruby-operator">=></span> <span class="ruby-string">'0'</span> }, [] ] <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-unauthorized" class="method-detail "> <div class="method-heading"> <span class="method-name">unauthorized</span><span class="method-args">(www_authenticate = challenge)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="unauthorized-source"> <pre><span class="ruby-comment"># File lib/rack/auth/abstract/handler.rb, line 20</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unauthorized</span>(<span class="ruby-identifier">www_authenticate</span> = <span class="ruby-identifier">challenge</span>) <span class="ruby-keyword">return</span> [ <span class="ruby-value">401</span>, { <span class="ruby-constant">CONTENT_TYPE</span> <span class="ruby-operator">=></span> <span class="ruby-string">'text/plain'</span>, <span class="ruby-constant">CONTENT_LENGTH</span> <span class="ruby-operator">=></span> <span class="ruby-string">'0'</span>, <span class="ruby-string">'WWW-Authenticate'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">www_authenticate</span>.<span class="ruby-identifier">to_s</span> }, [] ] <span class="ruby-keyword">end</span></pre> </div> </div> </div> </section> </section> </main> <footer id="validator-badges" role="contentinfo"> <p><a href="https://validator.w3.org/check/referer">Validate</a> <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. </footer>