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