Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAccessControlIP

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKAccessControlIP
All Implemented Interfaces:
dkAccessControl, DKConstant, DKConstantIP, DKMessageId, DKMessageIdIP, java.io.Serializable

public class DKAccessControlIP
extends java.lang.Object
implements dkAccessControl, DKConstantIP, DKMessageIdIP, java.io.Serializable

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

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantIP
    For details, see the class or interface
 
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.DKMessageIdIP
copyright, DK_IP_MSG_API_PROTOCOL_ERROR, DK_IP_MSG_CLIENT_API_NOT_OK, DK_IP_MSG_DATASTORE_READONLY, DK_IP_MSG_DOCIDNOTSET, DK_IP_MSG_FAF_ERROR, DK_IP_MSG_FAF_INTERNAL_ERROR, DK_IP_MSG_FAF_NOT_OK, DK_IP_MSG_FAF_WARNING, DK_IP_MSG_FOLDER_NOT_EMPTY, DK_IP_MSG_HOST_TIMEOUT, DK_IP_MSG_INVALID_CONN_OPTION, DK_IP_MSG_INVALID_DOCTYPE, DK_IP_MSG_INVALID_IODM_RC, DK_IP_MSG_INVALID_PARM, DK_IP_MSG_IODM_FAILURE, DK_IP_MSG_IODM_NOT_AVAILABLE, DK_IP_MSG_LOCKEDBYANOTHER, DK_IP_MSG_MISSING_CONN_OPTION, DK_IP_MSG_MSGID_NOT_FOUND, DK_IP_MSG_PROTOCOL_ERROR
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKAccessControlIP(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 IP Note: For IP/390 this method is not supported.
 void deleteAccessControlList(java.lang.String acl_name)
          Deletes an access control list from IP Note: For IP/390 this method is not supported.
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getName()
          Gets name of the access control
 dkCollection listAccessControlLists()
          Lists all the access control lists in IP Note: For IP/390 this will always be an empty list.
 dkCollection listGroups()
          Lists all the groups in IP Note: For IP/390 this will always be an empty list.
 dkCollection listPrivileges()
          Lists all the privileges in IP Note: For IP/390 this will always be an empty list.
 java.lang.String listPrivilegeString(java.lang.String privilege_name)
          Lists the privilege bit string of the specified privilege Note: For IP/390 this will always be an empty string ("").
 dkCollection listUsers()
          Lists all the users in IP Note: For IP/390 this will always be an empty list.
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setName(java.lang.String access_control_name)
          Sets the name of the access control
 java.lang.String type()
          Gets the type of the access control, which is DK_ACTYPE_IP.
 void updateAccessControlList(java.lang.String acl_name, java.lang.String description, dkCollection access_data)
          Updates an access control list in IP Note: For IP/390 this method is not supported.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKAccessControlIP

public DKAccessControlIP(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 the type of the access control, which is DK_ACTYPE_IP.
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 the 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 IP Note: For IP/390 this method is not supported. A DKUsageError expection will be thrown
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 IP Note: For IP/390 this method is not supported. A DKUsageError expection will be thrown
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 IP Note: For IP/390 this method is not supported. A DKUsageError expection will be thrown
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 IP Note: For IP/390 this will always be an empty list.
Specified by:
listAccessControlLists in interface dkAccessControl
Returns:
a collection of access control list names

listPrivileges

public dkCollection listPrivileges()
                            throws DKException,
                                   java.lang.Exception
Lists all the privileges in IP Note: For IP/390 this will always be an empty list.
Specified by:
listPrivileges in interface dkAccessControl
Returns:
a collection of privilege names

listUsers

public dkCollection listUsers()
                       throws DKException,
                              java.lang.Exception
Lists all the users in IP Note: For IP/390 this will always be an empty list.
Specified by:
listUsers in interface dkAccessControl
Returns:
a collection of user names

listGroups

public dkCollection listGroups()
                        throws DKException,
                               java.lang.Exception
Lists all the groups in IP Note: For IP/390 this will always be an empty list.
Specified by:
listGroups in interface dkAccessControl
Returns:
a collection of group names

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 Note: For IP/390 this will always be an empty string ("").
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.