Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkUserManagement

All Known Implementing Classes:
dkAbstractUserMgmt

public interface dkUserManagement

dkUserManagement : This class represents and processes datastore user management functions.


Method Summary
 void add(dkUserDef userDef)
          Adds a new user
 void add(dkUserGroupDef usrGrpDef)
          Adds a new user-group
 void addToGroup(java.lang.String group, java.lang.String userId)
          Deprecated. Replace by update
 void addUser(java.lang.String userId, java.lang.String password)
          Deprecated. Replace by add
 void addUser(java.lang.String userId, java.lang.String password, dkProfile profile)
          Deprecated. Replace by add
 void addUserGroup(java.lang.String groupName)
          Deprecated. Replace by add
 void addUserGroup(java.lang.String groupName, dkProfile groupProfile)
          Deprecated. Replace by add
 void changePassword(java.lang.String userId, java.lang.String oldPwd, java.lang.String newPwd)
          Changes the password of a given user-id
 void clearCache()
          Clear datastore cache
 dkUserDef createUserDef()
          Create user def
 dkUserGroupDef createUserGroupDef()
          Create user group def
 void del(dkUserDef userDef)
          Deletes a user from the system
 void del(dkUserGroupDef usrGrpDef)
          Deletes a user-group from the system
 void deleteUserDef(java.lang.String userName)
          Deletes a user from the system
 void deleteUserGroupDef(java.lang.String userGroupName)
          Deletes a user-group from the system
 void delUser(java.lang.String userId)
          Deprecated. Replace by deleteUserDef
 void delUserGroup(java.lang.String userGrp)
          Deprecated. Replace by deleteUserGroupDef
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 boolean isAdminUser(java.lang.String userName)
          Is specified user an administrative user
 dkCollection listUserDefs()
          Lists users defined in the system
 dkCollection listUserGroupDefs()
          Lists users groups defined in the system
 java.lang.String[] listUserGroups()
          Lists user groups defined in the system
 java.lang.String[] listUsers()
          Lists users defined in the system
 void removeFromGroup(java.lang.String group, java.lang.String userId)
          Deprecated. Replace by update
 dkUserDef retrieveUserDef(java.lang.String userName)
          Gets a user
 dkUserGroupDef retrieveUserGroupDef(java.lang.String userGroupName)
          Retrieve a user group
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void update(dkUserDef userDef)
          Update a user
 void update(dkUserGroupDef usrGrpDef)
          Update a new user-group
 

Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Returns:
the dkDatastore object

retrieveUserDef

public dkUserDef retrieveUserDef(java.lang.String userName)
                          throws DKException,
                                 java.lang.Exception
Gets a user

Note:DKUsageError exception thrown if method is not implemented

Returns:
user defintion

addUser

public void addUser(java.lang.String userId,
                    java.lang.String password)
             throws DKException,
                    java.lang.Exception
Deprecated. Replace by add

Creates a new user-id (with default information)

Note:DKUsageError exception thrown if method is not implemented

See Also:
add(dkUserDef)

addUser

public void addUser(java.lang.String userId,
                    java.lang.String password,
                    dkProfile profile)
             throws DKException,
                    java.lang.Exception
Deprecated. Replace by add

Creates a new user-id according to a given profile The profile is a datastore specific information about the user

Note:DKUsageError exception thrown if method is not implemented

See Also:
add(dkUserDef)

createUserDef

public dkUserDef createUserDef()
                        throws DKException,
                               java.lang.Exception
Create user def

Note:DKUsageError exception thrown if method is not implemented

Returns:
userDef object

add

public void add(dkUserDef userDef)
         throws DKException,
                java.lang.Exception
Adds a new user

Note:DKUsageError exception thrown if method is not implemented


update

public void update(dkUserDef userDef)
            throws DKException,
                   java.lang.Exception
Update a user

Note:DKUsageError exception thrown if method is not implemented


changePassword

public void changePassword(java.lang.String userId,
                           java.lang.String oldPwd,
                           java.lang.String newPwd)
                    throws DKException,
                           java.lang.Exception
Changes the password of a given user-id

Note:DKUsageError exception thrown if method is not implemented


delUser

public void delUser(java.lang.String userId)
             throws DKException,
                    java.lang.Exception
Deprecated. Replace by deleteUserDef

Deletes a user-id from the system

Note:DKUsageError exception thrown if method is not implemented

See Also:
deleteUserDef(java.lang.String)

del

public void del(dkUserDef userDef)
         throws DKException,
                java.lang.Exception
Deletes a user from the system

Note:DKUsageError exception thrown if method is not implemented


deleteUserDef

public void deleteUserDef(java.lang.String userName)
                   throws DKException,
                          java.lang.Exception
Deletes a user from the system

Note:DKUsageError exception thrown if method is not implemented


isAdminUser

public boolean isAdminUser(java.lang.String userName)
                    throws DKNotExistException,
                           DKException,
                           java.lang.Exception
Is specified user an administrative user

Note:DKUsageError exception thrown if method is not implemented


listUsers

public java.lang.String[] listUsers()
                             throws DKException,
                                    java.lang.Exception
Lists users defined in the system

Note:DKUsageError exception thrown if method is not implemented


listUserDefs

public dkCollection listUserDefs()
                          throws DKException,
                                 java.lang.Exception
Lists users defined in the system

Note:DKUsageError exception thrown if method is not implemented


listUserGroups

public java.lang.String[] listUserGroups()
                                  throws DKException,
                                         java.lang.Exception
Lists user groups defined in the system

Note:DKUsageError exception thrown if method is not implemented


listUserGroupDefs

public dkCollection listUserGroupDefs()
                               throws DKException,
                                      java.lang.Exception
Lists users groups defined in the system

Note:DKUsageError exception thrown if method is not implemented


createUserGroupDef

public dkUserGroupDef createUserGroupDef()
                                  throws DKException,
                                         java.lang.Exception
Create user group def

Note:DKUsageError exception thrown if method is not implemented

Returns:
userGroupDef object

retrieveUserGroupDef

public dkUserGroupDef retrieveUserGroupDef(java.lang.String userGroupName)
                                    throws DKException,
                                           java.lang.Exception
Retrieve a user group

Note:DKUsageError exception thrown if method is not implemented

Returns:
user defintion

addUserGroup

public void addUserGroup(java.lang.String groupName)
                  throws DKException,
                         java.lang.Exception
Deprecated. Replace by add

Creates a new user-group (with default information)

Note:DKUsageError exception thrown if method is not implemented

See Also:
add(dkUserGroupDef)

addUserGroup

public void addUserGroup(java.lang.String groupName,
                         dkProfile groupProfile)
                  throws DKException,
                         java.lang.Exception
Deprecated. Replace by add

Creates a new user-group according to a given profile The profile is a datastore specific information about the user-group. It may include a privilege set or other relevant information

Note:DKUsageError exception thrown if method is not implemented

See Also:
add(dkUserGroupDef)

add

public void add(dkUserGroupDef usrGrpDef)
         throws DKException,
                java.lang.Exception
Adds a new user-group

Note:DKUsageError exception thrown if method is not implemented


update

public void update(dkUserGroupDef usrGrpDef)
            throws DKException,
                   java.lang.Exception
Update a new user-group

Note:DKUsageError exception thrown if method is not implemented


delUserGroup

public void delUserGroup(java.lang.String userGrp)
                  throws DKException,
                         java.lang.Exception
Deprecated. Replace by deleteUserGroupDef

Deletes a user-group from the system

Note:DKUsageError exception thrown if method is not implemented

See Also:
deleteUserGroupDef(java.lang.String)

del

public void del(dkUserGroupDef usrGrpDef)
         throws DKException,
                java.lang.Exception
Deletes a user-group from the system

Note:DKUsageError exception thrown if method is not implemented


deleteUserGroupDef

public void deleteUserGroupDef(java.lang.String userGroupName)
                        throws DKException,
                               java.lang.Exception
Deletes a user-group from the system

Note:DKUsageError exception thrown if method is not implemented


addToGroup

public void addToGroup(java.lang.String group,
                       java.lang.String userId)
                throws DKException,
                       java.lang.Exception
Deprecated. Replace by update

Adds a user to a user-group

Note:DKUsageError exception thrown if method is not implemented

See Also:
update(dkUserGroupDef)

removeFromGroup

public void removeFromGroup(java.lang.String group,
                            java.lang.String userId)
                     throws DKException,
                            java.lang.Exception
Deprecated. Replace by update

Removes a user from a user-group

Note:DKUsageError exception thrown if method is not implemented

See Also:
update(dkUserGroupDef)

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear datastore cache

Note:DKUsageError exception thrown if method is not implemented


EIP Java APIs

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