Files
deb-python-oauth2client/docs/epy/oauth2client.tools.ClientRedirectHandler-class.html
2014-09-29 15:22:23 -07:00

349 lines
16 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.ClientRedirectHandler</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>&nbsp;&nbsp;&nbsp;<a
href="oauth2client-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- 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;ClientRedirectHandler
</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.ClientRedirectHandler-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ClientRedirectHandler</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.tools-pysrc.html#ClientRedirectHandler">source&nbsp;code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_oauth2cl_56" name="uml_class_diagram_for_oauth2cl_56">
<area shape="rect" id="node1_32" href="oauth2client.tools.ClientRedirectHandler-class.html#do_GET" title="Handle a GET request." alt="" coords="55,753,253,772"/>
<area shape="rect" id="node1_33" href="oauth2client.tools.ClientRedirectHandler-class.html#log_message" title="Do not log messages to stdout while running as command line program." alt="" coords="55,772,253,791"/>
<area shape="rect" id="node1" href="oauth2client.tools.ClientRedirectHandler-class.html" title="A handler for OAuth 2.0 redirects back to localhost." alt="" coords="43,723,265,797"/>
<area shape="rect" id="node2_34" href="javascript:void(0);" title="BaseHTTPServer.BaseHTTPRequestHandler.sys_version" alt="" coords="19,265,287,284"/>
<area shape="rect" id="node2_35" href="javascript:void(0);" title="BaseHTTPServer.BaseHTTPRequestHandler.server_version" alt="" coords="19,284,287,303"/>
<area shape="rect" id="node2_36" href="javascript:void(0);" title="BaseHTTPServer.BaseHTTPRequestHandler.default_request_version" alt="" coords="19,303,287,321"/>
<area shape="rect" id="node2_37" href="javascript:void(0);" title="BaseHTTPServer.BaseHTTPRequestHandler.error_message_format" alt="" coords="19,321,287,340"/>
<area shape="rect" id="node2_38" href="javascript:void(0);" title="BaseHTTPServer.BaseHTTPRequestHandler.error_content_type" alt="" coords="19,340,287,359"/>
<area shape="rect" id="node2_39" href="javascript:void(0);" title="BaseHTTPServer.BaseHTTPRequestHandler.weekdayname" alt="" coords="19,359,287,377"/>
<area shape="rect" id="node2_40" href="javascript:void(0);" title="BaseHTTPServer.BaseHTTPRequestHandler.monthname" alt="" coords="19,377,287,396"/>
<area shape="rect" id="node2_41" href="javascript:void(0);" title="BaseHTTPServer.BaseHTTPRequestHandler.protocol_version" alt="" coords="19,396,287,415"/>
<area shape="rect" id="node2_42" href="javascript:void(0);" title="BaseHTTPServer.BaseHTTPRequestHandler.MessageClass" alt="" coords="19,415,287,433"/>
<area shape="rect" id="node2_43" href="javascript:void(0);" title="BaseHTTPServer.BaseHTTPRequestHandler.responses" alt="" coords="19,433,287,452"/>
<area shape="rect" id="node2_44" href="javascript:void(0);" title="Parse a request (internal)." alt="" coords="19,455,287,473"/>
<area shape="rect" id="node2_45" href="javascript:void(0);" title="Handle a single HTTP request." alt="" coords="19,473,287,492"/>
<area shape="rect" id="node2_46" href="javascript:void(0);" title="Handle multiple requests if necessary." alt="" coords="19,492,287,511"/>
<area shape="rect" id="node2_47" href="javascript:void(0);" title="Send and log an error reply." alt="" coords="19,511,287,529"/>
<area shape="rect" id="node2_48" href="javascript:void(0);" title="Send the response header and log the response code." alt="" coords="19,529,287,548"/>
<area shape="rect" id="node2_49" href="javascript:void(0);" title="Send a MIME header." alt="" coords="19,548,287,567"/>
<area shape="rect" id="node2_50" href="javascript:void(0);" title="Send the blank line ending the MIME headers." alt="" coords="19,567,287,585"/>
<area shape="rect" id="node2_51" href="javascript:void(0);" title="Log an accepted request." alt="" coords="19,585,287,604"/>
<area shape="rect" id="node2_52" href="javascript:void(0);" title="Log an error." alt="" coords="19,604,287,623"/>
<area shape="rect" id="node2_53" href="javascript:void(0);" title="Return the server software version string." alt="" coords="19,623,287,641"/>
<area shape="rect" id="node2_54" href="javascript:void(0);" title="Return the current date and time formatted for a message header." alt="" coords="19,641,287,660"/>
<area shape="rect" id="node2_55" href="javascript:void(0);" title="Return the current time formatted for logging." alt="" coords="19,660,287,679"/>
<area shape="rect" id="node2_56" href="javascript:void(0);" title="Return the client address formatted for logging." alt="" coords="19,679,287,697"/>
<area shape="rect" id="node2" href="javascript:void(0);" title="HTTP request handler base class." alt="" coords="7,243,299,704"/>
<area shape="rect" id="node3_57" href="javascript:void(0);" title="SocketServer.BaseRequestHandler.__init__" alt="" coords="18,36,289,55"/>
<area shape="rect" id="node3" href="javascript:void(0);" title="Base class for request handler classes." alt="" coords="5,5,300,61"/>
<area shape="rect" id="node4_58" href="javascript:void(0);" title="SocketServer.StreamRequestHandler.rbufsize" alt="" coords="43,103,265,121"/>
<area shape="rect" id="node4_59" href="javascript:void(0);" title="SocketServer.StreamRequestHandler.wbufsize" alt="" coords="43,121,265,140"/>
<area shape="rect" id="node4_60" href="javascript:void(0);" title="SocketServer.StreamRequestHandler.timeout" alt="" coords="43,140,265,159"/>
<area shape="rect" id="node4_61" href="javascript:void(0);" title="SocketServer.StreamRequestHandler.disable_nagle_algorithm" alt="" coords="43,159,265,177"/>
<area shape="rect" id="node4_62" href="javascript:void(0);" title="SocketServer.StreamRequestHandler.setup" alt="" coords="43,180,265,199"/>
<area shape="rect" id="node4_63" href="javascript:void(0);" title="SocketServer.StreamRequestHandler.finish" alt="" coords="43,199,265,217"/>
<area shape="rect" id="node4" href="javascript:void(0);" title="Define self.rfile and self.wfile for stream sockets." alt="" coords="31,80,277,224"/>
</map>
<img src="uml_class_diagram_for_oauth2cl_56.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_56" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<pre class="literalblock">
A handler for OAuth 2.0 redirects back to localhost.
Waits for a single request and parses the query parameters
into the servers 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 width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="oauth2client.tools.ClientRedirectHandler-class.html#do_GET" class="summary-sig-name">do_GET</a>(<span class="summary-sig-arg">self</span>)</span><br />
Handle a GET request.</td>
<td align="right" valign="top">
<span class="codelink"><a href="oauth2client.tools-pysrc.html#ClientRedirectHandler.do_GET">source&nbsp;code</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">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="oauth2client.tools.ClientRedirectHandler-class.html#log_message" class="summary-sig-name">log_message</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">format</span>,
<span class="summary-sig-arg">*args</span>)</span><br />
Do not log messages to stdout while running as command line program.</td>
<td align="right" valign="top">
<span class="codelink"><a href="oauth2client.tools-pysrc.html#ClientRedirectHandler.log_message">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>BaseHTTPServer.BaseHTTPRequestHandler</code></b>:
<code>address_string</code>,
<code>date_time_string</code>,
<code>end_headers</code>,
<code>handle</code>,
<code>handle_one_request</code>,
<code>log_date_time_string</code>,
<code>log_error</code>,
<code>log_request</code>,
<code>parse_request</code>,
<code>send_error</code>,
<code>send_header</code>,
<code>send_response</code>,
<code>version_string</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.StreamRequestHandler</code></b>:
<code>finish</code>,
<code>setup</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.BaseRequestHandler</code></b>:
<code>__init__</code>
</p>
</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 colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>BaseHTTPServer.BaseHTTPRequestHandler</code></b>:
<code>MessageClass</code>,
<code>default_request_version</code>,
<code>error_content_type</code>,
<code>error_message_format</code>,
<code>monthname</code>,
<code>protocol_version</code>,
<code>responses</code>,
<code>server_version</code>,
<code>sys_version</code>,
<code>weekdayname</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.StreamRequestHandler</code></b>:
<code>disable_nagle_algorithm</code>,
<code>rbufsize</code>,
<code>timeout</code>,
<code>wbufsize</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" 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">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="do_GET"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">do_GET</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="oauth2client.tools-pysrc.html#ClientRedirectHandler.do_GET">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
Handle a GET request.
Parses the query parameters and prints a message
if the flow has completed. Note that we can't detect
if an error occurred.
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="log_message"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">log_message</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">format</span>,
<span class="sig-arg">*args</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="oauth2client.tools-pysrc.html#ClientRedirectHandler.log_message">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
Do not log messages to stdout while running as command line program.
</pre>
<dl class="fields">
<dt>Overrides:
BaseHTTPServer.BaseHTTPRequestHandler.log_message
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="oauth2client-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- 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 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>