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
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" /><link rel="stylesheet" type="text/css" href="./style/css/prettify.css" />
12 <script src="./style/scripts/prettify.js" type="text/javascript">
15 <link href="./images/favicon.ico" rel="shortcut icon" /></head>
16 <body id="manual-page"><div id="page-header">
17 <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>
18 <p class="apache">Apache HTTP Server Version 2.5</p>
19 <img alt="" src="./images/feather.gif" /></div>
20 <div class="up"><a href="./"><img title="<-" alt="<-" src="./images/left.gif" /></a></div>
22 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="./">Version 2.5</a></div><div id="page-content"><div id="preamble"><h1>Apache's Handler Use</h1>
24 <p><span>Available Languages: </span><a href="./en/handler.html" title="English"> en </a> |
25 <a href="./es/handler.html" hreflang="es" rel="alternate" title="Español"> es </a> |
26 <a href="./fr/handler.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
27 <a href="./ja/handler.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
28 <a href="./ko/handler.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
29 <a href="./tr/handler.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a> |
30 <a href="./zh-cn/handler.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese"> zh-cn </a></p>
33 <p>This document describes the use of Apache's Handlers.</p>
35 <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#definition">What is a Handler</a></li>
36 <li><img alt="" src="./images/down.gif" /> <a href="#examples">Examples</a></li>
37 <li><img alt="" src="./images/down.gif" /> <a href="#programmer">Programmer's Note</a></li>
39 <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
41 <h2><a name="definition" id="definition">What is a Handler</a></h2>
43 <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>
46 <p>A "handler" is an internal Apache representation of the
47 action to be performed when a file is called. Generally, files
48 have implicit handlers, based on the file type. Normally, all
49 files are simply served by the server, but certain file types
50 are "handled" separately.</p>
52 <p>Handlers may also be configured explicitly,
53 based on either filename extensions or on location,
54 without relation to file type. This is
55 advantageous both because it is a more elegant solution, and
56 because it also allows for both a type <strong>and</strong> a
57 handler to be associated with a file. (See also <a href="mod/mod_mime.html#multipleext">Files with Multiple
60 <p>Handlers can either be built into the server or included in
61 a module, or they can be added with the <code class="directive"><a href="./mod/mod_actions.html#action">Action</a></code> directive. The
62 built-in handlers in the standard distribution are as
66 <li><strong>default-handler</strong>: Send the file using the
67 <code>default_handler()</code>, which is the handler used by
68 default to handle static content. (core)</li>
70 <li><strong>send-as-is</strong>: Send file with HTTP headers
71 as is. (<code class="module"><a href="./mod/mod_asis.html">mod_asis</a></code>)</li>
73 <li><strong>cgi-script</strong>: Treat the file as a CGI
74 script. (<code class="module"><a href="./mod/mod_cgi.html">mod_cgi</a></code>)</li>
76 <li><strong>imap-file</strong>: Parse as an imagemap rule
77 file. (<code class="module"><a href="./mod/mod_imagemap.html">mod_imagemap</a></code>)</li>
79 <li><strong>server-info</strong>: Get the server's
80 configuration information. (<code class="module"><a href="./mod/mod_info.html">mod_info</a></code>)</li>
82 <li><strong>server-status</strong>: Get the server's status
83 report. (<code class="module"><a href="./mod/mod_status.html">mod_status</a></code>)</li>
85 <li><strong>type-map</strong>: Parse as a type map file for
86 content negotiation. (<code class="module"><a href="./mod/mod_negotiation.html">mod_negotiation</a></code>)</li>
88 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
90 <h2><a name="examples" id="examples">Examples</a></h2>
93 <h3><a name="example1" id="example1">Modifying static content using a CGI script</a></h3>
96 <p>The following directives will cause requests for files with
97 the <code>html</code> extension to trigger the launch of the
98 <code>footer.pl</code> CGI script.</p>
100 <div class="example"><p><code>
101 Action add-footer /cgi-bin/footer.pl<br />
102 AddHandler add-footer .html
105 <p>Then the CGI script is responsible for sending the
106 originally requested document (pointed to by the
107 <code>PATH_TRANSLATED</code> environment variable) and making
108 whatever modifications or additions are desired.</p>
111 <h3><a name="example2" id="example2">Files with HTTP headers</a></h3>
114 <p>The following directives will enable the
115 <code>send-as-is</code> handler, which is used for files which
116 contain their own HTTP headers. All files in the
117 <code>/web/htdocs/asis/</code> directory will be processed by
118 the <code>send-as-is</code> handler, regardless of their
119 filename extensions.</p>
121 <div class="example"><p><code>
122 <Directory /web/htdocs/asis><br />
123 <span class="indent">SetHandler send-as-is<br /></span>
128 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
129 <div class="section">
130 <h2><a name="programmer" id="programmer">Programmer's Note</a></h2>
133 <p>In order to implement the handler features, an addition has
134 been made to the <a href="developer/API.html">Apache API</a> that
135 you may wish to make use of. Specifically, a new record has
136 been added to the <code>request_rec</code> structure:</p>
138 <div class="example"><p><code>
142 <p>If you wish to have your module engage a handler, you need
143 only to set <code>r->handler</code> to the name of the
144 handler at any time prior to the <code>invoke_handler</code>
145 stage of the request. Handlers are implemented as they were
146 before, albeit using the handler name instead of a content
147 type. While it is not necessary, the naming convention for
148 handlers is to use a dash-separated word, with no slashes, so
149 as to not invade the media type name-space.</p>
151 <div class="bottomlang">
152 <p><span>Available Languages: </span><a href="./en/handler.html" title="English"> en </a> |
153 <a href="./es/handler.html" hreflang="es" rel="alternate" title="Español"> es </a> |
154 <a href="./fr/handler.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
155 <a href="./ja/handler.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
156 <a href="./ko/handler.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
157 <a href="./tr/handler.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a> |
158 <a href="./zh-cn/handler.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese"> zh-cn </a></p>
159 </div><div id="footer">
160 <p class="apache">Copyright 2012 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>
161 <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><script type="text/javascript">
162 if (typeof(prettyPrint) !== undefined) {