|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractUserDef | +--com.ibm.mm.sdk.common.DKUserDefICM
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.
GENERAL COMMENT - THOUGH THE WHOLE PRODUCT CALLS THE PLACE TO STORE RESOURCES AS RESOURCE MANAGER THIS CLASS
CALLS THEM OBJECT SERVER.
, Serialized FormFields 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 |
public DKUserDefICM()
This class represents a user in the library server..
DKUserDefICM user = new DKUserDefICM(); user.setDatastore(ds);
dkUserDef
,
dkAbstractUserDef
public DKUserDefICM(dkDatastore ds)
This class represents a user in the library server.
DKUserDefICM user = new DKUserDefICM(ds);
dkUserDef
,
dkAbstractUserDef
public DKUserDefICM(java.lang.String name)
This class represents a user in the library server.
DKUserDefICM user = new DKUserDefICM(String name);
name
- name of a user. It can be up to 32 characters long.dkUserDef
,
dkAbstractUserDef
Method Detail |
public java.lang.String getName()
getName
in class dkAbstractUserDef
public void setName(java.lang.String name)
setName
in class dkAbstractUserDef
name
- the name for the user.The name can be up to 32 characters long.public java.lang.String getDescription()
getDescription
in class dkAbstractUserDef
public void setDescription(java.lang.String desc)
setDescription
in class dkAbstractUserDef
desc
- - the user description. The description can be up to 128 characters long.public java.lang.String getUserPWD()
public void setUserPWD(java.lang.String pwd)
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.public int getPwdExpire()
public void setPwdExpire(int expire)
expire
- int - password expiration days for this userpublic java.lang.String getPrivSetName()
public void setPrivSetName(java.lang.String privSetName)
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.public java.lang.String getGrantPrivSetName()
public void setGrantPrivSetName(java.lang.String name)
grantPrivSetName
- String - name of grant privilege set to be assigned to this userpublic java.lang.String getDflItemACLName()
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.
public void setDflItemACLName(java.lang.String name)
name
- String - the default item ACL name to be assigned to this user.
The string can be up to 32 characters longpublic java.lang.String getObjServerName()
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.
listResourceMgrs.
public void setObjServerName(java.lang.String name)
name
- name of the resource manager to be assigned to this user.listResourceMgrs.
public java.lang.String getCollName()
public void setCollName(java.lang.String smsCollName)
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.public java.lang.String getDomainName()
public void setDomainName(java.lang.String name)
name
- - name of the admin domain to be assigned to this user..The name can be
up to 32 characters long.public java.lang.String getUserDN()
public void setUserDN(java.lang.String name)
name
- String - the distinguish name to be assigned to this user.public boolean isNameChanged()
public java.lang.String getOldName()
public boolean isSysPswd()
public void setSysPswd(boolean b)
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |