twisted.cred.authorizer.DefaultAuthorizer.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.authorizer.DefaultAuthorizer</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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&nbsp;twisted</a> ::
        <a href="twisted.cred.html">Package&nbsp;cred</a> ::
        <a href="twisted.cred.authorizer.html">Module&nbsp;authorizer</a> ::
        Class&nbsp;DefaultAuthorizer
      </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>&nbsp;|&nbsp;<a href="twisted.cred.authorizer.DefaultAuthorizer.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class DefaultAuthorizer</h2>

<pre class="base-tree">
<a href="twisted.python.reflect.Accessor.html"><code>Accessor</code></a> --+    
           |    
  <a href="twisted.cred.authorizer.Authorizer.html"><code>Authorizer</code></a> --+
               |
              <b>DefaultAuthorizer</b>
</pre><br />

<dl><dt><b>Known Subclasses:</b></dt>
<dd>
    <a href="twisted.conch.authorizer.OpenSSHConchAuthorizer.html"><code>OpenSSHConchAuthorizer</code></a></dd></dl>

<hr/>

<p>I am an authorizer which requires no external dependencies.</p>
I am implemented as a hash of Identities.
<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">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.cred.authorizer.DefaultAuthorizer.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>serviceCollection</span>)</span></code>
<br />
Create a hash of identities.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.cred.authorizer.DefaultAuthorizer.html#addIdentity" class="summary-sig-name"><code>addIdentity</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>identity</span>)</span></code>
<br />
Add an identity to me.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.cred.authorizer.DefaultAuthorizer.html#getIdentityRequest" class="summary-sig-name"><code>getIdentityRequest</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>name</span>)</span></code>
<br />
Get a Deferred callback registration object.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="removeIdentity"></a><span class="summary-sig"><span class="summary-sig-name">removeIdentity</span>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>identityName</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Authorizer</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.cred.authorizer.Authorizer.html#createIdentity" class="summary-sig-name"><code>createIdentity</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>name</span>)</span></code>
<br />
Create an identity of an appropriate type for this Authorizer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.cred.authorizer.Authorizer.html#get_application" class="summary-sig-name"><code>get_application</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.cred.authorizer.Authorizer.html#getServiceNamed" class="summary-sig-name"><code>getServiceNamed</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.cred.authorizer.Authorizer.html#setApplication" class="summary-sig-name"><code>setApplication</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>app</span>)</span></code>
<br />
Set the application for this authorizer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.cred.authorizer.Authorizer.html#setServiceCollection" class="summary-sig-name"><code>setServiceCollection</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>collection</span>)</span></code>
<br />
Set the service collection for this authorizer.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Accessor</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.python.reflect.Accessor.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>k</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.python.reflect.Accessor.html#__getattr__" class="summary-sig-name"><code>__getattr__</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>k</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.python.reflect.Accessor.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>k</span>,
          <span class=summary-sig-arg>v</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.python.reflect.Accessor.html#reallyDel" class="summary-sig-name"><code>reallyDel</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>k</span>)</span></code>
<br />
*actually* del self.k without incurring side-effects.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.python.reflect.Accessor.html#reallySet" class="summary-sig-name"><code>reallySet</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>k</span>,
          <span class=summary-sig-arg>v</span>)</span></code>
<br />
*actually* set self.k to v without incurring side-effects.</td></tr>
</table><br />


<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Instance Variable Summary</th></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Authorizer</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a 
          href="twisted.internet.app._AbstractServiceCollection.html" 
          class="link"><code>_AbstractServiceCollection</code></a></font></td>
<td><b><a href="twisted.cred.authorizer.Authorizer.html#serviceCollection"><code>serviceCollection</code></a></b>: The set of services that are using this authorizer.</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>serviceCollection</span>=<span class=sig-default>None</span>)</span>
    <br /><i>(Constructor)</i>
  </h3>
  Create a hash of identities.
  <dl><dt></dt><dd>
    <dl><dt><b>Overrides:</b></dt>
      <dd><a href="twisted.cred.authorizer.Authorizer.html#__init__"><code>twisted.cred.authorizer.Authorizer.__init__</code></a></dd>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="addIdentity"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">addIdentity</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>identity</span>)</span>
  </h3>
  Add an identity to me.
  <dl><dt></dt><dd>
    <dl><dt><b>Overrides:</b></dt>
      <dd><a href="twisted.cred.authorizer.Authorizer.html#addIdentity"><code>twisted.cred.authorizer.Authorizer.addIdentity</code></a></dd>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="getIdentityRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">getIdentityRequest</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>name</span>)</span>
  </h3>
  <p>Get a Deferred callback registration object.</p>
  I return a <a href="twisted.internet.defer.Deferred.html" 
  class="link"><code>deferred</code></a> which will be called back to 
  when an identity is discovered to be available (or errback for 
  unavailable).
  <dl><dt></dt><dd>
    <dl><dt><b>Overrides:</b></dt>
      <dd><a href="twisted.cred.authorizer.Authorizer.html#getIdentityRequest"><code>twisted.cred.authorizer.Authorizer.getIdentityRequest</code></a></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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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:26 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>