Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d37e76fad280dda7565e08efe6a0426e081fd542 / . / docs / epy / oauth2client.client.Storage-class.html
blob: 432c5e59e4d2a32a25a80aa3bcdd8714e3abb47b [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>oauth2client.client.Storage</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 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
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 <a href="oauth2client.client-module.html">Module&nbsp;client</a> ::
39 Class&nbsp;Storage
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="oauth2client.client.Storage-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class Storage</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]58 <div class="private"><center> <map id="class_hierarchy_for_storage" name="class_hierarchy_for_storage">
59<area shape="rect" href="oauth2client.appengine.StorageByKeyName-class.html" title="appengine.StorageByKeyName" alt="" coords="5,61,208,88"/>
60<area shape="rect" href="oauth2client.client.Storage-class.html" title="Storage" alt="" coords="333,5,400,32"/>
61<area shape="rect" href="oauth2client.django_orm.Storage-class.html" title="django_orm.Storage" alt="" coords="232,61,368,88"/>
62<area shape="rect" href="oauth2client.file.Storage-class.html" title="file.Storage" alt="" coords="392,61,477,88"/>
63<area shape="rect" href="oauth2client.multistore_file._MultiStore._Storage-class.html" title="multistore_file._MultiStore._Storage" alt="" coords="501,61,728,88"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]64</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]65 <img src="class_hierarchy_for_storage.gif" alt='' usemap="#class_hierarchy_for_storage" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]66</center></div>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]67 <div class="public" style="display:none"><center> <map id="class_hierarchy_for_storage_2" name="class_hierarchy_for_storage_2">
68<area shape="rect" href="oauth2client.appengine.StorageByKeyName-class.html" title="appengine.StorageByKeyName" alt="" coords="5,61,208,88"/>
69<area shape="rect" href="oauth2client.client.Storage-class.html" title="Storage" alt="" coords="267,5,333,32"/>
70<area shape="rect" href="oauth2client.django_orm.Storage-class.html" title="django_orm.Storage" alt="" coords="232,61,368,88"/>
71<area shape="rect" href="oauth2client.file.Storage-class.html" title="file.Storage" alt="" coords="392,61,477,88"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]72</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]73 <img src="class_hierarchy_for_storage_2.gif" alt='' usemap="#class_hierarchy_for_storage_2" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]74</center></div>
75</center>
76<hr />
77<pre class="literalblock">
78Base class for all Storage objects.
79
80Store and retrieve a single credential. This class supports locking
81such that multiple processes and threads can operate on a single
82store.
83
84</pre>
85
86<!-- ==================== INSTANCE METHODS ==================== -->
87<a name="section-InstanceMethods"></a>
88<table class="summary" border="1" cellpadding="3"
89 cellspacing="0" width="100%" bgcolor="white">
90<tr bgcolor="#70b0f0" class="table-header">
91 <td colspan="2" class="table-header">
92 <table border="0" cellpadding="0" cellspacing="0" width="100%">
93 <tr valign="top">
94 <td align="left"><span class="table-header">Instance Methods</span></td>
95 <td align="right" valign="top"
96 ><span class="options">[<a href="#section-InstanceMethods"
97 class="privatelink" onclick="toggle_private();"
98 >hide private</a>]</span></td>
99 </tr>
100 </table>
101 </td>
102</tr>
103<tr>
104 <td width="15%" align="right" valign="top" class="summary">
105 <span class="summary-type">&nbsp;</span>
106 </td><td class="summary">
107 <table width="100%" cellpadding="0" cellspacing="0" border="0">
108 <tr>
109 <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#acquire_lock" class="summary-sig-name">acquire_lock</a>(<span class="summary-sig-arg">self</span>)</span><br />
110 Acquires any lock necessary to access this Storage.</td>
111 <td align="right" valign="top">
112 <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.acquire_lock">source&nbsp;code</a></span>
113
114 </td>
115 </tr>
116 </table>
117
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 <table width="100%" cellpadding="0" cellspacing="0" border="0">
125 <tr>
126 <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#release_lock" class="summary-sig-name">release_lock</a>(<span class="summary-sig-arg">self</span>)</span><br />
127 Release the Storage lock.</td>
128 <td align="right" valign="top">
129 <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.release_lock">source&nbsp;code</a></span>
130
131 </td>
132 </tr>
133 </table>
134
135 </td>
136 </tr>
137<tr>
138 <td width="15%" align="right" valign="top" class="summary">
139 <span class="summary-type">&nbsp;</span>
140 </td><td class="summary">
141 <table width="100%" cellpadding="0" cellspacing="0" border="0">
142 <tr>
143 <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#locked_get" class="summary-sig-name">locked_get</a>(<span class="summary-sig-arg">self</span>)</span><br />
144 Retrieve credential.</td>
145 <td align="right" valign="top">
146 <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_get">source&nbsp;code</a></span>
147
148 </td>
149 </tr>
150 </table>
151
152 </td>
153 </tr>
154<tr>
155 <td width="15%" align="right" valign="top" class="summary">
156 <span class="summary-type">&nbsp;</span>
157 </td><td class="summary">
158 <table width="100%" cellpadding="0" cellspacing="0" border="0">
159 <tr>
160 <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#locked_put" class="summary-sig-name">locked_put</a>(<span class="summary-sig-arg">self</span>,
161 <span class="summary-sig-arg">credentials</span>)</span><br />
162 Write a credential.</td>
163 <td align="right" valign="top">
164 <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_put">source&nbsp;code</a></span>
165
166 </td>
167 </tr>
168 </table>
169
170 </td>
171 </tr>
172<tr>
173 <td width="15%" align="right" valign="top" class="summary">
174 <span class="summary-type">&nbsp;</span>
175 </td><td class="summary">
176 <table width="100%" cellpadding="0" cellspacing="0" border="0">
177 <tr>
178 <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#locked_delete" class="summary-sig-name">locked_delete</a>(<span class="summary-sig-arg">self</span>)</span><br />
179 Delete a credential.</td>
180 <td align="right" valign="top">
181 <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_delete">source&nbsp;code</a></span>
182
183 </td>
184 </tr>
185 </table>
186
187 </td>
188 </tr>
189<tr>
190 <td width="15%" align="right" valign="top" class="summary">
191 <span class="summary-type">&nbsp;</span>
192 </td><td class="summary">
193 <table width="100%" cellpadding="0" cellspacing="0" border="0">
194 <tr>
195 <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>)</span><br />
196 Retrieve credential.</td>
197 <td align="right" valign="top">
198 <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.get">source&nbsp;code</a></span>
199
200 </td>
201 </tr>
202 </table>
203
204 </td>
205 </tr>
206<tr>
207 <td width="15%" align="right" valign="top" class="summary">
208 <span class="summary-type">&nbsp;</span>
209 </td><td class="summary">
210 <table width="100%" cellpadding="0" cellspacing="0" border="0">
211 <tr>
212 <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#put" class="summary-sig-name">put</a>(<span class="summary-sig-arg">self</span>,
213 <span class="summary-sig-arg">credentials</span>)</span><br />
214 Write a credential.</td>
215 <td align="right" valign="top">
216 <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.put">source&nbsp;code</a></span>
217
218 </td>
219 </tr>
220 </table>
221
222 </td>
223 </tr>
224<tr>
225 <td width="15%" align="right" valign="top" class="summary">
226 <span class="summary-type">&nbsp;</span>
227 </td><td class="summary">
228 <table width="100%" cellpadding="0" cellspacing="0" border="0">
229 <tr>
230 <td><span class="summary-sig"><a href="oauth2client.client.Storage-class.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">self</span>)</span><br />
231 Delete credential.</td>
232 <td align="right" valign="top">
233 <span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.delete">source&nbsp;code</a></span>
234
235 </td>
236 </tr>
237 </table>
238
239 </td>
240 </tr>
241 <tr>
242 <td colspan="2" class="summary">
243 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
244 <code>__delattr__</code>,
245 <code>__format__</code>,
246 <code>__getattribute__</code>,
247 <code>__hash__</code>,
248 <code>__init__</code>,
249 <code>__new__</code>,
250 <code>__reduce__</code>,
251 <code>__reduce_ex__</code>,
252 <code>__repr__</code>,
253 <code>__setattr__</code>,
254 <code>__sizeof__</code>,
255 <code>__str__</code>,
256 <code>__subclasshook__</code>
257 </p>
258 </td>
259 </tr>
260</table>
261<!-- ==================== PROPERTIES ==================== -->
262<a name="section-Properties"></a>
263<table class="summary" border="1" cellpadding="3"
264 cellspacing="0" width="100%" bgcolor="white">
265<tr bgcolor="#70b0f0" class="table-header">
266 <td colspan="2" class="table-header">
267 <table border="0" cellpadding="0" cellspacing="0" width="100%">
268 <tr valign="top">
269 <td align="left"><span class="table-header">Properties</span></td>
270 <td align="right" valign="top"
271 ><span class="options">[<a href="#section-Properties"
272 class="privatelink" onclick="toggle_private();"
273 >hide private</a>]</span></td>
274 </tr>
275 </table>
276 </td>
277</tr>
278 <tr>
279 <td colspan="2" class="summary">
280 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
281 <code>__class__</code>
282 </p>
283 </td>
284 </tr>
285</table>
286<!-- ==================== METHOD DETAILS ==================== -->
287<a name="section-MethodDetails"></a>
288<table class="details" border="1" cellpadding="3"
289 cellspacing="0" width="100%" bgcolor="white">
290<tr bgcolor="#70b0f0" class="table-header">
291 <td colspan="2" class="table-header">
292 <table border="0" cellpadding="0" cellspacing="0" width="100%">
293 <tr valign="top">
294 <td align="left"><span class="table-header">Method Details</span></td>
295 <td align="right" valign="top"
296 ><span class="options">[<a href="#section-MethodDetails"
297 class="privatelink" onclick="toggle_private();"
298 >hide private</a>]</span></td>
299 </tr>
300 </table>
301 </td>
302</tr>
303</table>
304<a name="acquire_lock"></a>
305<div>
306<table class="details" border="1" cellpadding="3"
307 cellspacing="0" width="100%" bgcolor="white">
308<tr><td>
309 <table width="100%" cellpadding="0" cellspacing="0" border="0">
310 <tr valign="top"><td>
311 <h3 class="epydoc"><span class="sig"><span class="sig-name">acquire_lock</span>(<span class="sig-arg">self</span>)</span>
312 </h3>
313 </td><td align="right" valign="top"
314 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.acquire_lock">source&nbsp;code</a></span>&nbsp;
315 </td>
316 </tr></table>
317
318 <pre class="literalblock">
319Acquires any lock necessary to access this Storage.
320
321This lock is not reentrant.
322
323</pre>
324 <dl class="fields">
325 </dl>
326</td></tr></table>
327</div>
328<a name="release_lock"></a>
329<div>
330<table class="details" border="1" cellpadding="3"
331 cellspacing="0" width="100%" bgcolor="white">
332<tr><td>
333 <table width="100%" cellpadding="0" cellspacing="0" border="0">
334 <tr valign="top"><td>
335 <h3 class="epydoc"><span class="sig"><span class="sig-name">release_lock</span>(<span class="sig-arg">self</span>)</span>
336 </h3>
337 </td><td align="right" valign="top"
338 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.release_lock">source&nbsp;code</a></span>&nbsp;
339 </td>
340 </tr></table>
341
342 <pre class="literalblock">
343Release the Storage lock.
344
345Trying to release a lock that isn't held will result in a
346RuntimeError.
347
348</pre>
349 <dl class="fields">
350 </dl>
351</td></tr></table>
352</div>
353<a name="locked_get"></a>
354<div>
355<table class="details" border="1" cellpadding="3"
356 cellspacing="0" width="100%" bgcolor="white">
357<tr><td>
358 <table width="100%" cellpadding="0" cellspacing="0" border="0">
359 <tr valign="top"><td>
360 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_get</span>(<span class="sig-arg">self</span>)</span>
361 </h3>
362 </td><td align="right" valign="top"
363 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_get">source&nbsp;code</a></span>&nbsp;
364 </td>
365 </tr></table>
366
367 <pre class="literalblock">
368Retrieve credential.
369
370The Storage lock must be held when this is called.
371
372Returns:
373 oauth2client.client.Credentials
374
375</pre>
376 <dl class="fields">
377 </dl>
378</td></tr></table>
379</div>
380<a name="locked_put"></a>
381<div>
382<table class="details" border="1" cellpadding="3"
383 cellspacing="0" width="100%" bgcolor="white">
384<tr><td>
385 <table width="100%" cellpadding="0" cellspacing="0" border="0">
386 <tr valign="top"><td>
387 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_put</span>(<span class="sig-arg">self</span>,
388 <span class="sig-arg">credentials</span>)</span>
389 </h3>
390 </td><td align="right" valign="top"
391 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_put">source&nbsp;code</a></span>&nbsp;
392 </td>
393 </tr></table>
394
395 <pre class="literalblock">
396Write a credential.
397
398The Storage lock must be held when this is called.
399
400Args:
401 credentials: Credentials, the credentials to store.
402
403</pre>
404 <dl class="fields">
405 </dl>
406</td></tr></table>
407</div>
408<a name="locked_delete"></a>
409<div>
410<table class="details" border="1" cellpadding="3"
411 cellspacing="0" width="100%" bgcolor="white">
412<tr><td>
413 <table width="100%" cellpadding="0" cellspacing="0" border="0">
414 <tr valign="top"><td>
415 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_delete</span>(<span class="sig-arg">self</span>)</span>
416 </h3>
417 </td><td align="right" valign="top"
418 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.locked_delete">source&nbsp;code</a></span>&nbsp;
419 </td>
420 </tr></table>
421
422 <pre class="literalblock">
423Delete a credential.
424
425The Storage lock must be held when this is called.
426
427</pre>
428 <dl class="fields">
429 </dl>
430</td></tr></table>
431</div>
432<a name="get"></a>
433<div>
434<table class="details" border="1" cellpadding="3"
435 cellspacing="0" width="100%" bgcolor="white">
436<tr><td>
437 <table width="100%" cellpadding="0" cellspacing="0" border="0">
438 <tr valign="top"><td>
439 <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>)</span>
440 </h3>
441 </td><td align="right" valign="top"
442 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.get">source&nbsp;code</a></span>&nbsp;
443 </td>
444 </tr></table>
445
446 <pre class="literalblock">
447Retrieve credential.
448
449The Storage lock must *not* be held when this is called.
450
451Returns:
452 oauth2client.client.Credentials
453
454</pre>
455 <dl class="fields">
456 </dl>
457</td></tr></table>
458</div>
459<a name="put"></a>
460<div>
461<table class="details" border="1" cellpadding="3"
462 cellspacing="0" width="100%" bgcolor="white">
463<tr><td>
464 <table width="100%" cellpadding="0" cellspacing="0" border="0">
465 <tr valign="top"><td>
466 <h3 class="epydoc"><span class="sig"><span class="sig-name">put</span>(<span class="sig-arg">self</span>,
467 <span class="sig-arg">credentials</span>)</span>
468 </h3>
469 </td><td align="right" valign="top"
470 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.put">source&nbsp;code</a></span>&nbsp;
471 </td>
472 </tr></table>
473
474 <pre class="literalblock">
475Write a credential.
476
477The Storage lock must be held when this is called.
478
479Args:
480 credentials: Credentials, the credentials to store.
481
482</pre>
483 <dl class="fields">
484 </dl>
485</td></tr></table>
486</div>
487<a name="delete"></a>
488<div>
489<table class="details" border="1" cellpadding="3"
490 cellspacing="0" width="100%" bgcolor="white">
491<tr><td>
492 <table width="100%" cellpadding="0" cellspacing="0" border="0">
493 <tr valign="top"><td>
494 <h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">self</span>)</span>
495 </h3>
496 </td><td align="right" valign="top"
497 ><span class="codelink"><a href="oauth2client.client-pysrc.html#Storage.delete">source&nbsp;code</a></span>&nbsp;
498 </td>
499 </tr></table>
500
501 <pre class="literalblock">
502Delete credential.
503
504Frees any resources associated with storing the credential.
505The Storage lock must *not* be held when this is called.
506
507Returns:
508 None
509
510</pre>
511 <dl class="fields">
512 </dl>
513</td></tr></table>
514</div>
515<br />
516<!-- ==================== NAVIGATION BAR ==================== -->
517<table class="navbar" border="0" width="100%" cellpadding="0"
518 bgcolor="#a0c0ff" cellspacing="0">
519 <tr valign="middle">
520
521 <!-- Tree link -->
522 <th>&nbsp;&nbsp;&nbsp;<a
523 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
524
525 <!-- Index link -->
526 <th>&nbsp;&nbsp;&nbsp;<a
527 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
528
529 <!-- Help link -->
530 <th>&nbsp;&nbsp;&nbsp;<a
531 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
532
533 <th class="navbar" width="100%"></th>
534 </tr>
535</table>
536<table border="0" cellpadding="0" cellspacing="0" width="100%%">
537 <tr>
538 <td align="left" class="footer">
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]539 Generated by Epydoc 3.0.1 on Fri Jun 15 13:13:24 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]540 </td>
541 <td align="right" class="footer">
542 <a target="mainFrame" href="http://epydoc.sourceforge.net"
543 >http://epydoc.sourceforge.net</a>
544 </td>
545 </tr>
546</table>
547
548<script type="text/javascript">
549 <!--
550 // Private objects are initially displayed (because if
551 // javascript is turned off then we want them to be
552 // visible); but by default, we want to hide them. So hide
553 // them unless we have a cookie that says to show them.
554 checkCookie();
555 // -->
556</script>
557</body>
558</html>