public interface IDfUser extends IDfPersistentObject
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
void |
changeHomeDocbase(java.lang.String userName,
boolean isImmediate)
Change the home repository of this user.
|
java.lang.String |
getACLDomain()
Returns the domain of the ACL associated with a user.
|
java.lang.String |
getACLName()
Returns the name of the ACL associated with a user.
|
java.lang.String |
getAliasSet()
Returns the name of the user's default alias set.
|
IDfId |
getAliasSetId()
Returns the object ID of the user's default alias set.
|
int |
getClientCapability()
Returns the client capability as an integer.
|
java.lang.String |
getDefaultFolder()
Returns the default folder for a user.
|
java.lang.String |
getDescription()
Returns the user-defined description for a user.
|
int |
getFailedAuthenticationAttempts()
Returns the number of failed attempts to authenticate the user.
|
int |
getGroupDefPermit()
Returns the default group permission assigned to objects created by a user.
|
java.lang.String |
getHomeDocbase()
Returns the user's home repository.
|
IDfTime |
getModifyDate()
Returns the time and date that a user was last modified.
|
int |
getOwnerDefPermit()
Returns the default owner permission assigned to objects created by a user.
|
java.lang.String |
getUserAddress()
Returns the user's electronic mail address.
|
java.lang.String |
getUserDBName()
Returns the user's RDBMS user name.
|
java.lang.String |
getUserDelegation()
Returns the names of the user for workflow delegation.
|
java.lang.String |
getUserDistinguishedLDAPName()
Returns the user's distinguished name in LDAP.
|
java.lang.String |
getUserGroupName()
Returns the user's default group.
|
java.lang.String |
getUserLoginName()
Returns the user's Documentum user login name.
|
java.lang.String |
getUserName()
Returns the user's Documentum user name.
|
java.lang.String |
getUserOSDomain()
Returns the user's Windows NT domain name.
|
java.lang.String |
getUserOSName()
Returns the user's operating system user name.
|
java.lang.String |
getUserPassword()
Gets the user password for inline users.
|
int |
getUserPrivileges()
Returns the user's basic privileges.
|
int |
getUserSource()
Deprecated.
As of DFC 5.2.5, replaced by getUserSourceAsString()
|
java.lang.String |
getUserSourceAsString()
Returns this user's source.
|
int |
getUserState()
Returns the availability of a user to process workitems.
|
int |
getUserXPrivileges()
Returns the user's extended privileges.
|
int |
getWorldDefPermit()
Returns the default world permission assigned to objects created by a user.
|
boolean |
hasEvents()
Returns
true , if the user is registered for auditable events; false otherwise. |
boolean |
hasSession()
Check to see if this user has an active repository session.
|
boolean |
isGloballyManaged()
Indicates whether the ACL associated with a user is managed globally or locally.
|
boolean |
isGroup()
Returns a Boolean value indicating whether a user is a group or an individual user.
|
boolean |
isSuperUser()
Indicates whether a user has the SUPERUSER privilege for the current repository.
|
boolean |
isSystemAdmin()
Indicates whether a user has the SYSADMIN privilege for the current repository.
|
boolean |
isWorkflowDisabled()
Returns a boolean value indicating the user's availability for workflow.
|
void |
renameUser(java.lang.String userName,
boolean isImmediate,
boolean unlockObjects,
boolean reportOnly)
Renames this user.
|
void |
setAliasSet(java.lang.String aliasSetName)
Sets the default alias set for this user.
|
void |
setClientCapability(int clientCapability)
Sets the client capability for this user
|
void |
setDefaultACL(java.lang.String aclName)
Sets the default ACL for this user to a system ACL (owned by the repository owner).
|
void |
setDefaultACLEx(java.lang.String domainName,
java.lang.String aclName)
Sets the default ACL for this user.
|
void |
setDefaultFolder(java.lang.String folderPath,
boolean isPrivate)
Sets the default folder for this user.
|
void |
setDescription(java.lang.String description)
Sets the default description for this user.
|
void |
setFailedAuthenticationAttempts(int failedAttempts)
Sets the number of failed attempts to authenticate the user.
|
void |
setGloballyManaged(boolean isGloballyManaged)
Sets the user as either global (managed by federation) or local.
|
void |
setHomeDocbase(java.lang.String docbaseName)
Sets this user's home repository.
|
void |
setUserAddress(java.lang.String userAddress)
Sets the user's email address.
|
void |
setUserDBName(java.lang.String userDBName)
Sets this user's RDBMS user name.
|
void |
setUserDelegation(java.lang.String delegateUserName)
Sets the name of the user to whom to delegate work items.
|
void |
setUserGroupName(java.lang.String userGroupName)
Sets this user's default group.
|
void |
setUserLoginName(java.lang.String userLoginName)
Sets the user's Documentum user login name To change the user login name of an existing user.
|
void |
setUserName(java.lang.String userName)
Sets the name of this user.
|
void |
setUserOSName(java.lang.String accountName,
java.lang.String domainName)
Sets this user's authentication information: operating system account name and domain.
|
void |
setUserPassword(java.lang.String value)
Sets the user password for inline users.
|
void |
setUserPrivileges(int userPrivileges)
Sets this user's privileges level.
|
void |
setUserSource(int userSource)
Deprecated.
As of DFC 5.2.5, replaced by setUserSourceAsString(String)
|
void |
setUserSourceAsString(java.lang.String userSource)
Sets this user's source.
|
void |
setUserState(int userState,
boolean unlockObjects)
Sets this user's activation state (active/inactive).
|
void |
setUserXPrivileges(int userXPrivileges)
Sets the user's extended privileges.
|
void |
setWorkflowDisabled(boolean disabled)
Sets whether this user is workflow disabled.
|
void |
setWriteFederationLogOption(int options)
Sets the options on various properties to write to the federation log when properties are changed.
|
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
static final int DF_PRIVILEGE_NONE
static final int DF_PRIVILEGE_CREATE_TYPE
static final int DF_PRIVILEGE_CREATE_CABINET
static final int DF_PRIVILEGE_CREATE_GROUP
static final int DF_PRIVILEGE_SYSADMIN
static final int DF_PRIVILEGE_SUPERUSER
static final int DF_XPRIVILEGE_CONFIG_AUDIT
static final int DF_XPRIVILEGE_PURGE_AUDIT
static final int DF_XPRIVILEGE_VIEW_AUDIT
static final int DF_USER_ACTIVE
static final int DF_USER_INACTIVE
static final int DF_USER_LOCKED
static final int DF_USER_LOCKED_INACTIVE
static final int DF_AUTHENTICATE_USER_DEFINED
static final int DF_AUTHENTICATE_NONE
static final int DF_AUTHENTICATE_LDAP
static final int DF_AUTHENTICATE_UNIX_ONLY
static final int DF_AUTHENTICATE_DOMAIN_ONLY
static final int DF_AUTHENTICATE_UNIX_FIRST
static final int DF_AUTHENTICATE_DOMAIN_FIRST
static final int DF_AUTHENTICATE_KERBEROS
static final int DF_AUTHENTICATE_OTDS
static final int DF_CAPABILITY_NONE
static final int DF_CAPABILITY_CONSUMER
static final int DF_CAPABILITY_CONTRIBUTOR
static final int DF_CAPABILITY_COORDINATOR
static final int DF_CAPABILITY_SYSTEM_ADMIN
static final int DF_WRITE_CLIENT_CAPABILITY_LOG
static final int DF_WRITE_PRIVILEGES_LOG
static final int DF_WRITE_USER_STATE_LOG
static final int DF_WRITE_WF_DISABLED_LOG
static final int DF_WRITE_XPRIVILEGES_LOG
java.lang.String getUserName() throws DfException
DfException
- if a server error occursjava.lang.String getUserOSName() throws DfException
DfException
- if a server error occursjava.lang.String getUserAddress() throws DfException
DfException
- if a server error occursjava.lang.String getUserGroupName() throws DfException
DfException
- if a server error occursint getUserPrivileges() throws DfException
The following list specifies the privilege level corresponding to all possible return values:
public static final int PRIV_NONE=0; public static final int PRIV_CREATETYPE=1; public static final int PRIV_CREATECABINET=2; public static final int PRIV_CREATEGROUP=4; public static final int PRIV_SYSADMIN=8; public static final int PRIV_SUPERUSER=16;
Refer to the Server Administrator's Guide for more information about privileges.
DfException
- if a server error occursboolean isSuperUser() throws DfException
DfException
- if a server error occursboolean isSystemAdmin() throws DfException
DfException
- if a server error occursint getOwnerDefPermit() throws DfException
DfException
- if a server error occursint getGroupDefPermit() throws DfException
DfException
- if a server error occursint getWorldDefPermit() throws DfException
DfException
- if a server error occursjava.lang.String getDefaultFolder() throws DfException
DfException
- if a server error occursboolean isGroup() throws DfException
DfException
- if a server error occursjava.lang.String getUserDBName() throws DfException
DfException
- if a server error occursjava.lang.String getDescription() throws DfException
DfException
- if a server error occursjava.lang.String getACLDomain() throws DfException
DfException
- if a server error occursjava.lang.String getACLName() throws DfException
DfException
- if a server error occursjava.lang.String getUserOSDomain() throws DfException
DfException
- if a server error occursjava.lang.String getHomeDocbase() throws DfException
DfException
- if a server error occursint getUserState() throws DfException
Return Value User State 0 Fully available 1 Fully unavailable
DfException
- if a server error occursboolean isGloballyManaged() throws DfException
DfException
- if a server error occursIDfTime getModifyDate() throws DfException
DfException
- if a server error occursIDfId getAliasSetId() throws DfException
DfException
- if a server error occursjava.lang.String getAliasSet() throws DfException
DfException
- if a server error occursDfUserAliasSetNotFoundException
- if getAliasSetId returns a non-null value but the alias set is
not in the repository.int getClientCapability() throws DfException
0 = Server Default, Consumer 1 = Consumer 2 = Contributor 4 = Coordinator 8 = Administrator (equivalent to dmdba)For a description of user roles, see the chapter "Users and Groups," in the Content Server Administrator's Guide.
DfException
- if a server error occursjava.lang.String getUserDelegation() throws DfException
DfException
- if a server error occursboolean isWorkflowDisabled() throws DfException
true
means the user is not available; false
means the user is availableDfException
- if a server error occursint getUserSource() throws DfException
DfException
getUserSourceAsString()
boolean hasSession() throws DfException
DfException
java.lang.String getUserLoginName() throws DfException
DfException
- if a server error occursvoid setUserLoginName(java.lang.String userLoginName) throws DfException
userLoginName
- name of the this user.DfException
void setDefaultACL(java.lang.String aclName) throws DfException
aclName
- The name of ACL to assign to the user.DfException
void setDefaultACLEx(java.lang.String domainName, java.lang.String aclName) throws DfException
domainName
- The domain of the the default ACL. To specify a private default ACL provide the
user's name. To specify a system default ACL provide one of repositroy owners's name, the String 'dm_dbo'
or null.aclName
- The name of an ACL to assign to the user.DfException
void setAliasSet(java.lang.String aliasSetName) throws DfException
aliasSetName
- Name of the user's default alias setDfException
void setClientCapability(int clientCapability) throws DfException
clientCapability
- value for user's capabilityDfException
void setDefaultFolder(java.lang.String folderPath, boolean isPrivate) throws DfException
folderPath
- full path in the repository to the user's default folder. If this is an invalid folder path,
an exception is thrown.isPrivate
- true
can only be seen by user; false
can be publically viewed. This
parameter only validates when the folder path does not exist in the repository and it is specified
as a cabinet.DfException
void setDescription(java.lang.String description) throws DfException
description
- description of the user.DfException
void setHomeDocbase(java.lang.String docbaseName) throws DfException
docbaseName
- name for user's home repositoryDfException
void changeHomeDocbase(java.lang.String userName, boolean isImmediate) throws DfException
userName
- the new home repository name.isImmediate
- Determines if the job should be run immediately or scheduled to run later.DfException
void setUserAddress(java.lang.String userAddress) throws DfException
userAddress
- value for user addressDfException
void setUserDBName(java.lang.String userDBName) throws DfException
userDBName
- name for user in the RDBMSDfException
void setUserDelegation(java.lang.String delegateUserName) throws DfException
delegateUserName
- name for delegationDfException
void setUserGroupName(java.lang.String userGroupName) throws DfException
userGroupName
- name of the user's default group. If this is not a valid group, an exception is thrown.
An exception is thrown if this is null because this is a required property.DfException
void setUserName(java.lang.String userName) throws DfException
userName
- name of the this user.DfException
void renameUser(java.lang.String userName, boolean isImmediate, boolean unlockObjects, boolean reportOnly) throws DfException
userName
- user name to be set or renamed to (existing user)isImmediate
- Detemines if the job should be run immediately or run on schedule.unlockObjects
- control if the objects should be unlocked when renaming user. If this is a new user, this
parameter does not take any effect.reportOnly
- control if the job created is to report or actual rename. If this is a new user, this
parameter does not take any effect.DfException
void setUserOSName(java.lang.String accountName, java.lang.String domainName) throws DfException
accountName
- user OS account for authenticationdomainName
- user domain for authentication (Windows only)DfException
void setUserPrivileges(int userPrivileges) throws DfException
userPrivileges
- privilege level for userDfException
void setUserState(int userState, boolean unlockObjects) throws DfException
userState
- 1
user cannot log in. 0
user can log in.unlockObjects
- to control whether this method should unlock any sysobjects locked by this user.
Note: unlockObjects parameter is ignored and its value will always be true.DfException
void setGloballyManaged(boolean isGloballyManaged) throws DfException
isGloballyManaged
- true
if the user is managed by a Federation. false
if the user is managed locally.DfException
void setUserSource(int userSource) throws DfException
userSource
- value to which source is setDfException
setUserSourceAsString(String)
void setWorkflowDisabled(boolean disabled) throws DfException
disabled
- If true
, workflow is disabled. false
indicates that workflow
is enabled.DfException
void setWriteFederationLogOption(int options) throws DfException
options
- Flags can be any combination of DF_WRITE_CLIENT_CAPABILITY_LOG
, DF_WRITE_PRIVILEGES_LOG
, DF_WRITE_USER_STATE_LOG
and DF_WRITE_WF_DISABLED_LOG
bitwise OR'ed together. It defines what you want to write in
the federation log:DfException
void setUserXPrivileges(int userXPrivileges) throws DfException
DF_XPRIVILEGE_CONFIG_AUDIT DF_XPRIVILEGE_PURGE_AUDIT DF_XPRIVILEGE_VIEW_AUDITFor example, to grant view and purge privileges, the calling argument should be:
DF_XPRIVILEGE_VIEW_AUDIT + DF_XPRIVILEGE_PURGE_AUDITThis overrides any prior value. You cannot add privileges by making successive calls.
userXPrivileges
- Extended privilege level for userDfException
int getUserXPrivileges() throws DfException
DF_XPRIVILEGE_CONFIG_AUDIT = 8 DF_XPRIVILEGE_PURGE_AUDIT = 16 DF_XPRIVILEGE_VIEW_AUDIT = 32Refer to the Server Administrator's Guide for more information about privileges.
DfException
- if a server error occursvoid setFailedAuthenticationAttempts(int failedAttempts) throws DfException
failedAttempts
- Valid values are -1 or 0. Setting to -1 would disable the failed authentication attempts
feature. Setting to 0 would activate this user in the repository, if he or she were
deactivated.DfException
- if a server error occurs or if an invalid value is passed.int getFailedAuthenticationAttempts() throws DfException
DfException
- if a server error occurs.java.lang.String getUserDistinguishedLDAPName() throws DfException
DfException
- if a server error occurs.boolean hasEvents() throws DfException
true
, if the user is registered for auditable events; false
otherwise.DfException
- if a server error occurs.java.lang.String getUserSourceAsString() throws DfException
DfException
void setUserSourceAsString(java.lang.String userSource) throws DfException
userSource
- value to which source is set.DfException
java.lang.String getUserPassword() throws DfException
DfException
void setUserPassword(java.lang.String value) throws DfException
DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.