Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / oauth2client.appengine.StorageByKeyName-class.html
blob: 5002d1244325219ec2580d53255ab47a62f47d12 [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.appengine.StorageByKeyName</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.appengine-module.html">Module&nbsp;appengine</a> ::
39 Class&nbsp;StorageByKeyName
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.appengine.StorageByKeyName-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 StorageByKeyName</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_oauth2cl_9" name="uml_class_diagram_for_oauth2cl_9">
59<area shape="rect" href="oauth2client.appengine.StorageByKeyName-class.html#__init__" title="Constructor for Storage." alt="" coords="17,185,383,204"/>
60<area shape="rect" href="oauth2client.appengine.StorageByKeyName-class.html#locked_get" title="Retrieve Credential from datastore." alt="" coords="17,204,383,223"/>
61<area shape="rect" href="oauth2client.appengine.StorageByKeyName-class.html#locked_put" title="Write a Credentials to the datastore." alt="" coords="17,223,383,241"/>
62<area shape="rect" href="oauth2client.appengine.StorageByKeyName-class.html#locked_delete" title="Delete Credential from datastore." alt="" coords="17,241,383,260"/>
63<area shape="rect" href="oauth2client.appengine.StorageByKeyName-class.html" title="Store and retrieve a single credential to and from the App Engine datastore." alt="" coords="16,160,384,261"/>
64<area shape="rect" href="oauth2client.client.Storage-class.html#acquire_lock" title="Acquires any lock necessary to access this Storage." alt="" coords="139,36,261,55"/>
65<area shape="rect" href="oauth2client.client.Storage-class.html#release_lock" title="Release the Storage lock." alt="" coords="139,55,261,73"/>
66<area shape="rect" href="oauth2client.client.Storage-class.html#get" title="Retrieve credential." alt="" coords="139,73,261,92"/>
67<area shape="rect" href="oauth2client.client.Storage-class.html#put" title="Write a credential." alt="" coords="139,92,261,111"/>
68<area shape="rect" href="oauth2client.client.Storage-class.html#delete" title="Delete credential." alt="" coords="139,111,261,129"/>
69<area shape="rect" href="oauth2client.client.Storage-class.html" title="Base class for all Storage objects." alt="" coords="137,11,263,131"/>
70</map>
71 <img src="uml_class_diagram_for_oauth2cl_9.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_9" ismap="ismap" class="graph-without-title" />
72</center>
73</center>
74<hr />
75<pre class="literalblock">
76Store and retrieve a single credential to and from
77the App Engine datastore.
78
79This Storage helper presumes the Credentials
80have been stored as a CredenialsProperty
81on a datastore model class, and that entities
82are stored by key_name.
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.appengine.StorageByKeyName-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
110 <span class="summary-sig-arg">model</span>,
111 <span class="summary-sig-arg">key_name</span>,
112 <span class="summary-sig-arg">property_name</span>,
113 <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>)</span><br />
114 Constructor for Storage.</td>
115 <td align="right" valign="top">
116 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.__init__">source&nbsp;code</a></span>
117
118 </td>
119 </tr>
120 </table>
121
122 </td>
123 </tr>
124<tr>
125 <td width="15%" align="right" valign="top" class="summary">
126 <span class="summary-type">&nbsp;</span>
127 </td><td class="summary">
128 <table width="100%" cellpadding="0" cellspacing="0" border="0">
129 <tr>
130 <td><span class="summary-sig"><a href="oauth2client.appengine.StorageByKeyName-class.html#locked_get" class="summary-sig-name">locked_get</a>(<span class="summary-sig-arg">self</span>)</span><br />
131 Retrieve Credential from datastore.</td>
132 <td align="right" valign="top">
133 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_get">source&nbsp;code</a></span>
134
135 </td>
136 </tr>
137 </table>
138
139 </td>
140 </tr>
141<tr>
142 <td width="15%" align="right" valign="top" class="summary">
143 <span class="summary-type">&nbsp;</span>
144 </td><td class="summary">
145 <table width="100%" cellpadding="0" cellspacing="0" border="0">
146 <tr>
147 <td><span class="summary-sig"><a href="oauth2client.appengine.StorageByKeyName-class.html#locked_put" class="summary-sig-name">locked_put</a>(<span class="summary-sig-arg">self</span>,
148 <span class="summary-sig-arg">credentials</span>)</span><br />
149 Write a Credentials to the datastore.</td>
150 <td align="right" valign="top">
151 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_put">source&nbsp;code</a></span>
152
153 </td>
154 </tr>
155 </table>
156
157 </td>
158 </tr>
159<tr>
160 <td width="15%" align="right" valign="top" class="summary">
161 <span class="summary-type">&nbsp;</span>
162 </td><td class="summary">
163 <table width="100%" cellpadding="0" cellspacing="0" border="0">
164 <tr>
165 <td><span class="summary-sig"><a href="oauth2client.appengine.StorageByKeyName-class.html#locked_delete" class="summary-sig-name">locked_delete</a>(<span class="summary-sig-arg">self</span>)</span><br />
166 Delete Credential from datastore.</td>
167 <td align="right" valign="top">
168 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_delete">source&nbsp;code</a></span>
169
170 </td>
171 </tr>
172 </table>
173
174 </td>
175 </tr>
176 <tr>
177 <td colspan="2" class="summary">
178 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Storage-class.html">client.Storage</a></code></b>:
179 <code><a href="oauth2client.client.Storage-class.html#acquire_lock">acquire_lock</a></code>,
180 <code><a href="oauth2client.client.Storage-class.html#delete">delete</a></code>,
181 <code><a href="oauth2client.client.Storage-class.html#get">get</a></code>,
182 <code><a href="oauth2client.client.Storage-class.html#put">put</a></code>,
183 <code><a href="oauth2client.client.Storage-class.html#release_lock">release_lock</a></code>
184 </p>
185 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
186 <code>__delattr__</code>,
187 <code>__format__</code>,
188 <code>__getattribute__</code>,
189 <code>__hash__</code>,
190 <code>__new__</code>,
191 <code>__reduce__</code>,
192 <code>__reduce_ex__</code>,
193 <code>__repr__</code>,
194 <code>__setattr__</code>,
195 <code>__sizeof__</code>,
196 <code>__str__</code>,
197 <code>__subclasshook__</code>
198 </p>
199 </td>
200 </tr>
201</table>
202<!-- ==================== PROPERTIES ==================== -->
203<a name="section-Properties"></a>
204<table class="summary" border="1" cellpadding="3"
205 cellspacing="0" width="100%" bgcolor="white">
206<tr bgcolor="#70b0f0" class="table-header">
207 <td colspan="2" class="table-header">
208 <table border="0" cellpadding="0" cellspacing="0" width="100%">
209 <tr valign="top">
210 <td align="left"><span class="table-header">Properties</span></td>
211 <td align="right" valign="top"
212 ><span class="options">[<a href="#section-Properties"
213 class="privatelink" onclick="toggle_private();"
214 >hide private</a>]</span></td>
215 </tr>
216 </table>
217 </td>
218</tr>
219 <tr>
220 <td colspan="2" class="summary">
221 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
222 <code>__class__</code>
223 </p>
224 </td>
225 </tr>
226</table>
227<!-- ==================== METHOD DETAILS ==================== -->
228<a name="section-MethodDetails"></a>
229<table class="details" border="1" cellpadding="3"
230 cellspacing="0" width="100%" bgcolor="white">
231<tr bgcolor="#70b0f0" class="table-header">
232 <td colspan="2" class="table-header">
233 <table border="0" cellpadding="0" cellspacing="0" width="100%">
234 <tr valign="top">
235 <td align="left"><span class="table-header">Method Details</span></td>
236 <td align="right" valign="top"
237 ><span class="options">[<a href="#section-MethodDetails"
238 class="privatelink" onclick="toggle_private();"
239 >hide private</a>]</span></td>
240 </tr>
241 </table>
242 </td>
243</tr>
244</table>
245<a name="__init__"></a>
246<div>
247<table class="details" border="1" cellpadding="3"
248 cellspacing="0" width="100%" bgcolor="white">
249<tr><td>
250 <table width="100%" cellpadding="0" cellspacing="0" border="0">
251 <tr valign="top"><td>
252 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
253 <span class="sig-arg">model</span>,
254 <span class="sig-arg">key_name</span>,
255 <span class="sig-arg">property_name</span>,
256 <span class="sig-arg">cache</span>=<span class="sig-default">None</span>)</span>
257 <br /><em class="fname">(Constructor)</em>
258 </h3>
259 </td><td align="right" valign="top"
260 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.__init__">source&nbsp;code</a></span>&nbsp;
261 </td>
262 </tr></table>
263
264 <pre class="literalblock">
265Constructor for Storage.
266
267Args:
268 model: db.Model, model class
269 key_name: string, key name for the entity that has the credentials
270 property_name: string, name of the property that is a CredentialsProperty
271 cache: memcache, a write-through cache to put in front of the datastore
272
273</pre>
274 <dl class="fields">
275 <dt>Overrides:
276 object.__init__
277 </dt>
278 </dl>
279</td></tr></table>
280</div>
281<a name="locked_get"></a>
282<div>
283<table class="details" border="1" cellpadding="3"
284 cellspacing="0" width="100%" bgcolor="white">
285<tr><td>
286 <table width="100%" cellpadding="0" cellspacing="0" border="0">
287 <tr valign="top"><td>
288 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_get</span>(<span class="sig-arg">self</span>)</span>
289 </h3>
290 </td><td align="right" valign="top"
291 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_get">source&nbsp;code</a></span>&nbsp;
292 </td>
293 </tr></table>
294
295 <pre class="literalblock">
296Retrieve Credential from datastore.
297
298Returns:
299 oauth2client.Credentials
300
301</pre>
302 <dl class="fields">
303 <dt>Overrides:
304 <a href="oauth2client.client.Storage-class.html#locked_get">client.Storage.locked_get</a>
305 </dt>
306 </dl>
307</td></tr></table>
308</div>
309<a name="locked_put"></a>
310<div>
311<table class="details" border="1" cellpadding="3"
312 cellspacing="0" width="100%" bgcolor="white">
313<tr><td>
314 <table width="100%" cellpadding="0" cellspacing="0" border="0">
315 <tr valign="top"><td>
316 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_put</span>(<span class="sig-arg">self</span>,
317 <span class="sig-arg">credentials</span>)</span>
318 </h3>
319 </td><td align="right" valign="top"
320 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_put">source&nbsp;code</a></span>&nbsp;
321 </td>
322 </tr></table>
323
324 <pre class="literalblock">
325Write a Credentials to the datastore.
326
327Args:
328 credentials: Credentials, the credentials to store.
329
330</pre>
331 <dl class="fields">
332 <dt>Overrides:
333 <a href="oauth2client.client.Storage-class.html#locked_put">client.Storage.locked_put</a>
334 </dt>
335 </dl>
336</td></tr></table>
337</div>
338<a name="locked_delete"></a>
339<div>
340<table class="details" border="1" cellpadding="3"
341 cellspacing="0" width="100%" bgcolor="white">
342<tr><td>
343 <table width="100%" cellpadding="0" cellspacing="0" border="0">
344 <tr valign="top"><td>
345 <h3 class="epydoc"><span class="sig"><span class="sig-name">locked_delete</span>(<span class="sig-arg">self</span>)</span>
346 </h3>
347 </td><td align="right" valign="top"
348 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#StorageByKeyName.locked_delete">source&nbsp;code</a></span>&nbsp;
349 </td>
350 </tr></table>
351
352 <pre class="literalblock">
353Delete Credential from datastore.
354
355</pre>
356 <dl class="fields">
357 <dt>Overrides:
358 <a href="oauth2client.client.Storage-class.html#locked_delete">client.Storage.locked_delete</a>
359 </dt>
360 </dl>
361</td></tr></table>
362</div>
363<br />
364<!-- ==================== NAVIGATION BAR ==================== -->
365<table class="navbar" border="0" width="100%" cellpadding="0"
366 bgcolor="#a0c0ff" cellspacing="0">
367 <tr valign="middle">
368
369 <!-- Tree link -->
370 <th>&nbsp;&nbsp;&nbsp;<a
371 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
372
373 <!-- Index link -->
374 <th>&nbsp;&nbsp;&nbsp;<a
375 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
376
377 <!-- Help link -->
378 <th>&nbsp;&nbsp;&nbsp;<a
379 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
380
381 <th class="navbar" width="100%"></th>
382 </tr>
383</table>
384<table border="0" cellpadding="0" cellspacing="0" width="100%%">
385 <tr>
386 <td align="left" class="footer">
387 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:08 2012
388 </td>
389 <td align="right" class="footer">
390 <a target="mainFrame" href="http://epydoc.sourceforge.net"
391 >http://epydoc.sourceforge.net</a>
392 </td>
393 </tr>
394</table>
395
396<script type="text/javascript">
397 <!--
398 // Private objects are initially displayed (because if
399 // javascript is turned off then we want them to be
400 // visible); but by default, we want to hide them. So hide
401 // them unless we have a cookie that says to show them.
402 checkCookie();
403 // -->
404</script>
405</body>
406</html>