2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
4 <!-- $LastChangedRevision$ -->
7 Licensed to the Apache Software Foundation (ASF) under one or more
8 contributor license agreements. See the NOTICE file distributed with
9 this work for additional information regarding copyright ownership.
10 The ASF licenses this file to You under the Apache License, Version 2.0
11 (the "License"); you may not use this file except in compliance with
12 the License. You may obtain a copy of the License at
14 http://www.apache.org/licenses/LICENSE-2.0
16 Unless required by applicable law or agreed to in writing, software
17 distributed under the License is distributed on an "AS IS" BASIS,
18 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 See the License for the specific language governing permissions and
20 limitations under the License.
23 <modulesynopsis metafile="mod_request_body.xml.meta">
25 <name>request_body</name>
26 <description>Filters to handle and make available HTTP request bodies</description>
30 <name>KeptBodySize</name>
31 <description>Keep the request body instead of discarding it up to
32 the specified maximum size, for potential use by filters such as
33 mod_include.</description>
34 <syntax>KeptBodySize <var>maximum size in bytes</var></syntax>
35 <default>KeptBodySize 0</default>
36 <contextlist><context>directory</context>
40 <p>Under normal circumstances, request handlers such as the
41 default handler for static files will discard the request body
42 when it is not needed by the request handler. As a result,
43 filters such as mod_include are limited to making <code>GET</code> requests
44 only when including other URLs as subrequests, even if the
45 original request was a <code>POST</code> request, as the discarded
46 request body is no longer available once filter processing is
49 <p>When this directive has a value greater than zero, request
50 handlers that would otherwise discard request bodies will
51 instead set the request body aside for use by filters up to
52 the maximum size specified. In the case of the mod_include
53 filter, an attempt to <code>POST</code> a request to the static
54 shtml file will cause any subrequests to be <code>POST</code>
55 requests, instead of <code>GET</code> requests as before.</p>
57 <p>This feature makes it possible to break up complex web pages and
58 web applications into small individual components, and combine
59 the components and the surrounding web page structure together
60 using <module>mod_include</module>. The components can take the
61 form of CGI programs, scripted languages, or URLs reverse proxied
62 into the URL space from another server using
63 <module>mod_proxy</module>.</p>
65 <p><strong>Note:</strong> Each request set aside has to be set
66 aside in temporary RAM until the request is complete. As a result,
67 care should be taken to ensure sufficient RAM is available on the
68 server to support the intended load. Use of this directive
69 should be limited to where needed on targeted parts of your
70 URL space, and with the lowest possible value that is still big
71 enough to hold a request body.</p>
73 <p>If the request size sent by the client exceeds the maximum
74 size allocated by this directive, the server will return
75 <code>413 Request Entity Too Large</code>.</p>
79 <seealso><a href="mod_include.html">mod_include</a> documentation</seealso>
80 <seealso><a href="mod_auth_form.html">mod_auth_form</a> documentation</seealso>