API docs for “services.auth.YamlWordsRealm”

Class s.a.YamlWordsRealm(InMemoryWordsRealm):

Implements interfaces: twisted.cred.checkers.ICredentialsChecker

Undocumented

Method	__init__	Undocumented
Method	userFactory	Undocumented
Method	addUser	Add the given user to this service.
Method	addGroup	Add the given group to this service.
Method	requestAvatarId
Method	save	Undocumented
Method	load	Undocumented
Method	_checkpw	Undocumented
Method	_hashpw	Undocumented

Method	itergroups	Return all groups available on this service.
Method	lookupUser	Undocumented
Method	lookupGroup	Retrieve a group by name.

Method	groupFactory	Undocumented
Method	logoutFactory	Undocumented
Method	requestAvatar	Return avatar which provides one of the given interfaces.
Method	getGroup	Retrieve the group by the given name.
Method	getUser	Retrieve the user by the given name.
Method	createUser	Create a new user with the given name.
Method	createGroup	Create a new group with the given name.

def __init__(self, name, file): (source)

Undocumented

def userFactory(self, name): (source)

Undocumented

def addUser(self, user): (source)

Add the given user to this service.

This is an internal method intented to be overridden by WordsRealm subclasses, not called by external code.

Parameters	user	(type: `IUser` )
Returns	A Deferred which fires with `None` when the user is added, or which fails with `twisted.words.ewords.DuplicateUser` if a user with the same name exists already. (type: `twisted.internet.defer.Deferred` )

def addGroup(self, group): (source)

Add the given group to this service.

Parameters	group	(type: `IGroup` )
Returns	A Deferred which fires with `None` when the group is added, or which fails with `twisted.words.ewords.DuplicateGroup` if a group with the same name exists already. (type: `twisted.internet.defer.Deferred` )

def requestAvatarId(self, creds): (source)

Parameters	credentials	something which implements one of the interfaces in self.credentialInterfaces.
Returns	a Deferred which will fire a string which identifies an avatar, an empty tuple to specify an authenticated anonymous user (provided as checkers.ANONYMOUS) or fire a Failure(UnauthorizedLogin). Alternatively, return the result itself.
See Also	`twisted.cred.credentials`

def _checkpw(self, user, creds): (source)

Undocumented

def _hashpw(self, pw): (source)

Undocumented

def save(self): (source)

Undocumented

def load(self): (source)

Undocumented

API Documentation for OtfBot - the friendly Bot, generated by pydoctor at 2010-01-04 01:40:56.