Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAccessControlDD

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKAccessControlDD
All Implemented Interfaces:
dkAccessControl, DKConstant, DKConstantDD, DKMessageId, DKMessageIdDD, java.io.Serializable

public class DKAccessControlDD
extends java.lang.Object
implements dkAccessControl, DKConstantDD, DKMessageIdDD, java.io.Serializable

DKAccessControlDD : This class represents and processes datastore access control functions.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDD
copyright, DK_ACTYPE_DD, DK_DD_APPEND, DK_DD_ATTR, DK_DD_BINDER, DK_DD_BLOB, DK_DD_CABINET, DK_DD_CREATE, DK_DD_CREATE_DATE, DK_DD_DATASTORE_EXT, DK_DD_DEFAULT_MIMETYPE, DK_DD_DLL_NAME, DK_DD_DOC_TYPE, DK_DD_DOCUMENT, DK_DD_DS_API_NAME, DK_DD_DSTYPE, DK_DD_FIELD, DK_DD_FILENAME, DK_DD_KEYWORD, DK_DD_LIBRARY, DK_DD_OPT_CONTENT, DK_DD_OPT_CONTENT_ATTRONLY, DK_DD_OPT_CONTENT_NO, DK_DD_OPT_CONTENT_YES, DK_DD_OPT_LIMIT, DK_DD_OPT_NO_LIMIT, DK_DD_OPT_RUN_FINALIZE_ON_EXIT, DK_DD_OPT_RUN_FINALIZE_ON_EXIT_NO, DK_DD_OPT_RUN_FINALIZE_ON_EXIT_YES, DK_DD_OPT_SEARCH_OPTION, DK_DD_OPT_SEARCH_OPTION_STEMS, DK_DD_OPT_SEARCH_OPTION_THESAURUS, DK_DD_OPT_SORT_ORDER, DK_DD_OPT_SORT_ORDER_DATE_ASC, DK_DD_OPT_SORT_ORDER_DATE_DES, DK_DD_OPT_SORT_ORDER_SCORES, DK_DD_OVERWRITE, DK_DD_PID_DOC_EXT, DK_DD_PID_DOC_ID, DK_DD_PID_DOC_ID_CNT, DK_DD_PROFILE, DK_DD_ROOM, DK_DD_SERVER_TYPE, DK_DD_TITLE, DK_DD_UNKNOWN
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdDD
copyright, DK_DD_MSG_MSGID_DOMDOC, DK_DD_MSG_MSGID_GOVERNOR, DK_DD_MSG_MSGID_NO_ATTR_OBJ, DK_DD_MSG_MSGID_NO_BINDER_OBJ, DK_DD_MSG_MSGID_NO_CABINET_OBJ, DK_DD_MSG_MSGID_NO_DOCUMENT_OBJ, DK_DD_MSG_MSGID_NO_MESSAGE, DK_DD_MSG_MSGID_NO_ROOM_OBJ, DK_DD_MSG_MSGID_NO_SUCCESS, DK_DD_MSG_MSGID_NUL_PARAM
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKAccessControlDD(dkDatastore ds)
          Constructs the access control and initializes it with the datastore.
 
Method Summary
 void addAccessControlList(java.lang.String acl_name, java.lang.String description, dkCollection access_data)
          Adds an access control list in DD
 void deleteAccessControlList(java.lang.String acl_name)
          Deletes an access control list from DD
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getItemACL(java.lang.String itemID)
          Gets the ACL of the specified item ID
 java.lang.String getName()
          Gets name of the access control
 boolean isAccessControlList(java.lang.String acl_name)
          Determines if the specified name is an access control list
 boolean isAuthorized(java.lang.String privilege_string, int authority)
          Determines if the specified authority is granted for the given privilege string
 boolean isGroup(java.lang.String group_name)
          Determines if the specified name is a group name
 boolean isPrivilege(java.lang.String privilege_name)
          Determines if the specified name is a privilege name
 boolean isUser(java.lang.String user_name)
          Determines if the specified name is a group name
 DKAccessControlListDD listAccessControlList(java.lang.String acl_name)
          Lists a DKAccessControlListDD object based on the specified acl name
 dkCollection listAccessControlLists()
          Lists all the access control lists in DD
 dkCollection listGroups()
          Lists all the groups in DD
 dkCollection listGroups(java.lang.String user_name)
          Lists all the groups which a specified user is part of
 java.lang.String listPrivilege(java.lang.String user_name)
          Lists all the privilege name of the specific user in DD
 dkCollection listPrivileges()
          Lists all the privileges in DD
 java.lang.String listPrivilegeString(java.lang.String privilege_name)
          Lists the privilege bit string of the specified privilege
 dkCollection listUsers()
          Lists all the users in DD
 dkCollection listUsers(java.lang.String group_name)
          Lists all the users in a specified group
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setItemACL(java.lang.String itemID, java.lang.String acl_name)
          Sets the ACL of the specified item ID
 void setName(java.lang.String access_control_name)
          Sets name of the access control
 java.lang.String type()
          Gets type of the access control
 void updateAccessControlList(java.lang.String acl_name, java.lang.String description, dkCollection access_data)
          Updates an access control list in DD
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKAccessControlDD

public DKAccessControlDD(dkDatastore ds)
                  throws DKException
Constructs the access control and initializes it with the datastore.
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
                  throws java.lang.Exception
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkAccessControl

getDatastore

public dkDatastore getDatastore()
                         throws java.lang.Exception
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkAccessControl
Returns:
the dkDatastore object

type

public java.lang.String type()
                      throws java.lang.Exception
Gets type of the access control
Specified by:
type in interface dkAccessControl
Returns:
access control type

getName

public java.lang.String getName()
                         throws java.lang.Exception
Gets name of the access control
Specified by:
getName in interface dkAccessControl
Returns:
access control name

setName

public void setName(java.lang.String access_control_name)
             throws java.lang.Exception
Sets name of the access control
Specified by:
setName in interface dkAccessControl
Parameters:
access_control_name - access control name

addAccessControlList

public void addAccessControlList(java.lang.String acl_name,
                                 java.lang.String description,
                                 dkCollection access_data)
                          throws DKException,
                                 java.lang.Exception
Adds an access control list in DD
Specified by:
addAccessControlList in interface dkAccessControl
Parameters:
acl_name - the name of a new access control list
description - the desctiption of a new access cntrol list
access_data - a collection of access data

updateAccessControlList

public void updateAccessControlList(java.lang.String acl_name,
                                    java.lang.String description,
                                    dkCollection access_data)
                             throws DKException,
                                    java.lang.Exception
Updates an access control list in DD
Specified by:
updateAccessControlList in interface dkAccessControl
Parameters:
acl_name - the name of an existing access control list
description - the desctiption of an existing access cntrol list
access_data - a collection of access data

deleteAccessControlList

public void deleteAccessControlList(java.lang.String acl_name)
                             throws DKException,
                                    java.lang.Exception
Deletes an access control list from DD
Specified by:
deleteAccessControlList in interface dkAccessControl
Parameters:
acl_name - the name of an existing access control list

listAccessControlLists

public dkCollection listAccessControlLists()
                                    throws DKException,
                                           java.lang.Exception
Lists all the access control lists in DD
Specified by:
listAccessControlLists in interface dkAccessControl
Returns:
a collection of access control list names

listAccessControlList

public DKAccessControlListDD listAccessControlList(java.lang.String acl_name)
                                            throws DKException,
                                                   java.lang.Exception
Lists a DKAccessControlListDD object based on the specified acl name
Parameters:
acl_name - the name of an access control list
Returns:
a DKAccessCntrolListDD object

getItemACL

public java.lang.String getItemACL(java.lang.String itemID)
                            throws DKException,
                                   java.lang.Exception
Gets the ACL of the specified item ID
Parameters:
itemID - the name of an item ID
Returns:
the ACL name of the specified item ID

setItemACL

public void setItemACL(java.lang.String itemID,
                       java.lang.String acl_name)
                throws DKException,
                       java.lang.Exception
Sets the ACL of the specified item ID
Parameters:
itemID - the name of an item ID
acl_name - the name of an access control list

listPrivileges

public dkCollection listPrivileges()
                            throws DKException,
                                   java.lang.Exception
Lists all the privileges in DD
Specified by:
listPrivileges in interface dkAccessControl
Returns:
a collection of privilege names

listPrivilege

public java.lang.String listPrivilege(java.lang.String user_name)
                               throws DKException,
                                      java.lang.Exception
Lists all the privilege name of the specific user in DD
Returns:
a privilege name

listUsers

public dkCollection listUsers()
                       throws DKException,
                              java.lang.Exception
Lists all the users in DD
Specified by:
listUsers in interface dkAccessControl
Returns:
a collection of user names

listUsers

public dkCollection listUsers(java.lang.String group_name)
                       throws DKException,
                              java.lang.Exception
Lists all the users in a specified group
Returns:
a collection of user names

listGroups

public dkCollection listGroups()
                        throws DKException,
                               java.lang.Exception
Lists all the groups in DD
Specified by:
listGroups in interface dkAccessControl
Returns:
a collection of group names

listGroups

public dkCollection listGroups(java.lang.String user_name)
                        throws DKException,
                               java.lang.Exception
Lists all the groups which a specified user is part of
Returns:
a collection of group names

isAuthorized

public boolean isAuthorized(java.lang.String privilege_string,
                            int authority)
                     throws DKException,
                            java.lang.Exception
Determines if the specified authority is granted for the given privilege string
Returns:
a boolean value

isAccessControlList

public boolean isAccessControlList(java.lang.String acl_name)
                            throws DKException,
                                   java.lang.Exception
Determines if the specified name is an access control list
Returns:
a boolean value

isPrivilege

public boolean isPrivilege(java.lang.String privilege_name)
                    throws DKException,
                           java.lang.Exception
Determines if the specified name is a privilege name
Returns:
a boolean value

isUser

public boolean isUser(java.lang.String user_name)
               throws DKException,
                      java.lang.Exception
Determines if the specified name is a group name
Returns:
a boolean name

isGroup

public boolean isGroup(java.lang.String group_name)
                throws DKException,
                       java.lang.Exception
Determines if the specified name is a group name
Returns:
a boolean value

listPrivilegeString

public java.lang.String listPrivilegeString(java.lang.String privilege_name)
                                     throws DKException,
                                            java.lang.Exception
Lists the privilege bit string of the specified privilege
Specified by:
listPrivilegeString in interface dkAccessControl
Returns:
a privilege bit string

EIP Java APIs

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