You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2012/02/09 03:00:11 UTC
svn commit: r1242205 [3/36] - in /libcloud/site/trunk/content/apidocs: ./
0.8.0/
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.BaseDriver.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.BaseDriver.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.BaseDriver.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.BaseDriver.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,116 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.base.BaseDriver : 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.c.b.BaseDriver(<span title="object">object</span>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L752">View Source</a>
+ <a href="classIndex.html#libcloud.common.base.BaseDriver">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.compute.base.NodeDriver.html">libcloud.compute.base.NodeDriver</a>, <a href="libcloud.dns.base.DNSDriver.html">libcloud.dns.base.DNSDriver</a>, <a href="libcloud.loadbalancer.base.Driver.html">libcloud.loadbalancer.base.Driver</a>, <a href="libcloud.storage.base.StorageDriver.html">libcloud.storage.base.StorageDriver</a></p>
+ </div>
+ <pre>Base driver class from which other classes can inherit from.</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id572">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.BaseDriver.html#__init__">__init__</a></td>
+ <td><tt>@keyword key: API key or username to used @type key: str</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.BaseDriver.html#_ex_connection_class_kwargs">_ex_connection_class_kwargs</a></td>
+ <td><tt>Return extra connection keyword arguments which are passed to the Connection class constructor.</tt></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.base.BaseDriver.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, key, secret=None, secure=True, host=None, port=None, api_version=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L759" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.compute.base.NodeDriver.html">libcloud.compute.base.NodeDriver</a>, <a href="libcloud.dns.base.DNSDriver.html">libcloud.dns.base.DNSDriver</a>, <a href="libcloud.loadbalancer.base.Driver.html">libcloud.loadbalancer.base.Driver</a>, <a href="libcloud.storage.base.StorageDriver.html">libcloud.storage.base.StorageDriver</a></div>
+ <pre>@keyword key: API key or username to used
+@type key: str
+
+@keyword secret: Secret password to be used
+@type secret: str
+
+@keyword secure: Weither to use HTTPS or HTTP. Note: Some providers
+ only support HTTPS, and it is on by default.
+@type secure: bool
+
+@keyword host: Override hostname used for connections.
+@type host: str
+
+@keyword port: Override port used for connections.
+@type port: int
+
+@keyword api_version: Optional API version. Only used by drivers
+ which support multiple API versions.
+@type api_version: str</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.BaseDriver._ex_connection_class_kwargs">
+
+ </a>
+ <a name="_ex_connection_class_kwargs">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _ex_connection_class_kwargs(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L804" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.compute.drivers.openstack.OpenStackNodeDriver.html">libcloud.compute.drivers.openstack.OpenStackNodeDriver</a></div>
+ <pre>Return extra connection keyword arguments which are passed to the
+Connection class constructor.</pre>
+ </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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.Connection.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.Connection.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.Connection.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.Connection.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,414 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.base.Connection : 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.c.b.Connection(<span title="object">object</span>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L344">View Source</a>
+ <a href="classIndex.html#libcloud.common.base.Connection">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.common.base.PollingConnection.html">libcloud.common.base.PollingConnection</a>, <a href="libcloud.compute.base.ConnectionKey.html">libcloud.compute.base.ConnectionKey</a></p>
+ </div>
+ <pre>A Base Connection class to derive from.</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id569">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#__init__">__init__</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#set_context">set_context</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#connect">connect</a></td>
+ <td><tt>Establish a connection with the API server.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#user_agent_append">user_agent_append</a></td>
+ <td><tt>Append a token to a user agent string.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#request">request</a></td>
+ <td><tt>Request a given `action`.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#morph_action_hook">morph_action_hook</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#add_default_params">add_default_params</a></td>
+ <td><tt>Adds default parameters (such as API key, version, etc.) to the passed `params`</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#add_default_headers">add_default_headers</a></td>
+ <td><tt>Adds default headers (such as Authorization, X-Foo-Bar) to the passed `headers`</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#pre_connect_hook">pre_connect_hook</a></td>
+ <td><tt>A hook which is called before connecting to the remote server. This hook can perform a final manipulation on the params, headers and url parameters.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#encode_data">encode_data</a></td>
+ <td><tt>Encode body data.</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#_tuple_from_url">_tuple_from_url</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#_user_agent">_user_agent</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.base.Connection.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, secure=True, host=None, port=None, url=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L360" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.compute.base.ConnectionKey.html">libcloud.compute.base.ConnectionKey</a>, <a href="libcloud.loadbalancer.drivers.rackspace.RackspaceConnection.html">libcloud.loadbalancer.drivers.rackspace.RackspaceConnection</a></div>
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection.set_context">
+
+ </a>
+ <a name="set_context">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ set_context(self, context):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L382" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection._tuple_from_url">
+
+ </a>
+ <a name="_tuple_from_url">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _tuple_from_url(self, url):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L385" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection.connect">
+
+ </a>
+ <a name="connect">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ connect(self, host=None, port=None, base_url=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L411" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>Establish a connection with the API server.
+
+@type host: C{str}
+@param host: Optional host to override our default
+
+@type port: C{int}
+@param port: Optional port to override our default
+
+@returns: A connection</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection._user_agent">
+
+ </a>
+ <a name="_user_agent">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _user_agent(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L446" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection.user_agent_append">
+
+ </a>
+ <a name="user_agent_append">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ user_agent_append(self, token):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L452" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>Append a token to a user agent string.
+
+Users of the library should call this to uniquely identify thier requests
+to a provider.
+
+@type token: C{str}
+@param token: Token to add to the user agent.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection.request">
+
+ </a>
+ <a name="request">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ request(self, action, params=None, data='', headers=None, method='GET', raw=False):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L464" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.loadbalancer.drivers.rackspace.RackspaceConnection.html">libcloud.loadbalancer.drivers.rackspace.RackspaceConnection</a></div>
+ <pre>Request a given `action`.
+
+Basically a wrapper around the connection
+object's `request` that does some helpful pre-processing.
+
+@type action: C{str}
+@param action: A path
+
+@type params: C{dict}
+@param params: Optional mapping of additional parameters to send. If
+ None, leave as an empty C{dict}.
+
+@type data: C{unicode}
+@param data: A body of data to send with the request.
+
+@type headers: C{dict}
+@param headers: Extra headers to add to the request
+ None, leave as an empty C{dict}.
+
+@type method: C{str}
+@param method: An HTTP method such as "GET" or "POST".
+
+@type raw: C{bool}
+@param raw: True to perform a "raw" request aka only send the headers
+ and use the rawResponseCls class. This is used with
+ storage API when uploading a file.
+
+@return: An instance of type I{responseCls}</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection.morph_action_hook">
+
+ </a>
+ <a name="morph_action_hook">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ morph_action_hook(self, action):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L568" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection.add_default_params">
+
+ </a>
+ <a name="add_default_params">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ add_default_params(self, params):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L571" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.common.cloudstack.CloudStackConnection.html">libcloud.common.cloudstack.CloudStackConnection</a>, <a href="libcloud.common.cloudstack.CloudStackConnection.html">libcloud.common.cloudstack.CloudStackConnection</a></div>
+ <pre>Adds default parameters (such as API key, version, etc.)
+to the passed `params`
+
+Should return a dictionary.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection.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/common/base.py#L580" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>Adds default headers (such as Authorization, X-Foo-Bar)
+to the passed `headers`
+
+Should return a dictionary.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection.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/common/base.py#L589" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.common.cloudstack.CloudStackConnection.html">libcloud.common.cloudstack.CloudStackConnection</a>, <a href="libcloud.common.cloudstack.CloudStackConnection.html">libcloud.common.cloudstack.CloudStackConnection</a></div>
+ <pre>A hook which is called before connecting to the remote server.
+This hook can perform a final manipulation on the params, headers and
+url parameters.
+
+@type params: C{dict}
+@param params: Request parameters.
+
+@type headers: C{dict}
+@param headers: Request headers.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Connection.encode_data">
+
+ </a>
+ <a name="encode_data">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ encode_data(self, data):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L603" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>Encode body data.
+
+Override in a provider's subclass.</pre>
+ </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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.JsonResponse.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.JsonResponse.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.JsonResponse.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.JsonResponse.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,109 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.base.JsonResponse : 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.c.b.JsonResponse(<a href="libcloud.common.base.Response.html">Response</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L138">View Source</a>
+ <a href="classIndex.html#libcloud.common.base.JsonResponse">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.common.brightbox.BrightboxResponse.html">libcloud.common.brightbox.BrightboxResponse</a>, <a href="libcloud.common.cloudstack.CloudStackResponse.html">libcloud.common.cloudstack.CloudStackResponse</a>, <a href="libcloud.common.gogrid.GoGridResponse.html">libcloud.common.gogrid.GoGridResponse</a>, <a href="libcloud.common.linode.LinodeResponse.html">libcloud.common.linode.LinodeResponse</a>, <a href="libcloud.compute.drivers.bluebox.BlueboxResponse.html">libcloud.compute.drivers.bluebox.BlueboxResponse</a>, <a href="libcloud.compute.drivers.dreamhost.DreamhostResponse.html">libcloud.compute.drivers.dreamhost.DreamhostResponse</a>, <a href="libcloud.compute.drivers.elasticstack.ElasticStackResponse.html">libcloud.compute.drivers.elasticstack.ElasticStackResponse</a>, <a href="libcloud.compute.drivers.rimuhosting.RimuHostingResponse.html">libcloud.compute.drivers.rimuhosting.RimuHostingResponse</a>, <a href="libcloud.compute.drivers.
vpsnet.VPSNetResponse.html">libcloud.compute.drivers.vpsnet.VPSNetResponse</a>, <a href="libcloud.loadbalancer.drivers.rackspace.RackspaceResponse.html">libcloud.loadbalancer.drivers.rackspace.RackspaceResponse</a></p>
+ </div>
+ <pre>A Base JSON Response class to derive from.</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id557">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.JsonResponse.html#parse_body">parse_body</a></td>
+ <td><tt>Parse response body.</tt></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.Response.html">Response</a>:
+ </p>
+ <table class="children sortable" id="id558">
+
+
+<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">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#parse_error">parse_error</a></td>
+ <td><tt>Parse the error messages.</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#success">success</a></td>
+ <td><tt>Determine if our request was successful.</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#_decompress_response">_decompress_response</a></td>
+ <td><tt>Decompress a response body if it is using deflate or gzip encoding.</tt></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.base.JsonResponse.parse_body">
+
+ </a>
+ <a name="parse_body">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ parse_body(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L142" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.common.base.Response.html#parse_body">libcloud.common.base.Response.parse_body</a></div><div class="interfaceinfo">overridden in <a href="libcloud.common.brightbox.BrightboxResponse.html">libcloud.common.brightbox.BrightboxResponse</a>, <a href="libcloud.common.linode.LinodeResponse.html">libcloud.common.linode.LinodeResponse</a>, <a href="libcloud.compute.drivers.dreamhost.DreamhostResponse.html">libcloud.compute.drivers.dreamhost.DreamhostResponse</a>, <a href="libcloud.compute.drivers.rimuhosting.RimuHostingResponse.html">libcloud.compute.drivers.rimuhosting.RimuHostingResponse</a>, <a href="libcloud.compute.drivers.vpsnet.VPSNetResponse.html">libcloud.compute.drivers.vpsnet.VPSNetResponse</a>, <a href="libcloud.loadbalancer.drivers.rackspace.RackspaceResponse.html">libcloud.loadbalancer.drivers.rackspace.RackspaceResponse</a></div>
+ <pre>Parse response body.
+
+Override in a provider's subclass.
+
+@return: Parsed body.</pre>
+ </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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingConnection.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingConnection.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingConnection.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingConnection.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,100 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.base.LoggingConnection : 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.c.b.LoggingConnection : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L216">View Source</a>
+ <a href="classIndex.html#libcloud.common.base.LoggingConnection">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.common.base.LoggingHTTPConnection.html">libcloud.common.base.LoggingHTTPConnection</a>, <a href="libcloud.common.base.LoggingHTTPSConnection.html">libcloud.common.base.LoggingHTTPSConnection</a></p>
+ </div>
+ <pre>Debug class to log all HTTP(s) requests as they could be made
+with the C{curl} command.
+
+@cvar log: file-like object that logs entries are written to.</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id563">
+
+
+<tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.LoggingConnection.html#_log_response">_log_response</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.LoggingConnection.html#_log_curl">_log_curl</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.base.LoggingConnection._log_response">
+
+ </a>
+ <a name="_log_response">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _log_response(self, r):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L225" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.LoggingConnection._log_curl">
+
+ </a>
+ <a name="_log_curl">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _log_curl(self, method, url, body, headers):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L280" 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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingHTTPConnection.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingHTTPConnection.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingHTTPConnection.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingHTTPConnection.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,119 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.base.LoggingHTTPConnection : 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.c.b.LoggingHTTPConnection(<a href="libcloud.common.base.LoggingConnection.html">LoggingConnection</a>, <span title="LibcloudHTTPConnection">LibcloudHTTPConnection</span>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L320">View Source</a>
+ <a href="classIndex.html#libcloud.common.base.LoggingHTTPConnection">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <pre>Utility Class for logging HTTP connections</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id567">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.LoggingHTTPConnection.html#getresponse">getresponse</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.LoggingHTTPConnection.html#request">request</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.LoggingConnection.html">LoggingConnection</a>:
+ </p>
+ <table class="children sortable" id="id568">
+
+
+<tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.LoggingConnection.html#_log_response">_log_response</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.LoggingConnection.html#_log_curl">_log_curl</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.base.LoggingHTTPConnection.getresponse">
+
+ </a>
+ <a name="getresponse">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ getresponse(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L325" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.LoggingHTTPConnection.request">
+
+ </a>
+ <a name="request">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ request(self, method, url, body=None, headers=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L333" 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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingHTTPSConnection.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingHTTPSConnection.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingHTTPSConnection.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.LoggingHTTPSConnection.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,171 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.base.LoggingHTTPSConnection : 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.c.b.LoggingHTTPSConnection(<a href="libcloud.common.base.LoggingConnection.html">LoggingConnection</a>, <a href="libcloud.compute.base.LibcloudHTTPSConnection.html">LibcloudHTTPSConnection</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L297">View Source</a>
+ <a href="classIndex.html#libcloud.common.base.LoggingHTTPSConnection">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <pre>Utility Class for logging HTTPS connections</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id564">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.LoggingHTTPSConnection.html#getresponse">getresponse</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.LoggingHTTPSConnection.html#request">request</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.LoggingConnection.html">LoggingConnection</a>:
+ </p>
+ <table class="children sortable" id="id565">
+
+
+<tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.LoggingConnection.html#_log_response">_log_response</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.LoggingConnection.html#_log_curl">_log_curl</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.compute.base.LibcloudHTTPSConnection.html">LibcloudHTTPSConnection</a>:
+ </p>
+ <table class="children sortable" id="id566">
+
+
+<tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.compute.base.LibcloudHTTPSConnection.html#__init__">__init__</a></td>
+ <td><tt>Constructor</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.compute.base.LibcloudHTTPSConnection.html#connect">connect</a></td>
+ <td><tt>Connect</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.compute.base.LibcloudHTTPSConnection.html#_setup_verify">_setup_verify</a></td>
+ <td><tt>Setup Verify SSL or not</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.compute.base.LibcloudHTTPSConnection.html#_setup_ca_cert">_setup_ca_cert</a></td>
+ <td><tt>Setup CA Certs</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.compute.base.LibcloudHTTPSConnection.html#_verify_hostname">_verify_hostname</a></td>
+ <td><tt>Verify hostname against peer cert</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.compute.base.LibcloudHTTPSConnection.html#_get_subject_alt_names">_get_subject_alt_names</a></td>
+ <td><tt>Get SubjectAltNames</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.compute.base.LibcloudHTTPSConnection.html#_get_common_name">_get_common_name</a></td>
+ <td><tt>Get Common Name</tt></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.base.LoggingHTTPSConnection.getresponse">
+
+ </a>
+ <a name="getresponse">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ getresponse(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L302" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.LoggingHTTPSConnection.request">
+
+ </a>
+ <a name="request">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ request(self, method, url, body=None, headers=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L310" 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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.PollingConnection.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.PollingConnection.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.PollingConnection.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.PollingConnection.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,287 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.base.PollingConnection : 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.c.b.PollingConnection(<a href="libcloud.common.base.Connection.html">Connection</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L611">View Source</a>
+ <a href="classIndex.html#libcloud.common.base.PollingConnection">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.common.cloudstack.CloudStackConnection.html">libcloud.common.cloudstack.CloudStackConnection</a>, <a href="libcloud.dns.drivers.rackspace.RackspaceDNSConnection.html">libcloud.dns.drivers.rackspace.RackspaceDNSConnection</a>, <a href="libcloud.loadbalancer.drivers.rackspace.RackspaceConnection.html">libcloud.loadbalancer.drivers.rackspace.RackspaceConnection</a></p>
+ </div>
+ <pre>Connection class which can also work with the async APIs.
+
+After initial requests, this class periodically polls for jobs status and
+waits until the job has finished.
+If job doesn't finish in timeout seconds, an Exception thrown.</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id570">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.PollingConnection.html#async_request">async_request</a></td>
+ <td><span class="undocumented">No summary</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.PollingConnection.html#get_request_kwargs">get_request_kwargs</a></td>
+ <td><tt>Arguments which are passed to the initial request() call inside async_request.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.PollingConnection.html#get_poll_request_kwargs">get_poll_request_kwargs</a></td>
+ <td><tt>Return keyword arguments which are passed to the request() method when polling for the job status.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.PollingConnection.html#has_completed">has_completed</a></td>
+ <td><tt>Return job completion status.</tt></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.Connection.html">Connection</a>:
+ </p>
+ <table class="children sortable" id="id571">
+
+
+<tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#__init__">__init__</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#set_context">set_context</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#connect">connect</a></td>
+ <td><tt>Establish a connection with the API server.</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#user_agent_append">user_agent_append</a></td>
+ <td><tt>Append a token to a user agent string.</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#request">request</a></td>
+ <td><tt>Request a given `action`.</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#morph_action_hook">morph_action_hook</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#add_default_params">add_default_params</a></td>
+ <td><tt>Adds default parameters (such as API key, version, etc.) to the passed `params`</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#add_default_headers">add_default_headers</a></td>
+ <td><tt>Adds default headers (such as Authorization, X-Foo-Bar) to the passed `headers`</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#pre_connect_hook">pre_connect_hook</a></td>
+ <td><tt>A hook which is called before connecting to the remote server. This hook can perform a final manipulation on the params, headers and url parameters.</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#encode_data">encode_data</a></td>
+ <td><tt>Encode body data.</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#_tuple_from_url">_tuple_from_url</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Connection.html#_user_agent">_user_agent</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.base.PollingConnection.async_request">
+
+ </a>
+ <a name="async_request">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ async_request(self, action, params=None, data='', headers=None, method='GET', context=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L623" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>Perform an 'async' request to the specified path. Keep in mind that
+this function is *blocking* and 'async' in this case means that the
+hit URL only returns a job ID which is the periodically polled until
+the job has completed.
+
+This function works like this:
+
+- Perform a request to the specified path. Response should contain a
+ 'job_id'.
+
+- Returned 'job_id' is then used to construct a URL which is used for
+ retrieving job status. Constructed URL is then periodically polled
+ until the response indicates that the job has completed or the timeout
+ of 'self.timeout' seconds has been reached.
+
+@type action: C{str}
+@param action: A path
+
+@type params: C{dict}
+@param params: Optional mapping of additional parameters to send. If
+ None, leave as an empty C{dict}.
+
+@type data: C{unicode}
+@param data: A body of data to send with the request.
+
+@type headers: C{dict}
+@param headers: Extra headers to add to the request
+ None, leave as an empty C{dict}.
+
+@type method: C{str}
+@param method: An HTTP method such as "GET" or "POST".
+
+@type context: C{dict}
+@param context: Context dictionary which is passed to the functions
+which construct initial and poll URL.
+
+@return: An instance of type I{responseCls}</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.PollingConnection.get_request_kwargs">
+
+ </a>
+ <a name="get_request_kwargs">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_request_kwargs(self, action, params=None, data='', headers=None, method='GET', context=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L689" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.common.cloudstack.CloudStackConnection.html">libcloud.common.cloudstack.CloudStackConnection</a></div>
+ <pre>Arguments which are passed to the initial request() call inside
+async_request.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.PollingConnection.get_poll_request_kwargs">
+
+ </a>
+ <a name="get_poll_request_kwargs">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_poll_request_kwargs(self, response, context, request_kwargs):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L699" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.common.cloudstack.CloudStackConnection.html">libcloud.common.cloudstack.CloudStackConnection</a>, <a href="libcloud.dns.drivers.rackspace.RackspaceDNSConnection.html">libcloud.dns.drivers.rackspace.RackspaceDNSConnection</a>, <a href="libcloud.loadbalancer.drivers.rackspace.RackspaceConnection.html">libcloud.loadbalancer.drivers.rackspace.RackspaceConnection</a></div>
+ <pre>Return keyword arguments which are passed to the request() method when
+polling for the job status.
+
+@param response: Response object returned by poll request.
+@type response: C{HTTPResponse}
+
+@param request_kwargs: Kwargs previously used to initiate the
+ poll request.
+@type response: C{dict}
+
+@return C{dict} Keyword arguments</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.PollingConnection.has_completed">
+
+ </a>
+ <a name="has_completed">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ has_completed(self, response):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L715" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.common.cloudstack.CloudStackConnection.html">libcloud.common.cloudstack.CloudStackConnection</a>, <a href="libcloud.dns.drivers.rackspace.RackspaceDNSConnection.html">libcloud.dns.drivers.rackspace.RackspaceDNSConnection</a>, <a href="libcloud.loadbalancer.drivers.rackspace.RackspaceConnection.html">libcloud.loadbalancer.drivers.rackspace.RackspaceConnection</a></div>
+ <pre>Return job completion status.
+
+@param response: Response object returned by poll request.
+@type response: C{HTTPResponse}
+
+@return C{bool} True if the job has completed, False otherwise.</pre>
+ </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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.RawResponse.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.RawResponse.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.RawResponse.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.RawResponse.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,209 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.base.RawResponse : 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.c.b.RawResponse(<a href="libcloud.common.base.Response.html">Response</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L177">View Source</a>
+ <a href="classIndex.html#libcloud.common.base.RawResponse">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.storage.drivers.cloudfiles.CloudFilesRawResponse.html">libcloud.storage.drivers.cloudfiles.CloudFilesRawResponse</a>, <a href="libcloud.storage.drivers.s3.S3RawResponse.html">libcloud.storage.drivers.s3.S3RawResponse</a></p>
+ </div>
+ <div class="undocumented">Undocumented</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id561">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.RawResponse.html#__init__">__init__</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.RawResponse.html#response">response</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.RawResponse.html#status">status</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.RawResponse.html#headers">headers</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.RawResponse.html#reason">reason</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.Response.html">Response</a>:
+ </p>
+ <table class="children sortable" id="id562">
+
+
+<tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#parse_body">parse_body</a></td>
+ <td><tt>Parse response body.</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#parse_error">parse_error</a></td>
+ <td><tt>Parse the error messages.</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#success">success</a></td>
+ <td><tt>Determine if our request was successful.</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#_decompress_response">_decompress_response</a></td>
+ <td><tt>Decompress a response body if it is using deflate or gzip encoding.</tt></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.base.RawResponse.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, connection):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L179" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.common.base.Response.html#__init__">libcloud.common.base.Response.__init__</a></div>
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.RawResponse.response">
+
+ </a>
+ <a name="response">
+
+ </a>
+ <div class="functionHeader">
+ @property<br />
+ def
+ response(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L188" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.RawResponse.status">
+
+ </a>
+ <a name="status">
+
+ </a>
+ <div class="functionHeader">
+ @property<br />
+ def
+ status(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L197" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.RawResponse.headers">
+
+ </a>
+ <a name="headers">
+
+ </a>
+ <div class="functionHeader">
+ @property<br />
+ def
+ headers(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L203" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.RawResponse.reason">
+
+ </a>
+ <a name="reason">
+
+ </a>
+ <div class="functionHeader">
+ @property<br />
+ def
+ reason(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L209" 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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.Response.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.Response.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.Response.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.Response.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,190 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.base.Response : 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.c.b.Response(<span title="object">object</span>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L48">View Source</a>
+ <a href="classIndex.html#libcloud.common.base.Response">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.common.base.JsonResponse.html">libcloud.common.base.JsonResponse</a>, <a href="libcloud.common.base.RawResponse.html">libcloud.common.base.RawResponse</a>, <a href="libcloud.common.base.XmlResponse.html">libcloud.common.base.XmlResponse</a>, <a href="libcloud.common.openstack.OpenStackAuthResponse.html">libcloud.common.openstack.OpenStackAuthResponse</a>, <a href="libcloud.compute.drivers.cloudsigma.CloudSigmaResponse.html">libcloud.compute.drivers.cloudsigma.CloudSigmaResponse</a>, <a href="libcloud.compute.drivers.ecp.ECPResponse.html">libcloud.compute.drivers.ecp.ECPResponse</a>, <a href="libcloud.compute.drivers.openstack.OpenStackResponse.html">libcloud.compute.drivers.openstack.OpenStackResponse</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesResponse.html">libcloud.storage.drivers.cloudfiles.CloudFilesResponse</a></p>
+ </div>
+ <pre>A Base Response class to derive from.</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id556">
+
+
+<tr class="method">
+
+
+ <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="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#parse_body">parse_body</a></td>
+ <td><tt>Parse response body.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#parse_error">parse_error</a></td>
+ <td><tt>Parse the error messages.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#success">success</a></td>
+ <td><tt>Determine if our request was successful.</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#_decompress_response">_decompress_response</a></td>
+ <td><tt>Decompress a response body if it is using deflate or gzip encoding.</tt></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.base.Response.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, response, connection):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L62" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.common.base.RawResponse.html">libcloud.common.base.RawResponse</a>, <a href="libcloud.common.gogrid.GoGridResponse.html">libcloud.common.gogrid.GoGridResponse</a>, <a href="libcloud.common.linode.LinodeResponse.html">libcloud.common.linode.LinodeResponse</a>, <a href="libcloud.compute.drivers.openstack.OpenStack_1_0_Response.html">libcloud.compute.drivers.openstack.OpenStack_1_0_Response</a>, <a href="libcloud.compute.drivers.openstack.OpenStack_1_1_Response.html">libcloud.compute.drivers.openstack.OpenStack_1_1_Response</a>, <a href="libcloud.compute.drivers.rimuhosting.RimuHostingResponse.html">libcloud.compute.drivers.rimuhosting.RimuHostingResponse</a>, <a href="libcloud.compute.drivers.voxel.VoxelResponse.html">libcloud.compute.drivers.voxel.VoxelResponse</a></div>
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Response.parse_body">
+
+ </a>
+ <a name="parse_body">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ parse_body(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L81" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.common.base.JsonResponse.html">libcloud.common.base.JsonResponse</a>, <a href="libcloud.common.base.XmlResponse.html">libcloud.common.base.XmlResponse</a>, <a href="libcloud.common.openstack.OpenStackAuthResponse.html">libcloud.common.openstack.OpenStackAuthResponse</a>, <a href="libcloud.compute.drivers.cloudsigma.CloudSigmaResponse.html">libcloud.compute.drivers.cloudsigma.CloudSigmaResponse</a>, <a href="libcloud.compute.drivers.ecp.ECPResponse.html">libcloud.compute.drivers.ecp.ECPResponse</a>, <a href="libcloud.compute.drivers.openstack.OpenStackResponse.html">libcloud.compute.drivers.openstack.OpenStackResponse</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesResponse.html">libcloud.storage.drivers.cloudfiles.CloudFilesResponse</a></div>
+ <pre>Parse response body.
+
+Override in a provider's subclass.
+
+@return: Parsed body.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Response.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/common/base.py#L91" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.common.brightbox.BrightboxResponse.html">libcloud.common.brightbox.BrightboxResponse</a>, <a href="libcloud.common.gogrid.GoGridResponse.html">libcloud.common.gogrid.GoGridResponse</a>, <a href="libcloud.compute.drivers.bluebox.BlueboxResponse.html">libcloud.compute.drivers.bluebox.BlueboxResponse</a>, <a href="libcloud.compute.drivers.cloudsigma.CloudSigmaResponse.html">libcloud.compute.drivers.cloudsigma.CloudSigmaResponse</a>, <a href="libcloud.compute.drivers.dreamhost.DreamhostResponse.html">libcloud.compute.drivers.dreamhost.DreamhostResponse</a>, <a href="libcloud.compute.drivers.ec2.EC2Response.html">libcloud.compute.drivers.ec2.EC2Response</a>, <a href="libcloud.compute.drivers.ecp.ECPResponse.html">libcloud.compute.drivers.ecp.ECPResponse</a>, <a href="libcloud.compute.drivers.elasticstack.ElasticStackResponse.html">libcloud.compute.drivers.elasticstack.ElasticStackResponse</a>, <a href="libcloud.comput
e.drivers.ibm_sbc.IBMResponse.html">libcloud.compute.drivers.ibm_sbc.IBMResponse</a>, <a href="libcloud.compute.drivers.opennebula.OpenNebulaResponse.html">libcloud.compute.drivers.opennebula.OpenNebulaResponse</a>, <a href="libcloud.compute.drivers.openstack.OpenStackResponse.html">libcloud.compute.drivers.openstack.OpenStackResponse</a>, <a href="libcloud.compute.drivers.opsource.OpsourceResponse.html">libcloud.compute.drivers.opsource.OpsourceResponse</a>, <a href="libcloud.compute.drivers.slicehost.SlicehostResponse.html">libcloud.compute.drivers.slicehost.SlicehostResponse</a>, <a href="libcloud.compute.drivers.voxel.VoxelResponse.html">libcloud.compute.drivers.voxel.VoxelResponse</a>, <a href="libcloud.compute.drivers.vpsnet.VPSNetResponse.html">libcloud.compute.drivers.vpsnet.VPSNetResponse</a>, <a href="libcloud.dns.drivers.zerigo.ZerigoDNSResponse.html">libcloud.dns.drivers.zerigo.ZerigoDNSResponse</a>, <a href="libcloud.storage.drivers.atmos.AtmosResponse.html">lib
cloud.storage.drivers.atmos.AtmosResponse</a>, <a href="libcloud.storage.drivers.s3.S3Response.html">libcloud.storage.drivers.s3.S3Response</a></div>
+ <pre>Parse the error messages.
+
+Override in a provider's subclass.
+
+@return: Parsed error.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Response.success">
+
+ </a>
+ <a name="success">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ success(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L101" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.common.brightbox.BrightboxResponse.html">libcloud.common.brightbox.BrightboxResponse</a>, <a href="libcloud.common.gogrid.GoGridResponse.html">libcloud.common.gogrid.GoGridResponse</a>, <a href="libcloud.common.linode.LinodeResponse.html">libcloud.common.linode.LinodeResponse</a>, <a href="libcloud.common.openstack.OpenStackAuthResponse.html">libcloud.common.openstack.OpenStackAuthResponse</a>, <a href="libcloud.compute.drivers.cloudsigma.CloudSigmaResponse.html">libcloud.compute.drivers.cloudsigma.CloudSigmaResponse</a>, <a href="libcloud.compute.drivers.ecp.ECPResponse.html">libcloud.compute.drivers.ecp.ECPResponse</a>, <a href="libcloud.compute.drivers.elasticstack.ElasticStackResponse.html">libcloud.compute.drivers.elasticstack.ElasticStackResponse</a>, <a href="libcloud.compute.drivers.ibm_sbc.IBMResponse.html">libcloud.compute.drivers.ibm_sbc.IBMResponse</a>, <a href="libcloud.compute.drivers.opennebula.Ope
nNebulaResponse.html">libcloud.compute.drivers.opennebula.OpenNebulaResponse</a>, <a href="libcloud.compute.drivers.openstack.OpenStackResponse.html">libcloud.compute.drivers.openstack.OpenStackResponse</a>, <a href="libcloud.compute.drivers.rimuhosting.RimuHostingResponse.html">libcloud.compute.drivers.rimuhosting.RimuHostingResponse</a>, <a href="libcloud.compute.drivers.vcloud.VCloudResponse.html">libcloud.compute.drivers.vcloud.VCloudResponse</a>, <a href="libcloud.compute.drivers.voxel.VoxelResponse.html">libcloud.compute.drivers.voxel.VoxelResponse</a>, <a href="libcloud.compute.drivers.vpsnet.VPSNetResponse.html">libcloud.compute.drivers.vpsnet.VPSNetResponse</a>, <a href="libcloud.dns.drivers.zerigo.ZerigoDNSResponse.html">libcloud.dns.drivers.zerigo.ZerigoDNSResponse</a>, <a href="libcloud.loadbalancer.drivers.rackspace.RackspaceResponse.html">libcloud.loadbalancer.drivers.rackspace.RackspaceResponse</a>, <a href="libcloud.storage.drivers.atmos.AtmosResponse.html">l
ibcloud.storage.drivers.atmos.AtmosResponse</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesResponse.html">libcloud.storage.drivers.cloudfiles.CloudFilesResponse</a>, <a href="libcloud.storage.drivers.s3.S3Response.html">libcloud.storage.drivers.s3.S3Response</a></div>
+ <pre>Determine if our request was successful.
+
+The meaning of this can be arbitrary; did we receive OK status? Did
+the node get created? Were we authenticated?
+
+@return: C{True} or C{False}</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.base.Response._decompress_response">
+
+ </a>
+ <a name="_decompress_response">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _decompress_response(self, response):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L112" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>Decompress a response body if it is using deflate or gzip encoding.
+
+@return: Decompressed response</pre>
+ </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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.XmlResponse.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.XmlResponse.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.XmlResponse.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.XmlResponse.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,109 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.base.XmlResponse : 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.c.b.XmlResponse(<a href="libcloud.common.base.Response.html">Response</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L158">View Source</a>
+ <a href="classIndex.html#libcloud.common.base.XmlResponse">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.common.aws.AWSBaseResponse.html">libcloud.common.aws.AWSBaseResponse</a>, <a href="libcloud.compute.drivers.ibm_sbc.IBMResponse.html">libcloud.compute.drivers.ibm_sbc.IBMResponse</a>, <a href="libcloud.compute.drivers.opennebula.OpenNebulaResponse.html">libcloud.compute.drivers.opennebula.OpenNebulaResponse</a>, <a href="libcloud.compute.drivers.opsource.OpsourceResponse.html">libcloud.compute.drivers.opsource.OpsourceResponse</a>, <a href="libcloud.compute.drivers.slicehost.SlicehostResponse.html">libcloud.compute.drivers.slicehost.SlicehostResponse</a>, <a href="libcloud.compute.drivers.vcloud.VCloudResponse.html">libcloud.compute.drivers.vcloud.VCloudResponse</a>, <a href="libcloud.compute.drivers.voxel.VoxelResponse.html">libcloud.compute.drivers.voxel.VoxelResponse</a>, <a href="libcloud.dns.drivers.zerigo.ZerigoDNSResponse.html">libcloud.dns.drivers.zerigo.ZerigoDNSResponse</a>, <a href="libcloud.storage.drivers.atmos.AtmosR
esponse.html">libcloud.storage.drivers.atmos.AtmosResponse</a></p>
+ </div>
+ <pre>A Base XML Response class to derive from.</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id559">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.XmlResponse.html#parse_body">parse_body</a></td>
+ <td><tt>Parse response body.</tt></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.Response.html">Response</a>:
+ </p>
+ <table class="children sortable" id="id560">
+
+
+<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">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#parse_error">parse_error</a></td>
+ <td><tt>Parse the error messages.</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#success">success</a></td>
+ <td><tt>Determine if our request was successful.</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.Response.html#_decompress_response">_decompress_response</a></td>
+ <td><tt>Decompress a response body if it is using deflate or gzip encoding.</tt></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.base.XmlResponse.parse_body">
+
+ </a>
+ <a name="parse_body">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ parse_body(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py#L162" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.common.base.Response.html#parse_body">libcloud.common.base.Response.parse_body</a></div><div class="interfaceinfo">overridden in <a href="libcloud.compute.drivers.voxel.VoxelResponse.html">libcloud.compute.drivers.voxel.VoxelResponse</a></div>
+ <pre>Parse response body.
+
+Override in a provider's subclass.
+
+@return: Parsed body.</pre>
+ </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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.base.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,105 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.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.c.base : module documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/base.py">View Source</a>
+
+ </p>
+ <div>
+
+ </div>
+ <div class="undocumented">No module docstring</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id555">
+
+
+<tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.base.Response.html">Response</a></td>
+ <td><tt>A Base Response class to derive from.</tt></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.base.JsonResponse.html">JsonResponse</a></td>
+ <td><tt>A Base JSON Response class to derive from.</tt></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.base.XmlResponse.html">XmlResponse</a></td>
+ <td><tt>A Base XML Response class to derive from.</tt></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.base.RawResponse.html">RawResponse</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.base.LoggingConnection.html">LoggingConnection</a></td>
+ <td><tt>Debug class to log all HTTP(s) requests as they could be made with the C{curl} command.</tt></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.base.LoggingHTTPSConnection.html">LoggingHTTPSConnection</a></td>
+ <td><tt>Utility Class for logging HTTPS connections</tt></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.base.LoggingHTTPConnection.html">LoggingHTTPConnection</a></td>
+ <td><tt>Utility Class for logging HTTP connections</tt></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.base.Connection.html">Connection</a></td>
+ <td><tt>A Base Connection class to derive from.</tt></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.base.PollingConnection.html">PollingConnection</a></td>
+ <td><tt>Connection class which can also work with the async APIs.</tt></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.base.BaseDriver.html">BaseDriver</a></td>
+ <td><tt>Base driver class from which other classes can inherit from.</tt></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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.BrightboxConnection.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.BrightboxConnection.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.BrightboxConnection.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.BrightboxConnection.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,123 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.brightbox.BrightboxConnection : 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.c.b.BrightboxConnection(<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.common.html">common</a>.<a href="libcloud.common.brightbox.html">brightbox</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/brightbox.py#L45">View Source</a>
+ <a href="classIndex.html#libcloud.common.brightbox.BrightboxConnection">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <pre>Connection class for the Brightbox driver</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id591">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.brightbox.BrightboxConnection.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.common.brightbox.BrightboxConnection.html#encode_data">encode_data</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.brightbox.BrightboxConnection.html#_fetch_oauth_token">_fetch_oauth_token</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.brightbox.BrightboxConnection._fetch_oauth_token">
+
+ </a>
+ <a name="_fetch_oauth_token">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _fetch_oauth_token(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/brightbox.py#L53" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.brightbox.BrightboxConnection.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/common/brightbox.py#L80" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.brightbox.BrightboxConnection.encode_data">
+
+ </a>
+ <a name="encode_data">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ encode_data(self, data):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/brightbox.py#L90" 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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.BrightboxResponse.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.BrightboxResponse.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.BrightboxResponse.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.BrightboxResponse.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,158 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.brightbox.BrightboxResponse : 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.c.b.BrightboxResponse(<a href="libcloud.common.base.JsonResponse.html">JsonResponse</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a>.<a href="libcloud.common.brightbox.html">brightbox</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/brightbox.py#L29">View Source</a>
+ <a href="classIndex.html#libcloud.common.brightbox.BrightboxResponse">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <div class="undocumented">Undocumented</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id589">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.brightbox.BrightboxResponse.html#success">success</a></td>
+ <td><tt>Determine if our request was successful.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.brightbox.BrightboxResponse.html#parse_body">parse_body</a></td>
+ <td><tt>Parse response body.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.brightbox.BrightboxResponse.html#parse_error">parse_error</a></td>
+ <td><tt>Parse the error messages.</tt></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.Response.html">Response</a> (via <a href="libcloud.common.base.JsonResponse.html">JsonResponse</a>):
+ </p>
+ <table class="children sortable" id="id590">
+
+
+<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><tt>Decompress a response body if it is using deflate or gzip encoding.</tt></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.common.brightbox.BrightboxResponse.success">
+
+ </a>
+ <a name="success">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ success(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/brightbox.py#L30" 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>
+ <pre>Determine if our request was successful.
+
+The meaning of this can be arbitrary; did we receive OK status? Did
+the node get created? Were we authenticated?
+
+@return: C{True} or C{False}</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.brightbox.BrightboxResponse.parse_body">
+
+ </a>
+ <a name="parse_body">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ parse_body(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/brightbox.py#L33" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.common.base.JsonResponse.html#parse_body">libcloud.common.base.JsonResponse.parse_body</a></div>
+ <pre>Parse response body.
+
+Override in a provider's subclass.
+
+@return: Parsed body.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.common.brightbox.BrightboxResponse.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/common/brightbox.py#L39" 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>
+ <pre>Parse the error messages.
+
+Override in a provider's subclass.
+
+@return: Parsed error.</pre>
+ </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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.html?rev=1242205&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.html (added)
+++ libcloud/site/trunk/content/apidocs/0.8.0/libcloud.common.brightbox.html Thu Feb 9 01:59:57 2012
@@ -0,0 +1,57 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.common.brightbox : 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.c.brightbox : module documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.common.html">common</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/common/brightbox.py">View Source</a>
+
+ </p>
+ <div>
+
+ </div>
+ <div class="undocumented">No module docstring</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id588">
+
+
+<tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.brightbox.BrightboxResponse.html">BrightboxResponse</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.common.brightbox.BrightboxConnection.html">BrightboxConnection</a></td>
+ <td><tt>Connection class for the Brightbox driver</tt></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-02-08 17:57:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file