1
<?xml version="1.0" encoding="ascii"?>
1
<?xml version="1.0" encoding="iso-8859-1"?>
2
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
3
"DTD/xhtml1-transitional.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
6
<title>openid.server.server.SigningEncoder</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
11
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="openid-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<!-- Project homepage -->
34
<th class="navbar" align="right" width="100%">
35
<table border="0" cellpadding="0" cellspacing="0">
36
<tr><th class="navbar" align="center"
37
><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
24
</p></th></tr></table>
41
28
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
31
<font size="-1"><b class="breadcrumbs">
45
32
<a href="openid-module.html">Package openid</a> ::
46
33
<a href="openid.server-module.html">Package server</a> ::
47
34
<a href="openid.server.server-module.html">Module server</a> ::
48
35
Class SigningEncoder
52
<table cellpadding="0" cellspacing="0">
53
<!-- hide/show private -->
54
<tr><td align="right"><span class="options"
55
>[<a href="frames.html" target="_top">frames</a
56
>] | <a href="openid.server.server.SigningEncoder-class.html"
57
target="_top">no frames</a>]</span></td></tr>
62
<!-- ==================== CLASS DESCRIPTION ==================== -->
63
<h1 class="epydoc">Class SigningEncoder</h1><span class="codelink"><a href="openid.server.server-pysrc.html#SigningEncoder">source code</a></span><br /><br />
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="openid.server.server.SigningEncoder-class.html" target="_top">no frames</a>]</font></td></tr>
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
44
<h2 class="class">Type SigningEncoder</h2>
64
46
<pre class="base-tree">
47
<a href="__builtin__.object-class.html"><code>object</code></a> --+
67
<a href="openid.server.server.Encoder-class.html">Encoder</a> --+
49
<a href="openid.server.server.Encoder-class.html"><code>Encoder</code></a> --+
69
<strong class="uidshort">SigningEncoder</strong>
73
56
I encode responses in to <a
74
href="openid.server.server.WebResponse-class.html"
75
class="link">WebResponses</a>, signing them when required.<br /><br />
77
<!-- ==================== NESTED CLASSES ==================== -->
78
<a name="section-NestedClasses"></a>
79
<table class="summary" border="1" cellpadding="3"
80
cellspacing="0" width="100%" bgcolor="white">
81
<tr bgcolor="#70b0f0" class="table-header">
82
<td colspan="2" class="table-header">
83
<table border="0" cellpadding="0" cellspacing="0" width="100%">
85
<td align="left"><span class="table-header">Nested Classes</span></td>
86
<td align="right" valign="top"
87
><span class="options">[<a href="#section-NestedClasses"
88
class="privatelink" onclick="toggle_private();"
89
>hide private</a>]</span></td>
95
<td colspan="2" class="summary">
96
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="openid.server.server.Encoder-class.html">Encoder</a></code></b>:
97
<code><a href="openid.server.server.WebResponse-class.html">responseFactory</a></code>
104
<!-- ==================== INSTANCE METHODS ==================== -->
105
<a name="section-InstanceMethods"></a>
106
<table class="summary" border="1" cellpadding="3"
107
cellspacing="0" width="100%" bgcolor="white">
108
<tr bgcolor="#70b0f0" class="table-header">
109
<td colspan="2" class="table-header">
110
<table border="0" cellpadding="0" cellspacing="0" width="100%">
112
<td align="left"><span class="table-header">Instance Methods</span></td>
113
<td align="right" valign="top"
114
><span class="options">[<a href="#section-InstanceMethods"
115
class="privatelink" onclick="toggle_private();"
116
>hide private</a>]</span></td>
122
<td width="15%" align="right" valign="top" class="summary">
123
<span class="summary-type"> </span>
124
</td><td class="summary">
125
<span class="summary-sig"><a href="openid.server.server.SigningEncoder-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
126
<span class="summary-sig-arg">signatory</span>)</span><br />
127
Create a <a href="openid.server.server.SigningEncoder-class.html"
128
class="link">SigningEncoder</a>.
132
<td width="15%" align="right" valign="top" class="summary">
133
<span class="summary-type"><a href="openid.server.server.WebResponse-class.html"
134
class="link">WebResponse</a></span>
135
</td><td class="summary">
136
<span class="summary-sig"><a href="openid.server.server.SigningEncoder-class.html#encode" class="summary-sig-name">encode</a>(<span class="summary-sig-arg">self</span>,
137
<span class="summary-sig-arg">response</span>)</span><br />
138
Encode a response to a <a
139
href="openid.server.server.WebResponse-class.html"
140
class="link">WebResponse</a>, signing it first if appropriate.
144
<td colspan="2" class="summary">
145
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
146
<code>__delattr__</code>,
147
<code>__getattribute__</code>,
148
<code>__hash__</code>,
149
<code>__new__</code>,
150
<code>__reduce__</code>,
151
<code>__reduce_ex__</code>,
152
<code>__repr__</code>,
153
<code>__setattr__</code>,
161
<!-- ==================== PROPERTIES ==================== -->
162
<a name="section-Properties"></a>
163
<table class="summary" border="1" cellpadding="3"
164
cellspacing="0" width="100%" bgcolor="white">
165
<tr bgcolor="#70b0f0" class="table-header">
166
<td colspan="2" class="table-header">
167
<table border="0" cellpadding="0" cellspacing="0" width="100%">
169
<td align="left"><span class="table-header">Properties</span></td>
170
<td align="right" valign="top"
171
><span class="options">[<a href="#section-Properties"
172
class="privatelink" onclick="toggle_private();"
173
>hide private</a>]</span></td>
179
<td colspan="2" class="summary">
180
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
181
<code>__class__</code>
188
<!-- ==================== METHOD DETAILS ==================== -->
189
<a name="section-MethodDetails"></a>
190
<table class="summary" border="1" cellpadding="3"
191
cellspacing="0" width="100%" bgcolor="white">
192
<tr bgcolor="#70b0f0" class="table-header">
193
<td colspan="2" class="table-header">
194
<table border="0" cellpadding="0" cellspacing="0" width="100%">
196
<td align="left"><span class="table-header">Method Details</span></td>
197
<td align="right" valign="top"
198
><span class="options">[<a href="#section-MethodDetails"
199
class="privatelink" onclick="toggle_private();"
200
>hide private</a>]</span></td>
57
href="openid.server.server.WebResponse-class.html"
58
class="link"><code>WebResponses</code></a>, signing them when
63
<!-- =========== START OF METHOD SUMMARY =========== -->
64
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
65
<tr bgcolor="#70b0f0" class="summary">
66
<th colspan="2">Method Summary</th></tr>
67
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
68
<td><code><span class="summary-sig"><a href="openid.server.server.SigningEncoder-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
69
<span class=summary-sig-arg>signatory</span>)</span></code>
71
Create a <a href="openid.server.server.SigningEncoder-class.html"
72
class="link"><code>SigningEncoder</code></a>.</td></tr>
73
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="openid.server.server.WebResponse-class.html"
74
class="link"><code>WebResponse</code></a>
76
<td><code><span class="summary-sig"><a href="openid.server.server.SigningEncoder-class.html#encode" class="summary-sig-name"><code>encode</code></a>(<span class=summary-sig-arg>self</span>,
77
<span class=summary-sig-arg>response</span>)</span></code>
79
Encode a response to a <a
80
href="openid.server.server.WebResponse-class.html"
81
class="link"><code>WebResponse</code></a>, signing it first if
82
appropriate.</td></tr>
84
<b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
85
<a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>,
86
<a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>,
87
<a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>,
88
<a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>,
89
<a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>,
90
<a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>,
91
<a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a>,
92
<a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>,
93
<a href="__builtin__.object-class.html#__str__"><code>__str__</code></a>
98
<!-- =========== START OF METHOD DETAILS =========== -->
99
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
100
<tr bgcolor="#70b0f0" class="details">
101
<th colspan="2">Method Details</th></tr>
206
104
<a name="__init__"></a>
208
<table class="details" border="1" cellpadding="3"
209
cellspacing="0" width="100%" bgcolor="white">
211
<table width="100%" cellpadding="0" cellspacing="0" border="0">
212
<tr valign="top"><td>
213
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
214
<span class="sig-arg">signatory</span>)</span>
215
<br /><em class="fname">(Constructor)</em>
105
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
106
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
107
<span class=sig-arg>signatory</span>)</span>
108
<br /><i>(Constructor)</i>
217
</td><td align="right" valign="top"
218
><span class="codelink"><a href="openid.server.server-pysrc.html#SigningEncoder.__init__">source code</a></span>
222
<br />Create a <a href="openid.server.server.SigningEncoder-class.html"
223
class="link">SigningEncoder</a>.
110
Create a <a href="openid.server.server.SigningEncoder-class.html"
111
class="link"><code>SigningEncoder</code></a>.
224
112
<dl><dt></dt><dd>
225
<dl><dt>Parameters:</dt></dl>
226
<ul class="nomargin">
227
<li><strong class="pname"><code>signatory</code></strong> (<a href="openid.server.server.Signatory-class.html"
228
class="link">Signatory</a>) - The <a href="openid.server.server.Signatory-class.html"
229
class="link">Signatory</a> I will make signatures with.</li>
113
<dl><dt><b>Parameters:</b></dt>
114
<dd><code><b>signatory</b></code> -
115
The <a href="openid.server.server.Signatory-class.html"
116
class="link"><code>Signatory</code></a> I will make signatures
118
<br /><i>
119
(type=<a href="openid.server.server.Signatory-class.html"
120
class="link"><code>Signatory</code></a>)</i>
123
<dl><dt><b>Overrides:</b></dt>
124
<dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>
235
127
</td></tr></table>
237
129
<a name="encode"></a>
239
<table class="details" border="1" cellpadding="3"
240
cellspacing="0" width="100%" bgcolor="white">
242
<table width="100%" cellpadding="0" cellspacing="0" border="0">
243
<tr valign="top"><td>
244
<h3 class="epydoc"><span class="sig"><span class="sig-name">encode</span>(<span class="sig-arg">self</span>,
245
<span class="sig-arg">response</span>)</span>
130
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
131
<h3><span class="sig"><span class="sig-name">encode</span>(<span class=sig-arg>self</span>,
132
<span class=sig-arg>response</span>)</span>
247
</td><td align="right" valign="top"
248
><span class="codelink"><a href="openid.server.server-pysrc.html#SigningEncoder.encode">source code</a></span>
252
<br />Encode a response to a <a
134
Encode a response to a <a
253
135
href="openid.server.server.WebResponse-class.html"
254
class="link">WebResponse</a>, signing it first if appropriate.
136
class="link"><code>WebResponse</code></a>, signing it first if
255
138
<dl><dt></dt><dd>
256
<dl><dt>Returns: <a href="openid.server.server.WebResponse-class.html"
257
class="link">WebResponse</a></dt></dl>
258
<dl><dt>Raises:</dt></dl>
259
<ul class="nomargin">
260
<li><code><strong class='fraise'><a href="openid.server.server.EncodingError-class.html">EncodingError</a></strong></code> - When I can't figure out how to encode this message.</li>
261
<li><code><strong class='fraise'><a href="openid.server.server.AlreadySigned-class.html">AlreadySigned</a></strong></code> - When this response is already signed.</li>
264
<a href="openid.server.server.Encoder-class.html#encode">Encoder.encode</a>
139
<dl><dt><b>Returns:</b></dt>
141
<a href="openid.server.server.WebResponse-class.html"
142
class="link"><code>WebResponse</code></a>
145
<dl><dt><b>Raises:</b></dt>
146
<dd><code><b>EncodingError</b></code> -
147
When I can't figure out how to encode this message.
148
<dd><code><b>AlreadySigned</b></code> -
149
When this response is already signed.
151
<dl><dt><b>Overrides:</b></dt>
152
<dd><a href="openid.server.server.Encoder-class.html#encode"><code>openid.server.server.Encoder.encode</code></a></dd>
267
155
</td></tr></table>
270
<!-- ==================== NAVIGATION BAR ==================== -->
271
<table class="navbar" border="0" width="100%" cellpadding="0"
272
bgcolor="#a0c0ff" cellspacing="0">
275
<th> <a
276
href="openid-module.html">Home</a> </th>
279
<th> <a
280
href="module-tree.html">Trees</a> </th>
283
<th> <a
284
href="identifier-index.html">Indices</a> </th>
287
<th> <a
288
href="help.html">Help</a> </th>
290
<!-- Project homepage -->
291
<th class="navbar" align="right" width="100%">
292
<table border="0" cellpadding="0" cellspacing="0">
293
<tr><th class="navbar" align="center"
294
><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
159
<!-- =========== START OF NAVBAR =========== -->
160
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
162
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
163
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
164
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
165
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
166
<th class="navbar" align="right" width="100%">
167
<table border="0" cellpadding="0" cellspacing="0">
168
<tr><th class="navbar" align="center">
170
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
171
</p></th></tr></table>
298
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
176
<table border="0" cellpadding="0" cellspacing="0" width="100%">
300
<td align="left" class="footer">Generated by Epydoc
301
3.0alpha3 on Fri Dec 8 13:26:20 2006</td>
302
<td align="right" class="footer">
303
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
178
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:12 2007</font></td>
179
<td align="right"><a href="http://epydoc.sourceforge.net"
180
><font size="-2">http://epydoc.sf.net</font></a></td>
308
<script type="text/javascript">
310
// Private objects are initially displayed (because if
311
// javascript is turned off then we want them to be
312
// visible); but by default, we want to hide them. So hide
313
// them unless we have a cookie that says to show them.