Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAccessControlListFed

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

public class DKAccessControlListFed
extends dkAbstractAccessControlList

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKAccessControlListFed()
          Default constructor Constructs the access control and initializes it with the datastore.
DKAccessControlListFed(dkDatastore ds)
          Constructs the access control and initializes it with the datastore.
DKAccessControlListFed(dkDatastore ds, java.lang.String name)
          Constructs the access control and initializes it with the datastore.
 
Method Summary
 void add()
          Deprecated.  
 void addACLData(DKACLData aclData)
          Adds a new pair of privilege set and user/group to this access control list.
 void addUserGroup(java.lang.String usrGrpName, short usrGrpType, dkPrivilegeSet privObj)
          Adds a new pair of privilege set and user/group to this access control list This is a memory only method.
 void checkin()
          Deprecated. no meaning
 void checkout()
          Deprecated. no meaning
 void clearCache()
          Clear privilege set cache
 void del()
          Deprecated.  
 dkCollection getAdminDomains()
          Gets the collection of domains that this privilege set belongs to
 java.lang.String getCheckedOutUserid()
          Deprecated. no meaning
 java.lang.String getGroupFromPrivilege(java.lang.String privName)
          Gets the associated group name from the privilege set name
 long getID()
          Gets ACL id
 DKPid getPid()
          Deprecated. no meaning
 dkPrivilegeSet getPrivilege(java.lang.String usrGrpName)
          Gets the associated privilege set objecct from the given user or group name
 java.lang.String getUserFromPrivilege(java.lang.String privName)
          Gets the associated user name from the privilege set name
 boolean isRetrieved()
          Checks to see if this acl have been retrieved
 dkCollection listACLData()
          Gets the access data of the access control list
 java.lang.String[] listGroups()
          Gets a list of groups in this access control list (memory only)
 java.lang.String[] listUsers()
          Gets a list of userids in this access control list (memory only)
 java.lang.String[] listUsrGrps()
          Gets a list of users and groups in this access control list (memory only)
 void removeACLData(DKACLData aclData)
          Removes a pair of privilege set and user/group from access control list (memory-only)
 void removeAllACLData()
          Removes all ACL data, i.e.
 void removeUserGroup(java.lang.String usrGrpName)
          Removes a user or group from access control list
 void retrieve()
          Deprecated.  
 void setAdminDomains(dkCollection collDomain)
          Sets domains that this privilege set belongs to
 void setID(long id)
          Sets ACL id
 void setID(java.lang.String fromId)
          Deprecated. no meaning
 void setPid(DKPid pid)
          Deprecated. no meaning
 void setRetrieved(boolean isRetrieved)
          Sets whether this acl has been retrieved
 void unlockCheckedOut()
          Deprecated. no meaning
 void update()
          Deprecated.  
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractAccessControlList
getDatastore, getDescription, getName, setDatastore, setDescription, setName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKAccessControlListFed

public DKAccessControlListFed()
Default constructor Constructs the access control and initializes it with the datastore.

DKAccessControlListFed

public DKAccessControlListFed(dkDatastore ds)
Constructs the access control and initializes it with the datastore.
Parameters:
ds - dkDatastore reference

DKAccessControlListFed

public DKAccessControlListFed(dkDatastore ds,
                              java.lang.String name)
Constructs the access control and initializes it with the datastore.
Parameters:
ds - dkDatastore reference
name - name of access control list
Method Detail

getPid

public DKPid getPid()
             throws java.lang.Exception
Deprecated. no meaning

Gets the persistent id of the access control list
Returns:
the persistent id of the access control list

setPid

public void setPid(DKPid pid)
            throws java.lang.Exception
Deprecated. no meaning

Sets the persistent id of the access control list

setID

public void setID(long id)
Sets ACL id
Parameters:
id - new id to be set to this ACL object

getID

public long getID()
Gets ACL id
Returns:
id of this ACL

setAdminDomains

public void setAdminDomains(dkCollection collDomain)
Sets domains that this privilege set belongs to
Parameters:
collDomain - a collection of DKAdminDomainDefICM this acl object belongs to

getAdminDomains

public dkCollection getAdminDomains()
Gets the collection of domains that this privilege set belongs to
Returns:
a collection of DKAdminDomainDefICM that this acl object belongs to

isRetrieved

public boolean isRetrieved()
Checks to see if this acl have been retrieved
Returns:
true if already retrieved, false otherwise

setRetrieved

public void setRetrieved(boolean isRetrieved)
Sets whether this acl has been retrieved
Parameters:
isRetrieved - true if already retrieved, false otherwise

listACLData

public dkCollection listACLData()
                         throws DKException,
                                java.lang.Exception
Gets the access data of the access control list
Overrides:
listACLData in class dkAbstractAccessControlList
Returns:
a collection of DKACLData of the access control list

listUsrGrps

public java.lang.String[] listUsrGrps()
                               throws DKException
Gets a list of users and groups in this access control list (memory only)
Overrides:
listUsrGrps in class dkAbstractAccessControlList
Returns:
an array of users and groups
Throws:
DKException - when error occurs in the server

listUsers

public java.lang.String[] listUsers()
                             throws DKException
Gets a list of userids in this access control list (memory only)
Overrides:
listUsers in class dkAbstractAccessControlList
Returns:
an array of user ids
Throws:
DKException - when error occurs in the server

listGroups

public java.lang.String[] listGroups()
                              throws DKException
Gets a list of groups in this access control list (memory only)
Overrides:
listGroups in class dkAbstractAccessControlList
Returns:
an array of groups
Throws:
DKException - when error occurs in the server

addACLData

public void addACLData(DKACLData aclData)
                throws DKAlreadyExistException,
                       DKException
Adds a new pair of privilege set and user/group to this access control list. (memory-only)
Overrides:
addACLData in class dkAbstractAccessControlList
Parameters:
acl_data - a DKACLData object

removeACLData

public void removeACLData(DKACLData aclData)
                   throws DKNotExistException,
                          DKException
Removes a pair of privilege set and user/group from access control list (memory-only)
Overrides:
removeACLData in class dkAbstractAccessControlList
Parameters:
acl_data - DKACLData object to be removed

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear privilege set cache
Overrides:
clearCache in class dkAbstractAccessControlList

getPrivilege

public dkPrivilegeSet getPrivilege(java.lang.String usrGrpName)
                            throws DKException
Gets the associated privilege set objecct from the given user or group name
Parameters:
usrGrpName - String - name of group or user
Returns:
dkPrivilegeSet - the associated privilege set object. Null will be returned if either the usrGrpName does not exist in this ACL.

getUserFromPrivilege

public java.lang.String getUserFromPrivilege(java.lang.String privName)
                                      throws DKException
Gets the associated user name from the privilege set name
Parameters:
privName - String - name of privilege set
Returns:
the associated user name. Null will be returned if either the privName does not exist in this ACL or there is no user associated with this privName

getGroupFromPrivilege

public java.lang.String getGroupFromPrivilege(java.lang.String privName)
                                       throws DKException
Gets the associated group name from the privilege set name
Parameters:
privName - String - name of privilege set
Returns:
the associated group name. Null will be returned if either the privName does not exist in this ACL or there is no group associated with this privName

addUserGroup

public void addUserGroup(java.lang.String usrGrpName,
                         short usrGrpType,
                         dkPrivilegeSet privObj)
                  throws DKAlreadyExistException,
                         DKException
Adds a new pair of privilege set and user/group to this access control list This is a memory only method. In order for it to be persisted in EIP system, you need to call update() method after this.
Parameters:
usrGrpName - name of userid or group to be added to this access control list
usrGrpType - either DK_CM_PATRON_TYPE_USER or DK_CM_PATRON_TYPE_GROUP
privObj - a privilege set object to be associated to the usrGrpName

removeUserGroup

public void removeUserGroup(java.lang.String usrGrpName)
                     throws DKNotExistException,
                            DKException
Removes a user or group from access control list
Parameters:
usrGrpName - name of userid or group to be removed from this access control list

removeAllACLData

public void removeAllACLData()
Removes all ACL data, i.e. removing all users and/or groups associated with privilege sets in this ACL object.

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Deprecated.  

Retrieves information of the access control list
Throws:
DKException - when error occurs in the server

add

public void add()
         throws DKAlreadyExistException,
                DKException,
                java.lang.Exception
Deprecated.  

Adds a new access control list into Fed
Throws:
DKAlreadyExistException - when current access control list object already exist in EIP server. Check to see if this new access control list name is unique.
DKException - when error occurs in the server

update

public void update()
            throws DKException,
                   java.lang.Exception
Deprecated.  

Updates an existing access control list in Fed

del

public void del()
         throws DKNotExistException,
                DKException,
                java.lang.Exception
Deprecated.  

Deletes an existing access control list from Fed

checkin

public void checkin()
             throws DKNotCheckedOutException,
                    DKException,
                    java.lang.Exception
Deprecated. no meaning

checks in the object data
Throws:
DKNotCheckedOutException - if this item is not currently checked out

checkout

public void checkout()
              throws DKAlreadyCheckedOutException,
                     DKException,
                     java.lang.Exception
Deprecated. no meaning

checks out the object data
Throws:
DKAlreadyCheckedOutException - if this item is currently checked out by another user.

unlockCheckedOut

public void unlockCheckedOut()
                      throws DKNotCheckedOutException,
                             DKException,
                             java.lang.Exception
Deprecated. no meaning

unlocks currently checked out object data
Throws:
DKNotCheckedOutException - if this item is not currently checked out

getCheckedOutUserid

public java.lang.String getCheckedOutUserid()
                                     throws DKNotCheckedOutException,
                                            DKException,
                                            java.lang.Exception
Deprecated. no meaning

gets the checked out userid. Subclass must implement this method.
Returns:
String - userid that checked out the object
Throws:
DKNotCheckedOutException - if this item is not currently checked out

setID

public void setID(java.lang.String fromId)
           throws java.lang.Exception
Deprecated. no meaning

Sets the pid of this data object
Parameters:
fromId - - data object primary id

EIP Java APIs

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