Index

DKAccessControlListFed

Purpose:

The DKAccessControlListFed class is derived from its base class dkAccessControl. This class is the concrete implementation access control facilities provided in the Content Manager version 8 (Fed).

Class summary:

class DKEXPORT DKAccessControlListFed : public dkAccessControlList
{
  public:
   DKAccessControlListFed();
   DKAccessControlListFed(dkDatastore* ds, const char* name);
   DKAccessControlListFed(dkDatastore* ds);
   virtual ~DKAccessControlListFed();
 
   virtual void add();
   virtual void addACLData(DKACLData* aclData);
   virtual void addUserGroup(const char* usrGrpName, short usrGrpType, dkPrivilegeSet* privObj);
   virtual void checkin();
   virtual void checkout();
   virtual void clearCache(); 
   virtual void del();
   virtual DKString getCheckedOutUserid();
   virtual DKString getGroupFromPrivilege(const char* privName);
   long getID();
   virtual const DKPid* getPid();
   virtual dkPrivilegeSet* getPrivilege(const char* usrGrpName);
   virtual DKString getUserFromPrivilege(const char* privName);
   virtual DKBoolean isRetrieved(); 
   virtual dkCollection* listACLData();
   virtual DKString* listGroups(long& arraySize);
   virtual DKString* listUsers(long& arraySize);
   virtual DKString* listUsrGrps(long& arraySize);
   virtual void removeACLData(DKACLData* aclData);
   virtual void removeAllACLData();
   virtual void removeUserGroup(const char* usrGrpName);
   virtual void retrieve();
   void setID(long id);
   virtual void setPid(const DKPid* pid);
   virtual void setRetrieved(DKBoolean isRetrieved); 
   virtual void unlockCheckedOut();
   virtual void update();
   void setAdminDomain(DKAdminDomainDefFed* domain);
   DKAdminDomainDefFed* getAdminDomain();
 
};

Members:

Constructors and destructor
The DKAccessControlListFed constructor has a parameter that is a pointer to a Fed datastore requesting for access control functions.
DKAccessControlListFed();
DKAccessControlListFed(dkDatastore* ds, const char* name);
DKAccessControlListFed(dkDatastore* ds);
~DKAccessControlListFed();
 

Member functions

add
Adds a new access control list into Fed.
virtual void add();

addACLData
Adds a new pair of privilege set and user/group to this access control list(memory-only).
virtual void addACLData(DKACLData* aclData);

addUserGroup
Adds a new pair of privilege set and user/group to this access control list This is a memory only method.
virtual void addUserGroup(const char* usrGrpName, short usrGrpType, dkPrivilegeSet* privObj);

checkout
Checks out the object data.
virtual void checkout();

checkin
Checks in the object data .
virtual void checkin();

clearCache
Clears the ACL cache.
virtual void clearCache();

del
Deletes an existing access control list from Fed.
virtual void del();

getCheckedOutUserid
Gets the user ID that has checked out an item.
virtual DKString getCheckedOutUserid();

getGroupFromPrivilege
Gets the associated group name from the privilege set name.
virtual DKString getGroupFromPrivilege(const char* privName);

getID
Gets ACL id.
long getID();

getPid
Deprecated, has no meaning.
virtual const DKPid* getPid();

getPrivilege
Gets the associated privilege set objecct from the given user or group name.
virtual dkPrivilegeSet* getPrivilege(const char* usrGrpName);

getUserFromPrivilege
Gets the associated user name from the privilege set name.
virtual DKString getUserFromPrivilege(const char* privName);

isRetrieved
Checks to see if the ACL have been retrieved.
DKBoolean isRetrieved();

listACLData
Gets the access data of the access control list.
virtual dkCollection* listACLData();

listGroups
Gets a list of groups in this access control list .
virtual DKString* listGroups(long& arraySize);

listUsers
Gets a list of userids in this access control list .
virtual DKString* listUsers(long& arraySize);

listUsrGrps
Gets a list of user or groups in this access control list .
virtual DKString* listUsrGrps(long& arraySize);

removeACLData
Removes a pair of privilege set and user/group from access control list(memory-only).
virtual void removeACLData(DKACLData* aclData);

removeAllACLData
Removes all ACL data.
virtual void removeAllACLData();

removeUserGroup
Removes a user or group from access control list.
virtual void removeUserGroup(const char* usrGrpName);

retrieve
Deprecated, has no meaning.
virtual void retrieve();

setID
Sets ACL id.
void setID(long id);

setPid
Deprecated, has no meaning.
virtual void setPid(const DKPid* pid);

setRetrieved
Sets whether the ACL has been retrieved.
void setRetrieved(DKBoolean isRetrieved);

unlockCheckedOut
Deprecated, has no meaning.
virtual void unlockCheckedOut();

update
Deprecated, has no meaning.
virtual void update();

setAdminDomain
Sets domain that this ACL belongs to.
void setAdminDomain(DKAdminDomainDefFed* domain);

getAdminDomain
Gets the domain that this ACL belongs to.
DKAdminDomainDefFed* getAdminDomain();

(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.