class twisted.protocols.ftp.BaseFTPRealm: (source)
Known subclasses: twisted.protocols.ftp.FTPRealm, twisted.protocols.ftp.SystemFTPRealm
Implements interfaces: twisted.cred.portal.IRealm
Base class for simple FTP realms which provides an easy hook for specifying the home directory for each user.
| Method | __init__ | Undocumented |
| Instance Variable | anonymousRoot | Undocumented |
| Method | getHomeDirectory | Return a FilePath representing the home directory of the given avatar. Override this in a subclass. |
| Method | requestAvatar | Return avatar which provides one of the given interfaces. |
Undocumented
Return avatar which provides one of the given interfaces.
| Parameters | avatarId | a string that identifies an avatar, as returned by ICredentialsChecker.requestAvatarId (via a Deferred). Alternatively, it may be twisted.cred.checkers.ANONYMOUS. |
| mind | usually None. See the description of mind in Portal.login. | |
| interfaces | the 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. | |