t.c.p.IRealm(Interface) : interface documentation

Part of twisted.cred.portal View Source View In Hierarchy

Known implementations: twisted.conch.manhole_tap._StupidRealm, twisted.conch.unix.UnixSSHRealm, twisted.mail.maildir.MaildirDirdbmDomain, twisted.manhole.service.Realm, twisted.protocols.ftp.FTPRealm, twisted.web.woven.simpleguard.MarkingRealm, twisted.words.service.WordsRealm

The realm connects application-specific objects to the authentication system.
Method requestAvatar Return avatar which provides one of the given interfaces.
def requestAvatar(avatarId, mind, *interfaces): (source)
Return avatar which provides one of the given interfaces.
ParametersavatarIda 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.
Returnsa 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.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.