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

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI05-delivery/trunk/doc/epydoc/private/delivery.server-module.html@1187
Revision 1187, 6.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</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        Module&nbsp;server
28      </b></font></br>
29    </td>
30    <td><table cellpadding="0" cellspacing="0">
31      <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/delivery.server-module.html">hide&nbsp;private</a>]</font></td></tr>
32      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="delivery.server-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
33    </table></td>
34</tr></table>
35
36<!-- =========== START OF MODULE DESCRIPTION =========== -->
37<h2 class="module">Module delivery.server</h2>
38
39Interface to the BBftp server.
40<hr/>
41<p><b>Author:</b> Stephen Pascoe</p>
42
43<p><b>Copyright:</b> Copyright (C) 2006 CCLRC & NERC
44</p>
45
46<p><b>License:</b> This software may be distributed under the terms of the Q Public Licence, version 1.0 or later.
47</p>
48
49
50<!-- =========== START OF CLASSES =========== -->
51<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
52<tr bgcolor="#70b0f0" class="summary">
53  <th colspan="2">Classes</th></tr>
54<tr><td width="15%">
55  <b><a href="delivery.server.AuthHandler-class.html"><code>AuthHandler</code></a></b></td>
56  <td>Abstract base class for implementing authentication.</td></tr>
57<tr><td width="15%">
58  <b><a href="delivery.server.AuthzHandler-class.html"><code>AuthzHandler</code></a></b></td>
59  <td>Abstract base class for implementing authorisation.</td></tr>
60<tr><td width="15%">
61  <b><a href="delivery.server.BasicClientAuthHandler-class.html"><code>BasicClientAuthHandler</code></a></b></td>
62  <td>This class makes communicating with the stand alone bbftp client slightly easier.</td></tr>
63<tr><td width="15%">
64  <b><a href="delivery.server.LiberalAuthzHandler-class.html"><code>LiberalAuthzHandler</code></a></b></td>
65  <td>Allow everything.</td></tr>
66</table><br />
67
68
69<!-- =========== START OF EXCEPTIONS =========== -->
70<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
71<tr bgcolor="#70b0f0" class="summary">
72  <th colspan="2">Exceptions</th></tr>
73<tr><td width="15%">
74  <b><a href="delivery.server.AuthenticationFailure-class.html"><code>AuthenticationFailure</code></a></b></td>
75  <td>Signals authentication failed.</td></tr>
76<tr><td width="15%">
77  <b><a href="delivery.server.AuthorisationFailure-class.html"><code>AuthorisationFailure</code></a></b></td>
78  <td>Signals authorisation failed.</td></tr>
79</table><br />
80
81
82<!-- =========== START OF FUNCTION SUMMARY =========== -->
83<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
84<tr bgcolor="#70b0f0" class="summary">
85  <th colspan="2">Function Summary</th></tr>
86<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
87  <td><code><span class="summary-sig"><a href="delivery.server-module.html#start" class="summary-sig-name"><code>start</code></a>(<span class=summary-sig-arg>authHandler</span>,
88          <span class=summary-sig-arg>args</span>)</span></code>
89<br />
90Start the bbftp server.</td></tr>
91</table><br />
92
93
94<!-- =========== START OF FUNCTION DETAILS =========== -->
95<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
96<tr bgcolor="#70b0f0" class="details">
97  <th colspan="2">Function Details</th></tr>
98</table>
99
100<a name="start"></a>
101<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
102  <h3><span class="sig"><span class="sig-name">start</span>(<span class=sig-arg>authHandler</span>,
103          <span class=sig-arg>args</span>)</span>
104  </h3>
105Start the bbftp server.
106
107The server performs a fork() during initialisation, the child process remains in
108the server's main loop and the parent returns from this function.  The server process
109calls authHandler.authorise() on each connection to do authentication/authorisation.
110  <dl><dt></dt><dd>
111    <dl><dt><b>Parameters:</b></dt>
112      <dd><code><b>authHandler</b></code> -
113 an instance of AuthHandler.
114      <dd><code><b>args</b></code> -
115 a list of command line arguments.
116      </dd>
117    </dl>
118    <dl><dt><b>Returns:</b></dt>
119      <dd>
120the PID of the server process.      </dd>
121    </dl>
122<p><b>Note:</b> because the server process forks, authHandler will not see any changes to the python
123    interpreter following the call to start().
124</p>
125
126  </dd></dl>
127</td></tr></table>
128<br />
129
130
131<!-- =========== START OF NAVBAR =========== -->
132<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
133  <tr valign="center">
134    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="delivery-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
135    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
136    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
137    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
138    <th class="navbar" width="100%"></th>
139  </tr>
140</table>
141
142<table border="0" cellpadding="0" cellspacing="0" width="100%">
143  <tr>
144    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Thu Jun 15 10:05:48 2006</font></td>
145    <td align="right"><a href="http://epydoc.sourceforge.net"
146                      ><font size="-2">http://epydoc.sf.net</font></a></td>
147  </tr>
148</table>
149</body>
150</html>
Note: See TracBrowser for help on using the repository browser.