class documentation

class SingletonRealm: (source)

Implements interfaces: twisted.cred.portal.IRealm

View In Hierarchy

Trivial realm implementation which is constructed with an interface and an avatar and returns that avatar when asked for that interface.

Method __init__ Undocumented
Method requestAvatar Return avatar which provides one of the given interfaces.
Instance Variable avatar Undocumented
Instance Variable interface Undocumented
def __init__(self, interface, avatar): (source)

Undocumented

def requestAvatar(self, avatarId, mind, *interfaces): (source)

Return avatar which provides one of the given interfaces.

Parameters
avatarIda 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.

Undocumented

interface = (source)

Undocumented