public interface IDfSession
IDfSessionManager.getSession(java.lang.String)
. You can also
use methods on IDfClient
to obtain sessions.IDfSessionManager
,
IDfClient
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CURRENCY_CHECK_ALWAYS
Currency check value to always check if the object is current.
|
static java.lang.String |
CURRENCY_CHECK_FIRST_ACCESS
Currency check value to only check currency for the first access.
|
static java.lang.String |
CURRENCY_CHECK_NEVER
Currency check value to never check if the object is current.
|
static java.lang.String |
CURRENCY_CHECK_ONCE_PER_SCOPE
Currency check value to only check currency once per currency scope.
|
static int |
DF_COMPLETED_ROUTER_TASKS
|
static int |
DF_NOTIFICATIONS
|
static int |
DF_ROUTER_TASKS
|
static int |
DF_TASKS
Filter used for calling
getTasks(java.lang.String, int, java.lang.String, java.lang.String) . |
static int |
DF_TASKS_AND_NOTIFICATIONS
Filter used for calling
getTasks(java.lang.String, int, java.lang.String, java.lang.String) . |
static int |
DF_WORKFLOW_TASKS
|
static int |
DM_EXEC
It is used with processing the return value of
apiDesc(java.lang.String) method. |
static int |
DM_GET
It is used with processing the return value of
apiDesc(java.lang.String) method. |
static int |
DM_OTHER
It is used with processing the return value of
apiDesc(java.lang.String) method. |
static int |
DM_SET
It is used with processing the return value of
apiDesc(java.lang.String) method. |
Modifier and Type | Method and Description |
---|---|
void |
abortTrans()
Closes an explicit database transaction and cancels any changes made since the call to
beginTrans() . |
void |
abortTransEx(IDfLocalTransaction tx)
abort the transaction specified by the IDfTransaction
|
void |
addDynamicGroup(java.lang.String groupName)
Adds the session user to the dynamic group for this session.
|
IDfList |
apiDesc(java.lang.String api)
Deprecated.
|
boolean |
apiExec(java.lang.String cmd,
java.lang.String args)
Deprecated.
|
java.lang.String |
apiGet(java.lang.String cmd,
java.lang.String args)
Deprecated.
|
java.io.ByteArrayInputStream |
apiGetBytes(java.lang.String cmd,
java.lang.String args,
java.lang.String buf,
java.lang.String buflen,
int length)
Deprecated.
|
boolean |
apiSet(java.lang.String cmd,
java.lang.String args,
java.lang.String value)
Deprecated.
|
boolean |
apiSetBytes(java.lang.String cmd,
java.lang.String args,
java.io.ByteArrayOutputStream content)
Deprecated.
|
IDfCollection |
apply(java.lang.String objId,
java.lang.String functionName,
IDfList args,
IDfList dataType,
IDfList values)
Calls the server API Apply method.
|
IDfId |
archive(java.lang.String predicate,
java.lang.String operatorName,
int priority,
boolean sendMail,
IDfTime dueDate)
Queues an archive request to the repository operator.
|
void |
assume(IDfLoginInfo loginInfo)
Gives ownership of the session to a new user.
|
void |
authenticate(IDfLoginInfo loginInfo)
Validates credentials without returning a new session.
|
void |
beginTrans()
Opens an explicit database transaction.
|
IDfLocalTransaction |
beginTransEx()
begin a nested transaction
|
void |
changePassword(java.lang.String oldPasswd,
java.lang.String newPasswd)
Changes a password.
|
com.documentum.fc.client.DormantStatus |
checkDormantStatus()
Checks the status of the server to which this session is connected
For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
|
com.documentum.fc.client.DormantStatus |
checkDormantStatus(boolean allServersForThisDocbase)
Checks whether a server or docbase is dormant or not
For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
|
IDfCollection |
collectMetrics(java.util.List<java.lang.String> metricsToCollect)
This methods indicates to the server to collect the metrics that have been passed in
to this method.
|
IDfCollection |
collectMetrics(java.util.List<java.lang.String> metricsToCollect,
java.lang.String outputFormat)
This methods indicates to the server to collect the metrics that have been passed in
to this method.
|
void |
commitTrans()
Commits all changes made after a
beginTrans() method call. |
void |
commitTransEx(IDfLocalTransaction tx)
commit the transaction specified by the IDfLocalTransaction
|
void |
dequeue(IDfId stampId)
Removes items from an inbox that were placed there using the
queue method. |
void |
dequeueAll()
Removes all items from an inbox that were placed there using the
queue method. |
java.lang.String |
describe(java.lang.String type,
java.lang.String objType)
Describes the attributes of a type or registered table.
|
boolean |
disableSaveInDormantState()
Disables save operation for dormant state.
|
void |
disconnect()
Disconnects the DFC session.
|
boolean |
enableSaveInDormantState()
Enables save operation for dormant state.
|
java.lang.String |
exportTicketKey(java.lang.String password)
Returns the login ticket key of the repository.
|
void |
flush(java.lang.String flushType,
java.lang.String cacheKey)
Removes cached queries from the client's query caches, ACLs and Group objects from the session cache, and type
information from the data dictionary cache.
|
void |
flushCache(boolean discardChanged)
Removes objects from the server and client caches.
|
void |
flushCachedQuery(java.lang.String dqlQuery)
Remove the specified query from the query cache.
|
void |
flushEx(java.lang.String flushType,
java.lang.String cacheKey,
boolean resetChangeBit,
boolean includeSubtypes)
Removes cached queries from the client's query caches, ACLs and Group objects from the session cache, and type
information from the data dictionary cache.
|
void |
flushGlobalCache(java.lang.String cacheName)
Removes objects from a global server cache.
|
void |
flushObject(IDfId objectId)
Remove the specified object from the cache.
|
IDfACL |
getACL(java.lang.String aclDomain,
java.lang.String aclName)
Returns an ACL object.
|
IDfAcsTransferPreferences |
getAcsTransferPreferences()
Returns an
IDfAcsTransferPreferences object. |
java.lang.String |
getAliasSet()
Returns the alias set name of this session config object.
|
java.lang.String |
getApplicationToken(java.lang.String userName,
java.lang.String scope,
int timeout,
java.lang.String appId,
boolean machineOnly)
Acquires an application access control token.
|
IDfAuditTrailManager |
getAuditTrailManager()
Retrieves the Audit Trail manager for this session.
|
IDfBatchManager |
getBatchManager()
return the batch manager of the session
|
IDfClient |
getClient()
Returns the DFC client object from which this session was obtained.
|
IDfTypedObject |
getClientConfig()
Returns an api config object.
|
IDfTypedObject |
getConnectionConfig()
Returns the connection config object for a repository session.
|
java.lang.String |
getDBMSName()
Returns the name of the RDBMS that underlies the repository identified in the default repository scope.
|
int |
getDefaultACL()
Identifies the default ACL for a Documentum server.
|
java.lang.String |
getDMCLSessionId()
Deprecated.
use
getSessionId() instead. |
IDfTypedObject |
getDocbaseConfig()
Returns a docbase config object for a repository session.
|
java.lang.String |
getDocbaseId()
Returns the ID of the repository defined as the default repository scope.
|
java.lang.String |
getDocbaseName()
Returns the name of the repository identified as the default repository scope.
|
java.lang.String |
getDocbaseOwnerName()
Returns the name of the user who owns the repository identified as the default repository scope.
|
java.lang.String |
getDocbaseScope()
Returns the default repository scope of this session.
|
IDfTypedObject |
getDocbrokerMap()
Returns information about the DocBrokers known to the DFC.
|
java.lang.String |
getDynamicGroup(int index)
Gets the dynamic group at the specified index from the sessionConfig.
|
int |
getDynamicGroupCount()
Gets the number of dynamic groups that the session user is actively participating as a member of.
|
IDfEventManager |
getEventManager()
Retrieves the Event manager for this session.
|
IDfCollection |
getEvents()
Returns all unread items in a user's inbox.
|
IDfFolder |
getFolderByPath(java.lang.String folderPath)
Returns a folder object.
|
IDfFolder |
getFolderBySpecification(java.lang.String folderSpec)
Returns the folder matching the folder specification or null if the folder can not be found.
|
IDfFormat |
getFormat(java.lang.String formatName)
Returns a format object that contains information about the format.
|
IDfFtConfig |
getFtConfig()
Get the fulltext configuration object that contains information about what capabilities
the underlying fulltext engine has
|
IDfGroup |
getGroup(java.lang.String groupName)
Returns a group object that contains information about the repository group.
|
IDfId |
getIdByQualification(java.lang.String qualification)
Returns the ID of a Documentum object that satisfies the DQL qualification.
|
IDfCollection |
getLastCollection()
Returns the collection object for the most recently executed query.
|
IDfLoginInfo |
getLoginInfo()
Returns a copy of the login information used to establish this DFC session.
|
java.lang.String |
getLoginTicket()
Returns a new ticket based on the current session login information.
|
java.lang.String |
getLoginTicketEx(java.lang.String userLoginName,
java.lang.String scope,
int timeout,
boolean singleUse,
java.lang.String serverName)
Returns a new ticket based on the current session login information.
|
java.lang.String |
getLoginTicketForUser(java.lang.String userName)
Returns a ticket for a specific user.
|
java.lang.String |
getLoginUserName()
Returns the repository name of the current user.
|
java.lang.String |
getMessage(int severityLevel)
Returns all messages from an established session at or above a specified severity level.
|
com.documentum.fc.client.mq.IDfMessageQueueManager |
getMessageQueueManager()
Get a message queue factory object.
|
IDfLocalModuleRegistry |
getModuleRegistry()
Factory method that instantiates an
IDfLocalModulesRegistry , a repository module registry object. |
IDfPersistentObject |
getObject(IDfId objectId)
Returns a Documentum server object.
|
IDfPersistentObject |
getObjectByPath(java.lang.String objectPath)
Returns a Documentum server object given a full path to the object.
|
IDfPersistentObject |
getObjectByQualification(java.lang.String qualification)
Returns a Documentum server object that satisfies the DQL qualification.
|
IDfPersistentObject |
getObjectByQualificationWithInterface(java.lang.String qualification,
java.lang.String interfaceName)
Deprecated.
Please use Aspects instead for interface extension. They provide similar functionality but are safer and more robust.
|
IDfEnumeration |
getObjectPaths(IDfId objectId)
Generate
IDfEnumeration |
IDfObjectPathsMap |
getObjectPaths(IDfList objectIdsList)
Generate a map of
IDfObjectPath |
IDfEnumeration |
getObjectsByQuery(java.lang.String dql,
java.lang.String optionalTypeName)
Returns an enumeration of persistent objects using data obtained through a query.
|
IDfPersistentObject |
getObjectWithCaching(IDfId objectId,
java.lang.String typeNameIgnored,
java.lang.String classNameIgnored,
java.lang.String currencyCheckValue,
boolean usePersistentCache,
boolean useSharedCache)
Returns a Documentum server object.
|
IDfPersistentObject |
getObjectWithInterface(IDfId objectId,
java.lang.String extraInterfaceName)
Deprecated.
Please use Aspects instead for interface extension. They provide similar functionality but are safer and more robust.
|
IDfPersistentObject |
getObjectWithOptions(IDfId objectId,
IDfGetObjectOptions objectOptions)
Returns a Documentum server object.
|
IDfPersistentObject |
getObjectWithType(IDfId objectId,
java.lang.String typeNameIgnored,
java.lang.String classNameIgnored)
Deprecated.
|
IDfSession |
getRelatedSession(IDfId objectId)
Returns a related session appropriate for operating on the given object id.
|
IDfSession |
getRelatedSession(java.lang.String docbaseSpecString)
Returns a related session to a named docbase.
|
IDfRelationType |
getRelationType(java.lang.String relationName)
Returns a relation type object that contains information about a kind of relationship.
|
IDfPersistentObject |
getReplicaForMaster(IDfId masterId)
Get the replica object for a specific master object.
|
IDfCollection |
getRunnableProcesses(java.lang.String additionalAttributes)
Returns a collection that contains the object ID and attribute values of all installed dm_process objects in a
repository.
|
java.lang.String |
getSecurityMode()
Returns the security mode of the repository identified as the default repository scope.
|
IDfTypedObject |
getServerConfig()
Returns a server config object for a repository session.
|
IDfTypedObject |
getServerMap(java.lang.String docbaseName)
Returns information about the servers that are known to a DocBroker.
|
java.lang.String |
getServerVersion()
Returns the version string of a Documentum server.
|
IDfTypedObject |
getSessionConfig()
Returns the session config object for a repository session.
|
java.lang.String |
getSessionId()
Returns the DFC session ID of the session.
|
IDfSessionManager |
getSessionManager()
Returns the session manager that manages the current session.
|
IDfSessionScopeManager |
getSessionScopeManager()
Returns an IDfSessionScopeManager object.
|
IDfCollection |
getTasks(java.lang.String userName,
int filter,
java.lang.String additionalAttributes,
java.lang.String orderBy)
Retrieves the work items assigned to the specified user.
|
IDfCollection |
getTasksEx(java.lang.String userName,
int filter,
IDfList orderByList,
IDfList ascendingList)
Retrieves the work items assigned to the specified user.
|
IDfType |
getType(java.lang.String typeName)
Returns a Documentum server type object.
|
IDfTypedObject |
getTypeDescription(java.lang.String typeName,
java.lang.String attribute,
IDfId policyId,
java.lang.String state)
Returns the data dictionary information about an object type and its attributes.
|
IDfUser |
getUser(java.lang.String userName)
Returns a user object that contains information about the repository user.
|
IDfUser |
getUserByLoginName(java.lang.String userLoginName,
java.lang.String userLoginDomain)
Returns a user object that contains information about the repository user.
|
IDfUser |
getUserByOSName(java.lang.String userOSName,
java.lang.String userOSDomain)
Returns a user object that contains information about the repository user.
|
IDfVersionTreeLabels |
getVersionTreeLabels(IDfId chronicleId)
Returns the version labels associated with the versions of a SysObject.
|
boolean |
hasEvents()
Indicates whether a user's inbox contains unread items.
|
boolean |
importTicketKey(java.lang.String key,
java.lang.String password)
Sets the given key, encrypted using the given password, as the login ticket key of the repository.
|
boolean |
isACLDocbase()
Indicates whether repository identified as the default repository scope is operating in ACL mode.
|
boolean |
isAdopted()
Deprecated.
|
boolean |
isClientAuthenticated()
Stateful connection information.
|
boolean |
isConnected()
Indicates whether the DFC session is still connected to a repository server.
|
boolean |
isDeadlockVictim()
Indicates whether the DFC session was chosen as the vicim of a deadlock.
|
boolean |
isRemote()
Deprecated.
|
boolean |
isRestricted()
Indicates whether the DFC session is a restricted session.
|
boolean |
isServerAuthenticated()
Stateful connection information.
|
boolean |
isServerTraceOptionSet(java.lang.String optionName)
Queries the status of server-side tracing options for the session.
|
boolean |
isShared()
Indicates whether the session is a shared DFC session.
|
boolean |
isTransactionActive()
Checks if there is an active transaction.
|
void |
killSession(IDfId sessionId,
java.lang.String immediacyLevel,
java.lang.String message)
Kill the specified server session.
|
IDfCollection |
listMetricsState()
Retrieves the state of all the metrics that are gatherable from the server.
|
boolean |
lock(int timeoutInMsec)
Deprecated.
|
boolean |
makeActive()
Makes a request to move the server to which this session is connected to an active state
For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
|
boolean |
makeActive(boolean allServersForThisDocbase)
Makes a request to move the docbase or server to an active state
For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
|
IDfPersistentObject |
newLightObject(java.lang.String typeName,
IDfId parentId)
Creates a persistent light type object given a specified Documentum server shareable type.
|
IDfPersistentObject |
newObject(java.lang.String typeName)
Creates a persistent object given a specified Documentum server type.
|
IDfPersistentObject |
newObjectWithType(java.lang.String typeName,
java.lang.String classNameIgnored)
Deprecated.
|
IDfWorkflowBuilder |
newWorkflowBuilder(IDfId processId)
Creates a workflow builder object.
|
boolean |
projectActiveStatus()
Only projects to docbroker that this server is active.
|
boolean |
projectDormantStatus()
Only projects to docbroker that this server is dormant.
|
void |
publishDataDictionary(java.lang.String locale,
java.lang.String typeName,
java.lang.String attributeName,
boolean forcePublish)
Publish Data Dictionary information.
|
void |
purgeLocalFiles()
Removes all files that have been copied into the local area during the current session.
|
void |
reInit(java.lang.String serverConfigName)
Reinitializes a server's root and spawned processes.
|
void |
reInitEx(java.lang.String serverConfigName,
boolean sendToDocBroker)
Reinitializes a server's root and spawned processes.
|
void |
removeDynamicGroup(java.lang.String groupName)
Removes the session user from the dynamic group for this session.
|
void |
reparentLightObjects(IDfId newParentId,
IDfList childIds)
Reparents multiple lightweight objects at a time.
|
boolean |
requestDormancy()
Makes a request to move the server to which this session is connected to a dormant state.
|
boolean |
requestDormancy(boolean allServersForThisDocbase)
Makes a request to move the docbase or server to a dormant state
For this operation to succeed, the user of this session should be a member of the dm_datacenter_managers group
|
boolean |
resetMetrics()
This is for resetting the metrics.
|
boolean |
resetPassword(java.lang.String password)
Resets password or login ticket associated with the user credential of the current session.
|
boolean |
resetTicketKey()
Generates an asymmetric key and sets it as the login ticket key of the repository.
|
java.lang.String |
resolveAlias(IDfId sysObject,
java.lang.String scopeAlias)
Returns the value mapped to a given alias.
|
void |
reStart(java.lang.String serverConfigName,
boolean restartClient)
Reinitializes a server's spawned process to which the current session is connected.
|
IDfId |
restore(java.lang.String predicate,
java.lang.String dumpFile,
java.lang.String operatorName,
int priority,
boolean sendMail,
IDfTime dueDate)
Queues a request to restore a content file or files from the archives.
|
IDfId |
sendToDistributionList(IDfList toUsers,
IDfList toGroups,
java.lang.String instructions,
IDfList objectIDs,
int priority,
boolean endNotification)
Deprecated.
|
IDfId |
sendToDistributionListEx(IDfList toUsers,
IDfList toGroups,
java.lang.String instructions,
IDfList objectIDs,
int priority,
int flags)
Creates and starts an ad-hoc workflow.
|
void |
setAcsTransferPreferences(IDfAcsTransferPreferences acsTransferPreferences)
Sets an
IDfAcsTransferPreferences object. |
void |
setAliasSet(java.lang.String name)
Sets the alias_set attribute of this session_config.
|
void |
setBatchHint(int batchSize)
Sets the maximum number of rows returned to the server for each call to the underlying RDBMS.
|
java.lang.String |
setDocbaseScope(java.lang.String docbaseName)
THIS METHOD IS NOT THREAD SAFE.
|
java.lang.String |
setDocbaseScopeById(IDfId objectId)
THIS METHOD IS NOT THREAD SAFE.
|
void |
setServerTraceLevel(int level,
java.lang.String facility)
Sets the session's tracing level for a particular facility on the server.
|
void |
shutdown(boolean immediate,
boolean deleteEntry)
Shuts down a server.
|
IDfCollection |
startGatheringMetrics(java.util.List<java.lang.String> metricsToGather)
This methods indicates to the server to start gathering the metrics that have been passed in
to this method.
|
IDfCollection |
stopGatheringMetrics(java.util.List<java.lang.String> metricsToStop)
This methods indicates to the server to stop gathering the metrics that have been passed in
to this method.
|
void |
traceDMCL(int level,
java.lang.String traceFile)
Deprecated.
Please configure tracing using the ClientConfig object
IDfClient.getClientConfig() |
boolean |
unlock()
Deprecated.
|
static final int DF_TASKS
getTasks(java.lang.String, int, java.lang.String, java.lang.String)
.static final int DF_NOTIFICATIONS
getTasks(java.lang.String, int, java.lang.String, java.lang.String)
and getTasksEx(java.lang.String, int, com.documentum.fc.common.IDfList, com.documentum.fc.common.IDfList)
.static final int DF_TASKS_AND_NOTIFICATIONS
getTasks(java.lang.String, int, java.lang.String, java.lang.String)
.static final int DF_WORKFLOW_TASKS
getTasksEx(java.lang.String, int, com.documentum.fc.common.IDfList, com.documentum.fc.common.IDfList)
.static final int DF_ROUTER_TASKS
getTasksEx(java.lang.String, int, com.documentum.fc.common.IDfList, com.documentum.fc.common.IDfList)
.static final int DF_COMPLETED_ROUTER_TASKS
getTasksEx(java.lang.String, int, com.documentum.fc.common.IDfList, com.documentum.fc.common.IDfList)
.static final int DM_GET
apiDesc(java.lang.String)
method. Represents cmdCallType for dmAPIGet().static final int DM_SET
apiDesc(java.lang.String)
method. Represents cmdCallType for dmAPISet().static final int DM_EXEC
apiDesc(java.lang.String)
method. Represents cmdCallType for dmAPIExec().static final int DM_OTHER
apiDesc(java.lang.String)
method. Represents cmdCallType for other
methods.static final java.lang.String CURRENCY_CHECK_ALWAYS
static final java.lang.String CURRENCY_CHECK_NEVER
static final java.lang.String CURRENCY_CHECK_FIRST_ACCESS
static final java.lang.String CURRENCY_CHECK_ONCE_PER_SCOPE
boolean isConnected()
IDfException.DM_DFCSESS_E_DISCONNECTED
to be thrown.true
if this session is connected to a Documentum server; false
if this session
has been disconnected.disconnect()
boolean isShared() throws DfException
A shared session is a session obtained using IDfClient.getSharedSession(java.lang.String, com.documentum.fc.common.IDfLoginInfo, java.lang.String)
true
if this is a shared session; false
if it is notDfException
- if the session has been disconnectedvoid disconnect() throws DfException
IDfException.DM_DFCSESS_E_DISCONNECTED
to be thrown.
You cannot use this method to disconnect an adopted session.
The following code example demonstrates how to disconnect a session:
sess.disconnect(); if (!sess.isConnected()) { // Successfully disconnected... }
DfException
- if this is an adopted session or this session is already diconnected.isConnected()
boolean isTransactionActive() throws DfException
DfException
void beginTrans() throws DfException
beginTrans
method.
Note that any changes that you save or check in are not committed to a repository until you call the
commitTrans
method.
You can cancel the database transaction by calling the abortTrans
method. Refer to the Server
Fundamentals for more information about explicit transactions.DfException
- if a server error occursabortTrans()
,
commitTrans()
void abortTrans() throws DfException
beginTrans()
.
An explicit database transaction is a transaction that is opened by executing the beginTrans
method.
Refer to the Server Fundamentals for more information about explicit transactions.DfException
- if a server error occursbeginTrans()
,
commitTrans()
void commitTrans() throws DfException
beginTrans()
method call.
You cannot call commitTrans
if you have previously called abortTrans
or
commitTrans
on a database transaction.DfException
- if a server error occursabortTrans()
,
beginTrans()
IDfLocalTransaction beginTransEx() throws DfException
DfException
void commitTransEx(IDfLocalTransaction tx) throws DfException
tx
- the IDfLocalTransaction objectDfException
void abortTransEx(IDfLocalTransaction tx) throws DfException
tx
- the IDfLocalTransaction objectDfException
IDfBatchManager getBatchManager()
void authenticate(IDfLoginInfo loginInfo) throws DfException
loginInfo
- An IDfLoginInfo
object that contains the required user validation information.DfException
- if a server error occurs.IDfSessionManager getSessionManager()
IDfTypedObject getSessionConfig() throws DfException
DfException
- if a server error occursIDfTypedObject getConnectionConfig() throws DfException
DfException
- if a server error occursIDfTypedObject getDocbaseConfig() throws DfException
DfException
- if a server error occursIDfTypedObject getServerConfig() throws DfException
DfException
- if a server error occursjava.lang.String getSessionId() throws DfException
IDfClient.findSession(java.lang.String)
to obtain access to the session object.DfException
- if this session has been disconnectedIDfLoginInfo getLoginInfo() throws DfException
DfException
- if the session has been disconnectedIDfSession getRelatedSession(java.lang.String docbaseSpecString) throws DfException
DfException
IDfSession getRelatedSession(IDfId objectId) throws DfException
DfException
java.lang.String getLoginUserName() throws DfException
getLoginInfo()
or retrieve the user object and examine
the user_os_name attribute.
For more information about user names, refer to Server Administrator's Guide.DfException
- if a server error occursjava.lang.String getDocbaseId() throws DfException
DfException
- if a server error occursjava.lang.String getDocbaseName() throws DfException
DfException
- if a server error occursjava.lang.String getServerVersion() throws DfException
DfException
- if a server error occursjava.lang.String getDocbaseOwnerName() throws DfException
DfException
- if a server error occursjava.lang.String getDBMSName() throws DfException
DfException
- if a server error occursjava.lang.String getSecurityMode() throws DfException
DfException
- if a server error occursint getDefaultACL() throws DfException
Possible return values are:
Integer Identifing 1 ACL associated with the object's primary folder 2 ACL associated with the object's type 3 ACL associated with the user who created the objectThe default return value is 3.
DfException
- if a server error occursboolean isACLDocbase() throws DfException
true
if the repository is operating in ACL mode; false
if it is operating in OGW
mode.DfException
- if a server error occursIDfPersistentObject getObject(IDfId objectId) throws DfException
IDfId idObj = new DfId("0900d5bb8001f900"); IDfPersistentObject perObj = sess.getObject(idObj); if (perObj.getObjectId().getId().equals("0900d5bb8001f900")) { // Successfully fetched object... }
objectId
- an IDfId object that contains the object ID.DfException
- if the persistent object specified with objectID
doesn't exist, or a server
error occurs.getObjectByQualification(java.lang.String)
,
getIdByQualification(java.lang.String)
IDfPersistentObject getObjectWithOptions(IDfId objectId, IDfGetObjectOptions objectOptions) throws DfException
IDfId idObj = new DfId("0900d5bb8001f900"); IDfGetObjectOptions objectOptions = clientx.getGetObjectOptions(); //set object with partition, cachePersistently, currencyCheckValue value //by default, it's 0, fasle and null IDfPersistentObject perObj = sess.getObjectwithOptions(idObj,objectOptions); if (perObj.getObjectId().getId().equals("0900d5bb8001f900")) { // Successfully fetched object... }
objectId
- an IDfId object that contains the object ID.objectOptions
- an IDfId object that contains the object ID.DfException
- if the persistent object specified with objectID
with options doesn't exist,
or a server error occurs.getObjectByQualification(java.lang.String)
,
getIdByQualification(java.lang.String)
IDfPersistentObject newObject(java.lang.String typeName) throws DfException
save
method.
The following code example demonstrates how to create a dm_document object:
IDfSysObject sysObj = (IDfSysObject)sess.newObject("dm_document"); sysObj.setObjectName("testObject"); sysObj.setSubject("DFC Example Doc"); sysObj.setContentType("crtext"); sysObj.setFile("c:\dfctest.txt"); sysObj.link("/DFCTest"); sysObj.save();
typeName
- the object type of the new object, with underscores. For example, enter dm_document
to create a document object.DfException
- if a server error occurs.IDfPersistentObject newLightObject(java.lang.String typeName, IDfId parentId) throws DfException
typeName
- name of a light typeparentId
- object Id of the shareable parent object instanceDfException
IDfPersistentObject getObjectWithCaching(IDfId objectId, java.lang.String typeNameIgnored, java.lang.String classNameIgnored, java.lang.String currencyCheckValue, boolean usePersistentCache, boolean useSharedCache) throws DfException
objType
, the method returns an IDfPersistentObject interface to the
object. If you include className
parameter, the method returns an object of the specified class. The
class must derive from the IDfPersistentObject interface.objectId
- An IDfId object that contains the object's object IDtypeNameIgnored
- The type name is ignored. It is not needed.classNameIgnored
- The class name is ignored. It violates TBO type safety and is no longer supported.currencyCheckValue
- specifies that the object should be persistently cached and indicates how often the
object needs to checked for consistency with the server. If the value is numeric it
indicates the time (in seconds) which the caller is willing to allow the object to be
used without being rechecked for consistency. If the requested object is found in the
cache and has not been checked for consistency in the specified time period then it is
checked and re-fetched from the server if necessary. If the value is non-numeric then
it specifies a cache configuration object which defines the consistency check rules.
Specify null
if you don't want the object persistently cached.usePersistentCache
- set to true
if want the object the object cached persistentlyuseSharedCache
- Reserved for future useDfException
- if objType
specifies an invalid object type, if className
specifies
a class that cannot be instantiated, or if a server error occursgetObject(com.documentum.fc.common.IDfId)
,
getObjectByQualification(java.lang.String)
,
getIdByQualification(java.lang.String)
IDfId getIdByQualification(java.lang.String qualification) throws DfException
IDfId idObj = sess.getIdByQualification("dm_document where r_object_id='0900d5bb8001f900'"); if (idObj.getId().equals("0900d5bb8001f900")) { // Successfully fetched id... }
qualification
- a DQL qualification consisting of that portion of a SELECT statement beginning with the
keyword FROM. The DQL qualification uniquely identifies an object in a repository.qualification
, the null
IDfId is returned.DfException
- if a server error occurs.getObject(com.documentum.fc.common.IDfId)
,
getObjectByQualification(java.lang.String)
IDfPersistentObject getObjectByQualification(java.lang.String qualification) throws DfException
IDfSysObject sysObj = (IDfSysObject)sess.getObjectByQualification("dm_document where r_object_id='0900d5bb8001f900' and object_name='testObject'"); if (sysObj.getObjectName().equals("testObject")) { // Successfully fetched object... }
qualification
- a DQL qualification consisting of that portion of a SELECT statement beginning with the
keyword FROM. The DQL qualification uniquely identifies an object in a repository.qualification
, the returned interface contains null
.DfException
- if a server error occurs.getObject(com.documentum.fc.common.IDfId)
,
getIdByQualification(java.lang.String)
IDfEnumeration getObjectsByQuery(java.lang.String dql, java.lang.String optionalTypeName) throws DfException
DfException
IDfPersistentObject getObjectByPath(java.lang.String objectPath) throws DfException
IDfSysObject sysObj = (IDfSysObject)sess.getObjectByPath("/DFCTest/testObject"); if (sysObj.getObjectName().equals("testObject")) { // Successfully fetched object... }
objectPath
- the path to the object specified in the following format: /cabinet_name/folder_name/object_name.null
if the server cannot
find an object at the specified path.DfException
- if server error occurs.IDfFolder getFolderByPath(java.lang.String folderPath) throws DfException
folderPath
- The path to the Folder object in the following format: /cabinet name/folder name/folder name.
The last folder name in the path must be the folder you want to return.null
if the server cannot find the specified
folder object.DfException
- if a server error occursIDfFolder getFolderBySpecification(java.lang.String folderSpec) throws DfException
folderSpec
- a path or object id for a folderDfException
- if the folder can not be found or some other error occursIDfPersistentObject newObjectWithType(java.lang.String typeName, java.lang.String classNameIgnored) throws DfException
save
method.typeName
- the object type of the new object, with underscores. For example, enter
dm_document
to create a document object.classNameIgnored
- The class name is ignored. It violates TBO type safety and is no longer supported.DfException
- if a server error occursnewObject(java.lang.String)
IDfPersistentObject getObjectWithType(IDfId objectId, java.lang.String typeNameIgnored, java.lang.String classNameIgnored) throws DfException
objType
, the method returns an IDfPersistentObject interface to the
object. If you include className
parameter, the method returns an object of the specified class. The
class must derive from the IDfPersistentObject interface.objectId
- An IDfId object that contains the object's object IDtypeNameIgnored
- The type name is ignored. It is not needed.classNameIgnored
- The class name is ignored. It violates TBO type safety and is no longer supported.DfException
- if objType
specifies an invalid object type, if className
specifies
a class that cannot be instantiated, or if a server error occursgetObject(com.documentum.fc.common.IDfId)
IDfPersistentObject getObjectWithInterface(IDfId objectId, java.lang.String extraInterfaceName) throws DfException, DfServiceNotFoundException, DfDborNotFoundException
objectId
- An IDfId object that contains the object's object IDextraInterfaceName
- The fully qualified name of an interface configured in DBORDfException
- if objType
specifies an invalid object type, or if a server error
occursDfServiceNotFoundException
- if interfaceName
is not configured in DBORDfDborNotFoundException
- if DBOR is not foundIDfPersistentObject getObjectByQualificationWithInterface(java.lang.String qualification, java.lang.String interfaceName) throws DfException, DfServiceNotFoundException
qualification
- a DQL qualification consisting of that portion of a SELECT statement beginning with the
keyword FROM. The DQL qualification uniquely identifies an object in a repository.interfaceName
- The fully qualified name of an interface configured in DBORDfException
- if objType
specifies an invalid object type, or if a server error
occursDfServiceNotFoundException
- if interfaceName
is not configured in DBORDfDborNotFoundException
- if DBOR is not foundgetObjectByQualification(java.lang.String)
IDfPersistentObject getReplicaForMaster(IDfId masterId) throws DfException
masterId
- the id of the master object.DfException
void flush(java.lang.String flushType, java.lang.String cacheKey) throws DfException
flush
method to empty the session cache.
Refer to the Server Administrator's Guide for more information about removing content from local areas.flushType
- Identifies the cache that you want to flush. Valid values and their meanings are:
Value Meaning querycache User's query cache aclcache ACLs in the session cache groupcache Group objects in the session cache ddcache Data dictionary cache registrycache Registry cache persistentcache Persistent cache persistentobjcache Persistent object cache
cacheKey
- The name of an object type. Use this optional parameter only if ddcache is passed to
flushtype
. Note that all data dictionary information for the specified type and all
of its subtypes is flushed. If no argument is passed to this parameter, information for all
object types in the data dictionary is flushed.DfException
- if server error occursvoid flushEx(java.lang.String flushType, java.lang.String cacheKey, boolean resetChangeBit, boolean includeSubtypes) throws DfException
flush
method to empty the session cache.
Refer to the Server Administrator's Guide for more information about removing content from local areas.flushType
- Identifies the cache that you want to flush. Valid values and their meanings are:
Value Meaning querycache User's query cache aclcache ACLs in the session cache groupcache Group objects in the session cache ddcache Data dictionary cache registrycache Registry cache persistentcache Persistent cache persistentobjectcache Persistent object cache
cacheKey
- The name of an object type. Use this optional parameter only if ddcache is passed to
flushtype
. Note that all data dictionary information for the specified type and
all of its subtypes is flushed. If no argument is passed to this parameter, information for
all object types in the data dictionary is flushed.resetChangeBit
- Directs the Repository Server to reset the change bit in the registry cache to false for all
cache entries that are marked true when the cache is flushed. Use this only when the registry
cache is the target of the operation. The default is false.includeSubtypes
- Whether you want to flush registry objects that reference subtypes of the object type
identified by cacheKey. The default is false, meaning not to flush objects referencing
subtypes. Use this only when the registry cache is the target of the operation.DfException
- if server error occursvoid flushCache(boolean discardChanged) throws DfException
discardChanged
- true
if you want to discard objects that have been changed but not saved;
false
if not.DfException
- if a server error occursvoid flushGlobalCache(java.lang.String cacheName) throws DfException
cacheName
- The name of the server global cache to flushDfException
- if a server error occursIDfACL getACL(java.lang.String aclDomain, java.lang.String aclName) throws DfException
aclDomain
- the ACL domain. The domain is the owner of the ACL.aclName
- the name of the ACLnull
if the server cannot find the specified ACL
object.DfException
- if a server error occursIDfFormat getFormat(java.lang.String formatName) throws DfException
formatName
- the name of the format objectnull
if the server cannot find the specified
format object.DfException
- if server error occursIDfType getType(java.lang.String typeName) throws DfException
IDfType typeObj = sess.getType("dm_document"); for (int i = 0; i < typeObj.getAttrCount(); i++) { IDfAttr attrObj = typeObj.getAttr(i); System.out.println("Attribute Name: " + attrObj.getName()); }
typeName
- the name of the object type whose corresponding type object you want to return.null
if the server cannot find the type object.DfException
- if server error occurs.IDfTypedObject getTypeDescription(java.lang.String typeName, java.lang.String attribute, IDfId policyId, java.lang.String state) throws DfException
businesspolicyId
and
state
if you want state-specific data information for an object type and its attributes. Refer to
Server Fundamentals for more information about about the Data Dictionary.typeName
- The object type.attribute
- An attribute of the object type. This parameter is optional. If you include it, the method
returns information about the attribute but does not include the type information.policyId
- The business policy's object ID. This parameter is optional. If you pass an argument to this
parameter, you must also pass an argument to state
.state
- The name of one of the business policy states. This parameter is optional. If you pass an
argument to this parameter, you must also pass an argument to businessPolicyId
.DfException
- if a server error occursIDfGroup getGroup(java.lang.String groupName) throws DfException
groupName
- the name of the group objectnull
if the server cannot find the specified
group object.DfException
- if server error occursIDfUser getUser(java.lang.String userName) throws DfException
userName
- Set this to the user's repository name. If null
or empty string is passed, the
parameter defaults to the current logged-in user.null
if the server cannot find the User object.DfException
- if server error occursgetUserByOSName(java.lang.String, java.lang.String)
IDfUser getUserByOSName(java.lang.String userOSName, java.lang.String userOSDomain) throws DfException
userOSName
- the operating system's user name for the useruserOSDomain
- the Windows NT domain name associated with the user; Pass null
to this parameter
if the user, such as a user on a UNIX system, has no Windows NT domain name.null
if the server cannot find the
specified user.DfException
- if server error occursgetUser(java.lang.String)
IDfUser getUserByLoginName(java.lang.String userLoginName, java.lang.String userLoginDomain) throws DfException
userLoginName
- the user's login name for the useruserLoginDomain
- Name of the Windows domain against which this user is authenticated.
If the user is an LDAP user, the attribute stores the name of the LDAP directory
against which the user is authenticated.
Pass null
to this parameter if the user has no login domain name.null
if the server cannot find the
specified user.DfException
- if server error occursgetUser(java.lang.String)
java.lang.String getLoginTicket() throws DfException
DfException
- if a server error occursjava.lang.String getLoginTicketEx(java.lang.String userLoginName, java.lang.String scope, int timeout, boolean singleUse, java.lang.String serverName) throws DfException
userLoginName
- - the user login name (dm_user object's attribute "user_login_name" value)
for whom the login ticket is desired.scope
- - the scope of the acquired login ticket. It can be "server", "docbase", or "global".timeout
- - How long will acquired login ticket remain valid since generation.
Its value is expressed in minutes.
Docbase config, max_login_ticket_timeout attribute value is used, if the specified time is larger than it.
if unspecified, docbase config, login_ticket_timeout attribute value is used.singleUse
- - if the login ticket can be used once only or multiple timesserverName
- - When single_use is true, the acquired one-time login ticket will be valid in the specified
server only.DfException
java.lang.String getLoginTicketForUser(java.lang.String userName) throws DfException
userName
- the user for which the login ticket is desired.DfException
java.lang.String getAliasSet() throws DfException
DfException
- if server error occurssetAliasSet(java.lang.String)
void setAliasSet(java.lang.String name) throws DfException
name
- The alias set object name that is setting to the session configDfException
- if server error occursgetAliasSet()
java.lang.String resolveAlias(IDfId sysObject, java.lang.String scopeAlias) throws DfException
sysObject
parameter, the scopes
are searched in the following order to resolve the alias:
sysObject
parameter, the system
starts the search at the session scope and continues through the user
and server scopes if needed.
If you include an alias set name in the scopeAlias
parameter, the method ignores the scopes and searches only the
specified alias set to resolve the alias.sysObject
- an IDfId interface to a sysobject. If you include this, the method includes the business policy
scope in the search to resolve the alias. If you specify null
, the method ignores
the business policy scope.scopeAlias
- The alias you want to resolve. Use the following format:%[alias_set_name.]alias_name
,
where alias_set_name
is the name of the alias set that contains the alias
and alias_name
identifies the alias you want to resolve. The
alias_set_name
is optional. If you include this, the method ignores the
scopes and only searches the specified alias set.DfException
- if a server error occursjava.lang.String getMessage(int severityLevel) throws DfException
Note that DFC automatically calls getMessage
for error and fatal error
messages, severity levels 3 and 4, that occur during a call to a DFC method and puts the message in the thrown
exception.
severityLevel
- the minimum severity level of the session message that you want to get. Valid values and
their corresponding severity levels are:
Value Retrieves 1 Information messages 2 Warning messages 3 Error messages 4 Fatal error messages
DfException
- if a server error occursIDfCollection getLastCollection() throws DfException
DfException
- if a server error occursvoid setBatchHint(int batchSize) throws DfException
batchSize
- the maximum rows returned to the server for each call to the underlying RDBMSDfException
- if a server error occursIDfCollection apply(java.lang.String objId, java.lang.String functionName, IDfList args, IDfList dataType, IDfList values) throws DfException
If the repository was installed on a UNIX machine, the contents of the three IDfList arguments would be as follows:
Index | args | dataType | values |
---|---|---|---|
0 | METHOD |
S |
MyMethod |
1 | SAVE_RESULTS |
B |
T |
2 | ARGUMENTS |
S |
'a.b.c O''Reilly "A multiword arg"
An,arg,with,commas "He said \"I''m here\""
\\ \\\"'
|
\\
to \
, but the seventh argument would remain unchanged. This
reflects the escaping rules of the Windows shell, not any rules specific to the server API.objId
- The object ID of the object on which you are performing the procedure. The objId
is null
in some cases; for example, if you are specifying a name in
args
. Refer to the Server Reference Manual for syntax details for any
particular function.functionName
- The operation that you want to perform. Valid function names for user applications are
listed in the DQL Reference Manual. EMC Documentum applications may use any apply method call, internal
or external.args
- an IDfList interface to valid arguments for the function specified with
functionName
. Refer to the DQL Reference Manual for more information
about valid arguments.dataType
- an IDfList interface to the datatypes of the arguments specified with args
values
- an IDfList interface to the values assigned to the arguments specified with args
.DfException
- if a server error occursjava.lang.String describe(java.lang.String type, java.lang.String objType) throws DfException
type
- identifies whether you want attribute information about a type or a table; Valid type
values are TYPE and TABLE.objType
- the object type or table name. If you specified TYPE with type
, then specify a
Documentum object type, with underscores. For example, enter dm_document if you want attribute
information for the document object type. If you specified TABLE with type
, then
specify the name of a table in the underlying RDBMS.DfException
- if a server error occursIDfId archive(java.lang.String predicate, java.lang.String operatorName, int priority, boolean sendMail, IDfTime dueDate) throws DfException
predicate
- the object or objects that you want to archive. A valid predicate has the following format:
type_name WHERE qualification. type_name must be a dm_sysobject or
a subtype of dm_sysobject, and qualification must be a valid WHERE clause
qualification.operatorName
- the Documentum user who receives the archive requestpriority
- the priority level of the archive requestsendMail
- true
if you want the server to send an email notification about the archive
request to the user specified with operatorName
; false
if notdueDate
- an IDfTime interface to the date that the archive request should be completedDfException
- if a server error occursIDfId restore(java.lang.String predicate, java.lang.String dumpFile, java.lang.String operatorName, int priority, boolean sendMail, IDfTime dueDate) throws DfException
predicate
to the inbox of the repository operator. The
operator is responsible for running the dmarchive utility to restore the requested file or files.
Generally, it is not necessary to specify a dump file with the dumpfile
parameter. When you archive
an object, the system sets the set_file attribute of the associated content object to the full path of the dump
file. When you perform a restore, dmarchive reads the set_file attribute to determine which dump file it should
scan for the requested object. Refer to Server Fundamentals for more information about archiving
and restoring content files.predicate
- the object or objects that you want to restoredumpFile
- the dump file containing the archived file. Specify a value only if you do not want dmarchive
to search the dump file at the location specified in the set_file attributeoperatorName
- the repository operator. If you do not specify an operator, the event is queued to the default
operator, the user specified in the operator_name attribute of the server's server config
object.priority
- the priority level of the restore requestsendMail
- true
if you want the server to send an email notification to the specified
operator; false
if notdueDate
- an IDfTime interface to the date that the restore request should be completedDfException
- if a server error occursvoid changePassword(java.lang.String oldPasswd, java.lang.String newPasswd) throws DfException
oldPasswd
- the old passwordnewPasswd
- the new passwordDfException
- if a server error occursvoid purgeLocalFiles() throws DfException
purgeLocalFiles
encounters a file that it cannot delete, it does not stop but
instead continues deleting those files that it can delete.DfException
- if a server error occursvoid reInit(java.lang.String serverConfigName) throws DfException
reInit
to make the changes take affect. You must have sysadmin
or superuser privileges to call this method.
Refer to the Server Administrator's Guide for more information about reinitializing servers.serverConfigName
- the server config objectDfException
- if a server error occursvoid reInitEx(java.lang.String serverConfigName, boolean sendToDocBroker) throws DfException
reInit
to make the changes take affect. You must have
sysadmin or superuser privileges to call this method.
Refer to the Server Administrator's Guide for more information about reinitializing servers.serverConfigName
- the server config objectsendToDocBroker
- indicates whether server should send a checkpoint to the connection brokerDfException
- if a server error occursvoid reStart(java.lang.String serverConfigName, boolean restartClient) throws DfException
reInit
method to reinitialize the root server process.)serverConfigName
- the server config objectrestartClient
- true
if you want to change only the client portion of a session's
configuration; false
if not.DfException
- if a server error occursvoid shutdown(boolean immediate, boolean deleteEntry) throws DfException
immediate
- true
if you want the server to shut down immediately, without waiting for open
transactions to finish; false
if you want the server to wait for open
transactions to finish before shutting down. The default value is false
.deleteEntry
- true
if you want the DocBroker to delete its entry for the server you are
shutting down; false
if not. The default value is false
.DfException
- if a server error occursvoid dequeue(IDfId stampId) throws DfException
queue
method.
stampId
- the object ID of the dmi_queue_item object associated with the item that you want to remove from
the queue. Call getEvents
to obtain this ID.DfException
- if a server error occursvoid dequeueAll() throws DfException
queue
method.DfException
- if a server error occursboolean hasEvents() throws DfException
getEvents
to retrieve a user's unread items.true
if a user's inbox contains unread items; false
if notDfException
- if a server error occursIDfCollection getEvents() throws DfException
DfException
- if a server error occursIDfCollection getTasks(java.lang.String userName, int filter, java.lang.String additionalAttributes, java.lang.String orderBy) throws DfException
userName
- the user whose tasks you want to retrievefilter
- can be: DF_TASKS
or 1 to retrieve only tasks, DF_NOTIFICATIONS
or 2
to retrieve only notifications, DF_TASKS_AND_NOTIFICATIONS
or 3 to retrieve
both tasks and notifications.additionalAttributes
- the DQL query specifying the additional task attributes that you would like
retrievedorderBy
- the task attribute used to order the retrieved tasksadditionalAttributes
.DfException
- if the query failedIDfCollection getTasksEx(java.lang.String userName, int filter, IDfList orderByList, IDfList ascendingList) throws DfException
userName
- the user whose tasks you want to retrieve.filter
- any combination of: DF_NOTIFICATIONS
, DF_WORKFLOW_TASKS
, DF_ROUTER_TASKS
, or DF_COMPLETED_ROUTER_TASKS
. These categories should be bitwise
OR'ed together when you need to retrieve the tasks of multiple categories. Other filters
used for getTasks DF_TASKS
and DF_TASKS_AND_NOTIFICATIONS
are also
supported in this function. If DF_TASKS
is used, it is treated as DF_WORKFLOW_TASKS
|DF_ROUTER_TASKS
. If DF_TASKS_AND_NOTIFICATIONS
is
used, all kinds of items will be returned.
orderByList
- an IDfList
of the task attributes that are used to order the retrieved tasks.ascendingList
- an IDfList
of Boolean values to specify whether the corresponding order by attribute
should be sorted in ascending or descending order. Specify true
for ascending
order; false
for descending order.DfException
- if the query failed.IDfId sendToDistributionList(IDfList toUsers, IDfList toGroups, java.lang.String instructions, IDfList objectIDs, int priority, boolean endNotification) throws DfException
sendToDistributionListEx(com.documentum.fc.common.IDfList,
com.documentum.fc.common.IDfList, java.lang.String, com.documentum.fc.common.IDfList, int, int)
IDfList userList = new DfList(); IDfList groupList = new DfList(); IDfList objList = new DfList(); userList.appendString("joeuser"); groupList.appendString("EngineeringGroup"); objList.append(new DfId("0900d5bb8001f900")); IDfId wfId = sess.sendToDistributionList(userList,groupList,"Please review",objList,5,false);
toUsers
- an IDfList interface to the users that are assigned workflow tasks.toGroups
- an IDfList interface to the groups that are assigned workflow tasks.instructions
- task instructions for the recipients of workflow tasks.objectIDs
- an IDfList interface to the documents you want to distribute. You may only distribute
persistent objects in a workflow.priority
- An integer value corresponding to the priority level. The following list explains the
priority level corresponding to all permissible values:
Integer Priority Level 1 Low 5 Medium 10 High
endNotification
- defines whether a notification is sent to the sender of the distribution list when all the
recipients have finished their assigned task.DfException
- if the server fails to create the custom workflow.IDfId sendToDistributionListEx(IDfList toUsers, IDfList toGroups, java.lang.String instructions, IDfList objectIDs, int priority, int flags) throws DfException
IDfList userList = new DfList(); IDfList groupList = new DfList(); IDfList objList = new DfList(); userList.appendString("joeuser"); groupList.appendString("EngineeringGroup"); objList.append(new DfId("0900d5bb8001f900")); int flags = DF_REQ_SIGN_OFF | DF_REQ_END_NOTIFICATION; IDfId wfId = sess.sendToDistributionListEx(userList,groupList,"Please review",objList,5,flags);
toUsers
- an IDfList interface to the users that are assigned workflow tasks.toGroups
- an IDfList interface to the groups that are assigned workflow tasks.instructions
- task instructions for the recipients of workflow tasks.objectIDs
- an IDfList interface to the documents you want to the specified users and groups. You may
only distribute persistent objects in a workflow.priority
- An integer value corresponding to the priority level. The following list maps the valid
values to their corresponding priority levels:
Integer Priority Level 1 Low 5 Medium 10 High
flags
- Flags can be any combination of these options IDfWorkflow.DF_REQ_END_NOTIFICATION
, IDfWorkflow.DF_REQ_SIGN_OFF
, IDfWorkflow.DF_SEQUENTIAL
, IDfWorkflow.DF_ALLOW_REJECT_PREVIOUS
, and IDfWorkflow.DF_ALLOW_REJECT_INITIATOR
bitwise
OR'ed together.DfException
- if the server fails to create the ad-hoc workflow.IDfWorkflow.DF_REQ_END_NOTIFICATION
,
IDfWorkflow.DF_REQ_SIGN_OFF
,
IDfWorkflow.DF_SEQUENTIAL
,
IDfWorkflow.DF_ALLOW_REJECT_PREVIOUS
,
IDfWorkflow.DF_ALLOW_REJECT_INITIATOR
IDfCollection getRunnableProcesses(java.lang.String additionalAttributes) throws DfException
additionalAttributes
- The additional attributes of the workflows that you want to retrieve.DfException
- if the query failedIDfWorkflowBuilder newWorkflowBuilder(IDfId processId) throws DfException
processId
- the ID of the process object you want to attach to the workflow builder object. The process
object contains the workflow definition that the workflow builder object uses to create a
workflow object.DfException
- if a server error occursIDfVersionTreeLabels getVersionTreeLabels(IDfId chronicleId) throws DfException
chronicleId
- the object ID of the first version of the objectDfException
- if a server error occursIDfRelationType getRelationType(java.lang.String relationName) throws DfException
relationName
- the name of the relation type objectDfException
- if a server error occursIDfClient getClient()
IDfTypedObject getClientConfig() throws DfException
DfException
- if a server error occursIDfTypedObject getDocbrokerMap() throws DfException
DfException
- if a server error occursIDfTypedObject getServerMap(java.lang.String docbaseName) throws DfException
docbaseName
- the name of the repository associated with the servers for which you are requesting informationDfException
- if a server error occursIDfAuditTrailManager getAuditTrailManager() throws DfException
DfException
IDfEventManager getEventManager() throws DfException
DfException
java.lang.String getDocbaseScope() throws DfException
DfException
- if the session is disconnectedsetDocbaseScope(java.lang.String)
,
setDocbaseScopeById(com.documentum.fc.common.IDfId)
java.lang.String setDocbaseScope(java.lang.String docbaseName) throws DfException
synchronized (session) { String strOriginalScope = session.getDocbaseScope(); try { session.setDocbaseScopeById(exprObjId); [Your code goes here] } finally { session.setDocbaseScope(strOriginalScope); } }This solution works only for Java clients. Do not use this method from COM or .NET when several threads share the same DFC session. To return the current default docbase scope, use
getDocbaseScope()
.
For more information about docbase scope, refer to Server Fundamentals.docbaseName
- the repository nameDfException
- if the session is disconnectedgetDocbaseScope()
java.lang.String setDocbaseScopeById(IDfId objectId) throws DfException
objectId
- an IDfId object that contains the object IDDfException
- if the session is disconnectedgetDocbaseScope()
boolean isAdopted() throws DfException
IDfClient.adoptDMCLSession(java.lang.String)
.true
if this is an adopted DMCL session; false
if it is notDfException
- if the session has been disconnectedboolean isRemote() throws DfException
true
DfException
boolean lock(int timeoutInMsec)
timeoutInMsec
defines how long lock
waits for the session to become available. If the
session is not available in the specified amount of time, lock
returns false
.timeoutInMsec
- Specifies the amount of time, in milliseconds, to wait for the lock to be available. If 0 or
a negative value, lock
returns immediately without waiting.true
if successful or false
otherwiseunlock()
boolean unlock()
true
if successful or false
if your thread didn't own the locklock(int)
java.lang.String getDMCLSessionId() throws DfException
getSessionId()
instead.DfException
- if this session has been disconnectedvoid traceDMCL(int level, java.lang.String traceFile) throws DfException
IDfClient.getClientConfig()
level
- A value of 0 disables tracing, a non-zero value enables tracing.traceFile
- the location of the API log file; If unspecified a default value is used. Refer to
the Server Administrator's Guide for more information about tracing.DfException
- if a server error occursboolean isServerTraceOptionSet(java.lang.String optionName) throws DfException
optionName
- A valid server-side tracing option nameDfException
- if a server error occursvoid setServerTraceLevel(int level, java.lang.String facility) throws DfException
level
- facility
- DfException
- if a server error occursjava.lang.String apiGet(java.lang.String cmd, java.lang.String args) throws DfException
apiGet
automatically inserts the session ID into calls made to this method, do not add the
session argument to server API calls that require them.
The following code example demonstrates how to issue the "get" API method:
if (sess.apiGet("get","0900d5bb8001f900,object_name").equals("testDoc")) { // Get succeeded... }
cmd
- the server API.args
- the arguments for the API specified in cmd
. Refer to the Server Reference
Manual for more information about arguments for server APIs.cmd
. Refer to the Server Reference
Manual for more information about the return values for server APIs.DfException
- if the dmAPIGet
server API failed.boolean apiSet(java.lang.String cmd, java.lang.String args, java.lang.String value) throws DfException
if (sess.apiSet("set","0900d5bb8001f900,object_name","newName")) { // Set succeeded... }
cmd
- The server API.args
- The arguments for the API specified in cmd
. Refer to the Server Reference
Manual for more information about arguments for server APIs.value
- The value that you want to assign to the attribute.true
is always returnedDfException
- if the dmAPISet
server API failed.boolean apiExec(java.lang.String cmd, java.lang.String args) throws DfException
if (sess.apiExec("grant","0900d5bb8001f900,tuser,7")) { // Successfully issued the grant API... }
cmd
- the server API.args
- the arguments for the API specified in cmd
. Refer to the Server Reference
Manual for more information about arguments for server APIs.true
is always returnedDfException
- if the dmAPIExec
server API failed .java.io.ByteArrayInputStream apiGetBytes(java.lang.String cmd, java.lang.String args, java.lang.String buf, java.lang.String buflen, int length) throws DfException
apiGet
to process the collection returned when you issue a DMCL
getcontent method, which returns data from a memory buffer. Use Next to iterate through the collection and
apiGetBytes
to retrieve the items in the collection. Because apiGetBytes
automatically
inserts the session ID into calls made to this method, do not add that argument to server API calls that require
them.
For example:
coll=apiGet("getcontent","object_id") while(dmAPIExec("next",...) textBuffer=apiGetBytes("get",......)
cmd
- the server API that you want to pass to the DFC.args
- the arguments for the API specified in cmd
. Refer to the Server Reference
Manual for more information about arguments for server APIs.buf
- Set this to _content_buffer.buflen
- Set this to current_length.length
- The length of the content stored in memory. This parameter is optional and currently unused if
set.DfException
- if the server returns an error.boolean apiSetBytes(java.lang.String cmd, java.lang.String args, java.io.ByteArrayOutputStream content) throws DfException
apiSetBytes
instead of apiSet
in these instances.
However, application developers are encouraged to write to the DFC since all functionality in the server APIs can
be accessed through the DFC classes.
Refer to the Server Reference Manual for more information about server APIs.cmd
- The server API that you want to pass to the DFCargs
- The arguments for the API specified in cmd
. Refer to the Server Reference
Manual for information server API syntax.content
- A ByteArrayOutputStream containing the content that you want to pass with the server API specified
with cmd
true
if the call to the server API specified with cmd
was successful;
false
if notDfException
- if the server returns an errorIDfList apiDesc(java.lang.String api) throws DfException
IDfList list = apiDesc("apply"); String status = list.getString( 0 ); int cmdId = list.getInt( 1 ); int cmdCallType = list.getInt( 2 ); int cmdSession = list.getInt( 3 );
api
- the name of the apiDM_EXEC
, DM_GET
, DM_SET
, DM_OTHER
), and
the third integer is the session.DfException
- if a server error occursboolean resetTicketKey() throws DfException
DfException
java.lang.String exportTicketKey(java.lang.String password) throws DfException
password
- used to encrypt the login ticket key.DfException
boolean importTicketKey(java.lang.String key, java.lang.String password) throws DfException
key
- an encrypted login ticket key exported by exportTicketKey.password
- used to encrypt/decrypt the login ticket key.DfException
void addDynamicGroup(java.lang.String groupName) throws DfException
groupName
- name of the dynamic group to which the session user should be addedDfException
- if a server error occursvoid removeDynamicGroup(java.lang.String groupName) throws DfException
groupName
- name of the dynamic group from which to remove the session userDfException
- if a server error occursint getDynamicGroupCount() throws DfException
DfException
- if a server error occursjava.lang.String getDynamicGroup(int index) throws DfException
index
- of the dynamic group desiredDfException
- if a server error occursboolean resetPassword(java.lang.String password) throws DfException
password
- - new password or login ticketDfException
- if a server error occursjava.lang.String getApplicationToken(java.lang.String userName, java.lang.String scope, int timeout, java.lang.String appId, boolean machineOnly) throws DfException
userName
- - user for whom to acquire a tokenscope
- - the scope of acquired token. It can be "docbase" or "global"timeout
- - How long the acquired token will remain valid after generationappId
- - Application IDmachineOnly
- - if the acquired token can be used only on the client machine where is acquired.DfException
- if a server error occursIDfLocalModuleRegistry getModuleRegistry() throws DfException
IDfLocalModulesRegistry
, a repository module registry object.DfException
IDfEnumeration getObjectPaths(IDfId objectId) throws DfException
IDfEnumeration object of IDfObjectPath objects for an object with a given object
id.
objectId
- an IDfId
object that contains the object IDIDfEnumeration
object of IDfObjectPath
objects. IDfObjectPath
objects with empty or duplicate getAccessibleFolderIds() are ommited. IDfEnumeration
is
empty if object not found or there is no IDfObjectPath
objects to return.DfException
- if a server error occurs.IDfObjectPathsMap getObjectPaths(IDfList objectIdsList) throws DfException
IDfObjectPath objects for a list of objects with given object
ids.
objectIdsList
- an IDfList
of IDfId
object that contains the object IDsIDfObjectPathsMap
object of IDfObjectPath
objects.DfException
- if a server error occurs.void assume(IDfLoginInfo loginInfo) throws DfException
loginInfo
- An IDfLoginInfo
object that contains the required user validation information.DfException
- if a server error occurs.IDfAcsTransferPreferences getAcsTransferPreferences()
IDfAcsTransferPreferences
object.IDfAcsTransferPreferences
objectvoid setAcsTransferPreferences(IDfAcsTransferPreferences acsTransferPreferences)
IDfAcsTransferPreferences
object.acsTransferPreferences
- IDfAcsTransferPreferences
objectboolean isRestricted()
changePassword(java.lang.String, java.lang.String)
.boolean isDeadlockVictim()
void publishDataDictionary(java.lang.String locale, java.lang.String typeName, java.lang.String attributeName, boolean forcePublish) throws DfException
locale
- Identifies the locale for which you want to publish data dictionary information. You can specify a locale or the keyword DM_SESSION_DD_LOCALE. You can specify any locale found in the dd_locales attribute of the docbase config object.typeName
- Identifies the object type for which you want to publish data dictionary information. Use the object type�s internal name. If this is not included, all data dictionary information for the specified locale is published.attributeName
- Identifies a specific attribute whose information you want to publish. If you include an attribute name, you must include the type argument, and the type argument must identify the object type for which the attribute is defined.forcePublish
- Indicates whether to publish all data dictionary objects for the object type, attribute , or locales or only those whose resync_needed attribute is TRUE. This argument is FALSE by default.DfException
boolean isServerAuthenticated()
boolean isClientAuthenticated()
void reparentLightObjects(IDfId newParentId, IDfList childIds) throws DfException
newParentId
- childIds
- DfException
void flushObject(IDfId objectId) throws DfException
DfException
void flushCachedQuery(java.lang.String dqlQuery) throws DfException
DfException
void killSession(IDfId sessionId, java.lang.String immediacyLevel, java.lang.String message) throws DfException
sessionId
- the id of the session to kill (returned by the LIST_SESSIONS administrative
method.immediacyLevel
- Enumeration value indicating when the session will be killed
(@see DfSessionKillImmediacyLevel).message
- a user message of up to 255 characters that will be placed in the server log.DfException
IDfSessionScopeManager getSessionScopeManager()
IDfFtConfig getFtConfig() throws DfException
DfException
com.documentum.fc.client.mq.IDfMessageQueueManager getMessageQueueManager()
DfException
boolean requestDormancy() throws DfException
DfException
- if an error occurs while requesting dormancyboolean requestDormancy(boolean allServersForThisDocbase) throws DfException
allServersForThisDocbase
- when true, dormancy is requested for this docbase. This state is persistent for
the docbase and will have to be explicitly made active When false, dormancy is
requested only for the server through which this session is connectedDfException
- if an error occurs while requesting dormancycom.documentum.fc.client.DormantStatus checkDormantStatus() throws DfException
DfException
- if an error occurs while requesting statuscom.documentum.fc.client.DormantStatus checkDormantStatus(boolean allServersForThisDocbase) throws DfException
allServersForThisDocbase
- when true, status check is requested for this docbase. When false, status check
is requested only for the server through which this session is connectedDfException
- if an error occurs while requesting statusboolean makeActive() throws DfException
DfException
- if an error occurs while requesting dormancyboolean makeActive(boolean allServersForThisDocbase) throws DfException
allServersForThisDocbase
- when true, a request is made to make this docbase active. When false, a request
is made to make the server to which this session is connected active.DfException
- if an error occurs while requesting dormancyboolean enableSaveInDormantState() throws DfException
DfException
- if an error occurs while enabling save operations in dormant stateboolean disableSaveInDormantState() throws DfException
DfException
- if an error occurs while disabling saveboolean projectDormantStatus() throws DfException
DfException
- if an error occurs while projecting dormant status to docbrokerboolean projectActiveStatus() throws DfException
projectDormantStatus
.DfException
- if an error occurs while projecting dormant status to docbroker or if the server is in
DORMANT state and this method is called to make it ACTIVE.IDfCollection startGatheringMetrics(java.util.List<java.lang.String> metricsToGather) throws DfException
componentIdentifer@metric
where
componentIdentifier is CS i.e. Content Server. If no componentIdentifier is specified it will still pick CS.
Please lookup the server administration manual for the names of metrics that can be gathered.metricsToGather
- a list of metrics in the above mentioned format to start gatheringDfException
- if an error occurs while gathering metricsIDfCollection stopGatheringMetrics(java.util.List<java.lang.String> metricsToStop) throws DfException
componentIdentifer@metric
where
componentIdentifier is CS i.e Content Server. If no componentIdentifier is specified it still defaults to CS.
Please lookup the server administration manual for the names of metrics that can be gathered.metricsToStop
- a list of metrics in the above mentioned format to stop gatheringDfException
- if an error occurs while gathering metricsIDfCollection collectMetrics(java.util.List<java.lang.String> metricsToCollect) throws DfException
componentIdentifer@metric
where
componentIdentifier is CS i.e. Content Server. If no componentIdentifier is specified it will still pick Content Server.
Please lookup the server administration manual for the names of metrics that can be gathered.metricsToCollect
- a list of metrics in the above mentioned format to collectDfException
- if an error occurs while gathering metricsIDfCollection collectMetrics(java.util.List<java.lang.String> metricsToCollect, java.lang.String outputFormat) throws DfException
componentIdentifer@metric
where
componentIdentifier is CS i.e. Content Server. If no componentIdentifier is specified it will still pick Content Server.
Please lookup the server administration manual for the names of metrics that can be gathered.metricsToCollect
- a list of metrics in the above mentioned format to collectoutputFormat
- a String indicating the format in which metrics are gathered. Valid values are,
- NATIVE or empty String or null – Behaves like the method with no parameter for the metrics
-JSON – The metrics gathered will be in JSON formatDfException
- if an error occurs while gathering metricsIDfCollection listMetricsState() throws DfException
DfException
- if an error occurs while listing metric statesboolean resetMetrics() throws DfException
DfException
- if an error occured while resetting metricsCopyright 1994-2023 OpenText Corporation. All rights reserved.