Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkAccessControlList

All Known Implementing Classes:
dkAbstractAccessControlList

public interface dkAccessControlList


Method Summary
 void addACLData(DKACLData acc_data)
          Adds a new pair of privilege set and user/group to this access control list.
 void clearCache()
          Clear access control list cache
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getDescription()
          gets the description of this access control list set
 java.lang.String getName()
          gets the name of this access control list set
 dkCollection listACLData()
          List the access control list data from the persistent datastore
 java.lang.String[] listGroups()
          List the user groups in this access control list (memory-only)
 java.lang.String[] listUsers()
          List the userids in this access control list (memory-only)
 java.lang.String[] listUsrGrps()
          List the users and groups in this access control list (memory-only)
 void removeACLData(DKACLData acc_data)
          Removes a user or group from access control list (memory-only)
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setDescription(java.lang.String description)
          sets the description of this access control list set
 void setName(java.lang.String name)
          sets the name for this access control list set
 

Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Parameters:
ds - datastore

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Returns:
the dkDatastore object

getName

public java.lang.String getName()
gets the name of this access control list set
Returns:
access control list name

setName

public void setName(java.lang.String name)
sets the name for this access control list set
Parameters:
name - access control list name

getDescription

public java.lang.String getDescription()
gets the description of this access control list set
Returns:
access control list description

setDescription

public void setDescription(java.lang.String description)
sets the description of this access control list set
Parameters:
name - access control list description

listACLData

public dkCollection listACLData()
                         throws DKException,
                                java.lang.Exception
List the access control list data from the persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Returns:
a collection of dkACLData of the access control list

listUsrGrps

public java.lang.String[] listUsrGrps()
                               throws DKException,
                                      java.lang.Exception
List the users and groups in this access control list (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Returns:
an array of users and groups
Throws:
DKException - when error occurs in the server

listUsers

public java.lang.String[] listUsers()
                             throws DKException,
                                    java.lang.Exception
List the userids in this access control list (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Returns:
an array of user ids
Throws:
DKException - when error occurs in the server

listGroups

public java.lang.String[] listGroups()
                              throws DKException,
                                     java.lang.Exception
List the user groups in this access control list (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Returns:
an array of groups
Throws:
DKException - when error occurs in the server

addACLData

public void addACLData(DKACLData acc_data)
                throws DKException,
                       java.lang.Exception
Adds a new pair of privilege set and user/group to this access control list. (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Parameters:
acc_data - a DKACLData object

removeACLData

public void removeACLData(DKACLData acc_data)
                   throws DKException,
                          java.lang.Exception
Removes a user or group from access control list (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Parameters:
acl_data - DKACLData object to be removed

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear access control list cache

Note:DKUsageError exception thrown if method is not implemented


EIP Java APIs

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