twisted.protocols.ftp.BaseFTPRealm

class documentation

class BaseFTPRealm: (source)

Known subclasses: twisted.protocols.ftp.FTPRealm, twisted.protocols.ftp.SystemFTPRealm

Implements interfaces: twisted.cred.portal.IRealm

View In Hierarchy

Base class for simple FTP realms which provides an easy hook for specifying the home directory for each user.
Method __init__ Undocumented
Method get​Home​Directory Return a FilePath representing the home directory of the given avatar. Override this in a subclass.
Method request​Avatar Return avatar which provides one of the given interfaces.
Instance Variable anonymous​Root Undocumented
def __init__(self, anonymousRoot): (source)
overridden in twisted.protocols.ftp.FTPRealm

Undocumented

def getHomeDirectory(self, avatarId): (source)
overridden in twisted.protocols.ftp.FTPRealm, twisted.protocols.ftp.SystemFTPRealm
Return a FilePath representing the home directory of the given avatar. Override this in a subclass.
Parameters
avatar​Id:strA user identifier returned from a credentials checker.
Returns
FilePathUndocumented
def requestAvatar(self, avatarId, mind, *interfaces): (source)
from twisted.cred.portal.IRealm
Return avatar which provides one of the given interfaces.
Parameters
avatar​Ida string that identifies an avatar, as returned by ICredentialsChecker.requestAvatarId (via a Deferred). Alternatively, it may be twisted.cred.checkers.ANONYMOUS.
mindusually None. See the description of mind in Portal.login.
*interfacesthe interface(s) the returned avatar should implement, e.g. IMailAccount. See the description of Portal.login.
Returns
a deferred which will fire a tuple of (interface, avatarAspect, logout), or the tuple itself. The interface will be one of the interfaces passed in the 'interfaces' argument. The 'avatarAspect' will implement that interface. The 'logout' object is a callable which will detach the mind from the avatar.
anonymousRoot = (source)
overridden in twisted.protocols.ftp.FTPRealm

Undocumented