source: TI05-delivery/trunk/doc/epydoc/public/delivery.server.AuthzHandler-class.html @ 1284

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

Documentation update

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