Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAccessControlV4

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKAccessControlV4
All Implemented Interfaces:
dkAccessControl, DKConstant, DKConstantV4, DKMessageId, DKMessageIdV4, java.io.Serializable

public class DKAccessControlV4
extends java.lang.Object
implements dkAccessControl, DKConstantV4, DKMessageIdV4, java.io.Serializable

DKAccessControlV4 : This class represents and processes the datastore access control functions.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantV4
    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.DKMessageIdV4
copyright, DK_V4_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKAccessControlV4(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 V4 - not supported by this datastore type
 void deleteAccessControlList(java.lang.String acl_name)
          Deletes an access control list from V4 - not supported by this datastore type
 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 - not supported by this datastore type
 java.lang.String getName()
          Gets the name of the access control - not supported by this datastore type
 boolean isAccessControlList(java.lang.String acl_name)
          Determines if the specified name is an access control list - not supported by this datastore type
 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 - not supported by this datastore type
 boolean isPrivilege(java.lang.String privilege_name)
          Determines if the specified name is a privilege name - not supported by this datastore type
 boolean isUser(java.lang.String user_name)
          Determines if the specified name is a group name - not supported by this datastore type
 DKAccessControlListV4 listAccessControlList(java.lang.String acl_name)
          Lists a DKAccessControlListV4 object based on the specified acl name - not supported by this datastore type
 dkCollection listAccessControlLists()
          Lists all the access control lists in V4 - not supported by this datastore type
 dkCollection listGroups()
          Lists all the groups in VI400 - not supported by this datastore type
 dkCollection listGroups(java.lang.String user_name)
          Lists all the groups which a specified user is part of - not supported by this datastore type
 java.lang.String listPrivilege(java.lang.String user_name)
          Lists all the privilege name of the specific user in VI400 - not supported by this datastore type
 dkCollection listPrivileges()
          Lists all the privileges in V4 - not supported by this datastore type
 java.lang.String listPrivilegeString(java.lang.String privilege_name)
          Lists the privilege bit string of the specified privilege - not supported by this datastore typ
 dkCollection listUsers()
          Lists all the users in V4 - not supported by this datastore type
 dkCollection listUsers(java.lang.String group_name)
          Lists all the users in a specified group - not supported by this datastore type
 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 - not supported by this datastore type
 void setName(java.lang.String accessControlName)
          Sets the name of the access control - not supported by this datastore type
 java.lang.String type()
          Gets the 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 V4 - not supported by this datastore type
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKAccessControlV4

public DKAccessControlV4(dkDatastore ds)
                  throws DKException
Constructs the access control and initializes it with the datastore.
Parameters:
ds - the dkDatastore object
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
Parameters:
ds - the dkDatastore object

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
Specified by:
type in interface dkAccessControl
Returns:
the access control type

getName

public java.lang.String getName()
                         throws java.lang.Exception
Gets the name of the access control - not supported by this datastore type
Specified by:
getName in interface dkAccessControl
Returns:
the access control name - always ""

setName

public void setName(java.lang.String accessControlName)
             throws java.lang.Exception
Sets the name of the access control - not supported by this datastore type
Specified by:
setName in interface dkAccessControl
Parameters:
accessControlName - the access control name
Throws:
DKException - always

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 V4 - not supported by this datastore type
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
Throws:
DKException - always

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 V4 - not supported by this datastore type
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
Throws:
DKException - always

deleteAccessControlList

public void deleteAccessControlList(java.lang.String acl_name)
                             throws DKException,
                                    java.lang.Exception
Deletes an access control list from V4 - not supported by this datastore type
Specified by:
deleteAccessControlList in interface dkAccessControl
Parameters:
acl_name - the name of an existing access control list
Throws:
DKException - always

listAccessControlLists

public dkCollection listAccessControlLists()
                                    throws DKException,
                                           java.lang.Exception
Lists all the access control lists in V4 - not supported by this datastore type
Specified by:
listAccessControlLists in interface dkAccessControl
Returns:
a collection of access control list names - always null

listAccessControlList

public DKAccessControlListV4 listAccessControlList(java.lang.String acl_name)
                                            throws DKException,
                                                   java.lang.Exception
Lists a DKAccessControlListV4 object based on the specified acl name - not supported by this datastore type
Parameters:
acl_name - the name of an access control list
Returns:
a DKAccessCntrolListV4 object - always null

getItemACL

public java.lang.String getItemACL(java.lang.String itemID)
                            throws DKException,
                                   java.lang.Exception
Gets the ACL of the specified item ID - not supported by this datastore type
Parameters:
itemID - the name of an item ID
Returns:
the ACL name of the specified item ID - always ""

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 - not supported by this datastore type
Parameters:
itemID - the name of an item ID
acl_name - the name of an access control list
Throws:
DKException - always

listPrivileges

public dkCollection listPrivileges()
                            throws DKException,
                                   java.lang.Exception
Lists all the privileges in V4 - not supported by this datastore type
Specified by:
listPrivileges in interface dkAccessControl
Returns:
a collection of privilege names - always null

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 VI400 - not supported by this datastore type
Returns:
a privilege name - always ""

listUsers

public dkCollection listUsers()
                       throws DKException,
                              java.lang.Exception
Lists all the users in V4 - not supported by this datastore type
Specified by:
listUsers in interface dkAccessControl
Returns:
a collection of user names - always null

listUsers

public dkCollection listUsers(java.lang.String group_name)
                       throws DKException,
                              java.lang.Exception
Lists all the users in a specified group - not supported by this datastore type
Returns:
a collection of user names - always null

listGroups

public dkCollection listGroups()
                        throws DKException,
                               java.lang.Exception
Lists all the groups in VI400 - not supported by this datastore type
Specified by:
listGroups in interface dkAccessControl
Returns:
a collection of group names - always null

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 - not supported by this datastore type
Returns:
a collection of group names - always null

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 - not supported by this datastore type
Returns:
a boolean value - always false

isPrivilege

public boolean isPrivilege(java.lang.String privilege_name)
                    throws DKException,
                           java.lang.Exception
Determines if the specified name is a privilege name - not supported by this datastore type
Returns:
a boolean value - always false

isUser

public boolean isUser(java.lang.String user_name)
               throws DKException,
                      java.lang.Exception
Determines if the specified name is a group name - not supported by this datastore type
Returns:
a boolean value - always false

isGroup

public boolean isGroup(java.lang.String group_name)
                throws DKException,
                       java.lang.Exception
Determines if the specified name is a group name - not supported by this datastore type
Returns:
a boolean value - always false

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 - not supported by this datastore typ
Specified by:
listPrivilegeString in interface dkAccessControl
Returns:
a privilege bit string - always ""

EIP Java APIs

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