~certify-web-dev/twisted/certify-trunk

« back to all changes in this revision

Viewing changes to doc/api/twisted.web.util.ParentRedirect.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2004-06-21 22:01:11 UTC
  • mto: (2.2.3 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040621220111-vkf909euqnyrp3nr
Tags: upstream-1.3.0
ImportĀ upstreamĀ versionĀ 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>twisted.web.util.ParentRedirect</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        <a href="twisted.html">Package&nbsp;twisted</a> ::
 
33
        <a href="twisted.web.html">Package&nbsp;web</a> ::
 
34
        <a href="twisted.web.util.html">Module&nbsp;util</a> ::
 
35
        Class&nbsp;ParentRedirect
 
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>&nbsp;|&nbsp;<a href="twisted.web.util.ParentRedirect.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
40
    </table></td>
 
41
</tr></table>
 
42
 
 
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
44
<h2 class="class">Class ParentRedirect</h2>
 
45
 
 
46
<pre class="base-tree">
 
47
<a href="twisted.web.resource.Resource.html"><code>Resource</code></a> --+
 
48
           |
 
49
          <b>ParentRedirect</b>
 
50
</pre><br />
 
51
 
 
52
<hr/>
 
53
 
 
54
I redirect to URLPath.here().
 
55
<hr/>
 
56
 
 
57
 
 
58
<!-- =========== START OF METHOD SUMMARY =========== -->
 
59
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
60
<tr bgcolor="#70b0f0" class="summary">
 
61
  <th colspan="2">Method Summary</th></tr>
 
62
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
63
  <td><code><a name="getChild"></a><span class="summary-sig"><span class="summary-sig-name">getChild</span>(<span class=summary-sig-arg>self</span>,
 
64
          <span class=summary-sig-arg>request</span>)</span></code>
 
65
</td></tr>
 
66
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
67
  <td><code><span class="summary-sig"><a href="twisted.web.util.ParentRedirect.html#render" class="summary-sig-name"><code>render</code></a>(<span class=summary-sig-arg>self</span>,
 
68
          <span class=summary-sig-arg>request</span>)</span></code>
 
69
<br />
 
70
Render a given resource.</td></tr>
 
71
<tr bgcolor="#e8f0f8" class="group">
 
72
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Resource</th></tr>
 
73
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
74
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
75
<br />
 
76
Initialize.</td></tr>
 
77
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
78
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#delEntity" class="summary-sig-name"><code>delEntity</code></a>(<span class=summary-sig-arg>self</span>,
 
79
          <span class=summary-sig-arg>name</span>)</span></code>
 
80
</td></tr>
 
81
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
82
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#getChildForRequest" class="summary-sig-name"><code>getChildForRequest</code></a>(<span class=summary-sig-arg>self</span>,
 
83
          <span class=summary-sig-arg>request</span>)</span></code>
 
84
</td></tr>
 
85
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
86
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#getChildWithDefault" class="summary-sig-name"><code>getChildWithDefault</code></a>(<span class=summary-sig-arg>self</span>,
 
87
          <span class=summary-sig-arg>path</span>,
 
88
          <span class=summary-sig-arg>request</span>)</span></code>
 
89
<br />
 
90
Retrieve a static or dynamically generated child resource from me.</td></tr>
 
91
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
92
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#getDynamicEntity" class="summary-sig-name"><code>getDynamicEntity</code></a>(<span class=summary-sig-arg>self</span>,
 
93
          <span class=summary-sig-arg>name</span>,
 
94
          <span class=summary-sig-arg>request</span>)</span></code>
 
95
</td></tr>
 
96
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
97
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#getStaticEntity" class="summary-sig-name"><code>getStaticEntity</code></a>(<span class=summary-sig-arg>self</span>,
 
98
          <span class=summary-sig-arg>name</span>)</span></code>
 
99
</td></tr>
 
100
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
101
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listDynamicEntities" class="summary-sig-name"><code>listDynamicEntities</code></a>(<span class=summary-sig-arg>self</span>,
 
102
          <span class=summary-sig-arg>request</span>)</span></code>
 
103
</td></tr>
 
104
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
105
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listDynamicNames" class="summary-sig-name"><code>listDynamicNames</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
106
</td></tr>
 
107
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
108
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listEntities" class="summary-sig-name"><code>listEntities</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
109
</td></tr>
 
110
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
111
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listNames" class="summary-sig-name"><code>listNames</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
112
</td></tr>
 
113
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
114
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listStaticEntities" class="summary-sig-name"><code>listStaticEntities</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
115
</td></tr>
 
116
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
117
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#listStaticNames" class="summary-sig-name"><code>listStaticNames</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
118
</td></tr>
 
119
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
120
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#putChild" class="summary-sig-name"><code>putChild</code></a>(<span class=summary-sig-arg>self</span>,
 
121
          <span class=summary-sig-arg>path</span>,
 
122
          <span class=summary-sig-arg>child</span>)</span></code>
 
123
<br />
 
124
Register a static child.</td></tr>
 
125
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
126
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#reallyPutEntity" class="summary-sig-name"><code>reallyPutEntity</code></a>(<span class=summary-sig-arg>self</span>,
 
127
          <span class=summary-sig-arg>name</span>,
 
128
          <span class=summary-sig-arg>entity</span>)</span></code>
 
129
</td></tr>
 
130
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
131
  <td><code><span class="summary-sig"><a href="twisted.web.resource.Resource.html#render_HEAD" class="summary-sig-name"><code>render_HEAD</code></a>(<span class=summary-sig-arg>self</span>,
 
132
          <span class=summary-sig-arg>request</span>)</span></code>
 
133
<br />
 
134
Default handling of HEAD method.</td></tr>
 
135
</table><br />
 
136
 
 
137
 
 
138
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
139
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
140
<tr bgcolor="#70b0f0" class="summary">
 
141
  <th colspan="2">Class Variable Summary</th></tr>
 
142
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
143
<td><b><a href="twisted.web.util.ParentRedirect.html#isLeaf"><code>isLeaf</code></a></b> = <span title="1">1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
 
144
<tr bgcolor="#e8f0f8" class="group">
 
145
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Resource</th></tr>
 
146
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
 
147
<td><b><a href="twisted.web.resource.Resource.html#__implements__"><code>__implements__</code></a></b> = <span title="(&lt;class twisted.web.resource.IResource at 0x8450e44&gt;,)"><code>(&lt;class&nbsp;twisted.web.resource.IResource&nbsp;<span class="variable-ellipsis">...</span></code>
 
148
</span></td></tr>
 
149
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
 
150
<td><b><a href="twisted.web.resource.Resource.html#server"><code>server</code></a></b> = <span title="None">None&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
 
151
</table><br />
 
152
 
 
153
 
 
154
<!-- =========== START OF METHOD DETAILS =========== -->
 
155
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
156
<tr bgcolor="#70b0f0" class="details">
 
157
  <th colspan="2">Method Details</th></tr>
 
158
</table>
 
159
 
 
160
<a name="render"></a>
 
161
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
162
  <h3><span class="sig"><span class="sig-name">render</span>(<span class=sig-arg>self</span>,
 
163
          <span class=sig-arg>request</span>)</span>
 
164
  </h3>
 
165
  <p>Render a given resource. See <a 
 
166
  href="twisted.web.resource.IResource.html" 
 
167
  class="link"><code>IResource</code></a>'s render method.</p>
 
168
  <p>I delegate to methods of self with the form 'render_METHOD' where 
 
169
  METHOD is the HTTP that was used to make the request. Examples: 
 
170
  render_GET, render_HEAD, render_POST, and so on. Generally you should 
 
171
  implement those methods instead of overriding this one.</p>
 
172
  <p>render_METHOD methods are expected to return a string which will be 
 
173
  the rendered page, unless the return value is 
 
174
  twisted.web.server.NOT_DONE_YET, in which case it is this class's 
 
175
  responsibility to write the results to request.write(data), then call 
 
176
  request.finish().</p>
 
177
  Old code that overrides render() directly is likewise expected to 
 
178
  return a string or NOT_DONE_YET.
 
179
  <dl><dt></dt><dd>
 
180
    <dl><dt><b>Overrides:</b></dt>
 
181
      <dd><a href="twisted.web.resource.Resource.html#render"><code>twisted.web.resource.Resource.render</code></a> <i>(inherited documentation)</i>
 
182
</dd>
 
183
    </dl>
 
184
  </dd></dl>
 
185
</td></tr></table>
 
186
<br />
 
187
 
 
188
 
 
189
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
 
190
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
191
<tr bgcolor="#70b0f0" class="details">
 
192
  <th colspan="2">Class Variable Details</th></tr>
 
193
</table>
 
194
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
195
<a name="isLeaf"></a>
 
196
<h3>isLeaf</h3>
 
197
<dl>
 
198
  <dt></dt>
 
199
  <dd>
 
200
    <dl>
 
201
      <dt><b>Type:</b></dt>
 
202
      <dd>
 
203
          <code>int</code>
 
204
 
 
205
      </dd>
 
206
<span title="1">      <dt><b>Value:</b></dt>
 
207
      <dd><table><tr><td>
 
208
<pre class="variable">
 
209
1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
 
210
        </td></tr></table></dd>
 
211
</span>    </dl>
 
212
  </dd>
 
213
</dl></td></tr></table>
 
214
<br />
 
215
 
 
216
 
 
217
<!-- =========== START OF NAVBAR =========== -->
 
218
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
219
  <tr valign="center">
 
220
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
221
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
222
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
223
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
224
    <th class="navbar" align="right" width="100%">
 
225
      <table border="0" cellpadding="0" cellspacing="0">
 
226
      <tr><th class="navbar" align="center">
 
227
        <p class="nomargin">
 
228
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
229
      </p></th></tr></table>
 
230
    </th>
 
231
  </tr>
 
232
</table>
 
233
 
 
234
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
235
  <tr>
 
236
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:51 2004</font></td>
 
237
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
238
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
239
  </tr>
 
240
</table>
 
241
</body>
 
242
</html>