Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKUserDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractUserDef
        |
        +--com.ibm.mm.sdk.common.DKUserDefICM
All Implemented Interfaces:
DKMessageId, DKMessageIdICM, dkUserDef, java.io.Serializable

public class DKUserDefICM
extends dkAbstractUserDef
implements DKMessageIdICM, java.io.Serializable

The DKUserDefICM class is the implementation of the abstract dkUserDef. Use this class to represent a user in the ICM datastore in your program. This class provides facilities to manage a user in the datastore such as the user's name, description, password, default SMS collection, default ACL code, user's privilege set, user's default resource manager etc.

See Also:
GENERAL COMMENT - THOUGH THE WHOLE PRODUCT CALLS THE PLACE TO STORE RESOURCES AS RESOURCE MANAGER THIS CLASS CALLS THEM OBJECT SERVER., Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKUserDefICM()
          Constructs and initializes a user class.
DKUserDefICM(dkDatastore ds)
          Constructs and initializes a user class associated with a given datastore.
DKUserDefICM(java.lang.String name)
          Constructs and initializes a user class with a specified user name.
 
Method Summary
 java.lang.String getCollName()
          Gets the user's default SMS collection name.
 java.lang.String getDescription()
          Gets the user's description
 java.lang.String getDflItemACLName()
          Gets the user's default item ACL name
 java.lang.String getDomainName()
          Gets the user's administrative domain name.
 java.lang.String getGrantPrivSetName()
          Gets Grant Privilege Set Name which was assigned to this user
 java.lang.String getName()
          Gets the user's name
 java.lang.String getObjServerName()
          Gets the user's default resource manager name
 java.lang.String getOldName()
          Deprecated.  
 java.lang.String getPrivSetName()
          Gets Privilege Set Name
 int getPwdExpire()
          Gets the user's password expiration.
 java.lang.String getUserDN()
          Gets user's distinguish name.
 java.lang.String getUserPWD()
          Gets the user password
 boolean isNameChanged()
          Deprecated.  
 boolean isSysPswd()
          Checks to see if this user use system defined password
 void setCollName(java.lang.String smsCollName)
          Sets default collection name
 void setDescription(java.lang.String desc)
          Sets the user's description
 void setDflItemACLName(java.lang.String name)
          Sets the user's default item ACL name
 void setDomainName(java.lang.String name)
          Sets the user's administrative domain name.
 void setGrantPrivSetName(java.lang.String name)
          Sets grant privilege set name
 void setName(java.lang.String name)
          Sets the user's name
 void setObjServerName(java.lang.String name)
          Sets the user's default resource manager name.
 void setPrivSetName(java.lang.String privSetName)
          Sets privilege set name
 void setPwdExpire(int expire)
          Sets user password expiration days The expired value is greater than 0 indicates the password will expire in that many days.
 void setSysPswd(boolean b)
          set this user is sysPswd enabled or not
 void setUserDN(java.lang.String name)
          Sets distinguish name for the user.
 void setUserPWD(java.lang.String pwd)
          Sets the user password
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractUserDef
changePassword, datastoreType, getDatastore, getFullName, setDatastore, setFullName, setPassword
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKUserDefICM

public DKUserDefICM()
Constructs and initializes a user class. The datastore should be initialized and a connection should exits before persisting this object in the datastore. The setDatastore method can be used to set the datastore.

This class represents a user in the library server..

 DKUserDefICM user = new DKUserDefICM(); 
 user.setDatastore(ds); 
 
See Also:
dkUserDef, dkAbstractUserDef

DKUserDefICM

public DKUserDefICM(dkDatastore ds)
Constructs and initializes a user class associated with a given datastore. The datastore should be initialized and a connection should exits before persisting this object in the datastore. The setDatastore method can be used to set the datastore.

This class represents a user in the library server.

 DKUserDefICM user = new DKUserDefICM(ds);
 
See Also:
dkUserDef, dkAbstractUserDef

DKUserDefICM

public DKUserDefICM(java.lang.String name)
Constructs and initializes a user class with a specified user name.

This class represents a user in the library server.

  DKUserDefICM user = new DKUserDefICM(String name);
  
Parameters:
name - name of a user. It can be up to 32 characters long.
See Also:
dkUserDef, dkAbstractUserDef
Method Detail

getName

public java.lang.String getName()
Gets the user's name
Overrides:
getName in class dkAbstractUserDef
Returns:
_name - the name of the user

setName

public void setName(java.lang.String name)
Sets the user's name
Overrides:
setName in class dkAbstractUserDef
Parameters:
name - the name for the user.The name can be up to 32 characters long.

getDescription

public java.lang.String getDescription()
Gets the user's description
Overrides:
getDescription in class dkAbstractUserDef
Returns:
_desc - user description

setDescription

public void setDescription(java.lang.String desc)
Sets the user's description
Overrides:
setDescription in class dkAbstractUserDef
Parameters:
desc - - the user description. The description can be up to 128 characters long.

getUserPWD

public java.lang.String getUserPWD()
Gets the user password
Returns:
_pwd - the password for the user.The password string can be up to 31 characters long. if this user object was returned from the datastore. The password will not be the original password.

setUserPWD

public void setUserPWD(java.lang.String pwd)
Sets the user password
Parameters:
pwd - password for the user. For a new instance of the object, when the object is persisted to the datastore, the password will be encoded and hashed. Thus once the object is persisted, the password cannot be retrieved in a legible format.

getPwdExpire

public int getPwdExpire()
Gets the user's password expiration. This returns the number in days. The returned value is greater than 0 indicates the password will expire in that many days. The returned value is equals to 0 indicates the password never expires The returned value is equals to -1 indicates password expires immediately
Returns:
_pwdExpire - pswd expiration for this user

setPwdExpire

public void setPwdExpire(int expire)
Sets user password expiration days The expired value is greater than 0 indicates the password will expire in that many days. The expired value is equals to 0 indicates the password never expires The expired value is equals to -1 indicates password expires immediately
Parameters:
expire - int - password expiration days for this user

getPrivSetName

public java.lang.String getPrivSetName()
Gets Privilege Set Name
Returns:
_privSetName The privilege set name asigned to this user.

setPrivSetName

public void setPrivSetName(java.lang.String privSetName)
Sets privilege set name
Parameters:
privSetName - String - name of privilege set to be assigned to this user. The privilege set name can be up to 32 characters long and this privilege set name should be defined before persisting this user object.

getGrantPrivSetName

public java.lang.String getGrantPrivSetName()
Gets Grant Privilege Set Name which was assigned to this user
Returns:
_grantPrivSetName

setGrantPrivSetName

public void setGrantPrivSetName(java.lang.String name)
Sets grant privilege set name
Parameters:
grantPrivSetName - String - name of grant privilege set to be assigned to this user

getDflItemACLName

public java.lang.String getDflItemACLName()
Gets the user's default item ACL name

If this user does not provide a ACL for the items that this user creates. the ICM datastore will assign this default item ACL code. This assignment of default ACL also depends on the ICM datastore setting on how to treat in such situations.

Returns:
_dflItemACLName - The default Item ACL code assigned to this user.

setDflItemACLName

public void setDflItemACLName(java.lang.String name)
Sets the user's default item ACL name
Parameters:
name - String - the default item ACL name to be assigned to this user. The string can be up to 32 characters long

getObjServerName

public java.lang.String getObjServerName()
Gets the user's default resource manager name

A default resource manager assigned to a user is where the resource items created by this user is stored by default. The user may override the default resource manager when the resource item is created.

Returns:
_objServerName String - name of the resource manager to be associated with the user
See Also:
listResourceMgrs.

setObjServerName

public void setObjServerName(java.lang.String name)
Sets the user's default resource manager name. Note: A default resource manager assigned to a user is where the resource items created by this user is stored by default. The user may override the default resource manager when the resource item is created.
Parameters:
name - name of the resource manager to be assigned to this user.
See Also:
listResourceMgrs.

getCollName

public java.lang.String getCollName()
Gets the user's default SMS collection name. Note: A default SMS collection assigned to a user is the collection where the resource items created by this user is stored by default. The user may override the default SMS collection when the resource item is created.
Returns:
_collName String - The user's default SMS collection name.
See Also:

setCollName

public void setCollName(java.lang.String smsCollName)
Sets default collection name
Parameters:
smsCollName - String - name of the default collection to be assigned to this user.. Note: A default SMS collection assigned to a user is the collection where the resource items created by this user is stored by default. The user may override the default SMS collection when the resource item is created.
See Also:

getDomainName

public java.lang.String getDomainName()
Gets the user's administrative domain name.
Returns:
domainName - administrative domain name to be assigned to this user

setDomainName

public void setDomainName(java.lang.String name)
Sets the user's administrative domain name.
Parameters:
name - - name of the admin domain to be assigned to this user..The name can be up to 32 characters long.

getUserDN

public java.lang.String getUserDN()
Gets user's distinguish name. This is the additional information for the user
Returns:
userDN - the distinguish name to be assigned to this user

setUserDN

public void setUserDN(java.lang.String name)
Sets distinguish name for the user. This is the additional information for the user
Parameters:
name - String - the distinguish name to be assigned to this user.

isNameChanged

public boolean isNameChanged()
Deprecated.  

Checks to see if the user name have been changed
Returns:
true if has been changed, false otherwise

getOldName

public java.lang.String getOldName()
Deprecated.  

Gets user old name
Returns:
_oldName - old name of this user

isSysPswd

public boolean isSysPswd()
Checks to see if this user use system defined password
Returns:
true if user use the system defined password

setSysPswd

public void setSysPswd(boolean b)
set this user is sysPswd enabled or not

EIP Java APIs

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