1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>openid.server.server.OpenIDResponse</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://openidenabled.com/python-openid/">Python-OpenID</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="openid-module.html">Package openid</a> ::
<a href="openid.server-module.html">Package server</a> ::
<a href="openid.server.server-module.html">Module server</a> ::
Class OpenIDResponse
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="openid.server.server.OpenIDResponse-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type OpenIDResponse</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<b>OpenIDResponse</b>
</pre><br />
<hr/>
I am a response to an OpenID request.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.OpenIDResponse-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>)</span></code>
<br />
Make a response to an <a
href="openid.server.server.OpenIDRequest-class.html"
class="link"><code>OpenIDRequest</code></a>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> None
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.OpenIDResponse-class.html#addExtension" class="summary-sig-name"><code>addExtension</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>extension_response</span>)</span></code>
<br />
Add an extension response to this response message.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> str
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.OpenIDResponse-class.html#encodeToKVForm" class="summary-sig-name"><code>encodeToKVForm</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Encode a response in key-value colon/newline format.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> str
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.OpenIDResponse-class.html#encodeToURL" class="summary-sig-name"><code>encodeToURL</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Encode a response as a URL for the user agent to GET.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> bool
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.OpenIDResponse-class.html#needsSigning" class="summary-sig-name"><code>needsSigning</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Does this response require signing?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> bool
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.OpenIDResponse-class.html#renderAsForm" class="summary-sig-name"><code>renderAsForm</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Returns True if this response's encoding is ENCODE_HTML_FORM.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> str
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.OpenIDResponse-class.html#toFormMarkup" class="summary-sig-name"><code>toFormMarkup</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>form_tag_attrs</span>)</span></code>
<br />
Returns the form markup for this response.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> str
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.OpenIDResponse-class.html#toHTML" class="summary-sig-name"><code>toHTML</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>form_tag_attrs</span>)</span></code>
<br />
Returns an HTML document that auto-submits the form markup for this
response.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.OpenIDResponse-class.html#whichEncoding" class="summary-sig-name"><code>whichEncoding</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
How should I be encoded?</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
<a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>,
<a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>,
<a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>,
<a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>,
<a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>,
<a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>,
<a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a>,
<a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>
</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="openid.message.Message-class.html"
class="link"><code>openid.message.Message</code></a></font></td>
<td><b><a href="openid.server.server.OpenIDResponse-class.html#fields"><code>fields</code></a></b>: My parameters as a dictionary with each key mapping to one value.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="openid.server.server.OpenIDRequest-class.html"
class="link"><code>OpenIDRequest</code></a></font></td>
<td><b><a href="openid.server.server.OpenIDResponse-class.html#request"><code>request</code></a></b>: The request I respond to.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">list of str</font></td>
<td><b><a href="openid.server.server.OpenIDResponse-class.html#signed"><code>signed</code></a></b>: The names of the fields which should be signed.</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>request</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Make a response to an <a
href="openid.server.server.OpenIDRequest-class.html"
class="link"><code>OpenIDRequest</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>request</b></code>
<br /><i>
(type=<a href="openid.server.server.OpenIDRequest-class.html"
class="link"><code>OpenIDRequest</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="addExtension"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addExtension</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>extension_response</span>)</span>
</h3>
Add an extension response to this response message.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>extension_response</b></code> -
An object that implements the extension interface for adding
arguments to an OpenID message.
<br /><i>
(type=<a href="openid.extension-module.html"
class="link"><code>openid.extension</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
None
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="encodeToKVForm"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">encodeToKVForm</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Encode a response in key-value colon/newline format.</p>
This is a machine-readable format used to respond to messages which
came directly from the consumer and not through the user agent.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
str
</dd>
</dl>
<p><b>See Also:</b> OpenID Specs, <a href="http://openid.net/specs.bml#keyvalue">Key-Value
Colon/Newline format</a>
</p>
</dd></dl>
</td></tr></table>
<a name="encodeToURL"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">encodeToURL</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Encode a response as a URL for the user agent to GET.</p>
You will generally use this URL with a HTTP redirect.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A URL to direct the user agent back to.
<br /><i>
(type=str)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="needsSigning"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">needsSigning</span>(<span class=sig-arg>self</span>)</span>
</h3>
Does this response require signing?
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
bool
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="renderAsForm"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">renderAsForm</span>(<span class=sig-arg>self</span>)</span>
</h3>
Returns True if this response's encoding is ENCODE_HTML_FORM.
Convenience method for server authors.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
bool
</dd>
</dl>
<p><b>Since:</b> 2.1.0
</p>
</dd></dl>
</td></tr></table>
<a name="toFormMarkup"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toFormMarkup</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>form_tag_attrs</span>=<span class=sig-default>None</span>)</span>
</h3>
Returns the form markup for this response.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>form_tag_attrs</b></code> -
Dictionary of attributes to be added to the form tag.
'accept-charset' and 'enctype' have defaults that can be
overridden. If a value is supplied for 'action' or 'method', it
will be replaced.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
str
</dd>
</dl>
<p><b>Since:</b> 2.1.0
</p>
</dd></dl>
</td></tr></table>
<a name="toHTML"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toHTML</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>form_tag_attrs</span>=<span class=sig-default>None</span>)</span>
</h3>
Returns an HTML document that auto-submits the form markup for this
response.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
str
</dd>
</dl>
<p><b>Since:</b> 2.1.?
</p>
<p><b>See Also:</b> toFormMarkup
</p>
</dd></dl>
</td></tr></table>
<a name="whichEncoding"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">whichEncoding</span>(<span class=sig-arg>self</span>)</span>
</h3>
How should I be encoded?
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
one of ENCODE_URL, ENCODE_HTML_FORM, or ENCODE_KVFORM.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="fields"></a>
<h3>fields</h3>
My parameters as a dictionary with each key mapping to one value. Keys
are parameter names with no leading "<code>openid.</code>".
e.g. "<code>identity</code>" and
"<code>mac_key</code>", never
"<code>openid.identity</code>".
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a href="openid.message.Message-class.html"
class="link"><code>openid.message.Message</code></a>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="request"></a>
<h3>request</h3>
The request I respond to.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a href="openid.server.server.OpenIDRequest-class.html"
class="link"><code>OpenIDRequest</code></a>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="signed"></a>
<h3>signed</h3>
The names of the fields which should be signed.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
list of str
</dd>
</dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://openidenabled.com/python-openid/">Python-OpenID</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Wed Apr 22 16:14:21 2009</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
