granicus.if.org Git - apache/blob - docs/manual/mod/mod_reflector.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   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
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  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.
  21 -->
  22
  23 <modulesynopsis metafile="mod_reflector.xml.meta">
  24
  25 <name>mod_reflector</name>
  26 <description>Reflect a request body as a response via the output filter stack.</description>
  27 <status>Base</status>
  28 <sourcefile>mod_reflector.c</sourcefile>
  29 <identifier>reflector_module</identifier>
  30 <compatibility>Version 2.3 and later</compatibility>
  31
  32 <summary>
  33     <p>This module allows request bodies to be reflected back to the
  34     client, in the process passing the request through the output filter
  35     stack. A suitably configured chain of filters can be used to transform
  36     the request into a response. This module can be used to turn an output
  37     filter into an HTTP service.</p>
  38 </summary>
  39
  40 <section id="examples"><title>Examples</title>
  41     <dl>
  42     <dt>Compression service</dt>
  43     <dd>Pass the request body through the DEFLATE filter to compress the
  44     body. This request requires a Content-Encoding request header containing
  45     "gzip" for the filter to return compressed data.
  46     <highlight language="config">
  47 &lt;Location "/compress"&gt;
  48     SetHandler reflector
  49     SetOutputFilter DEFLATE
  50 &lt;/Location&gt;
  51     </highlight>
  52     </dd>
  53
  54     <dt>Image downsampling service</dt>
  55     <dd>Pass the request body through an image downsampling filter, and reflect
  56     the results to the caller.
  57     <highlight language="config">
  58 &lt;Location "/downsample"&gt;
  59     SetHandler reflector
  60     SetOutputFilter DOWNSAMPLE
  61 &lt;/Location&gt;
  62     </highlight>
  63     </dd>
  64     </dl>
  65 </section>
  66
  67 <directivesynopsis>
  68 <name>ReflectorHeader</name>
  69 <description>Reflect an input header to the output headers</description>
  70 <syntax>ReflectorHeader <var>inputheader</var> <var>[outputheader]</var></syntax>
  71 <contextlist><context>server config</context><context>virtual host</context>
  72 <context>directory</context><context>.htaccess</context></contextlist>
  73 <override>Options</override>
  74
  75 <usage>
  76     <p>This directive controls the reflection of request headers to the response.
  77     The first argument is the name of the request header to copy. If the optional
  78     second argument is specified, it will be used as the name of the response
  79     header, otherwise the original request header name will be used.</p>
  80 </usage>
  81 </directivesynopsis>
  82
  83 </modulesynopsis>