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

`The RoleUserManagerToMiddleKit class.`

Classes

``

UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn(__builtin__.object)
  RoleUserManagerToMiddleKit(UserKit.UserManagerToMiddleKit.UserManagerToMiddleKit, UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn)
UserKit.UserManagerToMiddleKit.UserManagerToMiddleKit(UserKit.UserManager.UserManager)
  RoleUserManagerToMiddleKit(UserKit.UserManagerToMiddleKit.UserManagerToMiddleKit, UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn)

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

Method resolution order:
  RoleUserManagerToMiddleKit
  UserKit.UserManagerToMiddleKit.UserManagerToMiddleKit
  UserKit.UserManager.UserManager
  UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn
  __builtin__.object

Methods defined here:

__init__(self, userClass=None, store=None, useSQL=None)

initUserClass(self)
  `Invoked by __init__ to set the default user class.
  Overridden to pass on the semantics we inherit from
  RoleUsersManagerMixIn. The user class is a MiddleKit issue for us.`

Methods inherited from UserKit.UserManagerToMiddleKit.UserManagerToMiddleKit:

activeUsers(self)

addUser(self, user)

inactiveUsers(self)

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

setUserClass(self, userClass)
  `Overridden to verify that our userClass is really a MiddleObject.`

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

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

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

users(self)

Methods inherited from UserKit.UserManager.UserManager:

activeUserTimeout(self)

cachedUserTimeout(self)

clearCache(self)
  `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.`

createUser(self, 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 addUser().
  See also: userClass(), setUserClass()`

login(self, user, password)
  `Return the user if the login is successful, otherwise return None.`

loginExternalId(self, externalId, password)

loginName(self, userName, password)

loginSerialNum(self, serialNum, password)

logout(self, user)

modifiedUserTimeout(self)

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

setActiveUserTimeout(self, value)

setCachedUserTimeout(self, value)

setModifiedUserTimeout(self, value)

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

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

Data descriptors inherited from UserKit.UserManager.UserManager:

__dict__
  `dictionary for instance variables (if defined)`

__weakref__
  `list of weak references to the object (if defined)`

Methods inherited from UserKit.RoleUserManagerMixIn.RoleUserManagerMixIn:

addRole(self, role)

clearRoles(self)

delRole(self, name)

hasRole(self, name)

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

roles(self)