RubyGems - webmachine - Versions diffs - 0.4.1 → 0.4.2 - Mend

webmachine 0.4.1 → 0.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (907) hide show

data/doc/Webmachine/Resource/Callbacks.html DELETED Viewed

@@ -1,3046 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Module: Webmachine::Resource::Callbacks
-    &mdash; Documentation by YARD 0.7.3
-</title>
-  <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
-  <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  relpath = '../..';
-  if (relpath != '') relpath += '/';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
-  </head>
-  <body>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    <div id="header">
-      <div id="menu">
-    <a href="../../_index.html">Index (C)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../../Webmachine.html" title="Webmachine (module)">Webmachine</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Resource</a></span></span>
-     &raquo;
-    <span class="title">Callbacks</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-    <a id="class_list_link" href="#">Class List</a>
-    <a id="method_list_link" href="#">Method List</a>
-    <a id="file_list_link" href="#">File List</a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Module: Webmachine::Resource::Callbacks
-</h1>
-<dl class="box">
-    <dt class="r1">Included in:</dt>
-    <dd class="r1"><span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Webmachine::Resource</a></span></dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/webmachine/resource/callbacks.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    These methods are the primary way your <span class='object_link'><a href="../Resource.html" title="Webmachine::Resource (class)">Webmachine::Resource</a></span>
-instance interacts with HTTP and the
-<span class='object_link'><a href="../Decision/FSM.html" title="Webmachine::Decision::FSM (class)">Decision::FSM</a></span>. Implementing a callback can change
-the portions of the graph that are made available to your
-application.
-  </div>
-</div>
-<div class="tags">
-</div>
-    <h2>
-      Instance Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#allow_missing_post%3F-instance_method" title="#allow_missing_post? (instance method)">- (true, false) <strong>allow_missing_post?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If the resource accepts POST requests to nonexistent resources,
-then this should return true.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#allowed_methods-instance_method" title="#allowed_methods (instance method)">- (Array&lt;String&gt;) <strong>allowed_methods</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>HTTP methods that are allowed on this resource.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#base_uri-instance_method" title="#base_uri (instance method)">- (String, ...) <strong>base_uri</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This will be called after <span class='object_link'><a href="#create_path-instance_method" title="Webmachine::Resource::Callbacks#create_path (method)">#create_path</a></span> but before setting the
-Location response header, and is used to determine the root
-URI of the new resource.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#charsets_provided-instance_method" title="#charsets_provided (instance method)">- (nil, Array) <strong>charsets_provided</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If this is anything other than nil, it must be an array of pairs
-where each pair is of the form Charset, Converter where Charset
-is a string naming a charset and Converter is an arity-1 method
-in the resource which will be called on the produced body in a
-GET and ensure that it is in Charset.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#content_types_accepted-instance_method" title="#content_types_accepted (instance method)">- (Array) <strong>content_types_accepted</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Similarly to content_types_provided, this should return an array
-of mediatype/handler pairs, except that it is for incoming
-resource representations -- for example, PUT requests.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#content_types_provided-instance_method" title="#content_types_provided (instance method)">- (Object) <strong>content_types_provided</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This should return an array of pairs where each pair is of the
-form [mediatype, :handler] where mediatype is a String of
-Content-Type format (or <span class='object_link'><a href="../MediaType.html" title="Webmachine::MediaType (class)">MediaType</a></span>) and :handler
-is a Symbol naming the method which can provide a resource
-representation in that media type.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#create_path-instance_method" title="#create_path (instance method)">- (String, URI) <strong>create_path</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This will be called on a POST request if post_is_create? returns
-true.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#delete_completed%3F-instance_method" title="#delete_completed? (instance method)">- (true, false) <strong>delete_completed?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This method is called after a successful call to
-<span class='object_link'><a href="#delete_resource-instance_method" title="Webmachine::Resource::Callbacks#delete_resource (method)">#delete_resource</a></span> and should return false if the deletion was
-accepted but cannot yet be guaranteed to have finished.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#delete_resource-instance_method" title="#delete_resource (instance method)">- (true, false) <strong>delete_resource</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This method is called when a DELETE request should be enacted,
-and should return true if the deletion succeeded.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#encodings_provided-instance_method" title="#encodings_provided (instance method)">- (Hash) <strong>encodings_provided</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This should return a hash of encodings mapped to encoding
-methods for Content-Encodings your resource wants to
-provide.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#expires-instance_method" title="#expires (instance method)">- (Time, ...) <strong>expires</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If the resource expires, this method should return the date/time
-it expires.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#finish_request-instance_method" title="#finish_request (instance method)">- (Object) <strong>finish_request</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This method is called just before the final response is
-constructed and sent.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#forbidden%3F-instance_method" title="#forbidden? (instance method)">- (true, false) <strong>forbidden?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Is the request or client forbidden? Returning a truthy value
-(true or non-nil) will result in a '403 Forbidden' response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#generate_etag-instance_method" title="#generate_etag (instance method)">- (String<sup>?</sup>) <strong>generate_etag</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If this returns a value, it will be used as the value of the
-ETag header and for comparison in conditional requests.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#is_authorized%3F-instance_method" title="#is_authorized? (instance method)">- (true, ...) <strong>is_authorized?</strong>(authorization_header = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Is the client or request authorized? Returning anything other than true
-will result in a '401 Unauthorized' response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#is_conflict%3F-instance_method" title="#is_conflict? (instance method)">- (true, false) <strong>is_conflict?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If this returns true, the client will receive a '409 Conflict'
-response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#known_content_type%3F-instance_method" title="#known_content_type? (instance method)">- (true, false) <strong>known_content_type?</strong>(content_type = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If the Content-Type on PUT or POST is unknown, this should
-return false, which will result in a '415 Unsupported Media
-Type' response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#known_methods-instance_method" title="#known_methods (instance method)">- (Array&lt;String&gt;) <strong>known_methods</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>HTTP methods that are known to the resource.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#language_chosen-instance_method" title="#language_chosen (instance method)">- (Object) <strong>language_chosen</strong>(lang) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This should receive the chosen language and do something with
-it that is resource-specific.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#languages_provided-instance_method" title="#languages_provided (instance method)">- (Array&lt;String&gt;) <strong>languages_provided</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This should return a list of language tags provided by the
-resource.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#last_modified-instance_method" title="#last_modified (instance method)">- (Time, ...) <strong>last_modified</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This method should return the last modified date/time of the
-resource which will be added as the Last-Modified header in the
-response and used in negotiating conditional requests.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#malformed_request%3F-instance_method" title="#malformed_request? (instance method)">- (true, false) <strong>malformed_request?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If the request is malformed, this should return true, which will
-result in a '400 Malformed Request' response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#moved_permanently%3F-instance_method" title="#moved_permanently? (instance method)">- (String, ...) <strong>moved_permanently?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If this resource has moved to a new location permanently, this
-method should return the new location as a String or
-URI.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#moved_temporarily%3F-instance_method" title="#moved_temporarily? (instance method)">- (String, ...) <strong>moved_temporarily?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If this resource has moved to a new location temporarily, this
-method should return the new location as a String or
-URI.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#multiple_choices%3F-instance_method" title="#multiple_choices? (instance method)">- (true, false) <strong>multiple_choices?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If this returns true, then it is assumed that multiple
-representations of the response are possible and a single one
-cannot be automatically chosen, so a 300 Multiple Choices will
-be sent instead of a 200.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#options-instance_method" title="#options (instance method)">- (Hash) <strong>options</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If the OPTIONS method is supported and is used, this method
-should return a Hash of headers that should appear in the
-response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#post_is_create%3F-instance_method" title="#post_is_create? (instance method)">- (true, false) <strong>post_is_create?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If POST requests should be treated as a request to put content
-into a (potentially new) resource as opposed to a generic
-submission for processing, then this method should return
-true.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#previously_existed%3F-instance_method" title="#previously_existed? (instance method)">- (true, false) <strong>previously_existed?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If this resource is known to have existed previously, this
-method should return true.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#process_post-instance_method" title="#process_post (instance method)">- (true, ...) <strong>process_post</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If post_is_create? returns false, then this will be called to
-process any POST request.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#resource_exists%3F-instance_method" title="#resource_exists? (instance method)">- (true, false) <strong>resource_exists?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Does the resource exist? Returning a falsey value (false or nil)
-will result in a '404 Not Found' response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#service_available%3F-instance_method" title="#service_available? (instance method)">- (true, false) <strong>service_available?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Is the resource available? Returning a falsey value (false or
-nil) will result in a '503 Service Not Available'
-response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#uri_too_long%3F-instance_method" title="#uri_too_long? (instance method)">- (true, false) <strong>uri_too_long?</strong>(uri = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If the URI is too long to be processed, this should return true,
-which will result in a '414 Request URI Too Long'
-response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#valid_content_headers%3F-instance_method" title="#valid_content_headers? (instance method)">- (true, false) <strong>valid_content_headers?</strong>(content_headers = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If the request includes any invalid Content-* headers, this
-should return false, which will result in a '501 Not
-Implemented' response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#valid_entity_length%3F-instance_method" title="#valid_entity_length? (instance method)">- (true, false) <strong>valid_entity_length?</strong>(length = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If the entity length on PUT or POST is invalid, this should
-return false, which will result in a '413 Request Entity Too
-Large' response.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#validate_content_checksum-instance_method" title="#validate_content_checksum (instance method)">- (true, ...) <strong>validate_content_checksum</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>This method is called when verifying the Content-MD5 header
-against the request body.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#variances-instance_method" title="#variances (instance method)">- (Array&lt;String&gt;) <strong>variances</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>If this method is implemented, it should return a list of
-strings with header names that should be included in a given
-response's Vary header.</div></span>
-</li>
-    </ul>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <p class="signature first" id="allow_missing_post?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>allow_missing_post?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If the resource accepts POST requests to nonexistent resources,
-then this should return true. Defaults to false.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether to accept POST requests to missing
-resources.</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-55
-56
-57</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 55</span>
-<span class='kw'>def</span> <span class='id allow_missing_post?'>allow_missing_post?</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="allowed_methods-instance_method">
-    - (<tt>Array&lt;String&gt;</tt>) <strong>allowed_methods</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    HTTP methods that are allowed on this resource. This must return
-an Array of Strings in all capitals. Defaults to ['GET','HEAD'].
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
-        &mdash;
-        <div class='inline'>allowed methods on this resource</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-125
-126
-127</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 125</span>
-<span class='kw'>def</span> <span class='id allowed_methods'>allowed_methods</span>
-  <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>HEAD</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="base_uri-instance_method">
-    - (<tt>String</tt>, ...) <strong>base_uri</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    This will be called after <span class='object_link'><a href="#create_path-instance_method" title="Webmachine::Resource::Callbacks#create_path (method)">#create_path</a></span> but before setting the
-Location response header, and is used to determine the root
-URI of the new resource. Default is nil, which uses the URI of
-the request as the base.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>, <tt>URI</tt>, <tt>nil</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-187
-188
-189</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 187</span>
-<span class='kw'>def</span> <span class='id base_uri'>base_uri</span>
-  <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="charsets_provided-instance_method">
-    - (<tt>nil</tt>, <tt>Array</tt>) <strong>charsets_provided</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If this is anything other than nil, it must be an array of pairs
-where each pair is of the form Charset, Converter where Charset
-is a string naming a charset and Converter is an arity-1 method
-in the resource which will be called on the produced body in a
-GET and ensure that it is in Charset.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>nil</tt>, <tt>Array</tt>)</span>
-        &mdash;
-        <div class='inline'>The provided character sets and encoder
-methods, or nothing.</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-234
-235
-236</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 234</span>
-<span class='kw'>def</span> <span class='id charsets_provided'>charsets_provided</span>
-  <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="content_types_accepted-instance_method">
-    - (<tt>Array</tt>) <strong>content_types_accepted</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    Similarly to content_types_provided, this should return an array
-of mediatype/handler pairs, except that it is for incoming
-resource representations -- for example, PUT requests. Handler
-functions usually want to use <span class='object_link'><a href="../Request.html#body-instance_method" title="Webmachine::Request#body (method)">Webmachine::Request#body</a></span> to access the
-incoming entity.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array</tt>)</span>
-        &mdash;
-        <div class='inline'>an array of mediatype/handler pairs</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-222
-223
-224</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 222</span>
-<span class='kw'>def</span> <span class='id content_types_accepted'>content_types_accepted</span>
-  <span class='lbracket'>[</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="content_types_provided-instance_method">
-    - (<tt>Object</tt>) <strong>content_types_provided</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    This should return an array of pairs where each pair is of the
-form [mediatype, :handler] where mediatype is a String of
-Content-Type format (or <span class='object_link'><a href="../MediaType.html" title="Webmachine::MediaType (class)">MediaType</a></span>) and :handler
-is a Symbol naming the method which can provide a resource
-representation in that media type. For example, if a client
-request includes an 'Accept' header with a value that does not
-appear as a first element in any of the return pairs, then a
-'406 Not Acceptable' will be sent.  Default is [['text/html',
-:to_html]].
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'></span>
-        <div class='inline'>an array of mediatype/handler pairs</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-211
-212
-213</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 211</span>
-<span class='kw'>def</span> <span class='id content_types_provided'>content_types_provided</span>
-  <span class='lbracket'>[</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>text/html</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:to_html</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="create_path-instance_method">
-    - (<tt>String</tt>, <tt>URI</tt>) <strong>create_path</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    This will be called on a POST request if post_is_create? returns
-true. The path returned should be a valid URI part following the
-dispatcher prefix. That path will replace the previous one in
-the return value of <span class='object_link'><a href="../Request.html#disp_path-instance_method" title="Webmachine::Request#disp_path (method)">Webmachine::Request#disp_path</a></span> for all subsequent
-resource function calls in the course of this request.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>, <tt>URI</tt>)</span>
-        &mdash;
-        <div class='inline'>the path to the new resource</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-177
-178
-179</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 177</span>
-<span class='kw'>def</span> <span class='id create_path'>create_path</span>
-  <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="delete_completed?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>delete_completed?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    This method is called after a successful call to
-<span class='object_link'><a href="#delete_resource-instance_method" title="Webmachine::Resource::Callbacks#delete_resource (method)">#delete_resource</a></span> and should return false if the deletion was
-accepted but cannot yet be guaranteed to have finished. Defaults
-to true.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the deletion completed</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-154
-155
-156</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 154</span>
-<span class='kw'>def</span> <span class='id delete_completed?'>delete_completed?</span>
-  <span class='kw'>true</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="delete_resource-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>delete_resource</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    This method is called when a DELETE request should be enacted,
-and should return true if the deletion succeeded. Defaults to false.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the deletion succeeded.</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-144
-145
-146</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 144</span>
-<span class='kw'>def</span> <span class='id delete_resource'>delete_resource</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="encodings_provided-instance_method">
-    - (<tt>Hash</tt>) <strong>encodings_provided</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    This should return a hash of encodings mapped to encoding
-methods for Content-Encodings your resource wants to
-provide. The encoding will be applied to the response body
-automatically by Webmachine. A number of built-in encodings
-are provided in the <span class='object_link'><a href="Encodings.html" title="Webmachine::Resource::Encodings (module)">Encodings</a></span> module. Default includes only
-the 'identity' encoding.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        &mdash;
-        <div class='inline'>a hash of encodings and encoder methods/procs</div>
-    </li>
-</ul>
-  <h3>See Also:</h3>
-  <ul class="see">
-      <li><span class='object_link'><a href="Encodings.html" title="Webmachine::Resource::Encodings (module)">Encodings</a></span></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-265
-266
-267</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 265</span>
-<span class='kw'>def</span> <span class='id encodings_provided'>encodings_provided</span>
-  <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>identity</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='symbol'>:encode_identity</span> <span class='rbrace'>}</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="expires-instance_method">
-    - (<tt>Time</tt>, ...) <strong>expires</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If the resource expires, this method should return the date/time
-it expires. Default is nil.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Time</tt>, <tt>DateTime</tt>, <tt>Date</tt>, <tt>nil</tt>)</span>
-        &mdash;
-        <div class='inline'>the expiration time</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-344
-345
-346</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 344</span>
-<span class='kw'>def</span> <span class='id expires'>expires</span>
-  <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="finish_request-instance_method">
-    - (<tt>Object</tt>) <strong>finish_request</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    This method is called just before the final response is
-constructed and sent. The return value is ignored, so any effect
-of this method must be by modifying the response.
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-361</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 361</span>
-<span class='kw'>def</span> <span class='id finish_request'>finish_request</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="forbidden?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>forbidden?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    Is the request or client forbidden? Returning a truthy value
-(true or non-nil) will result in a '403 Forbidden' response.
-Defaults to false.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the client or request is forbidden.</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-46
-47
-48</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 46</span>
-<span class='kw'>def</span> <span class='id forbidden?'>forbidden?</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="generate_etag-instance_method">
-    - (<tt>String</tt><sup>?</sup>) <strong>generate_etag</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If this returns a value, it will be used as the value of the
-ETag header and for comparison in conditional requests. Default
-is nil.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
-        &mdash;
-        <div class='inline'>the entity tag for this resource</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-353
-354
-355</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 353</span>
-<span class='kw'>def</span> <span class='id generate_etag'>generate_etag</span>
-  <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="is_authorized?-instance_method">
-    - (<tt>true</tt>, ...) <strong>is_authorized?</strong>(authorization_header = nil)
-</p><div class="docstring">
-  <div class="discussion">
-    Is the client or request authorized? Returning anything other than true
-will result in a '401 Unauthorized' response.  Defaults to
-true. If a String is returned, it will be used as the value in
-the WWW-Authenticate header, which can also be set manually.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>authorization_header</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>The contents of the
-'Authorization' header sent by the client, if present.</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>, <tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the client is authorized,
-and if not, the WWW-Authenticate header when a String.</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-37
-38
-39</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 37</span>
-<span class='kw'>def</span> <span class='id is_authorized?'>is_authorized?</span><span class='lparen'>(</span><span class='id authorization_header'>authorization_header</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='kw'>true</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="is_conflict?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>is_conflict?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If this returns true, the client will receive a '409 Conflict'
-response. This is only called for PUT requests. Default is false.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>whether the submitted entity is in conflict
-with the current state of the resource</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-287
-288
-289</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 287</span>
-<span class='kw'>def</span> <span class='id is_conflict?'>is_conflict?</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="known_content_type?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>known_content_type?</strong>(content_type = nil)
-</p><div class="docstring">
-  <div class="discussion">
-    If the Content-Type on PUT or POST is unknown, this should
-return false, which will result in a '415 Unsupported Media
-Type' response. Defaults to true.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>content_type</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>the 'Content-Type' header sent by
-the client</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the passed media type is known or
-accepted</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-85
-86
-87</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 85</span>
-<span class='kw'>def</span> <span class='id known_content_type?'>known_content_type?</span><span class='lparen'>(</span><span class='id content_type'>content_type</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='kw'>true</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="known_methods-instance_method">
-    - (<tt>Array&lt;String&gt;</tt>) <strong>known_methods</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    HTTP methods that are known to the resource. Like
-<span class='object_link'><a href="#allowed_methods-instance_method" title="Webmachine::Resource::Callbacks#allowed_methods (method)">#allowed_methods</a></span>, this must return an Array of Strings in
-all capitals. Default includes all standard HTTP methods. One
-could override this callback to  allow additional methods,
-e.g. WebDAV.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
-        &mdash;
-        <div class='inline'>known methods</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-136
-137
-138</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 136</span>
-<span class='kw'>def</span> <span class='id known_methods'>known_methods</span>
-  <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GET</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>HEAD</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>POST</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>PUT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>TRACE</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>CONNECT</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>OPTIONS</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="language_chosen-instance_method">
-    - (<tt>Object</tt>) <strong>language_chosen</strong>(lang)
-</p><div class="docstring">
-  <div class="discussion">
-    This should receive the chosen language and do something with
-it that is resource-specific. The default is to store the
-value in the @language instance variable.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>lang</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>the negotiated language</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-252
-253
-254</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 252</span>
-<span class='kw'>def</span> <span class='id language_chosen'>language_chosen</span><span class='lparen'>(</span><span class='id lang'>lang</span><span class='rparen'>)</span>
-  <span class='ivar'>@language</span> <span class='op'>=</span> <span class='id lang'>lang</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="languages_provided-instance_method">
-    - (<tt>Array&lt;String&gt;</tt>) <strong>languages_provided</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    This should return a list of language tags provided by the
-resource. Default is the empty Array, in which the content is
-in no specific language.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
-        &mdash;
-        <div class='inline'>a list of provided languages</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-243
-244
-245</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 243</span>
-<span class='kw'>def</span> <span class='id languages_provided'>languages_provided</span>
-  <span class='lbracket'>[</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="last_modified-instance_method">
-    - (<tt>Time</tt>, ...) <strong>last_modified</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    This method should return the last modified date/time of the
-resource which will be added as the Last-Modified header in the
-response and used in negotiating conditional requests. Default
-is nil.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Time</tt>, <tt>DateTime</tt>, <tt>Date</tt>, <tt>nil</tt>)</span>
-        &mdash;
-        <div class='inline'>the last modified time</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-336
-337
-338</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 336</span>
-<span class='kw'>def</span> <span class='id last_modified'>last_modified</span>
-  <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="malformed_request?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>malformed_request?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If the request is malformed, this should return true, which will
-result in a '400 Malformed Request' response. Defaults to false.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the request is malformed.</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-63
-64
-65</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 63</span>
-<span class='kw'>def</span> <span class='id malformed_request?'>malformed_request?</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="moved_permanently?-instance_method">
-    - (<tt>String</tt>, ...) <strong>moved_permanently?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If this resource has moved to a new location permanently, this
-method should return the new location as a String or
-URI. Default is to return false.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>, <tt>URI</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>the new location of the resource, or
-false</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-316
-317
-318</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 316</span>
-<span class='kw'>def</span> <span class='id moved_permanently?'>moved_permanently?</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="moved_temporarily?-instance_method">
-    - (<tt>String</tt>, ...) <strong>moved_temporarily?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If this resource has moved to a new location temporarily, this
-method should return the new location as a String or
-URI. Default is to return false.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>, <tt>URI</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>the new location of the resource, or
-false</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-326
-327
-328</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 326</span>
-<span class='kw'>def</span> <span class='id moved_temporarily?'>moved_temporarily?</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="multiple_choices?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>multiple_choices?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If this returns true, then it is assumed that multiple
-representations of the response are possible and a single one
-cannot be automatically chosen, so a 300 Multiple Choices will
-be sent instead of a 200. Default is false.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>whether the multiple representations are
-possible</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-298
-299
-300</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 298</span>
-<span class='kw'>def</span> <span class='id multiple_choices?'>multiple_choices?</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="options-instance_method">
-    - (<tt>Hash</tt>) <strong>options</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If the OPTIONS method is supported and is used, this method
-should return a Hash of headers that should appear in the
-response. Defaults to {}.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        &mdash;
-        <div class='inline'>headers to appear in the response</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-117
-118
-119</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 117</span>
-<span class='kw'>def</span> <span class='id options'>options</span>
-  <span class='lbrace'>{</span><span class='rbrace'>}</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="post_is_create?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>post_is_create?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If POST requests should be treated as a request to put content
-into a (potentially new) resource as opposed to a generic
-submission for processing, then this method should return
-true. If it does return true, then <span class='object_link'><a href="#create_path-instance_method" title="Webmachine::Resource::Callbacks#create_path (method)">#create_path</a></span> will be called
-and the rest of the request will be treated much like a PUT to
-the path returned by that call.  Default is false.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether POST creates a new resource</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-166
-167
-168</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 166</span>
-<span class='kw'>def</span> <span class='id post_is_create?'>post_is_create?</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="previously_existed?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>previously_existed?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If this resource is known to have existed previously, this
-method should return true. Default is false.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>whether the resource existed previously</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-306
-307
-308</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 306</span>
-<span class='kw'>def</span> <span class='id previously_existed?'>previously_existed?</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="process_post-instance_method">
-    - (<tt>true</tt>, ...) <strong>process_post</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If post_is_create? returns false, then this will be called to
-process any POST request. If it succeeds, it should return true.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>, <tt>Fixnum</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the POST was successfully
-processed, or an alternate response code</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-196
-197
-198</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 196</span>
-<span class='kw'>def</span> <span class='id process_post'>process_post</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="resource_exists?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>resource_exists?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    Does the resource exist? Returning a falsey value (false or nil)
-will result in a '404 Not Found' response. Defaults to true.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the resource exists</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-13
-14
-15</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 13</span>
-<span class='kw'>def</span> <span class='id resource_exists?'>resource_exists?</span>
-  <span class='kw'>true</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="service_available?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>service_available?</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    Is the resource available? Returning a falsey value (false or
-nil) will result in a '503 Service Not Available'
-response. Defaults to true.  If the resource is only temporarily
-not available, add a 'Retry-After' response header in the body
-of the method.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-24
-25
-26</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 24</span>
-<span class='kw'>def</span> <span class='id service_available?'>service_available?</span>
-  <span class='kw'>true</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="uri_too_long?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>uri_too_long?</strong>(uri = nil)
-</p><div class="docstring">
-  <div class="discussion">
-    If the URI is too long to be processed, this should return true,
-which will result in a '414 Request URI Too Long'
-response. Defaults to false.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>uri</span>
-        <span class='type'>(<tt>URI</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>the request URI</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the request URI is too long.</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-73
-74
-75</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 73</span>
-<span class='kw'>def</span> <span class='id uri_too_long?'>uri_too_long?</span><span class='lparen'>(</span><span class='id uri'>uri</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='kw'>false</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="valid_content_headers?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>valid_content_headers?</strong>(content_headers = nil)
-</p><div class="docstring">
-  <div class="discussion">
-    If the request includes any invalid Content-* headers, this
-should return false, which will result in a '501 Not
-Implemented' response. Defaults to false.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>content_headers</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>Request headers that begin with
-'Content-'</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the Content-* headers are invalid
-or unsupported</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-97
-98
-99</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 97</span>
-<span class='kw'>def</span> <span class='id valid_content_headers?'>valid_content_headers?</span><span class='lparen'>(</span><span class='id content_headers'>content_headers</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='kw'>true</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="valid_entity_length?-instance_method">
-    - (<tt>true</tt>, <tt>false</tt>) <strong>valid_entity_length?</strong>(length = nil)
-</p><div class="docstring">
-  <div class="discussion">
-    If the entity length on PUT or POST is invalid, this should
-return false, which will result in a '413 Request Entity Too
-Large' response. Defaults to true.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>length</span>
-        <span class='type'>(<tt>Fixnum</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>the size of the request body (entity)</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the body is a valid length (not too
-large)</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-108
-109
-110</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 108</span>
-<span class='kw'>def</span> <span class='id valid_entity_length?'>valid_entity_length?</span><span class='lparen'>(</span><span class='id length'>length</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='kw'>true</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="validate_content_checksum-instance_method">
-    - (<tt>true</tt>, ...) <strong>validate_content_checksum</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    This method is called when verifying the Content-MD5 header
-against the request body. To do your own validation, implement
-it in this callback, returning true or false. To bypass header
-validation, simply return true.  Default is nil, which will
-invoke Webmachine's default validation.
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>true</tt>, <tt>false</tt>, <tt>nil</tt>)</span>
-        &mdash;
-        <div class='inline'>Whether the Content-MD5 header
-validates against the request body</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-371
-372
-373</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 371</span>
-<span class='kw'>def</span> <span class='id validate_content_checksum'>validate_content_checksum</span>
-  <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="variances-instance_method">
-    - (<tt>Array&lt;String&gt;</tt>) <strong>variances</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    If this method is implemented, it should return a list of
-strings with header names that should be included in a given
-response's Vary header. The standard conneg headers (Accept,
-Accept-Encoding, Accept-Charset, Accept-Language) do not need to
-be specified here as Webmachine will add the correct elements of
-those automatically depending on resource behavior. Default is
-[].
-  </div>
-</div>
-<div class="tags">
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
-        &mdash;
-        <div class='inline'>a list of variance headers</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-278
-279
-280</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/resource/callbacks.rb', line 278</span>
-<span class='kw'>def</span> <span class='id variances'>variances</span>
-  <span class='lbracket'>[</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Wed Jan  4 08:47:41 2012 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.3 (ruby-1.9.3).
-</div>
-  </body>
-</html>