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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
|
<?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.extensions.ax.FetchRequest</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.extensions-module.html">Package extensions</a> ::
<a href="openid.extensions.ax-module.html">Module ax</a> ::
Class FetchRequest
</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.extensions.ax.FetchRequest-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type FetchRequest</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<a href="openid.extension.Extension-class.html"><code>Extension</code></a> --+
|
<code>AXMessage</code> --+
|
<b>FetchRequest</b>
</pre><br />
<hr/>
An attribute exchange 'fetch_request' message. This message is sent by
a relying party when it wishes to obtain attributes about the subject of
an OpenID authentication 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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>update_url</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.extensions.ax.FetchRequest-class.html#has_key" class="summary-sig-name"><code>__contains__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>type_uri</span>)</span></code>
<br />
Is the given type URI present in this fetch_request?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.extensions.ax.FetchRequest-class.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Iterate over the attribute type URIs in this fetch_request</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.extensions.ax.FetchRequest-class.html#add" class="summary-sig-name"><code>add</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>attribute</span>)</span></code>
<br />
Add an attribute to this attribute exchange request.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code><a href="openid.extensions.ax.FetchRequest-class.html"
class="link"><code>FetchRequest</code></a></code> or
<code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="openid.extensions.ax.FetchRequest-class.html#fromOpenIDRequest" class="summary-sig-name"><code>fromOpenIDRequest</code></a>(<span class=summary-sig-arg>cls</span>,
<span class=summary-sig-arg>openid_request</span>)</span></code>
<br />
Extract a FetchRequest from an OpenID message <i>(Class method)</i>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> {unicode:unicode}
</font></td>
<td><code><span class="summary-sig"><a href="openid.extensions.ax.FetchRequest-class.html#getExtensionArgs" class="summary-sig-name"><code>getExtensionArgs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the serialized form of this attribute fetch request.</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.extensions.ax.FetchRequest-class.html#getRequiredAttrs" class="summary-sig-name"><code>getRequiredAttrs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the type URIs for all attributes that have been marked as
required.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.extensions.ax.FetchRequest-class.html#has_key" class="summary-sig-name"><code>has_key</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>type_uri</span>)</span></code>
<br />
Is the given type URI present in this fetch_request?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.extensions.ax.FetchRequest-class.html#iterAttrs" class="summary-sig-name"><code>iterAttrs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Iterate over the AttrInfo objects that are contained in this
fetch_request.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.extensions.ax.FetchRequest-class.html#parseExtensionArgs" class="summary-sig-name"><code>parseExtensionArgs</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>ax_args</span>)</span></code>
<br />
Given attribute exchange arguments, populate this FetchRequest.</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="openid.extension.Extension-class.html"><code>Extension</code></a>:</b>
<a href="openid.extension.Extension-class.html#toMessage"><code>toMessage</code></a>
<br />
<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>,
<a href="__builtin__.object-class.html#__str__"><code>__str__</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">{str:AttrInfo}</font></td>
<td><b><a href="openid.extensions.ax.FetchRequest-class.html#requested_attributes"><code>requested_attributes</code></a></b>: The attributes that have been requested thus far, indexed by the type
URI.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="openid.extensions.ax.FetchRequest-class.html#update_url"><code>update_url</code></a></b>: A URL that will accept responses for this attribute exchange request,
even in the absence of the user who made this request.</td></tr>
<tr><td colspan="2">
</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="openid.extensions.ax.FetchRequest-class.html#mode"><code>mode</code></a></b>: The type of this attribute exchange message.</td></tr>
<tr><td colspan="2">
</td></tr>
</table><br />
<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Method Details</th></tr>
</table>
<a name="has_key"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__contains__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>type_uri</span>)</span>
<br /><i>(In operator)</i>
</h3>
Is the given type URI present in this fetch_request?
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__iter__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__iter__</span>(<span class=sig-arg>self</span>)</span>
</h3>
Iterate over the attribute type URIs in this fetch_request
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="add"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>attribute</span>)</span>
</h3>
Add an attribute to this attribute exchange request.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>attribute</b></code> -
The attribute that is being requested
<br /><i>
(type=<code><code>AttrInfo</code></code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
None
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>KeyError</b></code> -
when the requested attribute is already present in this fetch
request.
</dl>
</dd></dl>
</td></tr></table>
<a name="getExtensionArgs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getExtensionArgs</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get the serialized form of this attribute fetch request.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The fetch request message parameters
<br /><i>
(type={unicode:unicode})</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="openid.extension.Extension-class.html#getExtensionArgs"><code>openid.extension.Extension.getExtensionArgs</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getRequiredAttrs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getRequiredAttrs</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get the type URIs for all attributes that have been marked as
required.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of the type URIs for attributes that have been marked
as required.
<br /><i>
(type=[str])</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="has_key"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">has_key</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>type_uri</span>)</span>
</h3>
Is the given type URI present in this fetch_request?
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="iterAttrs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">iterAttrs</span>(<span class=sig-arg>self</span>)</span>
</h3>
Iterate over the AttrInfo objects that are contained in this
fetch_request.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parseExtensionArgs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parseExtensionArgs</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>ax_args</span>)</span>
</h3>
Given attribute exchange arguments, populate this FetchRequest.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>ax_args</b></code> -
Attribute Exchange arguments from the request. As returned
from <a href="openid.message.Message-class.html#getArgs"
class="link"><code>Message.getArgs</code></a>.
<br /><i>
(type=dict)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>KeyError</b></code> -
if the message is not consistent in its use of namespace
aliases.
<dd><code><b>NotAXMessage</b></code> -
If ax_args does not include an Attribute Exchange mode.
<dd><code><b>AXError</b></code> -
If the data to be parsed does not follow the attribute
exchange specification. At least when 'if_available' or
'required' is not specified for a particular attribute type.
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Method Details</th></tr>
</table>
<a name="fromOpenIDRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fromOpenIDRequest</span>(<span class=sig-arg>cls</span>,
<span class=sig-arg>openid_request</span>)</span>
</h3>
Extract a FetchRequest from an OpenID message
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>openid_request</b></code> -
The OpenID authentication request containing the attribute
fetch request
<br /><i>
(type=<code><a
href="openid.server.server.CheckIDRequest-class.html"
class="link"><code>openid.server.server.CheckIDRequest</code></a></code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The FetchRequest extracted from the message or None, if the
message contained no AX extension.
<br /><i>
(type=<code><a href="openid.extensions.ax.FetchRequest-class.html"
class="link"><code>FetchRequest</code></a></code> or
<code>None</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>KeyError</b></code> -
if the AuthRequest is not consistent in its use of namespace
aliases.
<dd><code><b>AXError</b></code> -
When parseExtensionArgs would raise same.
</dl>
<p><b>See Also:</b> <a
href="openid.extensions.ax.FetchRequest-class.html#parseExtensionArgs"
class="link"><code>parseExtensionArgs</code></a>
</p>
</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="requested_attributes"></a>
<h3>requested_attributes</h3>
The attributes that have been requested thus far, indexed by the type
URI.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
{str:AttrInfo}
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="update_url"></a>
<h3>update_url</h3>
A URL that will accept responses for this attribute exchange request,
even in the absence of the user who made this request.
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="mode"></a>
<h3>mode</h3>
The type of this attribute exchange message. This must be overridden
in subclasses.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="'fetch_request'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>fetch_request<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </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>
|
