234 lines
11 KiB
HTML
234 lines
11 KiB
HTML
<?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">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="oauth2client-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </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 oauth2client</a> ::
|
|
<a href="oauth2client.tools-module.html">Module tools</a> ::
|
|
Class 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 private</a>]</span></td></tr>
|
|
<tr><td align="right"><span class="options"
|
|
>[<a href="frames.html" target="_top">frames</a
|
|
>] | <a href="oauth2client.tools.ClientRedirectServer-class.html"
|
|
target="_top">no 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 code</a></span></p>
|
|
<center>
|
|
<center> <map id="uml_class_diagram_for_oauth2cl_57" name="uml_class_diagram_for_oauth2cl_57">
|
|
<area shape="rect" id="node1_22" href="oauth2client.tools.ClientRedirectServer-class.html#query_params" title="oauth2client.tools.ClientRedirectServer.query_params" alt="" coords="191,572,314,591"/>
|
|
<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="179,549,326,605"/>
|
|
<area shape="rect" id="node2_23" href="javascript:void(0);" title="BaseHTTPServer.HTTPServer.allow_reuse_address" alt="" coords="162,484,343,503"/>
|
|
<area shape="rect" id="node2_24" href="javascript:void(0);" title="Override server_bind to store the server name." alt="" coords="162,505,343,524"/>
|
|
<area shape="rect" id="node2" href="javascript:void(0);" title="BaseHTTPServer.HTTPServer" alt="" coords="150,461,355,531"/>
|
|
<area shape="rect" id="node3_25" href="javascript:void(0);" title="SocketServer.TCPServer.address_family" alt="" coords="18,247,486,265"/>
|
|
<area shape="rect" id="node3_26" href="javascript:void(0);" title="SocketServer.TCPServer.socket_type" alt="" coords="18,265,486,284"/>
|
|
<area shape="rect" id="node3_27" href="javascript:void(0);" title="SocketServer.TCPServer.request_queue_size" alt="" coords="18,284,486,303"/>
|
|
<area shape="rect" id="node3_28" href="javascript:void(0);" title="Constructor." alt="" coords="18,305,486,324"/>
|
|
<area shape="rect" id="node3_29" href="javascript:void(0);" title="Called by constructor to activate the server." alt="" coords="18,324,486,343"/>
|
|
<area shape="rect" id="node3_30" href="javascript:void(0);" title="Called to clean-up the server." alt="" coords="18,343,486,361"/>
|
|
<area shape="rect" id="node3_31" href="javascript:void(0);" title="Return socket file number." alt="" coords="18,361,486,380"/>
|
|
<area shape="rect" id="node3_32" href="javascript:void(0);" title="Get the request and client address from the socket." alt="" coords="18,380,486,399"/>
|
|
<area shape="rect" id="node3_33" href="javascript:void(0);" title="Called to shutdown and close an individual request." alt="" coords="18,399,486,417"/>
|
|
<area shape="rect" id="node3_34" href="javascript:void(0);" title="Called to clean up an individual request." alt="" coords="18,417,486,436"/>
|
|
<area shape="rect" id="node3" href="javascript:void(0);" title="Base class for various socket-based server classes." alt="" coords="5,224,497,443"/>
|
|
<area shape="rect" id="node4_35" href="javascript:void(0);" title="SocketServer.BaseServer.timeout" alt="" coords="113,28,391,47"/>
|
|
<area shape="rect" id="node4_36" href="javascript:void(0);" title="Handle one request at a time until shutdown." alt="" coords="113,49,391,68"/>
|
|
<area shape="rect" id="node4_37" href="javascript:void(0);" title="Stops the serve_forever loop." alt="" coords="113,68,391,87"/>
|
|
<area shape="rect" id="node4_38" href="javascript:void(0);" title="Handle one request, possibly blocking." alt="" coords="113,87,391,105"/>
|
|
<area shape="rect" id="node4_39" href="javascript:void(0);" title="Called if no new request arrives within self.timeout." alt="" coords="113,105,391,124"/>
|
|
<area shape="rect" id="node4_40" href="javascript:void(0);" title="Verify the request." alt="" coords="113,124,391,143"/>
|
|
<area shape="rect" id="node4_41" href="javascript:void(0);" title="Call finish_request." alt="" coords="113,143,391,161"/>
|
|
<area shape="rect" id="node4_42" href="javascript:void(0);" title="Finish one request by instantiating RequestHandlerClass." alt="" coords="113,161,391,180"/>
|
|
<area shape="rect" id="node4_43" href="javascript:void(0);" title="Handle an error gracefully." alt="" coords="113,180,391,199"/>
|
|
<area shape="rect" id="node4" href="javascript:void(0);" title="Base class for server classes." alt="" coords="100,5,403,205"/>
|
|
</map>
|
|
<img src="uml_class_diagram_for_oauth2cl_57.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_57" 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"> </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">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="oauth2client-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </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 Mon Sep 29 15:21:53 2014
|
|
</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>
|