|
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.DKAccessControlListICM
The Content Manager version 8 access control model is applied at the level of the controlled entity. A controlled entity is a unit of protected user data. In different Content Manager installations, the controlled entity can be an individual item, item-type, or the entire library. Operations on the controlled entities are regulated by one or more control rules. The access control list (ACL) is the container for these control rules. The DKAccessControlListICM class represents a Content Manager version 8 ACL. Every controlled entity in a Content Manager system must be bound to an ACL. Default settings can be configured by the system administrator, if appropriate. An ACL is associated with an item type to enforce access control at the item type level. Similarly, an item level access control is established by binding an ACL to the desired item when the item is created. When a user initiates an operation on the item, the system will check the user's privilege and the ACL associated with this item to determine if this user has the right to perform such an operation on this item. The right to access an item also requires the right to access the item type based on which this item type is defined. An ACL is created by calling one of its multiple constructors. If the datastore with which this ACL shall be associated is known at the time of object creation, then one of the constructors that take a datastore parameter is used. Otherwise, the default constructor is used and the setDatastore method is called on the created ACL instance once the datastore instance has also been created.
DKPrivilegeICM
, Serialized FormFields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKAccessControlListICM()
Constructs and initializes an access control list class that is not currently associated with any datastore instance. |
|
DKAccessControlListICM(dkDatastore ds)
Constructor that takes a datastore instance as a parameter. |
|
DKAccessControlListICM(dkDatastore ds,
java.lang.String name)
Constructor that takes a datastore instance and a name as a parameter. |
Method Summary | |
void |
addACLData(DKACLData aclData)
Adds the specified access control rule to the in-memory (cached) representation of this ACL object instance Adds |
void |
clearCache()
Removes all the access control rules from the in-memory (cached) representation of this ACL object instance. |
dkCollection |
getAdminDomains()
Retrieves the collection of domains with which this ACL instance is associated. |
long |
getID()
Retrieves the identifier for this ACL. |
dkCollection |
listACLData()
Retrieves the access control data associated with this object from the datastore if the cache is turned off or if cache is on but the access control rules have not yet been retrieved into it. |
java.lang.String[] |
listGroups()
Retrieves the list of user groups associated with this ACL from the in-memory (cached) representation of this object instance. |
java.lang.String[] |
listUsers()
Retrieves the list of users associated with this ACL from the in-memory (cached) representation of this object instance. |
java.lang.String[] |
listUsrGrps()
Retrieves the list of users and user groups associated with this ACL from the in-memory (cached) representation of this object instance. |
void |
removeACLData(DKACLData aclData)
Removes the specified access control rule from the in-memory (cached) representation of this ACL object instance. |
void |
setAdminDomains(dkCollection collDomain)
Sets the admininstration domains that this ACL object instance is associated with. |
void |
setID(long id)
Sets the identifier for this access control listobject |
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 DKAccessControlListICM()
public DKAccessControlListICM(dkDatastore ds)
ds
- datastore object as an instance of DKDatastoreICMpublic DKAccessControlListICM(dkDatastore ds, java.lang.String name)
ds
- datastore refrence as an instance of DKDatastoreICMname
- name for the of the created access control listMethod Detail |
public void setID(long id)
id
- new identifier value for to be set to this ACL objectpublic long getID()
public void setAdminDomains(dkCollection collDomain)
collDomain
- a collection of DKAdminDomainDefICM objects that this ACL object will be associated withpublic dkCollection getAdminDomains()
public dkCollection listACLData() throws DKException, java.lang.Exception
listACLData
in class dkAbstractAccessControlList
DKException
- if error occursjava.lang.Exception
- if error occursDKACLData
public java.lang.String[] listUsrGrps() throws DKException
listUsrGrps
in class dkAbstractAccessControlList
DKException
- when error occurspublic java.lang.String[] listUsers() throws DKException
listUsers
in class dkAbstractAccessControlList
DKException
- when error occurspublic java.lang.String[] listGroups() throws DKException
listGroups
in class dkAbstractAccessControlList
DKException
- when error occurspublic void addACLData(DKACLData aclData) throws DKAlreadyExistException, DKException
addACLData
in class dkAbstractAccessControlList
aclData
- an access control rule as an instance of DKACLData objectDKAlreadyExistException
- if the user/user group specified in this ACL rule
already exists in the other ACL rules already associated with this objectDKException
- when error occurspublic void removeACLData(DKACLData aclData) throws DKNotExistException, DKException
removeACLData
in class dkAbstractAccessControlList
aclData
- the access control rule as an instance of DKACLData to be removedDKNotExistException
- if the user/user group specified in this ACL rule
does not exist in any of the other ACL rules already associated with this objectDKException
- when error occurspublic void clearCache() throws DKException, java.lang.Exception
clearCache
in class dkAbstractAccessControlList
DKException
- when error occursjava.lang.Exception
- when error occurs
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |