source: TI05-delivery/trunk/doc/epydoc/private/delivery.server.AuthzHandler-class.html @ 1187

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI05-delivery/trunk/doc/epydoc/private/delivery.server.AuthzHandler-class.html@1187
Revision 1187, 11.5 KB checked in by spascoe, 13 years ago (diff)

Auto-generated documentation included for the python-server interface.

Some file clean up prior to alpha. Fixed some confusion between authentication
and authorisation in the API.

The embedded client test case is disabled because it doesn't work :-(.

Line 
1<?xml version="1.0" encoding="iso-8859-1"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3          "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6  <title>delivery.server.AuthzHandler</title>
7  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8</head>
9<body bgcolor="white" text="black" link="blue" vlink="#204080"
10      alink="#204080">
11
12<!-- =========== START OF NAVBAR =========== -->
13<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14  <tr valign="center">
15    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="delivery-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
16    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
17    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
18    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
19    <th class="navbar" width="100%"></th>
20  </tr>
21</table>
22<table width="100%" cellpadding="0" cellspacing="0">
23  <tr valign="top">
24    <td width="100%">
25      <font size="-1"><b class="breadcrumbs">
26        <a href="delivery-module.html">Package&nbsp;delivery</a> ::
27        <a href="delivery.server-module.html">Module&nbsp;server</a> ::
28        Class&nbsp;AuthzHandler
29      </b></font></br>
30    </td>
31    <td><table cellpadding="0" cellspacing="0">
32      <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/delivery.server.AuthzHandler-class.html">hide&nbsp;private</a>]</font></td></tr>
33      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="delivery.server.AuthzHandler-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
34    </table></td>
35</tr></table>
36
37<!-- =========== START OF CLASS DESCRIPTION =========== -->
38<h2 class="class">Type AuthzHandler</h2>
39
40<pre class="base-tree">
41<a href="__builtin__.object-class.html"><code>object</code></a> --+
42         |
43        <b>AuthzHandler</b>
44</pre><br />
45
46<dl><dt><b>Known Subclasses:</b></dt>
47<dd>
48    <a href="delivery.server.LiberalAuthzHandler-class.html"><code>LiberalAuthzHandler</code></a></dd></dl>
49
50<hr/>
51
52Abstract base class for implementing authorisation.
53<hr/>
54
55
56<!-- =========== START OF METHOD SUMMARY =========== -->
57<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
58<tr bgcolor="#70b0f0" class="summary">
59  <th colspan="2">Method Summary</th></tr>
60<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
61  <td><code><span class="summary-sig"><a href="delivery.server.AuthzHandler-class.html#authzControl" class="summary-sig-name"><code>authzControl</code></a>(<span class=summary-sig-arg>self</span>,
62          <span class=summary-sig-arg>msgcode</span>,
63          <span class=summary-sig-arg>transferoption</span>,
64          <span class=summary-sig-arg>path</span>)</span></code>
65<br />
66Authorise a control command.</td></tr>
67<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
68  <td><code><span class="summary-sig"><a href="delivery.server.AuthzHandler-class.html#authzRetr" class="summary-sig-name"><code>authzRetr</code></a>(<span class=summary-sig-arg>self</span>,
69          <span class=summary-sig-arg>path</span>)</span></code>
70<br />
71Authorise a retrieve request.</td></tr>
72<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
73  <td><code><span class="summary-sig"><a href="delivery.server.AuthzHandler-class.html#authzStore" class="summary-sig-name"><code>authzStore</code></a>(<span class=summary-sig-arg>self</span>,
74          <span class=summary-sig-arg>path</span>)</span></code>
75<br />
76Authorise a store request.</td></tr>
77<tr bgcolor="#e8f0f8" class="group">
78  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from object</th></tr>
79<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
80  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
81<br />
82x.__init__(...) initializes x; see x.__class__.__doc__ for signature...</td></tr>
83<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
84  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
85<br />
86x.__delattr__('name') <==> del x.name...</td></tr>
87<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
88  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
89<br />
90x.__getattribute__('name') <==> x.name...</td></tr>
91<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
92  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
93<br />
94x.__hash__() <==> hash(x)...</td></tr>
95<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
96  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
97          <span class=summary-sig-arg>S</span>,
98          <span class="summary-sig-vararg">...</span>)</span></code>
99<br />
100T.__new__(S, ...) -> a new object with type S, a subtype of T...</td></tr>
101<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
102  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
103<br />
104helper for pickle...</td></tr>
105<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
106  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
107<br />
108helper for pickle...</td></tr>
109<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
110  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
111<br />
112x.__repr__() <==> repr(x)...</td></tr>
113<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
114  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
115<br />
116x.__setattr__('name', value) <==> x.name = value...</td></tr>
117<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
118  <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
119<br />
120x.__str__() <==> str(x)...</td></tr>
121</table><br />
122
123
124<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
125<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
126<tr bgcolor="#70b0f0" class="summary">
127  <th colspan="2">Instance Variable Summary</th></tr>
128<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
129<td><b><a href="delivery.server.AuthzHandler-class.html#username:"><code>username:</code></a></b>: the client's username.</td></tr>
130</table><br />
131
132
133<!-- =========== START OF METHOD DETAILS =========== -->
134<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
135<tr bgcolor="#70b0f0" class="details">
136  <th colspan="2">Method Details</th></tr>
137</table>
138
139<a name="authzControl"></a>
140<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
141  <h3><span class="sig"><span class="sig-name">authzControl</span>(<span class=sig-arg>self</span>,
142          <span class=sig-arg>msgcode</span>,
143          <span class=sig-arg>transferoption</span>,
144          <span class=sig-arg>path</span>)</span>
145  </h3>
146Authorise a control command.
147  <dl><dt></dt><dd>
148    <dl><dt><b>Parameters:</b></dt>
149      <dd><code><b>msgcode</b></code> -
150 the command type.
151      <dd><code><b>transferoption</b></code> -
152 extra options specified in the command.
153      <dd><code><b>path</b></code> -
154 the file or directory to which the command applies.
155      </dd>
156    </dl>
157    <dl><dt><b>Returns:</b></dt>
158      <dd>
159bool for success or failure.      </dd>
160    </dl>
161  </dd></dl>
162</td></tr></table>
163
164<a name="authzRetr"></a>
165<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
166  <h3><span class="sig"><span class="sig-name">authzRetr</span>(<span class=sig-arg>self</span>,
167          <span class=sig-arg>path</span>)</span>
168  </h3>
169Authorise a retrieve request.
170  <dl><dt></dt><dd>
171    <dl><dt><b>Parameters:</b></dt>
172      <dd><code><b>path</b></code> -
173 the file being retrieved.
174      </dd>
175    </dl>
176    <dl><dt><b>Returns:</b></dt>
177      <dd>
178bool for success or failure.      </dd>
179    </dl>
180  </dd></dl>
181</td></tr></table>
182
183<a name="authzStore"></a>
184<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
185  <h3><span class="sig"><span class="sig-name">authzStore</span>(<span class=sig-arg>self</span>,
186          <span class=sig-arg>path</span>)</span>
187  </h3>
188Authorise a store request.
189  <dl><dt></dt><dd>
190    <dl><dt><b>Parameters:</b></dt>
191      <dd><code><b>path</b></code> -
192 the destination file.
193      </dd>
194    </dl>
195    <dl><dt><b>Returns:</b></dt>
196      <dd>
197bool for success or failure.      </dd>
198    </dl>
199  </dd></dl>
200</td></tr></table>
201<br />
202
203
204<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
205<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
206<tr bgcolor="#70b0f0" class="details">
207  <th colspan="2">Instance Variable Details</th></tr>
208</table>
209<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
210<a name="username:"></a>
211<h3>username:</h3>
212the client's username.  This attribute must be set before an instance of AuthzHandler
213    is returned to the bbftp server process by AuthHandler.authenticate().</td></tr></table>
214<br />
215
216
217<!-- =========== START OF NAVBAR =========== -->
218<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
219  <tr valign="center">
220    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="delivery-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
221    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
222    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
223    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
224    <th class="navbar" width="100%"></th>
225  </tr>
226</table>
227
228<table border="0" cellpadding="0" cellspacing="0" width="100%">
229  <tr>
230    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Thu Jun 15 10:05:48 2006</font></td>
231    <td align="right"><a href="http://epydoc.sourceforge.net"
232                      ><font size="-2">http://epydoc.sf.net</font></a></td>
233  </tr>
234</table>
235</body>
236</html>
Note: See TracBrowser for help on using the repository browser.