Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractAccessControlList

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractAccessControlList
All Implemented Interfaces:
dkAccessControlList, DKMessageId, java.io.Serializable
Direct Known Subclasses:
DKAccessControlListFed, DKAccessControlListICM

public abstract class dkAbstractAccessControlList
extends java.lang.Object
implements dkAccessControlList, DKMessageId, java.io.Serializable

This class defines methods to access user information

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkAbstractAccessControlList()
          Constructs a new dkAbstractAccessControlList class without owner datastore object.
dkAbstractAccessControlList(dkDatastore ds)
          Constructs a new dkAbstractAccessControlList class with owner datastore object
 
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 datastore cache
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getDescription()
          gets the description of this access control list
 java.lang.String getName()
          Gets User name
 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
 void setName(java.lang.String name)
          Sets User name
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractAccessControlList

public dkAbstractAccessControlList()
Constructs a new dkAbstractAccessControlList class without owner datastore object.

dkAbstractAccessControlList

public dkAbstractAccessControlList(dkDatastore ds)
Constructs a new dkAbstractAccessControlList class with owner datastore object
Parameters:
ds - reference to owner datastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkAccessControlList
Following copied from interface: com.ibm.mm.sdk.common.dkAccessControlList
Parameters:
ds - datastore

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkAccessControlList
Returns:
the dkDatastore object

getName

public java.lang.String getName()
Gets User name
Specified by:
getName in interface dkAccessControlList
Returns:
name of this user

setName

public void setName(java.lang.String name)
Sets User name
Specified by:
setName in interface dkAccessControlList
Parameters:
name - new name to be set to this User object

getDescription

public java.lang.String getDescription()
gets the description of this access control list
Specified by:
getDescription in interface dkAccessControlList
Following copied from interface: com.ibm.mm.sdk.common.dkAccessControlList
Returns:
access control list description

setDescription

public void setDescription(java.lang.String description)
sets the description of this access control list
Specified by:
setDescription in interface dkAccessControlList
Following copied from interface: com.ibm.mm.sdk.common.dkAccessControlList
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

Specified by:
listACLData in interface dkAccessControlList
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

Specified by:
listUsrGrps in interface dkAccessControlList
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

Specified by:
listUsers in interface dkAccessControlList
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

Specified by:
listGroups in interface dkAccessControlList
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

Specified by:
addACLData in interface dkAccessControlList
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

Specified by:
removeACLData in interface dkAccessControlList
Parameters:
acl_data - DKACLData object to be removed

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear datastore cache

Note:DKUsageError exception thrown if method is not implemented

Specified by:
clearCache in interface dkAccessControlList

EIP Java APIs

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