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
|
<?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.Decoder</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 Decoder
</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.Decoder-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type Decoder</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<b>Decoder</b>
</pre><br />
<hr/>
I decode an incoming web request in to a <a
href="openid.server.server.OpenIDRequest-class.html"
class="link"><code>OpenIDRequest</code></a>.
<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.Decoder-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>server</span>)</span></code>
<br />
Construct a Decoder.</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><code><span class="summary-sig"><a href="openid.server.server.Decoder-class.html#decode" class="summary-sig-name"><code>decode</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>query</span>)</span></code>
<br />
I transform query parameters into 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><span class="summary-sig"><a href="openid.server.server.Decoder-class.html#defaultDecoder" class="summary-sig-name"><code>defaultDecoder</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>server</span>)</span></code>
<br />
Called to decode queries when no handler for that mode is found.</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>,
<a href="__builtin__.object-class.html#__str__"><code>__str__</code></a>
</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>server</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Construct a Decoder.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>server</b></code> -
The server which I am decoding requests for. (Necessary
because some replies reference their server.)
<br /><i>
(type=<a href="openid.server.server.Server-class.html"
class="link"><code>Server</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="decode"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">decode</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>query</span>)</span>
</h3>
<p>I transform query parameters into an <a
href="openid.server.server.OpenIDRequest-class.html"
class="link"><code>OpenIDRequest</code></a>.</p>
If the query does not seem to be an OpenID request at all, I return
<code>None</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>query</b></code> -
The query parameters as a dictionary with each key mapping to
one value.
<br /><i>
(type=dict)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="openid.server.server.OpenIDRequest-class.html"
class="link"><code>OpenIDRequest</code></a>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ProtocolError</b></code> -
When the query does not seem to be a valid OpenID request.
</dl>
</dd></dl>
</td></tr></table>
<a name="defaultDecoder"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">defaultDecoder</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>message</span>,
<span class=sig-arg>server</span>)</span>
</h3>
Called to decode queries when no handler for that mode is found.
<dl><dt></dt><dd>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ProtocolError</b></code> -
This implementation always raises <a
href="openid.server.server.ProtocolError-class.html"
class="link"><code>ProtocolError</code></a>.
</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:20 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>
|
