RoleUserManager¶
The RoleUserManager class.
- class UserKit.RoleUserManager.RoleUserManager(userClass=None)¶
Bases:
UserManager,RoleUserManagerMixInSee the base classes for more information.
- __init__(userClass=None)¶
- activeUserTimeout()¶
- activeUsers()¶
Return a list of all active users.
- addRole(role)¶
- addUser(user)¶
- cachedUserTimeout()¶
- clearCache()¶
Clear 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.
- clearRoles()¶
- createUser(name, password, userClass=None)¶
Return 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 self.addUser().
See also: userClass(), setUserClass()
- delRole(name)¶
- hasRole(name)¶
- inactiveUsers()¶
- initUserClass()¶
Invoked by __init__ to set the default user class to RoleUser.
- login(user, password)¶
Return the user if login is successful, otherwise return None.
- loginExternalId(externalId, password)¶
- loginName(userName, password)¶
- loginSerialNum(serialNum, password)¶
- logout(user)¶
- modifiedUserTimeout()¶
- numActiveUsers()¶
Return the number of active users (e.g. the logged in users).
- role(name, default=<class 'MiscUtils.NoDefault'>)¶
- roles()¶
- setActiveUserTimeout(value)¶
- setCachedUserTimeout(value)¶
- setModifiedUserTimeout(value)¶
- setUserClass(userClass)¶
Set the userClass, which cannot be None and must inherit from User.
See also: userClass().
- shutDown()¶
Perform any tasks necessary to shut down the user manager.
Subclasses may override and must invoke super as their last step.
- userClass()¶
Return the userClass, which is used by createUser.
The default value is UserKit.User.User.
- userForExternalId(externalId, default=<class 'MiscUtils.NoDefault'>)¶
Return the user with the given external id.
The user record is pulled into memory if needed.
- userForName(name, default=<class 'MiscUtils.NoDefault'>)¶
Return the user with the given name.
The user record is pulled into memory if needed.
- userForSerialNum(serialNum, default=<class 'MiscUtils.NoDefault'>)¶
Return the user with the given serialNum.
The user record is pulled into memory if needed.
- users()¶
Return a list of all users (regardless of login status).