Purpose:
This class represents and implements datastore user management functions. An instance of DKUserMgmtICM is created as part of a chain of instantiations when you create an instance of DKDatastoreICM. Use the userManagement() function of DKDatastoreAdminICM to get the DKUserMgmtICM instance. The following example illustrates getting the instance:
DKDatastoreICM ds; DKDatastoreDefICM* dsDef = 0; DKDatastoreAdminICM* dsAdmin = 0; DKUserMgmtICM* userMgmt = 0; /* Connect to the datastore */ ds.connect(uid, pwd, .....); ..... dsDef = (DKDatastoreDefICM*)ds.datastoreDef(); dsAdmin = (DKDatastoreAdminICM*)dsDef->datastoreAdmin(); userMgmt = (DKUserMgmtICM*)dsAdmin->userManagement(); ....
Since: Version 8
Class summary:
class DKEXPORT DKUserMgmtICM : public dkUserManagement { public: DKUserMgmtICM(); DKUserMgmtICM(dkDatastore * ds); virtual ~DKUserMgmtICM(); virtual void add(dkUserDef* userDefObj); virtual void add(dkUserGroupDef* userGrpDef); void changePassword(const char* newPwd); void changePassword(const char* userId, const char* newPwd); virtual void changePassword(const char* userId, const char* oldPwd, const char* newPwd); virtual void clearCache(); virtual dkUserDef* createUserDef(); virtual dkUserGroupDef* createUserGroupDef(); virtual void del(dkUserDef* userDefObj); virtual void del(dkUserGroupDef* userGrpDef); virtual void delUser(const char* name); virtual void delUserGroupDef(const char* name); long getAccessLevel(); virtual dkUserDef* getUserDef(const char* name); DKString getUserDomain(const char* name); virtual dkUserGroupDef* getUserGroupDef(const char* name); long getUserPrivilege(const char* name); DKBoolean isAdminUser(const char* userName); DKBoolean isTraceEnabled(); DKString* listActiveUserNames(long& arrSize); virtual dkCollection* listGroupsForUser(const char* name); virtual dkCollection* listUserDefs(); virtual dkCollection* listUserGroupDefs(); virtual dkCollection* listUserGroupDefs(const char* domainName); DKString* listUserGroupNames(const char* domainName,long& arrSize); DKString* listUserGroupNames(long& arrSize); DKString* listUserGroups(long& arrSize); DKString* listUserGroups(const char* domainName,long& arrSize); DKString* listUserNames(const char* domainName,long& arrSize); DKString* listUserNames(long& arrSize); DKString* listUsers(const char* domainName,long& arrSize); DKString* listUsers(long& arrSize); DKString* listUsersInGroup(const char* id); void removeUserDef(const char* name); virtual dkUserDef* retrieveUserDef(const char* name); virtual dkUserGroupDef* retrieveUserGroupDef(const char* userGroupName); void removeUserGroupDef(const char* name); void setTraceEnabled(DKBoolean isEnabled); void update(dkUserDef* userDef); void update(dkUserGroupDef* userGroupDef); };
Members:
DKUserMgmtICM();
Default constructor. Creates an user mgmt object that is not associated with any datastore instance currently.
DKUserMgmtICM(dkDatastore * ds);
Constructor that takes a datastore instance as a parameter. The returned user mgmt object instance is associated with the datastore instance. Equivalent to calling the default constructor followed by the setDatastore method on the created object. Parameters: ds - valid instance of a datastore object. Should be an instance of DKDatastoreICM
virtual ~DKUserMgmtICM();
Destructor for this object.
virtual void add(dkUserGroupDef* userGrpDef);
virtual void add(dkUserGroupDef* userGrpDef);
virtual void clearCache();
void changePassword(const char* newPwd);
Throws: DKException if error occurs on the server.
void changePassWord(const char* userId, const char* newPwd);
Throws: DKException if error occurs on the server.
virtual void changePassword(const char* userId, const char* oldPwd, const char* newPwd);
virtual dkUserDef* createUserDef();
virtual dkUserGroupDef* createUserGroupDef();
virtual void del(dkUserDef* userDefObj);
virtual void del(dkUserGroupDef* userGrpDef);
virtual void delUser(const char* name);
virtual void delUserGroupDef(const char* name);
long getAccessLevel();
virtual dkUserDef* getUserDef(const char* name);
DKString getUserDomain(const char* name);
virtual dkUserGrouDef* getUserGroupDef(const char* name);
long getUserPrivilege(const char* name);
DKBoolean isAdminUser(const char* userName);
DKBoolean isTraceEnabled();
DKString* listActiveUserNames(long& arrSize);
Returns: array of active user names as DKString variables Throws: DKException if error occurs on the server.
DKString* listActiveUsernames(const char* domainName,long& arrSize)
virtual dkCollection* listUserDefs();
virtual dkCollection* listGroupsforUser(const char* name);
virtual dkCollection* listUserGroupDefs();
virtual dkCollection* listUserGroupDefs(const char* domainName);
Returns: array of user group names for the specified admin domain as DKString variables. Throws: DKException if error occurs on the server.
DKString* listUserGroupNames(const char* domainName,long& arrSize);
DKString* listUserGroupNames(long& arrSize);
DKString* listUserGroups(long& arrSize);
Returns: array of user group names as DKString variables. Throws: DKException if error occurs on the server.
DKString* listUserGroups(const char* domainName,long& arrSize);
Returns: array of user names as DKString variables. Throws: DKException if error occurs on the server.
DKString* listUserNames(const char* domainName,long& arrSize);
DKString* listUserNames(long& arrSize);
Returns: array of user names as DKString variables. Throws: DKException if error occurs on the server.
DKString* listUsers(const char* domainName,long& arrSize);
DKString* listUsers(long& arrSize);
DKString* listUsersInGroup(const char* name);
void removeUserDef(const char* name);
virtual dkUserDef* retrieveUserGroupDef(const char* userName);
virtual dkUserGroupDef* retrieveUserDef(const char* userGroupName);
void removeUserGroupDef(const char* name);
void setTraceEnabled(DKBoolean isEnabled);
void update(dkUserDef* userDef);
void update(dkUserGroupDef* userGroupDef);
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.