File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/HTTPServlet/FileHandler.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::HTTPServlet::FileHandler - RDoc 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"><a href="AbstractServlet.html">WEBrick::HTTPServlet::AbstractServlet</a>
</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-add_handler">::add_handler</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-remove_handler">::remove_handler</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::HTTPServlet::FileHandler">
<h1 id="class-WEBrick::HTTPServlet::FileHandler" class="class">
class WEBrick::HTTPServlet::FileHandler
</h1>
<section class="description">
<p>Serves a directory including fancy indexing and a variety of other options.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">server</span>.<span class="ruby-identifier">mount</span>(<span class="ruby-string">'/assets'</span>, <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPServlet</span><span class="ruby-operator">::</span><span class="ruby-constant">FileHandler</span>,
<span class="ruby-string">'/path/to/assets'</span>)
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-add_handler" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_handler</span><span
class="method-args">(suffix, handler)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Allow custom handling of requests for files with <code>suffix</code> by class <code>handler</code></p>
<div class="method-source-code" id="add_handler-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/filehandler.rb, line 182</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">add_handler</span>(<span class="ruby-identifier">suffix</span>, <span class="ruby-identifier">handler</span>)
<span class="ruby-constant">HandlerTable</span>[<span class="ruby-identifier">suffix</span>] = <span class="ruby-identifier">handler</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(server, root, options={}, default=Config::FileHandler)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a <a href="FileHandler.html"><code>FileHandler</code></a> servlet on <code>server</code> that serves files starting at directory <code>root</code></p>
<p><code>options</code> may be a <a href="../../Hash.html"><code>Hash</code></a> containing keys from WEBrick::Config::FileHandler or <code>true</code> or <code>false</code>.</p>
<p>If <code>options</code> is true or false then <code>:FancyIndexing</code> is enabled or disabled respectively.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/filehandler.rb, line 203</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">server</span>, <span class="ruby-identifier">root</span>, <span class="ruby-identifier">options</span>={}, <span class="ruby-identifier">default</span>=<span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">FileHandler</span>)
<span class="ruby-ivar">@config</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">config</span>
<span class="ruby-ivar">@logger</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-value">:Logger</span>]
<span class="ruby-ivar">@root</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">root</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>
<span class="ruby-identifier">options</span> = { <span class="ruby-value">:FancyIndexing</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">default</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-remove_handler" class="method-detail ">
<div class="method-heading">
<span class="method-name">remove_handler</span><span
class="method-args">(suffix)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Remove custom handling of requests for files with <code>suffix</code></p>
<div class="method-source-code" id="remove_handler-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/filehandler.rb, line 189</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">remove_handler</span>(<span class="ruby-identifier">suffix</span>)
<span class="ruby-constant">HandlerTable</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">suffix</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>