File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/HTTPServlet/AbstractServlet.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::HTTPServlet::AbstractServlet - 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 class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#class-WEBrick::HTTPServlet::AbstractServlet-label-A+Simple+Servlet">A Simple Servlet</a>
<li><a href="#class-WEBrick::HTTPServlet::AbstractServlet-label-Servlet+Configuration">Servlet Configuration</a>
</ul>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../../Object.html">Object</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-get_instance">::get_instance</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-do_GET">#do_GET</a>
<li ><a href="#method-i-do_HEAD">#do_HEAD</a>
<li ><a href="#method-i-do_OPTIONS">#do_OPTIONS</a>
<li ><a href="#method-i-redirect_to_directory_uri">#redirect_to_directory_uri</a>
<li ><a href="#method-i-service">#service</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::HTTPServlet::AbstractServlet">
<h1 id="class-WEBrick::HTTPServlet::AbstractServlet" class="class">
class WEBrick::HTTPServlet::AbstractServlet
</h1>
<section class="description">
<p><a href="AbstractServlet.html"><code>AbstractServlet</code></a> allows HTTP server modules to be reused across multiple servers and allows encapsulation of functionality.</p>
<p>By default a servlet will respond to GET, HEAD (through an alias to GET) and OPTIONS requests.</p>
<p>By default a new servlet is initialized for every request. A servlet instance can be reused by overriding <a href="AbstractServlet.html#method-c-get_instance"><code>::get_instance</code></a> in the <a href="AbstractServlet.html"><code>AbstractServlet</code></a> subclass.</p>
<h2 id="class-WEBrick::HTTPServlet::AbstractServlet-label-A+Simple+Servlet">A Simple Servlet<span><a href="#class-WEBrick::HTTPServlet::AbstractServlet-label-A+Simple+Servlet">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">Simple</span> <span class="ruby-operator"><</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">AbstractServlet</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_GET</span> <span class="ruby-identifier">request</span>, <span class="ruby-identifier">response</span>
<span class="ruby-identifier">status</span>, <span class="ruby-identifier">content_type</span>, <span class="ruby-identifier">body</span> = <span class="ruby-identifier">do_stuff_with</span> <span class="ruby-identifier">request</span>
<span class="ruby-identifier">response</span>.<span class="ruby-identifier">status</span> = <span class="ruby-identifier">status</span>
<span class="ruby-identifier">response</span>[<span class="ruby-string">'Content-Type'</span>] = <span class="ruby-identifier">content_type</span>
<span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span> = <span class="ruby-identifier">body</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_stuff_with</span> <span class="ruby-identifier">request</span>
<span class="ruby-keyword">return</span> <span class="ruby-value">200</span>, <span class="ruby-string">'text/plain'</span>, <span class="ruby-string">'you got a page'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
<p>This servlet can be mounted on a server at a given path:</p>
<pre class="ruby"><span class="ruby-identifier">server</span>.<span class="ruby-identifier">mount</span> <span class="ruby-string">'/simple'</span>, <span class="ruby-constant">Simple</span>
</pre>
<h2 id="class-WEBrick::HTTPServlet::AbstractServlet-label-Servlet+Configuration">Servlet Configuration<span><a href="#class-WEBrick::HTTPServlet::AbstractServlet-label-Servlet+Configuration">¶</a> <a href="#top">↑</a></span></h2>
<p>Servlets can be configured via initialize. The first argument is the HTTP server the servlet is being initialized for.</p>
<pre>class Configurable < Simple
def initialize server, color, size
super server
@color = color
@size = size
end
def do_stuff_with request
content = "<p " \
%q{style="color: #{@color}; font-size: #{@size}"} \
">Hello, World!"
return 200, "text/html", content
end
end</pre>
<p>This servlet must be provided two arguments at mount time:</p>
<pre class="ruby"><span class="ruby-identifier">server</span>.<span class="ruby-identifier">mount</span> <span class="ruby-string">'/configurable'</span>, <span class="ruby-constant">Configurable</span>, <span class="ruby-string">'red'</span>, <span class="ruby-string">'2em'</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-get_instance" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_instance</span><span
class="method-args">(server, *options)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Factory for servlet instances that will handle a request from <code>server</code> using <code>options</code> from the mount point. By default a new servlet instance is created for every call.</p>
<div class="method-source-code" id="get_instance-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/abstract.rb, line 83</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">get_instance</span>(<span class="ruby-identifier">server</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">options</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">server</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">options</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, *options)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Initializes a new servlet for <code>server</code> using <code>options</code> which are stored as-is in +@options+. +@logger+ is also provided.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/abstract.rb, line 91</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">server</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">options</span>)
<span class="ruby-ivar">@server</span> = <span class="ruby-ivar">@config</span> = <span class="ruby-identifier">server</span>
<span class="ruby-ivar">@logger</span> = <span class="ruby-ivar">@server</span>[<span class="ruby-value">:Logger</span>]
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-do_GET" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_GET</span><span
class="method-args">(req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Raises a NotFound exception</p>
<div class="method-source-code" id="do_GET-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/abstract.rb, line 115</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_GET</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">NotFound</span>, <span class="ruby-string">"not found."</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-do_HEAD" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_HEAD</span><span
class="method-args">(req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Dispatches to <a href="AbstractServlet.html#method-i-do_GET"><code>do_GET</code></a></p>
<div class="method-source-code" id="do_HEAD-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/abstract.rb, line 122</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_HEAD</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">do_GET</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-do_OPTIONS" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_OPTIONS</span><span
class="method-args">(req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the allowed HTTP request methods</p>
<div class="method-source-code" id="do_OPTIONS-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/abstract.rb, line 129</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_OPTIONS</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">m</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">methods</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-regexp">/\Ado_([A-Z]+)\z/</span>) {<span class="ruby-node">$1</span>}
<span class="ruby-identifier">m</span>.<span class="ruby-identifier">sort!</span>
<span class="ruby-identifier">res</span>[<span class="ruby-string">"allow"</span>] = <span class="ruby-identifier">m</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">","</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-service" class="method-detail ">
<div class="method-heading">
<span class="method-name">service</span><span
class="method-args">(req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Dispatches to a <code>do_</code> method based on <code>req</code> if such a method is available. (<code>do_GET</code> for a GET request). Raises a MethodNotAllowed exception if the method is not implemented.</p>
<div class="method-source-code" id="service-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/abstract.rb, line 102</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">service</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">method_name</span> = <span class="ruby-string">"do_"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_method</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/-/</span>, <span class="ruby-string">"_"</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">method_name</span>)
<span class="ruby-identifier">__send__</span>(<span class="ruby-identifier">method_name</span>, <span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">MethodNotAllowed</span>,
<span class="ruby-node">"unsupported method `#{req.request_method}'."</span>
<span class="ruby-keyword">end</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-redirect_to_directory_uri" class="method-detail ">
<div class="method-heading">
<span class="method-name">redirect_to_directory_uri</span><span
class="method-args">(req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Redirects to a path ending in /</p>
<div class="method-source-code" id="redirect_to_directory_uri-source">
<pre><span class="ruby-comment"># File lib/webrick/httpservlet/abstract.rb, line 140</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">redirect_to_directory_uri</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">path</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">!=</span> <span class="ruby-value">?/</span>
<span class="ruby-identifier">location</span> = <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPUtils</span>.<span class="ruby-identifier">escape_path</span>(<span class="ruby-identifier">req</span>.<span class="ruby-identifier">path</span> <span class="ruby-operator">+</span> <span class="ruby-string">"/"</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">query_string</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">query_string</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-identifier">location</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"?"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">query_string</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">set_redirect</span>(<span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">MovedPermanently</span>, <span class="ruby-identifier">location</span>)
<span class="ruby-keyword">end</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>