twisted.web.woven.guard.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.woven.guard</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.woven.html">Package woven</a> ::
Module guard
</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.woven.guard.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.web.woven.guard</h2>
Resource protection for Woven. If you wish to use twisted.cred to
protect your Woven application, you are probably most interested in <a
href="twisted.web.woven.guard.UsernamePasswordWrapper.html"
class="link"><code>UsernamePasswordWrapper</code></a>.
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.guard.GuardSession.html"><code>GuardSession</code></a></b></td>
<td>A user's session with a system.</td></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.guard.PerspectiveWrapper.html"><code>PerspectiveWrapper</code></a></b></td>
<td>DEPRECATED.</td></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.guard.SessionWrapper.html"><code>SessionWrapper</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.guard.UsernamePasswordWrapper.html"><code>UsernamePasswordWrapper</code></a></b></td>
<td>I bring a <code>twisted.cred</code> Portal to the web.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_sessionCookie"></a><span class="summary-sig"><span class="summary-sig-name">_sessionCookie</span>()</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_setSession"></a><span class="summary-sig"><span class="summary-sig-name">_setSession</span>(<span class=summary-sig-arg>wrap</span>,
<span class=summary-sig-arg>req</span>,
<span class=summary-sig-arg>cook</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getResource"></a><span class="summary-sig"><span class="summary-sig-name">getResource</span>(<span class=summary-sig-arg>resource</span>,
<span class=summary-sig-arg>path</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="redirectToSession"></a><span class="summary-sig"><span class="summary-sig-name">redirectToSession</span>(<span class=summary-sig-arg>request</span>,
<span class=summary-sig-arg>garbage</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="urlToChild"></a><span class="summary-sig"><span class="summary-sig-name">urlToChild</span>(<span class=summary-sig-arg>request</span>,
<span class="summary-sig-vararg">*ar</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.web.woven.guard.html#__version__"><code>__version__</code></a></b> = <span title="'1.34'"><code><span class="variable-quote">'</span>1.34<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.web.woven.guard.html#DESTROY_PERSPECTIVE"><code>DESTROY_PERSPECTIVE</code></a></b> = <span title="'perspective-destroy'"><code><span class="variable-quote">'</span>perspective-destroy<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.web.woven.guard.html#INIT_PERSPECTIVE"><code>INIT_PERSPECTIVE</code></a></b> = <span title="'perspective-init'"><code><span class="variable-quote">'</span>perspective-init<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.web.woven.guard.html#INIT_SESSION"><code>INIT_SESSION</code></a></b> = <span title="'session-init'"><code><span class="variable-quote">'</span>session-init<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="twisted.python.formmethod.MethodSignature.html"
class="link"><code>MethodSignature</code></a></font></td>
<td><b><a href="twisted.web.woven.guard.html#loginSignature"><code>loginSignature</code></a></b> = <span title="<twisted.python.formmethod.MethodSignature instance at 0x8c8f49c>"><code><twisted.python.formmethod.MethodSignat<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="twisted.python.formmethod.MethodSignature.html"
class="link"><code>MethodSignature</code></a></font></td>
<td><b><a href="twisted.web.woven.guard.html#newLoginSignature"><code>newLoginSignature</code></a></b> = <span title="<twisted.python.formmethod.MethodSignature instance at 0x88fa35c>"><code><twisted.python.formmethod.MethodSig<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.web.woven.guard.html#SESSION_KEY"><code>SESSION_KEY</code></a></b> = <span title="'__session_key__'"><code><span class="variable-quote">'</span>__session_key__<span class="variable-quote">'</span> </code>
</span></td></tr>
</table><br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__version__"></a>
<h3>__version__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'1.34'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>1.34<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="DESTROY_PERSPECTIVE"></a>
<h3>DESTROY_PERSPECTIVE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'perspective-destroy'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>perspective-destroy<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="INIT_PERSPECTIVE"></a>
<h3>INIT_PERSPECTIVE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'perspective-init'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>perspective-init<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="INIT_SESSION"></a>
<h3>INIT_SESSION</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'session-init'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>session-init<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="loginSignature"></a>
<h3>loginSignature</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a href="twisted.python.formmethod.MethodSignature.html"
class="link"><code>MethodSignature</code></a>
</dd>
<span title="<twisted.python.formmethod.MethodSignature instance at 0x8c8f49c>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<twisted.python.formmethod.MethodSignature instance at 0x8c8f49c> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="newLoginSignature"></a>
<h3>newLoginSignature</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a href="twisted.python.formmethod.MethodSignature.html"
class="link"><code>MethodSignature</code></a>
</dd>
<span title="<twisted.python.formmethod.MethodSignature instance at 0x88fa35c>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<twisted.python.formmethod.MethodSignature instance at 0x88fa35c> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="SESSION_KEY"></a>
<h3>SESSION_KEY</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'__session_key__'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>__session_key__<span class="variable-quote">'</span> </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:53 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>