openstack/deb-python-oauth2client
Code Issues Proposed changes
Files
b79c737dfe4bc6fd8994f8d701adaac13cf812fe
deb-python-oauth2client/docs/epy/oauth2client.tools.ClientRedirectServer-class.html
Joe Gregorio 37802c3426 Refresh docs
2013-08-06 12:24:05 -04:00

228 lines
11 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>oauth2client.tools.ClientRedirectServer</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
<a href="oauth2client.tools-module.html">Module&nbsp;tools</a> ::
Class&nbsp;ClientRedirectServer
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="oauth2client.tools.ClientRedirectServer-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ClientRedirectServer</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.tools-pysrc.html#ClientRedirectServer">source&nbsp;code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_oauth2cl_52" name="uml_class_diagram_for_oauth2cl_52">
<area shape="rect" id="node230" href="oauth2client.tools.ClientRedirectServer-class.html#query_params" title="oauth2client.tools.ClientRedirectServer.query_params" alt="" coords="187,583,309,601"/>
<area shape="rect" id="node1" href="oauth2client.tools.ClientRedirectServer-class.html" title="A server to handle OAuth 2.0 redirects back to localhost." alt="" coords="175,558,321,615"/>
<area shape="rect" id="node231" href="javascript:void(0);" title="BaseHTTPServer.HTTPServer.allow_reuse_address" alt="" coords="156,492,339,511"/>
<area shape="rect" id="node231" href="javascript:void(0);" title="Override server_bind to store the server name." alt="" coords="156,513,339,532"/>
<area shape="rect" id="node2" href="javascript:void(0);" title="BaseHTTPServer.HTTPServer" alt="" coords="144,467,349,538"/>
<area shape="rect" id="node232" href="javascript:void(0);" title="SocketServer.TCPServer.address_family" alt="" coords="17,252,479,271"/>
<area shape="rect" id="node232" href="javascript:void(0);" title="SocketServer.TCPServer.socket_type" alt="" coords="17,271,479,289"/>
<area shape="rect" id="node232" href="javascript:void(0);" title="SocketServer.TCPServer.request_queue_size" alt="" coords="17,289,479,308"/>
<area shape="rect" id="node232" href="javascript:void(0);" title="Constructor." alt="" coords="17,311,479,329"/>
<area shape="rect" id="node232" href="javascript:void(0);" title="Called by constructor to activate the server." alt="" coords="17,329,479,348"/>
<area shape="rect" id="node232" href="javascript:void(0);" title="Called to clean&#45;up the server." alt="" coords="17,348,479,367"/>
<area shape="rect" id="node232" href="javascript:void(0);" title="Return socket file number." alt="" coords="17,367,479,385"/>
<area shape="rect" id="node232" href="javascript:void(0);" title="Get the request and client address from the socket." alt="" coords="17,385,479,404"/>
<area shape="rect" id="node232" href="javascript:void(0);" title="Called to shutdown and close an individual request." alt="" coords="17,404,479,423"/>
<area shape="rect" id="node232" href="javascript:void(0);" title="Called to clean up an individual request." alt="" coords="17,423,479,441"/>
<area shape="rect" id="node3" href="javascript:void(0);" title="Base class for various socket&#45;based server classes." alt="" coords="5,227,491,447"/>
<area shape="rect" id="node233" href="javascript:void(0);" title="SocketServer.BaseServer.timeout" alt="" coords="109,31,385,49"/>
<area shape="rect" id="node233" href="javascript:void(0);" title="Handle one request at a time until shutdown." alt="" coords="109,52,385,71"/>
<area shape="rect" id="node233" href="javascript:void(0);" title="Stops the serve_forever loop." alt="" coords="109,71,385,89"/>
<area shape="rect" id="node233" href="javascript:void(0);" title="Handle one request, possibly blocking." alt="" coords="109,89,385,108"/>
<area shape="rect" id="node233" href="javascript:void(0);" title="Called if no new request arrives within self.timeout." alt="" coords="109,108,385,127"/>
<area shape="rect" id="node233" href="javascript:void(0);" title="Verify the request." alt="" coords="109,127,385,145"/>
<area shape="rect" id="node233" href="javascript:void(0);" title="Call finish_request." alt="" coords="109,145,385,164"/>
<area shape="rect" id="node233" href="javascript:void(0);" title="Finish one request by instantiating RequestHandlerClass." alt="" coords="109,164,385,183"/>
<area shape="rect" id="node233" href="javascript:void(0);" title="Handle an error gracefully." alt="" coords="109,183,385,201"/>
<area shape="rect" id="node4" href="javascript:void(0);" title="Base class for server classes." alt="" coords="97,6,396,207"/>
</map>
<img src="uml_class_diagram_for_oauth2cl_52.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_52" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<pre class="literalblock">
A server to handle OAuth 2.0 redirects back to localhost.
Waits for a single request and parses the query parameters
into query_params and then stops serving.
</pre>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>BaseHTTPServer.HTTPServer</code></b>:
<code>server_bind</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.TCPServer</code></b>:
<code>__init__</code>,
<code>close_request</code>,
<code>fileno</code>,
<code>get_request</code>,
<code>server_activate</code>,
<code>server_close</code>,
<code>shutdown_request</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.BaseServer</code></b>:
<code>finish_request</code>,
<code>handle_error</code>,
<code>handle_request</code>,
<code>handle_timeout</code>,
<code>process_request</code>,
<code>serve_forever</code>,
<code>shutdown</code>,
<code>verify_request</code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.BaseServer</code></b> (private):
<code>_handle_request_noblock</code>
</p></div>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="query_params"></a><span class="summary-name">query_params</span> = <code title="{}">{}</code>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>BaseHTTPServer.HTTPServer</code></b>:
<code>allow_reuse_address</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.TCPServer</code></b>:
<code>address_family</code>,
<code>request_queue_size</code>,
<code>socket_type</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.BaseServer</code></b>:
<code>timeout</code>
</p>
</td>
</tr>
</table>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:46 2013
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
View Git Blame Copy Permalink