← Back to branch summary

~gary/python-openid/python-openid-2.2.1-patched

« back to all changes in this revision

Viewing changes to doc/openid.consumer.discover.OpenIDServiceEndpoint-class.html

  • Committer: Launchpad Patch Queue Manager
  • Date: 2007-11-30 02:46:28 UTC
  • mfrom: (1.1.1 pyopenid-2.0)
  • Revision ID: launchpad@pqm.canonical.com-20071130024628-qktwsew3383iawmq
[rs=SteveA] upgrade to python-openid-2.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/openid.consumer.discover.OpenIDServiceEndpoint-class.html
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">
5
5
<head>
6
6
  <title>openid.consumer.discover.OpenIDServiceEndpoint</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>
9
8
</head>
10
 
 
11
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
10
      alink="#204080">
13
 
<!-- ==================== NAVIGATION BAR ==================== -->
14
 
<table class="navbar" border="0" width="100%" cellpadding="0"
15
 
       bgcolor="#a0c0ff" cellspacing="0">
16
 
  <tr valign="middle">
17
 
  <!-- Home link -->
18
 
      <th>&nbsp;&nbsp;&nbsp;<a
19
 
        href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
 
 
21
 
  <!-- Tree link -->
22
 
      <th>&nbsp;&nbsp;&nbsp;<a
23
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
 
 
25
 
  <!-- Index link -->
26
 
      <th>&nbsp;&nbsp;&nbsp;<a
27
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
 
 
29
 
  <!-- Help link -->
30
 
      <th>&nbsp;&nbsp;&nbsp;<a
31
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
 
 
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>
38
 
          </tr></table></th>
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
 
24
      </p></th></tr></table>
 
25
    </th>
39
26
  </tr>
40
27
</table>
41
28
<table width="100%" cellpadding="0" cellspacing="0">
42
29
  <tr valign="top">
43
30
    <td width="100%">
44
 
      <span class="breadcrumbs">
 
31
      <font size="-1"><b class="breadcrumbs">
45
32
        <a href="openid-module.html">Package&nbsp;openid</a> ::
46
33
        <a href="openid.consumer-module.html">Package&nbsp;consumer</a> ::
47
34
        <a href="openid.consumer.discover-module.html">Module&nbsp;discover</a> ::
48
35
        Class&nbsp;OpenIDServiceEndpoint
49
 
      </span>
50
 
    </td>
51
 
    <td>
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
 
            >]&nbsp;|&nbsp;<a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html"
57
 
            target="_top">no&nbsp;frames</a>]</span></td></tr>
58
 
      </table>
59
 
    </td>
60
 
  </tr>
61
 
</table>
62
 
<!-- ==================== CLASS DESCRIPTION ==================== -->
63
 
<h1 class="epydoc">Class OpenIDServiceEndpoint</h1><span class="codelink"><a href="openid.consumer.discover-pysrc.html#OpenIDServiceEndpoint">source&nbsp;code</a></span><br /><br />
 
36
      </b></font></br>
 
37
    </td>
 
38
    <td><table cellpadding="0" cellspacing="0">
 
39
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
40
    </table></td>
 
41
</tr></table>
 
42
 
 
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
44
<h2 class="class">Type OpenIDServiceEndpoint</h2>
 
45
 
64
46
<pre class="base-tree">
65
 
object --+
 
47
<a href="__builtin__.object-class.html"><code>object</code></a> --+
66
48
         |
67
 
        <strong class="uidshort">OpenIDServiceEndpoint</strong>
68
 
</pre>
69
 
 
70
 
<hr />
71
 
Object representing an OpenID service endpoint.<br /><br />
72
 
 
73
 
<!-- ==================== INSTANCE METHODS ==================== -->
74
 
<a name="section-InstanceMethods"></a>
75
 
<table class="summary" border="1" cellpadding="3"
76
 
       cellspacing="0" width="100%" bgcolor="white">
77
 
<tr bgcolor="#70b0f0" class="table-header">
78
 
  <td colspan="2" class="table-header">
79
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
80
 
      <tr valign="top">
81
 
        <td align="left"><span class="table-header">Instance Methods</span></td>
82
 
        <td align="right" valign="top"
83
 
         ><span class="options">[<a href="#section-InstanceMethods"
84
 
         class="privatelink" onclick="toggle_private();"
85
 
         >hide private</a>]</span></td>
86
 
      </tr>
87
 
    </table>
88
 
  </td>
89
 
</tr>
90
 
<tr>
91
 
  <td width="15%" align="right" valign="top" class="summary">
92
 
    <span class="summary-type">&nbsp;</span>
93
 
  </td><td class="summary">
94
 
    <span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
95
 
      x.__init__(...) initializes x; see x.__class__.__doc__ for 
96
 
      signature
97
 
  </td>
98
 
</tr>
99
 
<tr>
100
 
  <td width="15%" align="right" valign="top" class="summary">
101
 
    <span class="summary-type">&nbsp;</span>
102
 
  </td><td class="summary">
103
 
    <span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#usesExtension" class="summary-sig-name">usesExtension</a>(<span class="summary-sig-arg">self</span>,
104
 
        <span class="summary-sig-arg">extension_uri</span>)</span>
105
 
  </td>
106
 
</tr>
107
 
<tr>
108
 
  <td width="15%" align="right" valign="top" class="summary">
109
 
    <span class="summary-type">&nbsp;</span>
110
 
  </td><td class="summary">
111
 
    <span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#parseService" class="summary-sig-name">parseService</a>(<span class="summary-sig-arg">self</span>,
112
 
        <span class="summary-sig-arg">yadis_url</span>,
113
 
        <span class="summary-sig-arg">uri</span>,
114
 
        <span class="summary-sig-arg">type_uris</span>,
115
 
        <span class="summary-sig-arg">service_element</span>)</span><br />
116
 
      Set the state of this object based on the contents of the service 
117
 
      element.
118
 
  </td>
119
 
</tr>
120
 
<tr>
121
 
  <td width="15%" align="right" valign="top" class="summary">
122
 
    <span class="summary-type">&nbsp;</span>
123
 
  </td><td class="summary">
124
 
    <span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#getServerID" class="summary-sig-name">getServerID</a>(<span class="summary-sig-arg">self</span>)</span><br />
125
 
      Return the identifier that should be sent as the 
126
 
      openid.identity_url parameter to the server.
127
 
  </td>
128
 
</tr>
129
 
  <tr>
130
 
    <td colspan="2" class="summary">
131
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
132
 
      <code>__delattr__</code>,
133
 
      <code>__getattribute__</code>,
134
 
      <code>__hash__</code>,
135
 
      <code>__new__</code>,
136
 
      <code>__reduce__</code>,
137
 
      <code>__reduce_ex__</code>,
138
 
      <code>__repr__</code>,
139
 
      <code>__setattr__</code>,
140
 
      <code>__str__</code>
141
 
      </p>
142
 
    </td>
143
 
  </tr>
144
 
</table>
145
 
 
146
 
<br />
147
 
<!-- ==================== CLASS METHODS ==================== -->
148
 
<a name="section-ClassMethods"></a>
149
 
<table class="summary" border="1" cellpadding="3"
150
 
       cellspacing="0" width="100%" bgcolor="white">
151
 
<tr bgcolor="#70b0f0" class="table-header">
152
 
  <td colspan="2" class="table-header">
153
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
154
 
      <tr valign="top">
155
 
        <td align="left"><span class="table-header">Class Methods</span></td>
156
 
        <td align="right" valign="top"
157
 
         ><span class="options">[<a href="#section-ClassMethods"
158
 
         class="privatelink" onclick="toggle_private();"
159
 
         >hide private</a>]</span></td>
160
 
      </tr>
161
 
    </table>
162
 
  </td>
163
 
</tr>
164
 
<tr>
165
 
  <td width="15%" align="right" valign="top" class="summary">
166
 
    <span class="summary-type">&nbsp;</span>
167
 
  </td><td class="summary">
168
 
    <span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#fromBasicServiceEndpoint" class="summary-sig-name">fromBasicServiceEndpoint</a>(<span class="summary-sig-arg">cls</span>,
169
 
        <span class="summary-sig-arg">endpoint</span>)</span><br />
170
 
      Create a new instance of this class from the endpoint object 
171
 
      passed in.
172
 
  </td>
173
 
</tr>
174
 
<tr>
175
 
  <td width="15%" align="right" valign="top" class="summary">
176
 
    <span class="summary-type">&nbsp;</span>
177
 
  </td><td class="summary">
178
 
    <span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#fromHTML" class="summary-sig-name">fromHTML</a>(<span class="summary-sig-arg">cls</span>,
179
 
        <span class="summary-sig-arg">uri</span>,
180
 
        <span class="summary-sig-arg">html</span>)</span><br />
181
 
      Parse the given document as HTML looking for an OpenID &lt;link 
182
 
      rel=...&gt;
183
 
  </td>
184
 
</tr>
185
 
</table>
186
 
 
187
 
<br />
188
 
<!-- ==================== CLASS VARIABLES ==================== -->
189
 
<a name="section-ClassVariables"></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%">
195
 
      <tr valign="top">
196
 
        <td align="left"><span class="table-header">Class Variables</span></td>
197
 
        <td align="right" valign="top"
198
 
         ><span class="options">[<a href="#section-ClassVariables"
199
 
         class="privatelink" onclick="toggle_private();"
200
 
         >hide private</a>]</span></td>
201
 
      </tr>
202
 
    </table>
203
 
  </td>
204
 
</tr>
205
 
<tr>
206
 
  <td width="15%" align="right" valign="top" class="summary">
207
 
    <span class="summary-type">&nbsp;</span>
208
 
  </td><td class="summary">
209
 
    <a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#openid_type_uris">openid_type_uris</a> = <code title="['http://openid.net/signon/1.2', 'http://openid.net/signon/1.1', 'http://openid.net/signon/1.0']">['http://openid.net/signon/1.2', 'http://openid.net/...</code>
210
 
  </td>
211
 
</tr>
212
 
</table>
213
 
 
214
 
<br />
215
 
<!-- ==================== INSTANCE VARIABLES ==================== -->
216
 
<a name="section-InstanceVariables"></a>
217
 
<table class="summary" border="1" cellpadding="3"
218
 
       cellspacing="0" width="100%" bgcolor="white">
219
 
<tr bgcolor="#70b0f0" class="table-header">
220
 
  <td colspan="2" class="table-header">
221
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
222
 
      <tr valign="top">
223
 
        <td align="left"><span class="table-header">Instance Variables</span></td>
224
 
        <td align="right" valign="top"
225
 
         ><span class="options">[<a href="#section-InstanceVariables"
226
 
         class="privatelink" onclick="toggle_private();"
227
 
         >hide private</a>]</span></td>
228
 
      </tr>
229
 
    </table>
230
 
  </td>
231
 
</tr>
232
 
<tr>
233
 
  <td width="15%" align="right" valign="top" class="summary">
234
 
    <span class="summary-type">&nbsp;</span>
235
 
  </td><td class="summary">
236
 
    <a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#canonicalID">canonicalID</a><br />
237
 
      For XRI, the persistent identifier.
238
 
  </td>
239
 
</tr>
240
 
<tr>
241
 
  <td width="15%" align="right" valign="top" class="summary">
242
 
    <span class="summary-type">&nbsp;</span>
243
 
  </td><td class="summary">
244
 
    <a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#identity_url">identity_url</a><br />
245
 
      the verified identifier.
246
 
  </td>
247
 
</tr>
248
 
</table>
249
 
 
250
 
<br />
251
 
<!-- ==================== PROPERTIES ==================== -->
252
 
<a name="section-Properties"></a>
253
 
<table class="summary" border="1" cellpadding="3"
254
 
       cellspacing="0" width="100%" bgcolor="white">
255
 
<tr bgcolor="#70b0f0" class="table-header">
256
 
  <td colspan="2" class="table-header">
257
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
258
 
      <tr valign="top">
259
 
        <td align="left"><span class="table-header">Properties</span></td>
260
 
        <td align="right" valign="top"
261
 
         ><span class="options">[<a href="#section-Properties"
262
 
         class="privatelink" onclick="toggle_private();"
263
 
         >hide private</a>]</span></td>
264
 
      </tr>
265
 
    </table>
266
 
  </td>
267
 
</tr>
268
 
  <tr>
269
 
    <td colspan="2" class="summary">
270
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
271
 
      <code>__class__</code>
272
 
      </p>
273
 
    </td>
274
 
  </tr>
275
 
</table>
276
 
 
277
 
<br />
278
 
<!-- ==================== METHOD DETAILS ==================== -->
279
 
<a name="section-MethodDetails"></a>
280
 
<table class="summary" border="1" cellpadding="3"
281
 
       cellspacing="0" width="100%" bgcolor="white">
282
 
<tr bgcolor="#70b0f0" class="table-header">
283
 
  <td colspan="2" class="table-header">
284
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
285
 
      <tr valign="top">
286
 
        <td align="left"><span class="table-header">Method Details</span></td>
287
 
        <td align="right" valign="top"
288
 
         ><span class="options">[<a href="#section-MethodDetails"
289
 
         class="privatelink" onclick="toggle_private();"
290
 
         >hide private</a>]</span></td>
291
 
      </tr>
292
 
    </table>
293
 
  </td>
294
 
</tr>
295
 
</table>
296
 
<a name="__init__"></a>
297
 
<div>
298
 
<table class="details" border="1" cellpadding="3"
299
 
       cellspacing="0" width="100%" bgcolor="white">
300
 
<tr><td>
301
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
302
 
  <tr valign="top"><td>
303
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
304
 
    <br /><em class="fname">(Constructor)</em>
305
 
  </h3>
306
 
  </td><td align="right" valign="top"
307
 
    ><span class="codelink"><a href="openid.consumer.discover-pysrc.html#OpenIDServiceEndpoint.__init__">source&nbsp;code</a></span>&nbsp;
308
 
    </td>
309
 
  </table>
310
 
  
311
 
  <br />x.__init__(...) initializes x; see x.__class__.__doc__ for 
312
 
  signature
313
 
  <dl><dt></dt><dd>
314
 
    <dl><dt>Overrides:
315
 
      object.__init__
316
 
        <dd><em class="note">(inherited documentation)</em></dd>
317
 
    </dt></dl>
318
 
  </dd></dl>
319
 
</td></tr></table>
320
 
</div>
321
 
<a name="usesExtension"></a>
322
 
<div>
323
 
<table class="details" border="1" cellpadding="3"
324
 
       cellspacing="0" width="100%" bgcolor="white">
325
 
<tr><td>
326
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
327
 
  <tr valign="top"><td>
328
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">usesExtension</span>(<span class="sig-arg">self</span>,
329
 
        <span class="sig-arg">extension_uri</span>)</span>
330
 
  </h3>
331
 
  </td><td align="right" valign="top"
332
 
    ><span class="codelink"><a href="openid.consumer.discover-pysrc.html#OpenIDServiceEndpoint.usesExtension">source&nbsp;code</a></span>&nbsp;
333
 
    </td>
334
 
  </table>
335
 
  
336
 
  
337
 
  <dl><dt></dt><dd>
338
 
  </dd></dl>
339
 
</td></tr></table>
340
 
</div>
 
49
        <b>OpenIDServiceEndpoint</b>
 
50
</pre><br />
 
51
 
 
52
<hr/>
 
53
 
 
54
Object representing an OpenID service endpoint.
 
55
<hr/>
 
56
 
 
57
 
 
58
<!-- =========== START OF METHOD SUMMARY =========== -->
 
59
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
60
<tr bgcolor="#70b0f0" class="summary">
 
61
  <th colspan="2">Method Summary</th></tr>
 
62
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
63
  <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></code>
 
64
</td></tr>
 
65
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
66
  <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>
 
67
</td></tr>
 
68
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
69
  <td><code><a name="compatibilityMode"></a><span class="summary-sig"><span class="summary-sig-name">compatibilityMode</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
70
</td></tr>
 
71
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
72
  <td><code><span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#fromBasicServiceEndpoint" class="summary-sig-name"><code>fromBasicServiceEndpoint</code></a>(<span class=summary-sig-arg>cls</span>,
 
73
          <span class=summary-sig-arg>endpoint</span>)</span></code>
 
74
<br />
 
75
Create a new instance of this class from the endpoint object passed 
 
76
in.    <i>(Class method)</i>
 
77
</td></tr>
 
78
<tr><td align="right" valign="top" width="15%"><font size="-1">        [OpenIDServiceEndpoint]
 
79
</font></td>
 
80
  <td><code><span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#fromHTML" class="summary-sig-name"><code>fromHTML</code></a>(<span class=summary-sig-arg>cls</span>,
 
81
          <span class=summary-sig-arg>uri</span>,
 
82
          <span class=summary-sig-arg>html</span>)</span></code>
 
83
<br />
 
84
Parse the given document as HTML looking for an OpenID &lt;link 
 
85
rel=...&gt;    <i>(Class method)</i>
 
86
</td></tr>
 
87
<tr><td align="right" valign="top" width="15%"><font size="-1">        OpenIDServiceEndpoint
 
88
</font></td>
 
89
  <td><code><span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#fromOPEndpointURL" class="summary-sig-name"><code>fromOPEndpointURL</code></a>(<span class=summary-sig-arg>cls</span>,
 
90
          <span class=summary-sig-arg>op_endpoint_url</span>)</span></code>
 
91
<br />
 
92
Construct an OP-Identifier OpenIDServiceEndpoint object for a given OP 
 
93
Endpoint URL    <i>(Class method)</i>
 
94
</td></tr>
 
95
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
96
  <td><code><span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#getLocalID" class="summary-sig-name"><code>getLocalID</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
97
<br />
 
98
Return the identifier that should be sent as the openid.identity 
 
99
parameter to the server.</td></tr>
 
100
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
101
  <td><code><a name="isOPIdentifier"></a><span class="summary-sig"><span class="summary-sig-name">isOPIdentifier</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
102
</td></tr>
 
103
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
104
  <td><code><span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#parseService" class="summary-sig-name"><code>parseService</code></a>(<span class=summary-sig-arg>self</span>,
 
105
          <span class=summary-sig-arg>yadis_url</span>,
 
106
          <span class=summary-sig-arg>uri</span>,
 
107
          <span class=summary-sig-arg>type_uris</span>,
 
108
          <span class=summary-sig-arg>service_element</span>)</span></code>
 
109
<br />
 
110
Set the state of this object based on the contents of the service 
 
111
element.</td></tr>
 
112
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
113
  <td><code><a name="preferredNamespace"></a><span class="summary-sig"><span class="summary-sig-name">preferredNamespace</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
114
</td></tr>
 
115
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
116
  <td><code><span class="summary-sig"><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#supportsType" class="summary-sig-name"><code>supportsType</code></a>(<span class=summary-sig-arg>self</span>,
 
117
          <span class=summary-sig-arg>type_uri</span>)</span></code>
 
118
<br />
 
119
Does this endpoint support this type?</td></tr>
 
120
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
121
  <td><code><a name="usesExtension"></a><span class="summary-sig"><span class="summary-sig-name">usesExtension</span>(<span class=summary-sig-arg>self</span>,
 
122
          <span class=summary-sig-arg>extension_uri</span>)</span></code>
 
123
</td></tr>
 
124
  <tr><td colspan="2">
 
125
    <b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
 
126
      <a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>, 
 
127
      <a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>, 
 
128
      <a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>, 
 
129
      <a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>, 
 
130
      <a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>, 
 
131
      <a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>, 
 
132
      <a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a>, 
 
133
      <a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>
 
134
    </td></tr>
 
135
</table><br />
 
136
 
 
137
 
 
138
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
 
139
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
140
<tr bgcolor="#70b0f0" class="summary">
 
141
  <th colspan="2">Instance Variable Summary</th></tr>
 
142
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
143
<td><b><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#canonicalID"><code>canonicalID</code></a></b>: For XRI, the persistent identifier.</td></tr>
 
144
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
145
<td><b><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#identity_url"><code>identity_url</code></a></b>: the verified identifier.</td></tr>
 
146
</table><br />
 
147
 
 
148
 
 
149
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
150
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
151
<tr bgcolor="#70b0f0" class="summary">
 
152
  <th colspan="2">Class Variable Summary</th></tr>
 
153
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
 
154
<td><b><a href="openid.consumer.discover.OpenIDServiceEndpoint-class.html#openid_type_uris"><code>openid_type_uris</code></a></b> = <span title="['http://specs.openid.net/auth/2.0/server', 'http://specs.openid.net/auth/2.0/signon', 'http://openid.net/signon/1.1', 'http://openid.net/signon/1.0']"><code>['http://specs.openid.net/auth/2.0/se<span class="variable-ellipsis">...</span></code>
 
155
</span></td></tr>
 
156
</table><br />
 
157
 
 
158
 
 
159
<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
 
160
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
161
<tr bgcolor="#70b0f0" class="details">
 
162
  <th colspan="2">Instance Method Details</th></tr>
 
163
</table>
 
164
 
 
165
<a name="getLocalID"></a>
 
166
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
167
  <h3><span class="sig"><span class="sig-name">getLocalID</span>(<span class=sig-arg>self</span>)</span>
 
168
  </h3>
 
169
  Return the identifier that should be sent as the openid.identity 
 
170
  parameter to the server.
 
171
  <dl><dt></dt><dd>
 
172
  </dd></dl>
 
173
</td></tr></table>
 
174
 
341
175
<a name="parseService"></a>
342
 
<div>
343
 
<table class="details" border="1" cellpadding="3"
344
 
       cellspacing="0" width="100%" bgcolor="white">
345
 
<tr><td>
346
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
347
 
  <tr valign="top"><td>
348
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">parseService</span>(<span class="sig-arg">self</span>,
349
 
        <span class="sig-arg">yadis_url</span>,
350
 
        <span class="sig-arg">uri</span>,
351
 
        <span class="sig-arg">type_uris</span>,
352
 
        <span class="sig-arg">service_element</span>)</span>
 
176
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
177
  <h3><span class="sig"><span class="sig-name">parseService</span>(<span class=sig-arg>self</span>,
 
178
          <span class=sig-arg>yadis_url</span>,
 
179
          <span class=sig-arg>uri</span>,
 
180
          <span class=sig-arg>type_uris</span>,
 
181
          <span class=sig-arg>service_element</span>)</span>
353
182
  </h3>
354
 
  </td><td align="right" valign="top"
355
 
    ><span class="codelink"><a href="openid.consumer.discover-pysrc.html#OpenIDServiceEndpoint.parseService">source&nbsp;code</a></span>&nbsp;
356
 
    </td>
357
 
  </table>
358
 
  
359
 
  <br />Set the state of this object based on the contents of the service 
 
183
  Set the state of this object based on the contents of the service 
360
184
  element.
361
185
  <dl><dt></dt><dd>
362
186
  </dd></dl>
363
187
</td></tr></table>
364
 
</div>
365
 
<a name="getServerID"></a>
366
 
<div>
367
 
<table class="details" border="1" cellpadding="3"
368
 
       cellspacing="0" width="100%" bgcolor="white">
369
 
<tr><td>
370
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
371
 
  <tr valign="top"><td>
372
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getServerID</span>(<span class="sig-arg">self</span>)</span>
 
188
 
 
189
<a name="supportsType"></a>
 
190
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
191
  <h3><span class="sig"><span class="sig-name">supportsType</span>(<span class=sig-arg>self</span>,
 
192
          <span class=sig-arg>type_uri</span>)</span>
373
193
  </h3>
374
 
  </td><td align="right" valign="top"
375
 
    ><span class="codelink"><a href="openid.consumer.discover-pysrc.html#OpenIDServiceEndpoint.getServerID">source&nbsp;code</a></span>&nbsp;
376
 
    </td>
377
 
  </table>
378
 
  
379
 
  <br />Return the identifier that should be sent as the openid.identity_url 
380
 
  parameter to the server.
 
194
  <p>Does this endpoint support this type?</p>
 
195
  I consider <code>/server</code> endpoints to implicitly support 
 
196
  <code>/signon</code>.
381
197
  <dl><dt></dt><dd>
382
198
  </dd></dl>
383
199
</td></tr></table>
384
 
</div>
 
200
<br />
 
201
 
 
202
 
 
203
<!-- =========== START OF CLASS METHOD DETAILS =========== -->
 
204
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
205
<tr bgcolor="#70b0f0" class="details">
 
206
  <th colspan="2">Class Method Details</th></tr>
 
207
</table>
 
208
 
385
209
<a name="fromBasicServiceEndpoint"></a>
386
 
<div>
387
 
<table class="details" border="1" cellpadding="3"
388
 
       cellspacing="0" width="100%" bgcolor="white">
389
 
<tr><td>
390
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
391
 
  <tr valign="top"><td>
392
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">fromBasicServiceEndpoint</span>(<span class="sig-arg">cls</span>,
393
 
        <span class="sig-arg">endpoint</span>)</span>
394
 
    <br /><em class="fname">Class Method</em>
 
210
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
211
  <h3><span class="sig"><span class="sig-name">fromBasicServiceEndpoint</span>(<span class=sig-arg>cls</span>,
 
212
          <span class=sig-arg>endpoint</span>)</span>
395
213
  </h3>
396
 
  </td><td align="right" valign="top"
397
 
    ><span class="codelink"><a href="openid.consumer.discover-pysrc.html#OpenIDServiceEndpoint.fromBasicServiceEndpoint">source&nbsp;code</a></span>&nbsp;
398
 
    </td>
399
 
  </table>
400
 
  
401
 
  <br />Create a new instance of this class from the endpoint object passed 
 
214
  Create a new instance of this class from the endpoint object passed 
402
215
  in.
403
216
  <dl><dt></dt><dd>
404
 
    <dl><dt>Returns:</dt>
405
 
        <dd>None or OpenIDServiceEndpoint for this endpoint object</dd></dl>
 
217
    <dl><dt><b>Returns:</b></dt>
 
218
      <dd>
 
219
        None or OpenIDServiceEndpoint for this endpoint object
 
220
      </dd>
 
221
    </dl>
406
222
  </dd></dl>
407
223
</td></tr></table>
408
 
</div>
 
224
 
409
225
<a name="fromHTML"></a>
410
 
<div>
411
 
<table class="details" border="1" cellpadding="3"
412
 
       cellspacing="0" width="100%" bgcolor="white">
413
 
<tr><td>
414
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
415
 
  <tr valign="top"><td>
416
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">fromHTML</span>(<span class="sig-arg">cls</span>,
417
 
        <span class="sig-arg">uri</span>,
418
 
        <span class="sig-arg">html</span>)</span>
419
 
    <br /><em class="fname">Class Method</em>
 
226
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
227
  <h3><span class="sig"><span class="sig-name">fromHTML</span>(<span class=sig-arg>cls</span>,
 
228
          <span class=sig-arg>uri</span>,
 
229
          <span class=sig-arg>html</span>)</span>
420
230
  </h3>
421
 
  </td><td align="right" valign="top"
422
 
    ><span class="codelink"><a href="openid.consumer.discover-pysrc.html#OpenIDServiceEndpoint.fromHTML">source&nbsp;code</a></span>&nbsp;
423
 
    </td>
424
 
  </table>
425
 
  
426
 
  <br />Parse the given document as HTML looking for an OpenID &lt;link 
 
231
  Parse the given document as HTML looking for an OpenID &lt;link 
427
232
  rel=...&gt;
428
233
  <dl><dt></dt><dd>
429
 
  </dd></dl>
430
 
</td></tr></table>
431
 
</div>
432
 
<br />
433
 
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
434
 
<a name="section-ClassVariableDetails"></a>
435
 
<table class="summary" border="1" cellpadding="3"
436
 
       cellspacing="0" width="100%" bgcolor="white">
437
 
<tr bgcolor="#70b0f0" class="table-header">
438
 
  <td colspan="2" class="table-header">
439
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
440
 
      <tr valign="top">
441
 
        <td align="left"><span class="table-header">Class Variable Details</span></td>
442
 
        <td align="right" valign="top"
443
 
         ><span class="options">[<a href="#section-ClassVariableDetails"
444
 
         class="privatelink" onclick="toggle_private();"
445
 
         >hide private</a>]</span></td>
446
 
      </tr>
447
 
    </table>
448
 
  </td>
449
 
</tr>
450
 
</table>
 
234
    <dl><dt><b>Returns:</b></dt>
 
235
      <dd>
 
236
        [OpenIDServiceEndpoint]
 
237
      </dd>
 
238
    </dl>
 
239
  </dd></dl>
 
240
</td></tr></table>
 
241
 
 
242
<a name="fromOPEndpointURL"></a>
 
243
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
244
  <h3><span class="sig"><span class="sig-name">fromOPEndpointURL</span>(<span class=sig-arg>cls</span>,
 
245
          <span class=sig-arg>op_endpoint_url</span>)</span>
 
246
  </h3>
 
247
  Construct an OP-Identifier OpenIDServiceEndpoint object for a given 
 
248
  OP Endpoint URL
 
249
  <dl><dt></dt><dd>
 
250
    <dl><dt><b>Parameters:</b></dt>
 
251
      <dd><code><b>op_endpoint_url</b></code> -
 
252
         The URL of the endpoint
 
253
      </dd>
 
254
    </dl>
 
255
    <dl><dt><b>Returns:</b></dt>
 
256
      <dd>
 
257
        OpenIDServiceEndpoint
 
258
      </dd>
 
259
    </dl>
 
260
  </dd></dl>
 
261
</td></tr></table>
 
262
<br />
 
263
 
 
264
 
 
265
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
 
266
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
267
<tr bgcolor="#70b0f0" class="details">
 
268
  <th colspan="2">Instance Variable Details</th></tr>
 
269
</table>
 
270
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
271
<a name="canonicalID"></a>
 
272
<h3>canonicalID</h3>
 
273
For XRI, the persistent identifier.
 
274
</td></tr></table>
 
275
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
276
<a name="identity_url"></a>
 
277
<h3>identity_url</h3>
 
278
the verified identifier.
 
279
</td></tr></table>
 
280
<br />
 
281
 
 
282
 
 
283
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
 
284
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
285
<tr bgcolor="#70b0f0" class="details">
 
286
  <th colspan="2">Class Variable Details</th></tr>
 
287
</table>
 
288
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
451
289
<a name="openid_type_uris"></a>
452
 
<div>
453
 
<table class="details" border="1" cellpadding="3"
454
 
       cellspacing="0" width="100%" bgcolor="white">
455
 
<tr><td>
456
 
  <h3 class="epydoc">openid_type_uris</h3>
457
 
  
458
 
  <dl><dt></dt><dd>
459
 
    <dl><dt>Value:</dt>
460
 
      <dd><table><tr><td><pre class="variable">
461
 
['http://openid.net/signon/1.2',
 
290
<h3>openid_type_uris</h3>
 
291
<dl>
 
292
  <dt></dt>
 
293
  <dd>
 
294
    <dl>
 
295
      <dt><b>Type:</b></dt>
 
296
      <dd>
 
297
          <code>list</code>
 
298
 
 
299
      </dd>
 
300
<span title="['http://specs.openid.net/auth/2.0/server', 'http://specs.openid.net/auth/2.0/signon', 'http://openid.net/signon/1.1', 'http://openid.net/signon/1.0']">      <dt><b>Value:</b></dt>
 
301
      <dd><table><tr><td>
 
302
<pre class="variable">
 
303
['http://specs.openid.net/auth/2.0/server',
 
304
 'http://specs.openid.net/auth/2.0/signon',
462
305
 'http://openid.net/signon/1.1',
463
 
 'http://openid.net/signon/1.0']                                       
464
 
      </pre></td></tr></table></dd>
465
 
    </dl>
466
 
  </dd></dl>
467
 
</td></tr></table>
468
 
</div>
469
 
<br />
470
 
<!-- ==================== INSTANCE VARIABLE DETAILS ==================== -->
471
 
<a name="section-InstanceVariableDetails"></a>
472
 
<table class="summary" border="1" cellpadding="3"
473
 
       cellspacing="0" width="100%" bgcolor="white">
474
 
<tr bgcolor="#70b0f0" class="table-header">
475
 
  <td colspan="2" class="table-header">
476
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
477
 
      <tr valign="top">
478
 
        <td align="left"><span class="table-header">Instance Variable Details</span></td>
479
 
        <td align="right" valign="top"
480
 
         ><span class="options">[<a href="#section-InstanceVariableDetails"
481
 
         class="privatelink" onclick="toggle_private();"
482
 
         >hide private</a>]</span></td>
483
 
      </tr>
484
 
    </table>
485
 
  </td>
486
 
</tr>
487
 
</table>
488
 
<a name="canonicalID"></a>
489
 
<div>
490
 
<table class="details" border="1" cellpadding="3"
491
 
       cellspacing="0" width="100%" bgcolor="white">
492
 
<tr><td>
493
 
  <h3 class="epydoc">canonicalID</h3>
494
 
  <br />For XRI, the persistent identifier.
495
 
  <dl><dt></dt><dd>
496
 
  </dd></dl>
497
 
</td></tr></table>
498
 
</div>
499
 
<a name="identity_url"></a>
500
 
<div>
501
 
<table class="details" border="1" cellpadding="3"
502
 
       cellspacing="0" width="100%" bgcolor="white">
503
 
<tr><td>
504
 
  <h3 class="epydoc">identity_url</h3>
505
 
  <br />the verified identifier.
506
 
  <dl><dt></dt><dd>
507
 
  </dd></dl>
508
 
</td></tr></table>
509
 
</div>
510
 
<br />
511
 
<!-- ==================== NAVIGATION BAR ==================== -->
512
 
<table class="navbar" border="0" width="100%" cellpadding="0"
513
 
       bgcolor="#a0c0ff" cellspacing="0">
514
 
  <tr valign="middle">
515
 
  <!-- Home link -->
516
 
      <th>&nbsp;&nbsp;&nbsp;<a
517
 
        href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
518
 
 
519
 
  <!-- Tree link -->
520
 
      <th>&nbsp;&nbsp;&nbsp;<a
521
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
522
 
 
523
 
  <!-- Index link -->
524
 
      <th>&nbsp;&nbsp;&nbsp;<a
525
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
526
 
 
527
 
  <!-- Help link -->
528
 
      <th>&nbsp;&nbsp;&nbsp;<a
529
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
530
 
 
531
 
  <!-- Project homepage -->
532
 
      <th class="navbar" align="right" width="100%">
533
 
        <table border="0" cellpadding="0" cellspacing="0">
534
 
          <tr><th class="navbar" align="center"
535
 
            ><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
536
 
          </tr></table></th>
 
306
 'http://openid.net/signon/1.0']                                       </pre>
 
307
        </td></tr></table></dd>
 
308
</span>    </dl>
 
309
  </dd>
 
310
</dl></td></tr></table>
 
311
<br />
 
312
 
 
313
 
 
314
<!-- =========== START OF NAVBAR =========== -->
 
315
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
316
  <tr valign="center">
 
317
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
318
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
319
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
320
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
321
    <th class="navbar" align="right" width="100%">
 
322
      <table border="0" cellpadding="0" cellspacing="0">
 
323
      <tr><th class="navbar" align="center">
 
324
        <p class="nomargin">
 
325
          <a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
 
326
      </p></th></tr></table>
 
327
    </th>
537
328
  </tr>
538
329
</table>
539
 
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
330
 
 
331
<table border="0" cellpadding="0" cellspacing="0" width="100%">
540
332
  <tr>
541
 
    <td align="left" class="footer">Generated by Epydoc
542
 
        3.0alpha3 on Fri Dec  8 13:26:20 2006</td>
543
 
    <td align="right" class="footer">
544
 
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
545
 
    </td>
 
333
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:12 2007</font></td>
 
334
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
335
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
546
336
  </tr>
547
337
</table>
548
 
 
549
 
<script type="text/javascript">
550
 
  <!--
551
 
  // Private objects are initially displayed (because if
552
 
  // javascript is turned off then we want them to be
553
 
  // visible); but by default, we want to hide them.  So hide
554
 
  // them unless we have a cookie that says to show them.
555
 
  checkCookie()
556
 
  // -->
557
 
</script>
558
 
  
559
338
</body>
560
339
</html>