UserKit.RoleUserManagerToFile | index /usr/local/share/webware/UserKit/RoleUserManagerToFile.py

Classes

``

UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn
  RoleUserManagerToFile(UserKit.UserManagerToFile.UserManagerToFile, UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn)
UserKit.UserManagerToFile.UserManagerToFile(UserKit.UserManager.UserManager)
  RoleUserManagerToFile(UserKit.UserManagerToFile.UserManagerToFile, UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn)

class RoleUserManagerToFile(UserKit.UserManagerToFile.UserManagerToFile, UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn)
`` | `See the base classes for more information.`

Method resolution order:
  RoleUserManagerToFile
  UserKit.UserManagerToFile.UserManagerToFile
  UserKit.UserManager.UserManager
  UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn

Methods defined here:

__init__(self, userClass=None)

Methods inherited from UserKit.UserManagerToFile.UserManagerToFile:

activeUsers(self)

addUser(self, user)

decoder(self)

encoder(self)

inactiveUsers(self)

initNextSerialNum(self)

loadUser(self, serialNum, default=<class MiscUtils.NoDefault>)
  `Loads the user with the given serial number from disk.
  If there is no such user, a KeyError will be raised unless a default value was passed, in which case that value is returned.`

nextSerialNum(self)

scanSerialNums(self)
  `Returns a list of all the serial numbers of users found on disk. Serial numbers are always integers.`

setEncoderDecoder(self, encoder, decoder)

setUserClass(self, userClass)
  `Overridden to mix in UserMixIn to the class that is passed in.`

setUserDir(self, userDir)
  `Sets the directory where user information is stored. You should strongly consider invoking initNextSerialNum() afterwards.`

userDir(self)

userForExternalId(self, externalId, default=<class MiscUtils.NoDefault>)

userForName(self, name, default=<class MiscUtils.NoDefault>)

userForSerialNum(self, serialNum, default=<class MiscUtils.NoDefault>)

users(self)

wasInstalled(self, owner)

Methods inherited from UserKit.UserManager.UserManager:

activeUserTimeout(self)

cachedUserTimeout(self)

clearCache(self)
  `Clears the cache of the manager. Use with extreme caution. If your program maintains a reference to a user object, but the manager loads in a new copy later on, then consistency problems could occur.
  The most popular use of this method is in the regression test suite.`

createUser(self, name, password, userClass=None)
  `Returns a newly created user that is added to the manager. If userClass is not specified, the manager's default user class is instantiated.
  This not imply that the user is logged in.
  This method invokes addUser().
  See also: userClass(), setUserClass()`

login(self, user, password)
  `Returns the user if the login is successful, otherwise returns None.`

loginExternalId(self, externalId, password)

loginName(self, userName, password)

loginSerialNum(self, serialNum, password)

logout(self, user)

modifiedUserTimeout(self)

numActiveUsers(self)
  `Returns the number of active users, e.g., users that are logged in.`

setActiveUserTimeout(self, value)

setCachedUserTimeout(self, value)

setModifiedUserTimeout(self, value)

shutDown(self)
  `Performs any tasks necessary to shut down the user manager. Subclasses may override and must invoke super as their *last* step.`

userClass(self)
  `Returns the userClass, which is used by createUser. The default value is UserKit.User.User.`

Methods inherited from UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn:

addRole(self, role)

clearRoles(self)

delRole(self, name)

hasRole(self, name)

initUserClass(self)
  `Invoked by __init__ to set the default user class to
  RoleUser.`

role(self, name, default=<class MiscUtils.NoDefault>)

roles(self)