Index

DXAccessControlDL

Purpose:

The DXAccessControlDL class defines access control functions provided in Content Manager.

Methods:

init
init(LPDISPATCH ds);

Must be called following the creation of a DXAccessControlDL object.

type
BSTR type();

Returns the type of access control.

getName
BSTR getName();

Returns the name of access control.

addAccessControlList
addAccessControlList(LPCTSTR acl_name, 
                     LPCTSTR description, 
                     LPDISPATCH access_data);

Adds an access control list into the system. acl_name specifies the name of access control list. description provides the textual information of the access control list. access_data specifies the access data entries of the access control list. Each access data entry is an object of DXAccessDataDL, which is defined below.

updateAccessControlList
updateAccessControlList(LPCTSTR acl_name, 
                        LPCTSTR description, 
                        LPDISPATCH access_data);

Updates an access control list in the system. acl_name specifies the name of access control list. description provides the textual information of the access control list. access_data specifies the access data entries of the access control list. Each access data entry is an object of DXAccessDataDL, which is defined below.

deleteAccessControlList
deleteAccessControlList(LPCTSTR acl_name);

Deletes an access control list in the system. acl_name specifies the name of access control list.

getItemACL
String getItemACL(LPCTSTR itemID);

Returns the name of access control list of the specified item ID.

setItemACL
setItemACL(LPCTSTR itemID, LPCTSTR acl_name);

Associates an access control list with the specified item ID.

listAccessControlLists
LPDISPATCH listAccessControlLists();

Returns a collection of DXAccessControlListDL objects defined in the system.

listAccessControlList
LPDISPATCH listAccessControlList(LPCTSTR acl_name);

Returns a DXAccessControlListDL object with the specified name.

listPrivileges
LPDISPATCH listPrivileges();

Returns a collection of string objects containing the name of privilege sets defined in the system.

listPrivilege
BSTR listPrivilege(LPCTSTR user_name);

Returns the privilege name of the specified user.

listUsers
LPDISPATCH listUsers();
LPDISPATCH listUsers(LPCTSTR group_name);

The first form returns a collection of string objects containing the name of users defined in the system. The second form returns a collection of string objects containing the name of users defined in a group.

listGroups
LPDISPATCH listGroups();
LPDISPATCH listGroups(LPCTSTR user_name);

The first form returns a collection of string objects containing the name of groups defined in the system. The second form returns a collection of string objects containing the name of groups that the specified user is part of.

listPrivilegeString
BSTR listPrivilegeString(LPCTSTR privilege_name);

Returns TRUE if the specified authority is granted in the privilege string.

isAuthorized
 BOOL isAuthorized(LPCTSTR privilege_string, long authority);

Returns TRUE if the specified authority is granted in the privilege string.

isAccessControlList
BOOL isAccessControlList(LPCTSTR acl_name);

Returns TRUE if the specified name is a valid access control list.

isPrivilege
BOOL isPrivilege(LPCTSTR privilege_name);

Returns TRUE if the specified name is a valid privilege.

isUser
BOOL isUser(LPCTSTR user_name);

Returns TRUE if the specified name is a valid user.

isGroup
BOOL isGroup(LPCTSTR group_name);

Returns TRUE if the specified name is a valid group.

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