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