twisted.web.guard.AuthForm.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!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>twisted.web.guard.AuthForm</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.web.html">Package web</a> ::
<a href="twisted.web.guard.html">Module guard</a> ::
Class AuthForm
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.web.guard.AuthForm.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class AuthForm</h2>
<pre class="base-tree">
<a href="twisted.web.widgets.Widget.html"><code>Widget</code></a> --+
|
<a href="twisted.web.widgets.Form.html"><code>Form</code></a> --+
|
<b>AuthForm</b>
</pre><br />
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.guard.AuthForm.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reqauth</span>,
<span class=summary-sig-arg>sessionIdentity</span>,
<span class=summary-sig-arg>sessionPerspective</span>)</span></code>
<br />
Initialize, specifying various options.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="didntGetIdentity"></a><span class="summary-sig"><span class="summary-sig-name">didntGetIdentity</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>unauth</span>,
<span class=summary-sig-arg>request</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="didntGetPerspective"></a><span class="summary-sig"><span class="summary-sig-name">didntGetPerspective</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>error</span>,
<span class=summary-sig-arg>request</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="gotIdentity"></a><span class="summary-sig"><span class="summary-sig-name">gotIdentity</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>ident</span>,
<span class=summary-sig-arg>password</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>perspectiveName</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="gotPerspective"></a><span class="summary-sig"><span class="summary-sig-name">gotPerspective</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>perspective</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>ident</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="passwordIsOk"></a><span class="summary-sig"><span class="summary-sig-name">passwordIsOk</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>msg</span>,
<span class=summary-sig-arg>ident</span>,
<span class=summary-sig-arg>password</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>perspectiveName</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.guard.AuthForm.html#process" class="summary-sig-name"><code>process</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>write</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>submit</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>password</span>,
<span class=summary-sig-arg>perspective</span>)</span></code>
<br />
Process the form results.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Form</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Form.html#_displayFormat" class="summary-sig-name"><code>_displayFormat</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>form</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Form.html#_displayProcess" class="summary-sig-name"><code>_displayProcess</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>form</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Form.html#_doProcess" class="summary-sig-name"><code>_doProcess</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>form</span>,
<span class=summary-sig-arg>write</span>,
<span class=summary-sig-arg>request</span>)</span></code>
<br />
(internal) Prepare arguments for self.process.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Form.html#display" class="summary-sig-name"><code>display</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>)</span></code>
<br />
Display the form.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Form.html#format" class="summary-sig-name"><code>format</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>form</span>,
<span class=summary-sig-arg>write</span>,
<span class=summary-sig-arg>request</span>)</span></code>
<br />
I display an HTML FORM according to the result of
self.getFormFields.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Form.html#formatError" class="summary-sig-name"><code>formatError</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>error</span>)</span></code>
<br />
Format an error message.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Form.html#getFormFields" class="summary-sig-name"><code>getFormFields</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>fieldSet</span>)</span></code>
<br />
I return a list of lists describing this form, or a Deferred.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Form.html#getFormID" class="summary-sig-name"><code>getFormID</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Override me: I disambiguate between multiple forms of the same
type.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Form.html#shouldProcess" class="summary-sig-name"><code>shouldProcess</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Form.html#tryAgain" class="summary-sig-name"><code>tryAgain</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>err</span>,
<span class=summary-sig-arg>req</span>)</span></code>
<br />
Utility method for re-drawing the form with an error message.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Widget</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.web.widgets.Widget.html#getTitle" class="summary-sig-name"><code>getTitle</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>request</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.web.guard.AuthForm.html#formAcceptExtraArgs"><code>formAcceptExtraArgs</code></a></b> = <span title="1">1 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.web.guard.AuthForm.html#formFields"><code>formFields</code></a></b> = <span title="[['string', 'Identity', 'username', ''], ['password', 'Password', 'password', ''], ['string', 'Perspective', 'perspective', '']]"><code>[['string', 'Identity', 'username', ''], ['<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Form</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.web.widgets.Form.html#actionURI"><code>actionURI</code></a></b> = <span title="''"><code><span class="variable-quote">'</span><span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.web.widgets.Form.html#formGen"><code>formGen</code></a></b> = <span title="{'checkbox': <function htmlFor_checkbox at 0x8542e54>, 'string': <function htmlFor_string at 0x8542d3c>, 'multimenu': <function htmlFor_multimenu at 0x8542e1c>, 'int': <function htmlFor_string at 0x8542d3c>, 'menu': <function htmlFor_menu at 0x8542de4>, 'float': <function htmlFor_string at 0x8542d3c>, 'checkgroup': <function htmlFor_checkgroup at 0x8542e8c>, 'radio': <function htmlFor_radio at 0x8542ec4>, 'file': <function htmlFor_file at 0x8542d04>, 'text': <function htmlFor_text at 0x8542dac>, 'hidden': <function htmlFor_hidden at 0x8542ccc>, 'password': <function htmlFor_password at 0x85..."><code>{'checkbox': <function htmlFor_checkbox at 0x8<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.web.widgets.Form.html#formParse"><code>formParse</code></a></b> = <span title="{'int': <type 'int'>, 'float': <type 'float'>}"><code>{'int': <type 'int'>, 'float': <type 'float'<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.web.widgets.Form.html#submitNames"><code>submitNames</code></a></b> = <span title="['Submit']"><code>['Submit'] </code>
</span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Widget</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.web.widgets.Widget.html#title"><code>title</code></a></b> = <span title="None">None </span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>reqauth</span>,
<span class=sig-arg>sessionIdentity</span>=<span class=sig-default>None</span>,
<span class=sig-arg>sessionPerspective</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Initialize, specifying various options.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>reqauth</b></code> -
a web.resource.Resource instance, indicating which resource a
user will be logging into with this form; this must specify a
serviceName attribute which indicates the name of the service
from which perspectives will be requested.
<dd><code><b>sessionIdentity</b></code> -
if specified, the name of the attribute on the user's session
to set for the identity they get from logging in to this
form.
<dd><code><b>sessionPerspective</b></code> -
if specified, the name of the attribute on the user's session
to set for the perspective they get from logging in to this
form.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="process"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">process</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>write</span>,
<span class=sig-arg>request</span>,
<span class=sig-arg>submit</span>,
<span class=sig-arg>username</span>,
<span class=sig-arg>password</span>,
<span class=sig-arg>perspective</span>)</span>
</h3>
Process the form results.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.web.widgets.Form.html#process"><code>twisted.web.widgets.Form.process</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="formAcceptExtraArgs"></a>
<h3>formAcceptExtraArgs</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="1"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
1 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="formFields"></a>
<h3>formFields</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[['string', 'Identity', 'username', ''], ['password', 'Password', 'password', ''], ['string', 'Perspective', 'perspective', '']]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[['string', 'Identity', 'username', ''],
['password', 'Password', 'password', ''],
['string', 'Perspective', 'perspective', '']] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:43 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>