You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by bu...@apache.org on 2012/07/16 03:49:36 UTC
svn commit: r825932 [31/38] - in /websites/staging/libcloud/trunk/content:
./ apidocs/0.8.0/
Added: websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.base.StorageDriver.html
==============================================================================
--- websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.base.StorageDriver.html (added)
+++ websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.base.StorageDriver.html Mon Jul 16 01:49:26 2012
@@ -0,0 +1,684 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.base.StorageDriver : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.b.StorageDriver(<a href="libcloud.common.base.BaseDriver.html">BaseDriver</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L157">View Source</a>
+ <a href="classIndex.html#libcloud.storage.base.StorageDriver">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></p>
+ </div>
+ <div>A base StorageDriver to derive from.<table class="fieldTable"></table></div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id87">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#__init__">__init__</a></td>
+ <td></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#list_containters">list_containters</a></td>
+ <td><span>Return a list of containers.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#list_container_objects">list_container_objects</a></td>
+ <td><span>Return a list of objects for the given container.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#get_container">get_container</a></td>
+ <td><span>Return a container instance.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#get_container_cdn_url">get_container_cdn_url</a></td>
+ <td><span>Return a container CDN URL.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#get_object">get_object</a></td>
+ <td><span>Return an object instance.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#get_object_cdn_url">get_object_cdn_url</a></td>
+ <td><span>Return a container CDN URL.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#enable_container_cdn">enable_container_cdn</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#enable_object_cdn">enable_object_cdn</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#download_object">download_object</a></td>
+ <td><span>Download an object to the specified destination path.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#download_object_as_stream">download_object_as_stream</a></td>
+ <td><span>Return a generator which yields object data.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#upload_object">upload_object</a></td>
+ <td><span>Upload an object currently located on a disk.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#upload_object_via_stream">upload_object_via_stream</a></td>
+ <td><span>Upload an object using an iterator.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#delete_object">delete_object</a></td>
+ <td><span>Delete an object.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#create_container">create_container</a></td>
+ <td><span>Create a new container.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#delete_container">delete_container</a></td>
+ <td><span>Delete a container.</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_get_object">_get_object</a></td>
+ <td><span>Call passed callback and start transfer of the object'</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_save_object">_save_object</a></td>
+ <td><span>Save object to the provided path.</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_object">_upload_object</a></td>
+ <td><span>Helper function for setting common request headers and calling the
+passed in callback which uploads an object.</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_data">_upload_data</a></td>
+ <td><span>Upload data stored in a string.</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_stream_data">_stream_data</a></td>
+ <td><span>Stream a data over an http connection.</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_file">_upload_file</a></td>
+ <td><span>Upload a file to the server.</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_get_hash_function">_get_hash_function</a></td>
+ <td><span>Return instantiated hash function for the hash type supported by the
+provider.</span></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.BaseDriver.html">BaseDriver</a>:
+ </p>
+ <table class="children sortable" id="id88">
+
+
+<tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.BaseDriver.html#_ex_connection_class_kwargs">_ex_connection_class_kwargs</a></td>
+ <td><span>Return extra connection keyword arguments which are passed to the
+Connection class constructor.</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.base.StorageDriver.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, key, secret=None, secure=True, host=None, port=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L167" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.common.base.BaseDriver.html#__init__">libcloud.common.base.BaseDriver.__init__</a></div><div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a></div>
+ <div><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">key</td><td>API key or username to used (type: str)</td></tr><tr><td></td><td class="fieldArg">secret</td><td>Secret password to be used (type: str)</td></tr><tr><td></td><td class="fieldArg">secure</td><td>Weither to use HTTPS or HTTP. Note: Some providers only support HTTPS, and
+it is on by default. (type: bool)</td></tr><tr><td></td><td class="fieldArg">host</td><td>Override hostname used for connections. (type: str)</td></tr><tr><td></td><td class="fieldArg">port</td><td>Override port used for connections. (type: int)</td></tr><tr><td></td><td class="fieldArg">api_version</td><td>Optional API version. Only used by drivers which support multiple API
+versions. (type: str)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.list_containters">
+
+ </a>
+ <a name="list_containters">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ list_containters(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L171" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div>Return a list of containers.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">A list of Container instances.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.list_container_objects">
+
+ </a>
+ <a name="list_container_objects">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ list_container_objects(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L180" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <div>Return a list of objects for the given container.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container</td><td>Container instance (type: <code>Container</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">A list of Object instances.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.get_container">
+
+ </a>
+ <a name="get_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_container(self, container_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L192" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <div>Return a container instance.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container_name</td><td>Container name. (type: <code>str</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2"><code>Container</code> instance.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.get_container_cdn_url">
+
+ </a>
+ <a name="get_container_cdn_url">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_container_cdn_url(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L204" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a></div>
+ <div>Return a container CDN URL.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container</td><td>Container instance (type: <code>Container</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">A CDN URL for this container.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.get_object">
+
+ </a>
+ <a name="get_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_object(self, container_name, object_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L216" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <div>Return an object instance.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container_name</td><td>Container name. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">object_name</td><td>Object name. (type: <code>str</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2"><code>Object</code> instance.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.get_object_cdn_url">
+
+ </a>
+ <a name="get_object_cdn_url">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_object_cdn_url(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L231" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a></div>
+ <div>Return a container CDN URL.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">obj</td><td>Object instance (type: <code>Object</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">A CDN URL for this object.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.enable_container_cdn">
+
+ </a>
+ <a name="enable_container_cdn">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ enable_container_cdn(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L243" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a></div>
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.enable_object_cdn">
+
+ </a>
+ <a name="enable_object_cdn">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ enable_object_cdn(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L247" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a></div>
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.download_object">
+
+ </a>
+ <a name="download_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download_object(self, obj, destination_path, overwrite_existing=False, delete_on_failure=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L251" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <div>Download an object to the specified destination path.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">obj</td><td>Object instance. (type: <code>Object</code>)</td></tr><tr><td></td><td class="fieldArg">destination_path</td><td>Full path to a file or a directory where the incoming file will be saved. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">overwrite_existing</td><td>True to overwrite an existing file, defaults to False. (type: <code>bool</code>)</td></tr><tr><td></td><td class="fieldArg">delete_on_failure</td><td>True to delete a partially downloaded file if the download was not
+successful (hash mismatch / file size). (type: <code>bool</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">True if an object has been successfully downloaded, False otherwise. (type: <code>bool</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.download_object_as_stream">
+
+ </a>
+ <a name="download_object_as_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download_object_as_stream(self, obj, chunk_size=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L276" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <div>Return a generator which yields object data.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">obj</td><td>Object instance (type: <code>Object</code>)</td></tr><tr><td></td><td class="fieldArg">chunk_size</td><td>Optional chunk size (in bytes). (type: <code>int</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.upload_object">
+
+ </a>
+ <a name="upload_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ upload_object(self, file_path, container, object_name, extra=None, verify_hash=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L289" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <div>Upload an object currently located on a disk.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">file_path</td><td>Path to the object on disk. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">container</td><td>Destination container. (type: <code>Container</code>)</td></tr><tr><td></td><td class="fieldArg">object_name</td><td>Object name. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">extra</td><td>(optional) Extra attributes (driver specific). (type: <code>dict</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.upload_object_via_stream">
+
+ </a>
+ <a name="upload_object_via_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ upload_object_via_stream(self, iterator, container, object_name, extra=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L309" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <div>Upload an object using an iterator.</p>
+<p>If a provider supports it, chunked transfer encoding is used and you
+don't need to know in advance the amount of data to be uploaded.</p>
+<p>Otherwise if a provider doesn't support it, iterator will be exhausted
+so a total size for data to be uploaded can be determined.</p>
+<p>Note: Exhausting the iterator means that the whole data must be buffered
+in memory which might result in memory exhausting when uploading a very
+large object.</p>
+<p>If a file is located on a disk you are advised to use upload_object
+function which uses fs.stat function to determine the file size and it
+doesn't need to buffer whole object in the memory.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">iterator</td><td>An object which implements the iterator interface. (type: <code>object</code>)</td></tr><tr><td></td><td class="fieldArg">container</td><td>Destination container. (type: <code>Container</code>)</td></tr><tr><td></td><td class="fieldArg">object_name</td><td>Object name. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">extra</td><td>(optional) Extra attributes (driver specific).
+<p>Note: This dictionary must contain a 'content_type' key which represents
+a content type of the stored object.</p> (type: <code>dict</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.delete_object">
+
+ </a>
+ <a name="delete_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete_object(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L347" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <div>Delete an object.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">obj</td><td>Object instance. (type: <code>Object</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2"><code>bool</code> True on success.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.create_container">
+
+ </a>
+ <a name="create_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ create_container(self, container_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L359" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <div>Create a new container.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container_name</td><td>Container name. (type: <code>str</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2"><code>Container</code> instance on success.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.delete_container">
+
+ </a>
+ <a name="delete_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete_container(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L371" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <div>Delete a container.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container</td><td>Container instance (type: <code>Container</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">True on success, False otherwise. (type: <code>bool</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._get_object">
+
+ </a>
+ <a name="_get_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _get_object(self, obj, callback, callback_kwargs, response, success_status_code=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L384" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div>Call passed callback and start transfer of the object'<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">obj</td><td>Object instance. (type: <code>Object</code>)</td></tr><tr><td></td><td class="fieldArg">callback</td><td>Function which is called with the passed callback_kwargs (type: <code>Function</code>)</td></tr><tr><td></td><td class="fieldArg">callback_kwargs</td><td>Keyword arguments which are passed to the callback. (type: <code>dict</code>)</td></tr><tr><td></td><td class="fieldArg">response</td><td>Response instance.</td></tr><tr><td></td><td class="fieldArg">success_status_code</td><td>Status code which represents a successful transfer (defaults to httplib.OK) (type: <code>int</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">True on success, False otherwise. (type: <code>bool</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Unknown Field: typed</t
d><td class="fieldArg">response</td><td><code>Response</code></td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._save_object">
+
+ </a>
+ <a name="_save_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _save_object(self, response, obj, destination_path, overwrite_existing=False, delete_on_failure=True, chunk_size=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L420" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div>Save object to the provided path.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">response</td><td>RawResponse instance. (type: <code>RawResponse</code>)</td></tr><tr><td></td><td class="fieldArg">obj</td><td>Object instance. (type: <code>Object</code>)</td></tr><tr><td></td><td class="fieldArg">destination_path</td><td>Destination directory. (type: <code>Str</code>)</td></tr><tr><td></td><td class="fieldArg">delete_on_failure</td><td>True to delete partially downloaded object if the download fails. (type: <code>bool</code>)</td></tr><tr><td></td><td class="fieldArg">overwrite_existing</td><td>True to overwrite a local path if it already exists. (type: <code>bool</code>)</td></tr><tr><td></td><td class="fieldArg">chunk_size</td><td>Optional chunk size (defaults to
+<code>libcloud.storage.base.CHUNK_SIZE</code>, 8kb) (type: <code>int</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">True on success, False otherwise. (type: <code>bool</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._upload_object">
+
+ </a>
+ <a name="_upload_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _upload_object(self, object_name, content_type, upload_func, upload_func_kwargs, request_path, request_method='PUT', headers=None, file_path=None, iterator=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L501" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div>Helper function for setting common request headers and calling the
+passed in callback which uploads an object.<table class="fieldTable"></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._upload_data">
+
+ </a>
+ <a name="_upload_data">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _upload_data(self, response, data, calculate_hash=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L567" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div>Upload data stored in a string.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">response</td><td>RawResponse object. (type: <code>RawResponse</code>)</td></tr><tr><td></td><td class="fieldArg">data</td><td>Data to upload. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">calculate_hash</td><td>True to calculate hash of the transfered data. (defauls to True). (type: <code>boolean</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">First item is a boolean indicator of success, second one is the uploaded
+data MD5 hash and the third one is the number of transferred bytes. (type: <code>tuple</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._stream_data">
+
+ </a>
+ <a name="_stream_data">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _stream_data(self, response, iterator, chunked=False, calculate_hash=True, chunk_size=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L607" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div>Stream a data over an http connection.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">response</td><td>RawResponse object. (type: <code>RawResponse</code>)</td></tr><tr><td></td><td class="fieldArg">response</td><td>An object which implements an iterator interface or a File like object with
+read method. (type: <code>RawResponse</code>)</td></tr><tr><td></td><td class="fieldArg">chunked</td><td>True if the chunked transfer encoding should be used (defauls to False). (type: <code>boolean</code>)</td></tr><tr><td></td><td class="fieldArg">calculate_hash</td><td>True to calculate hash of the transfered data. (defauls to True). (type: <code>boolean</code>)</td></tr><tr><td></td><td class="fieldArg">chunk_size</td><td>Optional chunk size (defaults to CHUNK_SIZE) (type: <code>int</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">First item is a boolean indicator of success, second one is the uploaded
+data MD5 hash and the third one is the number of transferred bytes. (type: <code>tuple</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._upload_file">
+
+ </a>
+ <a name="_upload_file">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _upload_file(self, response, file_path, chunked=False, calculate_hash=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L692" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div>Upload a file to the server.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">response</td><td>RawResponse object. (type: <code>RawResponse</code>)</td></tr><tr><td></td><td class="fieldArg">file_path</td><td>Path to a local file. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">response</td><td>An object which implements an iterator interface (File object, etc.) (type: <code>RawResponse</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">First item is a boolean indicator of success, second one is the uploaded
+data MD5 hash and the third one is the number of transferred bytes. (type: <code>tuple</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._get_hash_function">
+
+ </a>
+ <a name="_get_hash_function">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _get_hash_function(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L722" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div>Return instantiated hash function for the hash type supported by the
+provider.<table class="fieldTable"></table></div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2012-07-15 18:48:28.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.base.html
==============================================================================
--- websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.base.html (added)
+++ websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.base.html Mon Jul 16 01:49:26 2012
@@ -0,0 +1,63 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.base : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="module">l.s.base : module documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py">View Source</a>
+
+ </p>
+ <div>
+
+ </div>
+ <div>Provides base classes for working with storage<table class="fieldTable"></table></div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id84">
+
+
+<tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.storage.base.Object.html">Object</a></td>
+ <td><span>Represents an object (BLOB).</span></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.storage.base.Container.html">Container</a></td>
+ <td><span>Represents a container (bucket) which can hold multiple objects.</span></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html">StorageDriver</a></td>
+ <td><span>A base StorageDriver to derive from.</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2012-07-15 18:48:28.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.__init__.html
==============================================================================
--- websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.__init__.html (added)
+++ websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.__init__.html Mon Jul 16 01:49:26 2012
@@ -0,0 +1,40 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.drivers.__init__ : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="module">l.s.d.__init__ : module documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.drivers.html">drivers</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/__init__.py">View Source</a>
+
+ </p>
+ <div>
+
+ </div>
+ <div>Drivers for working with different providers<table class="fieldTable"></table></div>
+
+
+
+ <div id="splitTables">
+
+
+
+ </div>
+
+
+
+
+
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2012-07-15 18:48:28.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosConnection.html
==============================================================================
--- websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosConnection.html (added)
+++ websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosConnection.html Mon Jul 16 01:49:26 2012
@@ -0,0 +1,123 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.drivers.atmos.AtmosConnection : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.d.a.AtmosConnection(<span title="libcloud.common.base.ConnectionUserAndKey">ConnectionUserAndKey</span>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.drivers.html">drivers</a>.<a href="libcloud.storage.drivers.atmos.html">atmos</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L65">View Source</a>
+ <a href="classIndex.html#libcloud.storage.drivers.atmos.AtmosConnection">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <div class="undocumented">Undocumented</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id99">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosConnection.html#add_default_headers">add_default_headers</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosConnection.html#pre_connect_hook">pre_connect_hook</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosConnection.html#_calculate_signature">_calculate_signature</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosConnection.add_default_headers">
+
+ </a>
+ <a name="add_default_headers">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ add_default_headers(self, headers):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L68" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosConnection.pre_connect_hook">
+
+ </a>
+ <a name="pre_connect_hook">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ pre_connect_hook(self, params, headers):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L81" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosConnection._calculate_signature">
+
+ </a>
+ <a name="_calculate_signature">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _calculate_signature(self, params, headers):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L86" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2012-07-15 18:48:28.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosDriver.html
==============================================================================
--- websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosDriver.html (added)
+++ websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosDriver.html Mon Jul 16 01:49:26 2012
@@ -0,0 +1,695 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.drivers.atmos.AtmosDriver : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.d.a.AtmosDriver(<a href="libcloud.storage.base.StorageDriver.html">StorageDriver</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.drivers.html">drivers</a>.<a href="libcloud.storage.drivers.atmos.html">atmos</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L113">View Source</a>
+ <a href="classIndex.html#libcloud.storage.drivers.atmos.AtmosDriver">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.storage.drivers.ninefold.NinefoldStorageDriver.html">libcloud.storage.drivers.ninefold.NinefoldStorageDriver</a></p>
+ </div>
+ <div class="undocumented">Undocumented</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id100">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#__init__">__init__</a></td>
+ <td></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#list_containers">list_containers</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#get_container">get_container</a></td>
+ <td><span>Return a container instance.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#create_container">create_container</a></td>
+ <td><span>Create a new container.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#delete_container">delete_container</a></td>
+ <td><span>Delete a container.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#get_object">get_object</a></td>
+ <td><span>Return an object instance.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#upload_object">upload_object</a></td>
+ <td><span>Upload an object currently located on a disk.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#upload_object_via_stream">upload_object_via_stream</a></td>
+ <td><span>Upload an object using an iterator.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#download_object">download_object</a></td>
+ <td><span>Download an object to the specified destination path.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#download_object_as_stream">download_object_as_stream</a></td>
+ <td><span>Return a generator which yields object data.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#delete_object">delete_object</a></td>
+ <td><span>Delete an object.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#list_container_objects">list_container_objects</a></td>
+ <td><span>Return a list of objects for the given container.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#enable_object_cdn">enable_object_cdn</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#get_object_cdn_url">get_object_cdn_url</a></td>
+ <td><span>Return a container CDN URL.</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_cdn_signature">_cdn_signature</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_list_objects">_list_objects</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_namespace_path">_namespace_path</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_object_path">_object_path</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="staticmethod private">
+
+
+ <td>Static Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_emc_tag">_emc_tag</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_emc_meta">_emc_meta</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_get_more">_get_more</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.storage.base.StorageDriver.html">StorageDriver</a>:
+ </p>
+ <table class="children sortable" id="id101">
+
+
+<tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#list_containters">list_containters</a></td>
+ <td><span>Return a list of containers.</span></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#get_container_cdn_url">get_container_cdn_url</a></td>
+ <td><span>Return a container CDN URL.</span></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#enable_container_cdn">enable_container_cdn</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_get_object">_get_object</a></td>
+ <td><span>Call passed callback and start transfer of the object'</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_save_object">_save_object</a></td>
+ <td><span>Save object to the provided path.</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_object">_upload_object</a></td>
+ <td><span>Helper function for setting common request headers and calling the
+passed in callback which uploads an object.</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_data">_upload_data</a></td>
+ <td><span>Upload data stored in a string.</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_stream_data">_stream_data</a></td>
+ <td><span>Stream a data over an http connection.</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_file">_upload_file</a></td>
+ <td><span>Upload a file to the server.</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_get_hash_function">_get_hash_function</a></td>
+ <td><span>Return instantiated hash function for the hash type supported by the
+provider.</span></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.BaseDriver.html">BaseDriver</a> (via <a href="libcloud.storage.base.StorageDriver.html">StorageDriver</a>):
+ </p>
+ <table class="children sortable" id="id102">
+
+
+<tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.BaseDriver.html#_ex_connection_class_kwargs">_ex_connection_class_kwargs</a></td>
+ <td><span>Return extra connection keyword arguments which are passed to the
+Connection class constructor.</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, key, secret=None, secure=True, host=None, port=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L123" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#__init__">libcloud.storage.base.StorageDriver.__init__</a></div>
+ <div><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">key</td><td>API key or username to used (type: str)</td></tr><tr><td></td><td class="fieldArg">secret</td><td>Secret password to be used (type: str)</td></tr><tr><td></td><td class="fieldArg">secure</td><td>Weither to use HTTPS or HTTP. Note: Some providers only support HTTPS, and
+it is on by default. (type: bool)</td></tr><tr><td></td><td class="fieldArg">host</td><td>Override hostname used for connections. (type: str)</td></tr><tr><td></td><td class="fieldArg">port</td><td>Override port used for connections. (type: int)</td></tr><tr><td></td><td class="fieldArg">api_version</td><td>Optional API version. Only used by drivers which support multiple API
+versions. (type: str)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.list_containers">
+
+ </a>
+ <a name="list_containers">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ list_containers(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L127" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.get_container">
+
+ </a>
+ <a name="get_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_container(self, container_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L138" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#get_container">libcloud.storage.base.StorageDriver.get_container</a></div>
+ <div>Return a container instance.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container_name</td><td>Container name. (type: <code>str</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2"><code>Container</code> instance.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.create_container">
+
+ </a>
+ <a name="create_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ create_container(self, container_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L153" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#create_container">libcloud.storage.base.StorageDriver.create_container</a></div>
+ <div>Create a new container.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container_name</td><td>Container name. (type: <code>str</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2"><code>Container</code> instance on success.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.delete_container">
+
+ </a>
+ <a name="delete_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete_container(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L164" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#delete_container">libcloud.storage.base.StorageDriver.delete_container</a></div>
+ <div>Delete a container.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container</td><td>Container instance (type: <code>Container</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">True on success, False otherwise. (type: <code>bool</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.get_object">
+
+ </a>
+ <a name="get_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_object(self, container_name, object_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L176" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#get_object">libcloud.storage.base.StorageDriver.get_object</a></div>
+ <div>Return an object instance.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container_name</td><td>Container name. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">object_name</td><td>Object name. (type: <code>str</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2"><code>Object</code> instance.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.upload_object">
+
+ </a>
+ <a name="upload_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ upload_object(self, file_path, container, object_name, extra=None, verify_hash=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L205" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#upload_object">libcloud.storage.base.StorageDriver.upload_object</a></div>
+ <div>Upload an object currently located on a disk.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">file_path</td><td>Path to the object on disk. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">container</td><td>Destination container. (type: <code>Container</code>)</td></tr><tr><td></td><td class="fieldArg">object_name</td><td>Object name. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">extra</td><td>(optional) Extra attributes (driver specific). (type: <code>dict</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.upload_object_via_stream">
+
+ </a>
+ <a name="upload_object_via_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ upload_object_via_stream(self, iterator, container, object_name, extra=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L254" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#upload_object_via_stream">libcloud.storage.base.StorageDriver.upload_object_via_stream</a></div>
+ <div>Upload an object using an iterator.</p>
+<p>If a provider supports it, chunked transfer encoding is used and you
+don't need to know in advance the amount of data to be uploaded.</p>
+<p>Otherwise if a provider doesn't support it, iterator will be exhausted
+so a total size for data to be uploaded can be determined.</p>
+<p>Note: Exhausting the iterator means that the whole data must be buffered
+in memory which might result in memory exhausting when uploading a very
+large object.</p>
+<p>If a file is located on a disk you are advised to use upload_object
+function which uses fs.stat function to determine the file size and it
+doesn't need to buffer whole object in the memory.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">iterator</td><td>An object which implements the iterator interface. (type: <code>object</code>)</td></tr><tr><td></td><td class="fieldArg">container</td><td>Destination container. (type: <code>Container</code>)</td></tr><tr><td></td><td class="fieldArg">object_name</td><td>Object name. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">extra</td><td>(optional) Extra attributes (driver specific).
+<p>Note: This dictionary must contain a 'content_type' key which represents
+a content type of the stored object.</p> (type: <code>dict</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.download_object">
+
+ </a>
+ <a name="download_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download_object(self, obj, destination_path, overwrite_existing=False, delete_on_failure=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L311" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#download_object">libcloud.storage.base.StorageDriver.download_object</a></div>
+ <div>Download an object to the specified destination path.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">obj</td><td>Object instance. (type: <code>Object</code>)</td></tr><tr><td></td><td class="fieldArg">destination_path</td><td>Full path to a file or a directory where the incoming file will be saved. (type: <code>str</code>)</td></tr><tr><td></td><td class="fieldArg">overwrite_existing</td><td>True to overwrite an existing file, defaults to False. (type: <code>bool</code>)</td></tr><tr><td></td><td class="fieldArg">delete_on_failure</td><td>True to delete a partially downloaded file if the download was not
+successful (hash mismatch / file size). (type: <code>bool</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">True if an object has been successfully downloaded, False otherwise. (type: <code>bool</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.download_object_as_stream">
+
+ </a>
+ <a name="download_object_as_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download_object_as_stream(self, obj, chunk_size=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L327" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#download_object_as_stream">libcloud.storage.base.StorageDriver.download_object_as_stream</a></div>
+ <div>Return a generator which yields object data.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">obj</td><td>Object instance (type: <code>Object</code>)</td></tr><tr><td></td><td class="fieldArg">chunk_size</td><td>Optional chunk size (in bytes). (type: <code>int</code>)</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.delete_object">
+
+ </a>
+ <a name="delete_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete_object(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L339" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#delete_object">libcloud.storage.base.StorageDriver.delete_object</a></div>
+ <div>Delete an object.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">obj</td><td>Object instance. (type: <code>Object</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2"><code>bool</code> True on success.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.list_container_objects">
+
+ </a>
+ <a name="list_container_objects">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ list_container_objects(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L350" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#list_container_objects">libcloud.storage.base.StorageDriver.list_container_objects</a></div>
+ <div>Return a list of objects for the given container.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">container</td><td>Container instance (type: <code>Container</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">A list of Object instances.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.enable_object_cdn">
+
+ </a>
+ <a name="enable_object_cdn">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ enable_object_cdn(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L354" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#enable_object_cdn">libcloud.storage.base.StorageDriver.enable_object_cdn</a></div>
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.get_object_cdn_url">
+
+ </a>
+ <a name="get_object_cdn_url">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_object_cdn_url(self, obj, expiry=None, use_object=False):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L357" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#get_object_cdn_url">libcloud.storage.base.StorageDriver.get_object_cdn_url</a></div>
+ <div>Return a container CDN URL.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">obj</td><td>Object instance (type: <code>Object</code>)</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">A CDN URL for this object.</td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._cdn_signature">
+
+ </a>
+ <a name="_cdn_signature">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _cdn_signature(self, path, params):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L379" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._list_objects">
+
+ </a>
+ <a name="_list_objects">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _list_objects(self, tree, object_type=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L386" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._namespace_path">
+
+ </a>
+ <a name="_namespace_path">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _namespace_path(self, path):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L400" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._object_path">
+
+ </a>
+ <a name="_object_path">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _object_path(self, object_id):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L403" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._emc_tag">
+
+ </a>
+ <a name="_emc_tag">
+
+ </a>
+ <div class="functionHeader">
+ @staticmethod<br />
+ def
+ _emc_tag(tag):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L407" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._emc_meta">
+
+ </a>
+ <a name="_emc_meta">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _emc_meta(self, response):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L410" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._get_more">
+
+ </a>
+ <a name="_get_more">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _get_more(self, last_key, value_dict):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L417" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2012-07-15 18:48:28.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosError.html
==============================================================================
--- websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosError.html (added)
+++ websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosError.html Mon Jul 16 01:49:26 2012
@@ -0,0 +1,71 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.drivers.atmos.AtmosError : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.d.a.AtmosError(<span title="Exception">Exception</span>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.drivers.html">drivers</a>.<a href="libcloud.storage.drivers.atmos.html">atmos</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L45">View Source</a>
+ <a href="classIndex.html#libcloud.storage.drivers.atmos.AtmosError">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <div class="undocumented">Undocumented</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id95">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosError.html#__init__">__init__</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosError.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, code, message):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L46" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2012-07-15 18:48:28.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosResponse.html
==============================================================================
--- websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosResponse.html (added)
+++ websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.AtmosResponse.html Mon Jul 16 01:49:26 2012
@@ -0,0 +1,138 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.drivers.atmos.AtmosResponse : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.d.a.AtmosResponse(<a href="libcloud.common.base.XmlResponse.html">XmlResponse</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.drivers.html">drivers</a>.<a href="libcloud.storage.drivers.atmos.html">atmos</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L50">View Source</a>
+ <a href="classIndex.html#libcloud.storage.drivers.atmos.AtmosResponse">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <div class="undocumented">Undocumented</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id96">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosResponse.html#success">success</a></td>
+ <td><span>Determine if our request was successful.</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosResponse.html#parse_error">parse_error</a></td>
+ <td><span>Parse the error messages.</span></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.XmlResponse.html">XmlResponse</a>:
+ </p>
+ <table class="children sortable" id="id97">
+
+
+<tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.XmlResponse.html#parse_body">parse_body</a></td>
+ <td><span>Parse response body.</span></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.Response.html">Response</a> (via <a href="libcloud.common.base.XmlResponse.html">XmlResponse</a>):
+ </p>
+ <table class="children sortable" id="id98">
+
+
+<tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#__init__">__init__</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#_decompress_response">_decompress_response</a></td>
+ <td><span>Decompress a response body if it is using deflate or gzip encoding.</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosResponse.success">
+
+ </a>
+ <a name="success">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ success(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L51" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.common.base.Response.html#success">libcloud.common.base.Response.success</a></div>
+ <div>Determine if our request was successful.</p>
+<p>The meaning of this can be arbitrary; did we receive OK status? Did the
+node get created? Were we authenticated?<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2"><code>True</code> or <code>False</code></td></tr></table></div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosResponse.parse_error">
+
+ </a>
+ <a name="parse_error">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ parse_error(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L55" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.common.base.Response.html#parse_error">libcloud.common.base.Response.parse_error</a></div>
+ <div>Parse the error messages.</p>
+<p>Override in a provider's subclass.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">Parsed error.</td></tr></table></div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2012-07-15 18:48:28.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.html
==============================================================================
--- websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.html (added)
+++ websites/staging/libcloud/trunk/content/apidocs/0.8.0/libcloud.storage.drivers.atmos.html Mon Jul 16 01:49:26 2012
@@ -0,0 +1,95 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.drivers.atmos : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="module">l.s.d.atmos : module documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.drivers.html">drivers</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py">View Source</a>
+
+ </p>
+ <div>
+
+ </div>
+ <div class="undocumented">Undocumented</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id94">
+
+
+<tr class="function">
+
+
+ <td>Function</td>
+ <td><a href="libcloud.storage.drivers.atmos.html#collapse">collapse</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosError.html">AtmosError</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosResponse.html">AtmosResponse</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosConnection.html">AtmosConnection</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html">AtmosDriver</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.drivers.atmos.collapse">
+
+ </a>
+ <a name="collapse">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ collapse(s):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L42" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2012-07-15 18:48:28.
+ </address>
+ </body>
+</html>
\ No newline at end of file