| 1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
|---|
| 2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|---|
| 3 |
"DTD/xhtml1-transitional.dtd"> |
|---|
| 4 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 5 |
<head> |
|---|
| 6 |
<title>cherrypy.lib.filter.baseurlfilter.BaseUrlFilter</title> |
|---|
| 7 |
<link rel="stylesheet" href="epydoc.css" type="text/css"></link> |
|---|
| 8 |
</head> |
|---|
| 9 |
<body bgcolor="white" text="black" link="blue" vlink="#204080" |
|---|
| 10 |
alink="#204080"> |
|---|
| 11 |
|
|---|
| 12 |
<!-- =========== START OF NAVBAR =========== --> |
|---|
| 13 |
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> |
|---|
| 14 |
<tr valign="center"> |
|---|
| 15 |
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> |
|---|
| 16 |
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th> |
|---|
| 17 |
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th> |
|---|
| 18 |
<th class="navbar" align="right" width="100%"> |
|---|
| 19 |
<table border="0" cellpadding="0" cellspacing="0"> |
|---|
| 20 |
<tr><th class="navbar" align="center"> |
|---|
| 21 |
<p class="nomargin"> |
|---|
| 22 |
<a class="navbar" target="_top" href="http://www.turbogears.org">TurboGears</a> |
|---|
| 23 |
</p></th></tr></table> |
|---|
| 24 |
</th> |
|---|
| 25 |
</tr> |
|---|
| 26 |
</table> |
|---|
| 27 |
<table width="100%" cellpadding="0" cellspacing="0"> |
|---|
| 28 |
<tr valign="top"> |
|---|
| 29 |
<td width="100%"> |
|---|
| 30 |
<font size="-1"><b class="breadcrumbs"> |
|---|
| 31 |
<a href="cherrypy-module.html">Package cherrypy</a> :: |
|---|
| 32 |
<a href="cherrypy.lib-module.html">Package lib</a> :: |
|---|
| 33 |
<a href="cherrypy.lib.filter-module.html">Package filter</a> :: |
|---|
| 34 |
<a href="cherrypy.lib.filter.baseurlfilter-module.html">Module baseurlfilter</a> :: |
|---|
| 35 |
Class BaseUrlFilter |
|---|
| 36 |
</b></font></br> |
|---|
| 37 |
</td> |
|---|
| 38 |
<td><table cellpadding="0" cellspacing="0"> |
|---|
| 39 |
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="cherrypy.lib.filter.baseurlfilter.BaseUrlFilter-class.html" target="_top">no frames</a>]</font></td></tr> |
|---|
| 40 |
</table></td> |
|---|
| 41 |
</tr></table> |
|---|
| 42 |
|
|---|
| 43 |
<!-- =========== START OF CLASS DESCRIPTION =========== --> |
|---|
| 44 |
<h2 class="class">Type BaseUrlFilter</h2> |
|---|
| 45 |
|
|---|
| 46 |
<pre class="base-tree"> |
|---|
| 47 |
<a href="__builtin__.object-class.html"><code>object</code></a> --+ |
|---|
| 48 |
| |
|---|
| 49 |
<a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html"><code>BaseFilter</code></a> --+ |
|---|
| 50 |
| |
|---|
| 51 |
<b>BaseUrlFilter</b> |
|---|
| 52 |
</pre><br /> |
|---|
| 53 |
|
|---|
| 54 |
<hr/> |
|---|
| 55 |
|
|---|
| 56 |
<p>Filter that changes the base URL.</p> |
|---|
| 57 |
Useful when running a CP server behind Apache. |
|---|
| 58 |
<hr/> |
|---|
| 59 |
|
|---|
| 60 |
|
|---|
| 61 |
<!-- =========== START OF METHOD SUMMARY =========== --> |
|---|
| 62 |
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> |
|---|
| 63 |
<tr bgcolor="#70b0f0" class="summary"> |
|---|
| 64 |
<th colspan="2">Method Summary</th></tr> |
|---|
| 65 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 66 |
<td><code><span class="summary-sig"><a href="cherrypy.lib.filter.baseurlfilter.BaseUrlFilter-class.html#beforeRequestBody" class="summary-sig-name"><code>beforeRequestBody</code></a>(<span class=summary-sig-arg>self</span>)</span></code> |
|---|
| 67 |
<a href="source/cherrypy.lib.filter.basefilter-module.html#39" class="source">[source]</a> |
|---|
| 68 |
<br /> |
|---|
| 69 |
Called after the request header has been read/parsed</td></tr> |
|---|
| 70 |
<tr bgcolor="#e8f0f8" class="group"> |
|---|
| 71 |
<th colspan="2"> Inherited from BaseFilter</th></tr> |
|---|
| 72 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 73 |
<td><code><span class="summary-sig"><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#afterErrorResponse" class="summary-sig-name"><code>afterErrorResponse</code></a>(<span class=summary-sig-arg>self</span>)</span></code> |
|---|
| 74 |
<a href="source/cherrypy.lib.filter.basefilter-module.html#55" class="source">[source]</a> |
|---|
| 75 |
<br /> |
|---|
| 76 |
Called after _cpOnError and finalize</td></tr> |
|---|
| 77 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 78 |
<td><code><span class="summary-sig"><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#beforeErrorResponse" class="summary-sig-name"><code>beforeErrorResponse</code></a>(<span class=summary-sig-arg>self</span>)</span></code> |
|---|
| 79 |
<a href="source/cherrypy.lib.filter.basefilter-module.html#51" class="source">[source]</a> |
|---|
| 80 |
<br /> |
|---|
| 81 |
Called before _cpOnError and/or finalizing output</td></tr> |
|---|
| 82 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 83 |
<td><code><span class="summary-sig"><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#beforeFinalize" class="summary-sig-name"><code>beforeFinalize</code></a>(<span class=summary-sig-arg>self</span>)</span></code> |
|---|
| 84 |
<a href="source/cherrypy.lib.filter.basefilter-module.html#47" class="source">[source]</a> |
|---|
| 85 |
<br /> |
|---|
| 86 |
Called before final output processing</td></tr> |
|---|
| 87 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 88 |
<td><code><span class="summary-sig"><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#beforeMain" class="summary-sig-name"><code>beforeMain</code></a>(<span class=summary-sig-arg>self</span>)</span></code> |
|---|
| 89 |
<a href="source/cherrypy.lib.filter.basefilter-module.html#43" class="source">[source]</a> |
|---|
| 90 |
<br /> |
|---|
| 91 |
Called after the request body has been read/parsed</td></tr> |
|---|
| 92 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 93 |
<td><code><span class="summary-sig"><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#onEndResource" class="summary-sig-name"><code>onEndResource</code></a>(<span class=summary-sig-arg>self</span>)</span></code> |
|---|
| 94 |
<a href="source/cherrypy.lib.filter.basefilter-module.html#59" class="source">[source]</a> |
|---|
| 95 |
<br /> |
|---|
| 96 |
Called after finalizing the output (status, header, and body)</td></tr> |
|---|
| 97 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 98 |
<td><code><span class="summary-sig"><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#onStartResource" class="summary-sig-name"><code>onStartResource</code></a>(<span class=summary-sig-arg>self</span>)</span></code> |
|---|
| 99 |
<a href="source/cherrypy.lib.filter.basefilter-module.html#35" class="source">[source]</a> |
|---|
| 100 |
<br /> |
|---|
| 101 |
Called before any request processing has been done</td></tr> |
|---|
| 102 |
<tr bgcolor="#e8f0f8" class="group"> |
|---|
| 103 |
<th colspan="2"> Inherited from object</th></tr> |
|---|
| 104 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 105 |
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> |
|---|
| 106 |
<br /> |
|---|
| 107 |
x.__init__(...) initializes x; see x.__class__.__doc__ for |
|---|
| 108 |
signature</td></tr> |
|---|
| 109 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 110 |
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> |
|---|
| 111 |
<br /> |
|---|
| 112 |
x.__delattr__('name') <==> del x.name</td></tr> |
|---|
| 113 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 114 |
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> |
|---|
| 115 |
<br /> |
|---|
| 116 |
x.__getattribute__('name') <==> x.name</td></tr> |
|---|
| 117 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 118 |
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> |
|---|
| 119 |
<br /> |
|---|
| 120 |
x.__hash__() <==> hash(x)</td></tr> |
|---|
| 121 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 122 |
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, |
|---|
| 123 |
<span class=summary-sig-arg>S</span>, |
|---|
| 124 |
<span class="summary-sig-vararg">...</span>)</span></code> |
|---|
| 125 |
<br /> |
|---|
| 126 |
T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> |
|---|
| 127 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 128 |
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> |
|---|
| 129 |
<br /> |
|---|
| 130 |
helper for pickle</td></tr> |
|---|
| 131 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 132 |
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> |
|---|
| 133 |
<br /> |
|---|
| 134 |
helper for pickle</td></tr> |
|---|
| 135 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 136 |
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> |
|---|
| 137 |
<br /> |
|---|
| 138 |
x.__repr__() <==> repr(x)</td></tr> |
|---|
| 139 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 140 |
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> |
|---|
| 141 |
<br /> |
|---|
| 142 |
x.__setattr__('name', value) <==> x.name = value</td></tr> |
|---|
| 143 |
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> |
|---|
| 144 |
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> |
|---|
| 145 |
<br /> |
|---|
| 146 |
x.__str__() <==> str(x)</td></tr> |
|---|
| 147 |
</table><br /> |
|---|
| 148 |
|
|---|
| 149 |
|
|---|
| 150 |
<!-- =========== START OF METHOD DETAILS =========== --> |
|---|
| 151 |
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> |
|---|
| 152 |
<tr bgcolor="#70b0f0" class="details"> |
|---|
| 153 |
<th colspan="2">Method Details</th></tr> |
|---|
| 154 |
</table> |
|---|
| 155 |
|
|---|
| 156 |
<a name="beforeRequestBody"></a> |
|---|
| 157 |
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> |
|---|
| 158 |
<h3><span class="sig"><span class="sig-name">beforeRequestBody</span>(<span class=sig-arg>self</span>)</span> |
|---|
| 159 |
<a href="source/cherrypy.lib.filter.basefilter-module.html#39" class="source">[source]</a> </h3> |
|---|
| 160 |
Called after the request header has been read/parsed |
|---|
| 161 |
<dl><dt></dt><dd> |
|---|
| 162 |
<dl><dt><b>Overrides:</b></dt> |
|---|
| 163 |
<dd><a href="cherrypy.lib.filter.basefilter.BaseFilter-class.html#beforeRequestBody"><code>cherrypy.lib.filter.basefilter.BaseFilter.beforeRequestBody</code></a> <i>(inherited documentation)</i> |
|---|
| 164 |
</dd> |
|---|
| 165 |
</dl> |
|---|
| 166 |
</dd></dl> |
|---|
| 167 |
</td></tr></table> |
|---|
| 168 |
<br /> |
|---|
| 169 |
|
|---|
| 170 |
|
|---|
| 171 |
<!-- =========== START OF NAVBAR =========== --> |
|---|
| 172 |
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> |
|---|
| 173 |
<tr valign="center"> |
|---|
| 174 |
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> |
|---|
| 175 |
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th> |
|---|
| 176 |
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th> |
|---|
| 177 |
<th class="navbar" align="right" width="100%"> |
|---|
| 178 |
<table border="0" cellpadding="0" cellspacing="0"> |
|---|
| 179 |
<tr><th class="navbar" align="center"> |
|---|
| 180 |
<p class="nomargin"> |
|---|
| 181 |
<a class="navbar" target="_top" href="http://www.turbogears.org">TurboGears</a> |
|---|
| 182 |
</p></th></tr></table> |
|---|
| 183 |
</th> |
|---|
| 184 |
</tr> |
|---|
| 185 |
</table> |
|---|
| 186 |
|
|---|
| 187 |
<table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|---|
| 188 |
<tr> |
|---|
| 189 |
<td align="left"><font size="-2">Generated by Epydoc 2.1.99 on Wed Sep 14 13:09:29 2005</font></td> |
|---|
| 190 |
<td align="right"><a href="http://epydoc.sourceforge.net" |
|---|
| 191 |
><font size="-2">http://epydoc.sf.net</font></a></td> |
|---|
| 192 |
</tr> |
|---|
| 193 |
</table> |
|---|
| 194 |
</body> |
|---|
| 195 |
</html> |
|---|