← Back to branch summary

~ubuntu-branches/ubuntu/feisty/apache2/feisty

« back to all changes in this revision

Viewing changes to docs/manual/handler.html.en

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Barth
  • Date: 2006-12-09 21:05:45 UTC
  • mfrom: (0.6.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061209210545-h70s0xaqc2v8vqr2
Tags: 2.2.3-3.2
http://bugs.debian.org/396265
* Non-maintainer upload.
* 043_ajp_connection_reuse: Patch from upstream Bugzilla, fixing a critical
  issue with regard to connection reuse in mod_proxy_ajp.
  Closes: #396265

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/manual/handler.html.en
 
1
<?xml version="1.0" encoding="ISO-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
 
4
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
5
              This file is generated from xml source: DO NOT EDIT
 
6
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
7
      -->
 
8
<title>Apache's Handler Use - Apache HTTP Server</title>
 
9
<link href="./style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
 
10
<link href="./style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
 
11
<link href="./style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
 
12
<link href="./images/favicon.ico" rel="shortcut icon" /></head>
 
13
<body id="manual-page"><div id="page-header">
 
14
<p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/directives.html">Directives</a> | <a href="./faq/">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p>
 
15
<p class="apache">Apache HTTP Server Version 2.2</p>
 
16
<img alt="" src="./images/feather.gif" /></div>
 
17
<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="./images/left.gif" /></a></div>
 
18
<div id="path">
 
19
<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="./">Version 2.2</a></div><div id="page-content"><div id="preamble"><h1>Apache's Handler Use</h1>
 
20
<div class="toplang">
 
21
<p><span>Available Languages: </span><a href="./en/handler.html" title="English">&nbsp;en&nbsp;</a> |
 
22
<a href="./es/handler.html" hreflang="es" rel="alternate" title="Espa�ol">&nbsp;es&nbsp;</a> |
 
23
<a href="./ja/handler.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 
24
<a href="./ko/handler.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 
25
<a href="./ru/handler.html" hreflang="ru" rel="alternate" title="Russian">&nbsp;ru&nbsp;</a></p>
 
26
</div>
 
27
 
 
28
    <p>This document describes the use of Apache's Handlers.</p>
 
29
  </div>
 
30
<div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#definition">What is a Handler</a></li>
 
31
<li><img alt="" src="./images/down.gif" /> <a href="#examples">Examples</a></li>
 
32
<li><img alt="" src="./images/down.gif" /> <a href="#programmer">Programmer's Note</a></li>
 
33
</ul></div>
 
34
<div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 
35
<div class="section">
 
36
<h2><a name="definition" id="definition">What is a Handler</a></h2>
 
37
    
 
38
    <table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="./mod/mod_actions.html">mod_actions</a></code></li><li><code class="module"><a href="./mod/mod_asis.html">mod_asis</a></code></li><li><code class="module"><a href="./mod/mod_cgi.html">mod_cgi</a></code></li><li><code class="module"><a href="./mod/mod_imagemap.html">mod_imagemap</a></code></li><li><code class="module"><a href="./mod/mod_info.html">mod_info</a></code></li><li><code class="module"><a href="./mod/mod_mime.html">mod_mime</a></code></li><li><code class="module"><a href="./mod/mod_negotiation.html">mod_negotiation</a></code></li><li><code class="module"><a href="./mod/mod_status.html">mod_status</a></code></li></ul></td><td><ul><li><code class="directive"><a href="./mod/mod_actions.html#action">Action</a></code></li><li><code class="directive"><a href="./mod/mod_mime.html#addhandler">AddHandler</a></code></li><li><code class="directive"><a href="./mod/mod_mime.html#removehandler">RemoveHandler</a></code></li><li><code class="directive"><a href="./mod/core.html#sethandler">SetHandler</a></code></li></ul></td></tr></table>
 
39
 
 
40
 
 
41
    <p>A "handler" is an internal Apache representation of the
 
42
    action to be performed when a file is called. Generally, files
 
43
    have implicit handlers, based on the file type. Normally, all
 
44
    files are simply served by the server, but certain file types
 
45
    are "handled" separately.</p>
 
46
 
 
47
    <p>Handlers may also be configured explicitly, 
 
48
    based on either filename extensions or on location, 
 
49
    without relation to file type. This is
 
50
    advantageous both because it is a more elegant solution, and
 
51
    because it also allows for both a type <strong>and</strong> a
 
52
    handler to be associated with a file. (See also <a href="mod/mod_mime.html#multipleext">Files with Multiple
 
53
    Extensions</a>.)</p>
 
54
 
 
55
    <p>Handlers can either be built into the server or included in
 
56
    a module, or they can be added with the <code class="directive"><a href="./mod/mod_actions.html#action">Action</a></code> directive. The
 
57
    built-in handlers in the standard distribution are as
 
58
    follows:</p>
 
59
 
 
60
    <ul>
 
61
      <li><strong>default-handler</strong>: Send the file using the
 
62
      <code>default_handler()</code>, which is the handler used by
 
63
      default to handle static content. (core)</li>
 
64
 
 
65
      <li><strong>send-as-is</strong>: Send file with HTTP headers
 
66
      as is. (<code class="module"><a href="./mod/mod_asis.html">mod_asis</a></code>)</li>
 
67
 
 
68
      <li><strong>cgi-script</strong>: Treat the file as a CGI
 
69
      script. (<code class="module"><a href="./mod/mod_cgi.html">mod_cgi</a></code>)</li>
 
70
 
 
71
      <li><strong>imap-file</strong>: Parse as an imagemap rule
 
72
      file. (<code class="module"><a href="./mod/mod_imagemap.html">mod_imagemap</a></code>)</li>
 
73
 
 
74
      <li><strong>server-info</strong>: Get the server's
 
75
      configuration information. (<code class="module"><a href="./mod/mod_info.html">mod_info</a></code>)</li>
 
76
 
 
77
      <li><strong>server-status</strong>: Get the server's status
 
78
      report. (<code class="module"><a href="./mod/mod_status.html">mod_status</a></code>)</li>
 
79
 
 
80
      <li><strong>type-map</strong>: Parse as a type map file for
 
81
      content negotiation. (<code class="module"><a href="./mod/mod_negotiation.html">mod_negotiation</a></code>)</li>
 
82
    </ul>
 
83
  </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 
84
<div class="section">
 
85
<h2><a name="examples" id="examples">Examples</a></h2>
 
86
    
 
87
 
 
88
    <h3><a name="example1" id="example1">Modifying static content using a CGI script</a></h3>
 
89
      
 
90
 
 
91
      <p>The following directives will cause requests for files with
 
92
      the <code>html</code> extension to trigger the launch of the
 
93
      <code>footer.pl</code> CGI script.</p>
 
94
 
 
95
      <div class="example"><p><code>
 
96
        Action add-footer /cgi-bin/footer.pl<br />
 
97
        AddHandler add-footer .html
 
98
      </code></p></div>
 
99
 
 
100
      <p>Then the CGI script is responsible for sending the
 
101
      originally requested document (pointed to by the
 
102
      <code>PATH_TRANSLATED</code> environment variable) and making
 
103
      whatever modifications or additions are desired.</p>
 
104
 
 
105
    
 
106
    <h3><a name="example2" id="example2">Files with HTTP headers</a></h3>
 
107
      
 
108
 
 
109
      <p>The following directives will enable the
 
110
      <code>send-as-is</code> handler, which is used for files which
 
111
      contain their own HTTP headers. All files in the
 
112
      <code>/web/htdocs/asis/</code> directory will be processed by
 
113
      the <code>send-as-is</code> handler, regardless of their
 
114
      filename extensions.</p>
 
115
 
 
116
      <div class="example"><p><code>
 
117
        &lt;Directory /web/htdocs/asis&gt;<br />
 
118
        SetHandler send-as-is<br />
 
119
        &lt;/Directory&gt;
 
120
      </code></p></div>
 
121
 
 
122
    
 
123
  </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 
124
<div class="section">
 
125
<h2><a name="programmer" id="programmer">Programmer's Note</a></h2>
 
126
    
 
127
 
 
128
    <p>In order to implement the handler features, an addition has
 
129
    been made to the <a href="developer/API.html">Apache API</a> that
 
130
    you may wish to make use of. Specifically, a new record has
 
131
    been added to the <code>request_rec</code> structure:</p>
 
132
 
 
133
    <div class="example"><p><code>
 
134
      char *handler
 
135
    </code></p></div>
 
136
 
 
137
    <p>If you wish to have your module engage a handler, you need
 
138
    only to set <code>r-&gt;handler</code> to the name of the
 
139
    handler at any time prior to the <code>invoke_handler</code>
 
140
    stage of the request. Handlers are implemented as they were
 
141
    before, albeit using the handler name instead of a content
 
142
    type. While it is not necessary, the naming convention for
 
143
    handlers is to use a dash-separated word, with no slashes, so
 
144
    as to not invade the media type name-space.</p>
 
145
  </div></div>
 
146
<div class="bottomlang">
 
147
<p><span>Available Languages: </span><a href="./en/handler.html" title="English">&nbsp;en&nbsp;</a> |
 
148
<a href="./es/handler.html" hreflang="es" rel="alternate" title="Espa�ol">&nbsp;es&nbsp;</a> |
 
149
<a href="./ja/handler.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 
150
<a href="./ko/handler.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 
151
<a href="./ru/handler.html" hreflang="ru" rel="alternate" title="Russian">&nbsp;ru&nbsp;</a></p>
 
152
</div><div id="footer">
 
153
<p class="apache">Copyright 2006 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 
154
<p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/directives.html">Directives</a> | <a href="./faq/">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p></div>
 
155
</body></html>
 
 
b'\\ No newline at end of file'