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

Classes

``

UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn
  RoleUserManager(UserKit.UserManager.UserManager, UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn)
UserKit.UserManager.UserManager
  RoleUserManager(UserKit.UserManager.UserManager, UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn)

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

Method resolution order:
  RoleUserManager
  UserKit.UserManager.UserManager
  UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn

Methods defined here:

__init__(self, userClass=None)

Methods inherited from UserKit.UserManager.UserManager:

activeUserTimeout(self)

activeUsers(self)
  `Returns a list of all active users.`

addUser(self, user)

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()`

inactiveUsers(self)

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)

setUserClass(self, userClass)
  `Sets the userClass, which cannot be None and must inherit from User. See also: userClass().`

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.`

userForExternalId(self, externalId, default=<class MiscUtils.NoDefault at 0x832da1c>)
  `Returns the user with the given external id, pulling that user record into memory if needed.`

userForName(self, name, default=<class MiscUtils.NoDefault at 0x832da1c>)
  `Returns the user with the given name, pulling that user record into memory if needed.`

userForSerialNum(self, serialNum, default=<class MiscUtils.NoDefault at 0x832da1c>)
  `Returns the user with the given serialNum, pulling that user record into memory if needed.`

users(self)
  `Returns a list of all users (regardless of login status).`

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 at 0x832da1c>)

roles(self)