|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractAccessControlList | +--com.ibm.mm.sdk.common.DKAccessControlListFed
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 |
public DKAccessControlListFed()
public DKAccessControlListFed(dkDatastore ds)
ds
- dkDatastore referencepublic DKAccessControlListFed(dkDatastore ds, java.lang.String name)
ds
- dkDatastore referencename
- name of access control listMethod Detail |
public DKPid getPid() throws java.lang.Exception
public void setPid(DKPid pid) throws java.lang.Exception
public void setID(long id)
id
- new id to be set to this ACL objectpublic long getID()
public void setAdminDomains(dkCollection collDomain)
collDomain
- a collection of DKAdminDomainDefICM this acl object belongs topublic dkCollection getAdminDomains()
public boolean isRetrieved()
public void setRetrieved(boolean isRetrieved)
isRetrieved
- true if already retrieved, false otherwisepublic dkCollection listACLData() throws DKException, java.lang.Exception
listACLData
in class dkAbstractAccessControlList
public java.lang.String[] listUsrGrps() throws DKException
listUsrGrps
in class dkAbstractAccessControlList
DKException
- when error occurs in the serverpublic java.lang.String[] listUsers() throws DKException
listUsers
in class dkAbstractAccessControlList
DKException
- when error occurs in the serverpublic java.lang.String[] listGroups() throws DKException
listGroups
in class dkAbstractAccessControlList
DKException
- when error occurs in the serverpublic void addACLData(DKACLData aclData) throws DKAlreadyExistException, DKException
addACLData
in class dkAbstractAccessControlList
acl_data
- a DKACLData objectpublic void removeACLData(DKACLData aclData) throws DKNotExistException, DKException
removeACLData
in class dkAbstractAccessControlList
acl_data
- DKACLData object to be removedpublic void clearCache() throws DKException, java.lang.Exception
clearCache
in class dkAbstractAccessControlList
public dkPrivilegeSet getPrivilege(java.lang.String usrGrpName) throws DKException
usrGrpName
- String - name of group or userpublic java.lang.String getUserFromPrivilege(java.lang.String privName) throws DKException
privName
- String - name of privilege setpublic java.lang.String getGroupFromPrivilege(java.lang.String privName) throws DKException
privName
- String - name of privilege setpublic void addUserGroup(java.lang.String usrGrpName, short usrGrpType, dkPrivilegeSet privObj) throws DKAlreadyExistException, DKException
usrGrpName
- name of userid or group to be added to this access control listusrGrpType
- either DK_CM_PATRON_TYPE_USER or DK_CM_PATRON_TYPE_GROUPprivObj
- a privilege set object to be associated to the usrGrpNamepublic void removeUserGroup(java.lang.String usrGrpName) throws DKNotExistException, DKException
usrGrpName
- name of userid or group to be removed from this access control listpublic void removeAllACLData()
public void retrieve() throws DKException, java.lang.Exception
DKException
- when error occurs in the serverpublic void add() throws DKAlreadyExistException, DKException, java.lang.Exception
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 serverpublic void update() throws DKException, java.lang.Exception
public void del() throws DKNotExistException, DKException, java.lang.Exception
public void checkin() throws DKNotCheckedOutException, DKException, java.lang.Exception
DKNotCheckedOutException
- if this item is not currently checked outpublic void checkout() throws DKAlreadyCheckedOutException, DKException, java.lang.Exception
DKAlreadyCheckedOutException
- if this item is currently checked out
by another user.public void unlockCheckedOut() throws DKNotCheckedOutException, DKException, java.lang.Exception
DKNotCheckedOutException
- if this item is not currently checked outpublic java.lang.String getCheckedOutUserid() throws DKNotCheckedOutException, DKException, java.lang.Exception
DKNotCheckedOutException
- if this item is not currently checked outpublic void setID(java.lang.String fromId) throws java.lang.Exception
fromId
- - data object primary id
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |