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
|
<?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.consumer.consumer.SuccessResponse</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.consumer-module.html">Package consumer</a> ::
<a href="openid.consumer.consumer-module.html">Module consumer</a> ::
Class SuccessResponse
</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.consumer.consumer.SuccessResponse-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type SuccessResponse</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<code>Response</code> --+
|
<b>SuccessResponse</b>
</pre><br />
<hr/>
A response with a status of SUCCESS. Indicates that this request is a
successful acknowledgement from the OpenID server that the supplied URL
is, indeed controlled by the requesting agent.
<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>endpoint</span>,
<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>signed_fields</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__eq__"></a><span class="summary-sig"><span class="summary-sig-name">__eq__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__ne__"></a><span class="summary-sig"><span class="summary-sig-name">__ne__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class=summary-sig-arg>self</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.consumer.consumer.SuccessResponse-class.html#extensionResponse" class="summary-sig-name"><code>extensionResponse</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>namespace_uri</span>,
<span class=summary-sig-arg>require_signed</span>)</span></code>
<br />
Return response arguments in the specified namespace.</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.consumer.consumer.SuccessResponse-class.html#getReturnTo" class="summary-sig-name"><code>getReturnTo</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the openid.return_to argument from 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.consumer.consumer.SuccessResponse-class.html#getSigned" class="summary-sig-name"><code>getSigned</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>ns_uri</span>,
<span class=summary-sig-arg>ns_key</span>,
<span class=summary-sig-arg>default</span>)</span></code>
<br />
Return the specified signed field if available, otherwise return
default</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.consumer.consumer.SuccessResponse-class.html#getSignedNS" class="summary-sig-name"><code>getSignedNS</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>ns_uri</span>)</span></code>
<br />
Get signed arguments from the response message.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.consumer.consumer.SuccessResponse-class.html#isOpenID1" class="summary-sig-name"><code>isOpenID1</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Was this authentication response an OpenID 1 authentication
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.consumer.consumer.SuccessResponse-class.html#isSigned" class="summary-sig-name"><code>isSigned</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>ns_uri</span>,
<span class=summary-sig-arg>ns_key</span>)</span></code>
<br />
Return whether a particular key is signed, regardless of its namespace
alias</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#__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"><a
href="openid.consumer.discover.OpenIDServiceEndpoint-class.html"
class="link"><code>OpenIDServiceEndpoint</code></a></font></td>
<td><b><a href="openid.consumer.consumer.SuccessResponse-class.html#endpoint"><code>endpoint</code></a></b>: The endpoint that authenticated the identifier.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="openid.consumer.consumer.SuccessResponse-class.html#identity_url"><code>identity_url</code></a></b>: The identity URL that has been authenticated; the Claimed
Identifier.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="openid.consumer.consumer.SuccessResponse-class.html#signed_fields"><code>signed_fields</code></a></b>: The arguments in the server's response that were signed and
verified.</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>str</code></font></td>
<td><b><a href="openid.consumer.consumer.SuccessResponse-class.html#status"><code>status</code></a></b>: SUCCESS</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="extensionResponse"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">extensionResponse</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>namespace_uri</span>,
<span class=sig-arg>require_signed</span>)</span>
</h3>
Return response arguments in the specified namespace.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>namespace_uri</b></code> -
The namespace URI of the arguments to be returned.
<dd><code><b>require_signed</b></code> -
<p>True if the arguments should be among those signed in the
response, False if you don't care.</p>
If require_signed is True and the arguments are not signed,
return None.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getReturnTo"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getReturnTo</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Get the openid.return_to argument from this response.</p>
This is useful for verifying that this request was initiated by this
consumer.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The return_to URL supplied to the server on the initial
request, or <code>None</code> if the response did not contain an
<code>openid.return_to</code> argument.
<br /><i>
(type=str)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getSigned"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getSigned</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>ns_uri</span>,
<span class=sig-arg>ns_key</span>,
<span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span>
</h3>
Return the specified signed field if available, otherwise return
default
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getSignedNS"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getSignedNS</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>ns_uri</span>)</span>
</h3>
Get signed arguments from the response message. Return a dict of all
arguments in the specified namespace. If any of the arguments are not
signed, return None.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="isOpenID1"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">isOpenID1</span>(<span class=sig-arg>self</span>)</span>
</h3>
Was this authentication response an OpenID 1 authentication
response?
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="isSigned"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">isSigned</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>ns_uri</span>,
<span class=sig-arg>ns_key</span>)</span>
</h3>
Return whether a particular key is signed, regardless of its
namespace alias
<dl><dt></dt><dd>
</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="endpoint"></a>
<h3>endpoint</h3>
The endpoint that authenticated the identifier. You may access other
discovered information related to this endpoint, such as the CanonicalID
of an XRI, through this object.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a
href="openid.consumer.discover.OpenIDServiceEndpoint-class.html"
class="link"><code>OpenIDServiceEndpoint</code></a>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="identity_url"></a>
<h3>identity_url</h3>
The identity URL that has been authenticated; the Claimed Identifier.
See also <code>getDisplayIdentifier</code>.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="signed_fields"></a>
<h3>signed_fields</h3>
The arguments in the server's response that were signed and
verified.
</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="status"></a>
<h3>status</h3>
SUCCESS
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'success'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>success<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>
|