Package twisted :: Package coil :: Package plugins :: Module ftp :: Class FTPConfigurator
[frames | no frames]

Class FTPConfigurator

      Configurator --+
                     |
Collection --+       |
             |       |
   Constrained --+   |
                 |   |
            Locked --+
                     |
                    FTPConfigurator


Method Summary
  __init__(self, instance)
Initialize this configurator with the instance it will be configuring.
  config_root(self, root)
    Inherited from Configurator
  configDispensers(self)
Return list of dispensers.
  configure(self, dict)
Set a list of configuration variables.
  getConfiguration(self)
Return a mapping of key/value tuples describing my configuration.
  getInstance(self)
Return the instance being configured.
  getType(self, name)
Get the type of a configuration variable.
    Inherited from Locked
  entityConstraint(self, entity)
A method that determines whether an entity may be added to me.
  lock(self)
    Inherited from Constrained
  nameConstraint(self, name)
A method that determines whether an entity may be added to me with a given name.
  putEntity(self, name, entity)
Store an entity if it meets both constraints.
  reallyPutEntity(self, name, entity)
    Inherited from Collection
  delEntity(self, name)
Remove a static reference for 'name'.
  getDynamicEntity(self, name, request)
Subclass this to generate an entity on demand.
  getEntity(self, name, request)
Retrieve an entity from me.
  getStaticEntity(self, name)
Get an entity that was added to me using putEntity.
  listDynamicEntities(self, request)
A list of all name, entity that I can generate on demand.
  listDynamicNames(self)
Retrieve a list of the names of entities that I store references to.
  listEntities(self, request)
Retrieve a list of all name, entity pairs I contain.
  listNames(self, request)
Retrieve a list of all names for entities that I contain.
  listStaticEntities(self)
Retrieve a list of all name, entity pairs that I store references to.
  listStaticNames(self)
Retrieve a list of the names of entities that I store references to.
  removeEntity(self, name, request)
Remove an entity for 'name', based on the content of 'request'.
  storeEntity(self, name, request)
Store an entity for 'name', based on the content of 'request'.

Class Variable Summary
str configName = 'FTP Server'
dict configTypes = {'otp': ['boolean', 'OTP', 'Use One Time P...
class configurableClass = twisted.protocols.ftp.FTPFactory
    Inherited from Locked
int locked = 0                                                                     

Method Details

__init__(self, instance)
(Constructor)

Initialize this configurator with the instance it will be configuring.
Overrides:
twisted.coil.coil.Configurator.__init__ (inherited documentation)

Class Variable Details

configName

Type:
str
Value:
'FTP Server'                                                           

configTypes

Type:
dict
Value:
{'anonymous': ['boolean', 'Allow Anonymous Logins', ''],
 'otp': ['boolean', 'OTP', 'Use One Time Passwords.'],
 'root': [<type 'str'>, 'Root', 'The root folder for the FTP server.']\
,
 'thirdparty': ['boolean',
                'Allow 3rd-party Transfers',
                'Allow A to forward data to B. May be a security risk.\
'],
...                                                                    

Generated by Epydoc 2.0 on Sat Sep 13 04:21:06 2003 http://epydoc.sf.net