Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractUserMgmt

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractUserMgmt
All Implemented Interfaces:
DKConstant, DKMessageId, dkUserManagement, java.io.Serializable
Direct Known Subclasses:
DKUserMgmtDL, DKUserMgmtFed, DKUserMgmtICM, DKUserMgmtIP, DKUserMgmtOD, DKUserMgmtV4

public class dkAbstractUserMgmt
extends java.lang.Object
implements dkUserManagement, DKMessageId, DKConstant, java.io.Serializable

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

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
dkAbstractUserMgmt()
          Constructs a new dkAbstractUserMgmt class without owner datastore object.
dkAbstractUserMgmt(dkDatastore ds)
          Constructs a new dkAbstractUserMgmt class with owner datastore object
 
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 del
 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)
          Retrieve a user
 dkUserGroupDef retrieveUserGroupDef(java.lang.String userGroupName)
          Gets 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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractUserMgmt

public dkAbstractUserMgmt()
Constructs a new dkAbstractUserMgmt class without owner datastore object.

dkAbstractUserMgmt

public dkAbstractUserMgmt(dkDatastore ds)
Constructs a new dkAbstractUserMgmt class with owner datastore object
Parameters:
ds - reference to owner datastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkUserManagement

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkUserManagement
Returns:
the dkDatastore object

createUserDef

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
createUserDef in interface dkUserManagement
Returns:
userDef object

retrieveUserDef

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrieveUserDef in interface dkUserManagement
Returns:
user defintion

add

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
add in interface dkUserManagement

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

Specified by:
addUser in interface dkUserManagement
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

Specified by:
addUser in interface dkUserManagement
See Also:
add(dkUserDef)

update

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
update in interface dkUserManagement

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

Specified by:
changePassword in interface dkUserManagement

delUser

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

Deletes a user-id from the system

Note:DKUsageError exception thrown if method is not implemented

Specified by:
delUser in interface dkUserManagement
See Also:
del(dkUserDef)

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

Specified by:
del in interface dkUserManagement

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

Specified by:
deleteUserDef in interface dkUserManagement

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

Specified by:
listUsers in interface dkUserManagement

listUserDefs

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listUserDefs in interface dkUserManagement

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

Specified by:
listUserGroups in interface dkUserManagement

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

Specified by:
listUserGroupDefs in interface dkUserManagement

createUserGroupDef

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
createUserGroupDef in interface dkUserManagement
Returns:
userGroupDef object

retrieveUserGroupDef

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrieveUserGroupDef in interface dkUserManagement
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

Specified by:
addUserGroup in interface dkUserManagement
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

Specified by:
addUserGroup in interface dkUserManagement
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

Specified by:
add in interface dkUserManagement

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

Specified by:
update in interface dkUserManagement

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

Specified by:
delUserGroup in interface dkUserManagement
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

Specified by:
del in interface dkUserManagement

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

Specified by:
deleteUserGroupDef in interface dkUserManagement

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

Specified by:
addToGroup in interface dkUserManagement
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

Specified by:
removeFromGroup in interface dkUserManagement
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

Specified by:
clearCache in interface dkUserManagement

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

Specified by:
isAdminUser in interface dkUserManagement

EIP Java APIs

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