twisted.cred.portal.Portal.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.cred.portal.Portal</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.cred.html">Package cred</a> ::
<a href="twisted.cred.portal.html">Module portal</a> ::
Class Portal
</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.cred.portal.Portal.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Portal</h2>
<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.cred.portal.Portal.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>realm</span>,
<span class=summary-sig-arg>checkers</span>)</span></code>
<br />
Create a Portal to a <a href="twisted.cred.portal.IRealm.html"
class="link"><code>IRealm</code></a>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.portal.Portal.html#listCredentialsInterfaces" class="summary-sig-name"><code>listCredentialsInterfaces</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return list of credentials interfaces that can be used to login.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.portal.Portal.html#login" class="summary-sig-name"><code>login</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>credentials</span>,
<span class=summary-sig-arg>mind</span>,
<span class="summary-sig-vararg">*interfaces</span>)</span></code>
<br />
Return a deferred which will fire a tuple of (interface, avatarAspect,
logout).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="registerChecker"></a><span class="summary-sig"><span class="summary-sig-name">registerChecker</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>checker</span>,
<span class="summary-sig-vararg">*credentialInterfaces</span>)</span></code>
</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>realm</span>,
<span class=sig-arg>checkers</span>=<span class=sig-default>()</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Create a Portal to a <a href="twisted.cred.portal.IRealm.html"
class="link"><code>IRealm</code></a>.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="listCredentialsInterfaces"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listCredentialsInterfaces</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return list of credentials interfaces that can be used to login.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="login"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">login</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>credentials</span>,
<span class=sig-arg>mind</span>,
<span class="sig-vararg">*interfaces</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>credentials</b></code> -
an implementor of twisted.cred.credentials.ICredentials
<dd><code><b>mind</b></code> -
an object which implements a client-side interface for your
particular realm. In many cases, this may be None, so if the word
'mind' confuses you, just ignore it.
<dd><code><b>interfaces</b></code> -
list of interfaces for the perspective that the mind wishes to
attach to. Usually, this will be only one interface, for example
IMailAccount. For highly dynamic protocols, however, this may be
a list like (IMailAccount, IUserChooser, IServiceInfo). To
expand: if we are speaking to the system over IMAP, any
information that will be relayed to the user MUST be returned as
an IMailAccount implementor; IMAP clients would not be able to
understand anything else. Any information about unusual status
would have to be relayed as a single mail message in an
otherwise-empty mailbox. However, in a web-based mail system, or
a PB-based client, the ``mind'' object inside the web server
(implemented with a dynamic page-viewing mechanism such as woven)
or on the user's client program may be intelligent enough to
respond to several ``server''-side interfaces.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred which will fire a tuple of (interface,
avatarAspect, logout). The interface will be one of the
interfaces passed in the 'interfaces' argument. The
'avatarAspect' will implement that interface. The 'logout' object
is a callable which will detach the mind from the avatar. It must
be called when the user has conceptually disconnected from the
service. Although in some cases this will not be in
connectionLost (such as in a web-based session), it will always
be at the end of a user's interactive session.
</dd>
</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:08:55 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>