Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKUserMgmtOD

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractUserMgmt
        |
        +--com.ibm.mm.sdk.common.DKUserMgmtOD
All Implemented Interfaces:
DKConstant, DKMessageId, dkUserManagement, java.io.Serializable

public class DKUserMgmtOD
extends dkAbstractUserMgmt
implements DKMessageId, DKConstant

DKUserMgmtOD: This class represents and processes datastore user management functions for a Content Manager datastore.

DKUserMgmtOD does not have a public constructor. A DKUserMgmtOD object is created from a DKDatastoreOD object, as part of a chain for object creations. Use the userManagement() method of DKDatastoreAdminOD to get the DKUserMgmtOD object. The following example illustrates how to access a DKUserMgmtOD object:

    dsOD = new DKDatastoreOD();
     ... // Connect to the datastore
    dsDef = (DKDatastoreDefOD)dsOD.datastoreDef();
    dsAdmin = (DKDatastoreAdminOD)dsDef.datastoreAdmin();
    dsUserMgmt = (DKUserMgmtOD)dsAdmin.userManagement();
 

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
 
Method Summary
 void addToGroup(java.lang.String group, java.lang.String userId)
          Adds a user to a user-group
 void addUser(java.lang.String userId, java.lang.String password)
          Creates a new user-id (with default information)
 void addUser(java.lang.String userId, java.lang.String password, dkProfile profile)
          Creates a new user-id according to a given profile The profile is a datastore specific information about the user
 void addUserGroup(java.lang.String groupName)
          Creates a new user-group (with default information)
 void addUserGroup(java.lang.String groupName, dkProfile groupProfile)
          Creates a new user-group according to a given profile The profile is a datastore specific information about the user-group.
 void changePassword(java.lang.String userId, java.lang.String oldPwd, java.lang.String newPwd)
          Changes the password of a given user-id
 void delUser(java.lang.String userId)
          Deletes a user-id from the system
 void delUserGroup(java.lang.String userGrp)
          Deletes a user-group from the system
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 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)
          Removes a user from a user-group
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractUserMgmt
add, add, clearCache, createUserDef, createUserGroupDef, del, del, deleteUserDef, deleteUserGroupDef, isAdminUser, listUserDefs, listUserGroupDefs, retrieveUserDef, retrieveUserGroupDef, update, update
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Overrides:
setDatastore in class dkAbstractUserMgmt

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Overrides:
getDatastore in class dkAbstractUserMgmt
Returns:
the dkDatastore object

addUser

public void addUser(java.lang.String userId,
                    java.lang.String password)
             throws DKException,
                    java.lang.Exception
Creates a new user-id (with default information)
Overrides:
addUser in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.add(dkUserDef)

addUser

public void addUser(java.lang.String userId,
                    java.lang.String password,
                    dkProfile profile)
             throws DKException,
                    java.lang.Exception
Creates a new user-id according to a given profile The profile is a datastore specific information about the user
Overrides:
addUser in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.add(dkUserDef)

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
Overrides:
changePassword in class dkAbstractUserMgmt

delUser

public void delUser(java.lang.String userId)
             throws DKException,
                    java.lang.Exception
Deletes a user-id from the system
Overrides:
delUser in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.del(dkUserDef)

listUsers

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

listUserGroups

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

addUserGroup

public void addUserGroup(java.lang.String groupName)
                  throws DKException,
                         java.lang.Exception
Creates a new user-group (with default information)
Overrides:
addUserGroup in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.add(dkUserGroupDef)

addUserGroup

public void addUserGroup(java.lang.String groupName,
                         dkProfile groupProfile)
                  throws DKException,
                         java.lang.Exception
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
Overrides:
addUserGroup in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.add(dkUserGroupDef)

delUserGroup

public void delUserGroup(java.lang.String userGrp)
                  throws DKException,
                         java.lang.Exception
Deletes a user-group from the system
Overrides:
delUserGroup in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.deleteUserGroupDef(java.lang.String)

addToGroup

public void addToGroup(java.lang.String group,
                       java.lang.String userId)
                throws DKException,
                       java.lang.Exception
Adds a user to a user-group
Overrides:
addToGroup in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.update(dkUserGroupDef)

removeFromGroup

public void removeFromGroup(java.lang.String group,
                            java.lang.String userId)
                     throws DKException,
                            java.lang.Exception
Removes a user from a user-group
Overrides:
removeFromGroup in class dkAbstractUserMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractUserMgmt
See Also:
dkAbstractUserMgmt.update(dkUserGroupDef)

EIP Java APIs

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