public interface IDfClient
IDfClient
interface provides methods for:
Modifier and Type | Method and Description |
---|---|
void |
addUnavailableAcsServer(java.lang.String urlString)
Deprecated.
use IDfAcsClient.addUnavailableAcsServer()
|
IDfSession |
adoptDMCLSession(java.lang.String dmclSessionId)
Deprecated.
session adoption is no longer useful without a separate DMCL
|
void |
authenticate(java.lang.String docbaseName,
IDfLoginInfo loginInfo)
Validates a username/password combination without returning a new session.
|
java.lang.String |
decryptText(java.lang.String s1,
java.lang.String s2)
Deprecated.
|
java.lang.String |
encryptPassword(java.lang.String password)
Encrypts a password.
|
java.lang.String |
encryptText(java.lang.String s1,
java.lang.String s2)
Deprecated.
|
java.util.Enumeration |
enumSharedSessions(java.lang.String key)
Deprecated.
use
IDfSessionManager instead for session sharing |
IDfSession |
findSession(java.lang.String sessionId)
Returns an existing DFC session using a DFC session ID.
|
IDfEnumeration |
getAllNetworkLocations(java.lang.String locale)
Deprecated.
use IDfAcsClient.getAllNetworkLocations()
|
java.lang.String |
getApplicationTokenDiagnostics(java.lang.String applicationToken)
Return details extracted from an applicationToken.
|
IDfTypedObject |
getClientConfig()
Returns information about DFC.
|
IDfEnumeration |
getClientNetworkLocations(java.lang.String clientIPAddress,
java.lang.String locale)
Deprecated.
use IDfAcsClient.getClientNetworkLocations()
|
IDfProperties |
getContext(java.lang.String contextId)
Returns the
IDfProperties object associated with a particular client. |
IDfDbor |
getDbor()
Deprecated.
Please use
getModuleRegistry() instead |
IDfDocbaseMap |
getDocbaseMap()
Returns information about the repositories that are known to a connection broker.
|
IDfDocbaseMap |
getDocbaseMapEx(java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber)
Returns information about the repositories that are known to a connection broker.
|
java.lang.String |
getDocbaseNameFromDocbaseId(long docbaseId)
Returns the name of the repository with the specified numeric docbase id.
|
java.lang.String |
getDocbaseNameFromId(IDfId objectId)
Returns the name of the repository from where the object and its
IDfId originated. |
IDfTypedObject |
getDocbrokerMap()
Returns information about the connection brokers known to the DFC.
|
com.documentum.fc.client.license.ILicenseManager |
getLicenseManager() |
java.lang.String |
getLoginTicketDiagnostics(java.lang.String loginTicket)
Return details extracted from a login ticket.
|
IDfGlobalModuleRegistry |
getModuleRegistry()
Factory method that instantiates an
IDfGlobalModuleRegistry global module registry object. |
IDfNetworkLocationEntry |
getNetworkLocation(java.lang.String locationId,
java.lang.String locale)
Deprecated.
use IDfAcsClient.getNetworkLocation()
|
IDfTypedObject |
getServerMap(java.lang.String docbaseName)
Returns information about the servers that are known to a connection broker.
|
IDfTypedObject |
getServerMapEx(java.lang.String docbaseName,
java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber)
Returns information about the servers known to a connection broker.
|
IDfSession |
getSharedSession(java.lang.String docbaseName,
IDfLoginInfo loginInfo,
java.lang.String key)
Deprecated.
use
IDfSessionManager instead for session sharing |
com.documentum.fc.client.transaction.IDfTransactionManager |
getTransactionManager()
Returns the transaction manager.
|
void |
initCrypto(java.lang.String keyFile)
Initializes the key store for password encryption.
|
void |
initCryptoEx(java.lang.String keyFile,
java.lang.String passphrase)
Initializes the key store for password encryption.
|
IDfModule |
newModule(java.lang.String hostingDocbase,
java.lang.String moduleName,
IDfSessionManager sessionMgr)
Factory method that constructs and instantiates the specified Module.
|
com.documentum.operations.IDfOperationManager |
newOperationManager()
Returns operation manager.
|
IDfRetentionService |
newRetentionService()
Factory method to create a new instance of the retention service.
|
IDfSearchService |
newSearchService(IDfSessionManager sessionManager)
Deprecated.
Replaced by newSearchService(IDfSessionManager, String)
|
IDfSearchService |
newSearchService(IDfSessionManager sessionManager,
java.lang.String defaultMetadataDocbase)
Factory method to create a new instance of the search service.
|
IDfService |
newService(java.lang.String name,
IDfSessionManager sessionMgr)
Factory method that constructs and instantiates the specified business object service.
|
IDfSession |
newSession(java.lang.String docbaseName,
IDfLoginInfo loginInfo)
Factory method that always constructs a new
IDfSession object and establishes a new session with the
specified Documentum server. |
IDfSessionManager |
newSessionManager()
Factory method that constructs a new
IDfSessionManager object for managing sessions and transactions
with one or more repositories. |
boolean |
removeContext(java.lang.String contextId)
Deletes a
IDfProperties object containing client information. |
void |
setPrincipalSupport(IDfPrincipalSupport support)
Changes the session manager mode from "identity" mode to "Principal Support" mode in order to support single sign
in.
|
void |
unadoptDMCLSession(java.lang.String dmclSessionId)
Deprecated.
session adoption is no longer useful without a separate DMCL
|
IDfSession newSession(java.lang.String docbaseName, IDfLoginInfo loginInfo) throws DfException
IDfSession
object and establishes a new session with the
specified Documentum server.
Since DFC 5.1, it is recommended that you use IDfSessionManager.newSession(java.lang.String)
method instead of this
one.
Note that a DFC session created with this method is not shared. Use getSharedSession(java.lang.String, com.documentum.fc.common.IDfLoginInfo, java.lang.String)
to establish a
shared session with a server.
The following code example demonstrates how to obtain an IDfSession
interface to a new DFC session:
IDfClient client = DfClient.getLocalClient(); IDfLoginInfo login = new IDfLoginInfo(); login.setUser( "username" ); login.setPassword( "password" ); login.setDomain( null ); IDfSession session = client.newSession(docbaseName, login);
docbaseName
- identifies the repository with which you want to establish a session. Specify the name of the
repository in one of the following formats:loginInfo
- An IDfLoginInfo
object that contains the required user validation information.
You can pass in null to use the Windows NT Unified Login.IDfSession
interface to the new DFC session.DfException
- if a server error occurs.getSharedSession(java.lang.String, com.documentum.fc.common.IDfLoginInfo, java.lang.String)
,
IDfSession.disconnect()
,
IDfSessionManager.newSession(java.lang.String)
IDfSession getSharedSession(java.lang.String docbaseName, IDfLoginInfo loginInfo, java.lang.String key) throws DfException
IDfSessionManager
instead for session sharingThe following code example demonstrates how to obtain an interface to a non-shared session, then obtain an interface to the shared session:
IDfClient client = DfClient.getLocalClient(); IDfLoginInfo li = new IDfLoginInfo(); li.setUser("tuser"); li.setPassword("somePass"); // Here's a brand new session. IDfSession sess1 = client.getSharedSession("docbaseName", li, "uniqueKey"); // Here's a second session shared with sess1. IDfSession sess2 = client.getSharedSession("docbaseName", li, "uniqueKey");
docbaseName
- the repository with which you want to establish a DFC session: Specify the name of the
repository in one of the following formats:
loginInfo
- an IDfLoginInfo
interface containing the required user validation information. You may
leave this parameter empty if you want to use a unified login. Unified logins are specific to
Windows NT.key
- an application-defined string. Note that for security purposes, there is no DFC method that
returns this key. You must remember it if you wish to locate and use the shared session
created or returned by this method.IDfSession
interface to the new shared DFC session.DfException
- if a server error occurs.newSession(java.lang.String, com.documentum.fc.common.IDfLoginInfo)
,
IDfSession.disconnect()
,
enumSharedSessions(java.lang.String)
IDfSession adoptDMCLSession(java.lang.String dmclSessionId) throws DfException
connect
server
API, or is obtained from an existing DFC IDfSession
object via the method IDfSession.getDMCLSessionId()
. The purpose of this function is to allow an application that already has a DMCL
session to use DFC. In some cases, application developers may decide to call the DMCL directly when migrating
pre-DFC customizations. When possible, however, developers are encouraged to establish sessions through the
DFC.
The following code example demonstrates how to obtain an IDfSession
interface by adopting a DMCL
session obtained from another DFC session interface:
IDfClient client = DfClient.getLocalClient(); IDfSession sess2 = client.adoptDMCLSession(sess1.getDMCLSessionId());
dmclSessionId
- the DMCL session ID.IDfSession
interface to the DMCL session. Note
that you cannot call the IDfSession.disconnect()
method on the
returned IDfSession
interface. Use the
disconnect
DMCL server API instead.DfException
- if a server error occurs.unadoptDMCLSession(java.lang.String)
,
IDfSession.isAdopted()
,
IDfSession.getDMCLSessionId()
void unadoptDMCLSession(java.lang.String dmclSessionId) throws DfException
adoptDMCLSession(java.lang.String)
method.
A DMCL session is a session that is established by a direct call to the DMCL's connect
server API,
rather than through the DFC. Note that this method does not disconnect a DMCL session. Sessions established
through the DMCL must also be disconnected through the DMCL with a call to the disconnect
server
API.
The following code example demonstrates how to adopt a DMCL session then release the session by unadopting the
DMCL session:
IDfClient client = DfClient.getLocalClient(); IDfSession sess2 = client.adoptDMCLSession(sess1.getDMCLSessionId()); client.unadoptDMCLSession(sess2.getDMCLSessionId()); if (!sess2.isConnected()) { // This is what we expect... }
dmclSessionId
- the DMCL session IDDfException
- if a server error occursadoptDMCLSession(java.lang.String)
,
IDfSession.isAdopted()
java.util.Enumeration enumSharedSessions(java.lang.String key) throws DfException
IDfSessionManager
instead for session sharingkey
- an application-defined string that identifies the shared session. Note that there is no DFC method
that returns this key. This is the same string you passed to getSharedSession(java.lang.String, com.documentum.fc.common.IDfLoginInfo, java.lang.String)
.Enumeration
object containing all the shared sessions corresponding to the key.
Will return an empty enumeration if no session is shared using the key passed.DfException
- if a server error occurs.getSharedSession(java.lang.String, com.documentum.fc.common.IDfLoginInfo, java.lang.String)
IDfSession findSession(java.lang.String sessionId) throws DfException
IDfSession
instance where both instances share the same underlying session id.
The following code example demonstrates how to obtain a second IDfSession
interface from another IDfSession
interface:
IDfSession sess2 = client.findSession(sess1.getSessionId());
sessionId
- the DFC session ID obtained by calling IDfSession.getSessionId()
IDfSession
interface to the DFC session.DfException
- if a server error occurs.IDfSession.getSessionId()
IDfTypedObject getClientConfig() throws DfException
IDfTypedObject
interface to the client configuration informationDfException
- if a server error occursIDfDocbaseMap getDocbaseMap() throws DfException
DfException
- if a server error occursgetDocbaseMapEx(java.lang.String, java.lang.String, java.lang.String)
,
getServerMap(java.lang.String)
,
getDocbrokerMap()
IDfDocbaseMap getDocbaseMapEx(java.lang.String protocol, java.lang.String hostName, java.lang.String portNumber) throws DfException
protocol
- the protocol used to talk to the connection broker (not used in most cases)hostName
- the host machine on which the connection broker residesportNumber
- the port number which the connection broker is using for communicationsIDfDocbaseMap
interface to the extended information about the repositories that are known to a
connection brokerDfException
- if a server error occursgetDocbaseMap()
IDfTypedObject getDocbrokerMap() throws DfException
DfException
- if a server error occursgetDocbaseMap()
,
getServerMap(java.lang.String)
IDfTypedObject 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 occursgetDocbaseMap()
,
getDocbrokerMap()
IDfTypedObject getServerMapEx(java.lang.String docbaseName, java.lang.String protocol, java.lang.String hostName, java.lang.String portNumber) throws DfException
docbaseName
- the name of the repositoryprotocol
- the protocol used to talk to the connection brokerhostName
- the host machine on which the connection broker residesportNumber
- the port number which the connection broker is using for communicationsIDfDocbaseMap
interface to the extended information about the servers that are known to a
connection brokerDfException
- if a server error occursgetServerMap(java.lang.String)
java.lang.String getDocbaseNameFromId(IDfId objectId) throws DfException
IDfId
originated.objectId
- an IDfId
interface containing an object IDDfException
- if a server error occursjava.lang.String getDocbaseNameFromDocbaseId(long docbaseId) throws DfException
docbaseId
- the numeric docbase id.DfException
- if a server error occurs or if the docbase name is unknown.IDfProperties getContext(java.lang.String contextId) throws DfException
IDfProperties
object associated with a particular client.
IDfProperties
objects are non-persistent objects used to store arbitrary information about a client.contextId
- an application-defined key to the Properties object; Note that for security purposes, there is
no DFC method that returns this key.IDfProperties
interface to the client objectDfException
- if the specified IDfProperties
object doesn't exist and an attempt to create it
failsremoveContext(java.lang.String)
boolean removeContext(java.lang.String contextId) throws DfException
IDfProperties
object containing client information.
Property objects are non-persistent objects that store arbitrary information about a client used at runtime.contextId
- an application-defined key to the Properties object; Note that for security purposes, there is
no DFC method that returns this key.DfException
- if the method failsgetContext(java.lang.String)
IDfService newService(java.lang.String name, IDfSessionManager sessionMgr) throws DfServiceException
IDfClient client = DfClient.getLocalClient(); IDfSessionManager sMgr = client.newSessionManager(); String strService = IAutoNumber.class.getName(); IAutoNumber autonumber = (IAutoNumber)client.newService( strService, sMgr ); int iNextNumber = autonumber.getUniqueNumber();
name
- the logical service name. The business objects framework recommends use of the fully qualified
interface name of the service interface as a logical service name. This prevents naming
conflicts. Example: IAutoNumber.class.getName()
might return
"com.accelera.autonumber.IAutoNumber
" as the fully qualified name.sessionMgr
- the session handle of type IDfSessionManager
.IDfService
interface that can be downcasted to the specific service
interface.DfServiceInstantiationException
- Cannot create service due to class loading issues.DfServiceException
- Cannot create serviceDfDborNotFoundException
- Cannot find DBO RegistryDfServiceNotFoundException
- Cannot find service in DBORIDfDbor.lookupService(java.lang.String)
IDfModule newModule(java.lang.String hostingDocbase, java.lang.String moduleName, IDfSessionManager sessionMgr) throws DfServiceException
hostingDocbase
- the repository frommoduleName
- the logical module name. IDfSessionManager
.sessionMgr
- the session handle of typeIDfModule
interfaceDfServiceException
- Cannot create moduleIDfSessionManager newSessionManager()
IDfSessionManager
object for managing sessions and transactions
with one or more repositories. Since DFC 5.1, using this method instead of newSession is recommended.
The IDfSessionManager
object encapsulates one or more "managed" DFC session objects and dynamically
manages the session pool.
IDfClient client = DfClient.getLocalClient(); IDfSessionManager sMgr = client.newSessionManager(); IDfLoginInfo login = new DfLoginInfo(); login.setUser( strUserName ); login.setPassword( strPassword ); login.setDomain( null ); sMgr.setIdentity( strDocbase1, login ); sMgr.setIdentity( strDocbase2, login );
IDfSessionManager
object.void setPrincipalSupport(IDfPrincipalSupport support)
IDfPrincipalSupport
object must be a custom class that
implements IDfPrincipalSupport
and overrides its IDfPrincipalSupport.getSession(java.lang.String, java.lang.String)
method.support
- IDfPrincipalSupport
IDfDbor getDbor()
getModuleRegistry()
insteadIDfDbor
business objects registry management object.
IDfDbor dbor = m_client.getDbor(); IDfDborEntry entry = new DfDborEntry(); entry.setName( strDocbaseTypeName ); entry.setServiceBased( bDborService ); entry.setJavaClass( strJavaClass );// AutoNumberType.class.getName() ); entry.setVersion( "1.0" ); dbor.register( entry );
IDfDbor
management object.IDfDborEntry
java.lang.String encryptPassword(java.lang.String password) throws DfException
password
- unencrypted passwordDfException
java.lang.String getApplicationTokenDiagnostics(java.lang.String applicationToken) throws DfException
applicationToken
- DfException
IDfSession.getApplicationToken(String, String, int, String, boolean).
java.lang.String getLoginTicketDiagnostics(java.lang.String loginTicket) throws DfException
loginTicket
- DfException
IDfSession.getLoginTicketEx(String, String, int, boolean, String)
void initCrypto(java.lang.String keyFile) throws DfException
keyFile
- DfException
void initCryptoEx(java.lang.String keyFile, java.lang.String passphrase) throws DfException
keyFile
- passphrase
- The passphrase used to encrypt the AEK file.DfException
java.lang.String encryptText(java.lang.String s1, java.lang.String s2) throws DfException
DfException
java.lang.String decryptText(java.lang.String s1, java.lang.String s2) throws DfException
DfException
void authenticate(java.lang.String docbaseName, IDfLoginInfo loginInfo) throws DfException
docbaseName
- identifies the repository with which you want to authenticate. Specify the name of the
repository in one of the following formats:loginInfo
- An IDfLoginInfo
object that contains the required user validation information.DfException
- if a server error occurs.IDfGlobalModuleRegistry getModuleRegistry() throws DfException
IDfGlobalModuleRegistry
global module registry object.DfException
IDfSearchService newSearchService(IDfSessionManager sessionManager)
sessionManager
- A session manager to be used for authentication against search sourcesIDfSearchService newSearchService(IDfSessionManager sessionManager, java.lang.String defaultMetadataDocbase)
sessionManager
- A session manager to be used for authentication against search sourcesdefaultMetadataDocbase
- The default repository to pick the metadata information from (e.g. information on
types). This parameter can be safely set to null
if the search service
is configured to search only on repositories and not on any external source. This
parameter must not be null
if external sources are selected through
the search service. This repository must have a corresponding login information in
the session manager.IDfRetentionService newRetentionService()
IDfNetworkLocationEntry getNetworkLocation(java.lang.String locationId, java.lang.String locale) throws DfException
IDfNetworkLocationEntry
object by location identifier.locationId
- network location identifierlocale
- identifies the locale (currently not supported)DfException
IDfEnumeration getClientNetworkLocations(java.lang.String clientIPAddress, java.lang.String locale) throws DfException
IDfEnumeration
object that lists all IDfNetworkLocationEntry
objects.clientIPAddress
- client IP address
If this argument is null, all IDfNetworkLocationEntry objects
that can be used as a client network location for a given locale are returned.locale
- identifies the locale (currently not supported)IDfNetworkLocationEntry
objectsDfException
IDfEnumeration getAllNetworkLocations(java.lang.String locale) throws DfException
IDfEnumeration
object that lists all IDfNetworkLocationEntry
objects.locale
- identifies the locale (currently not supported)IDfNetworkLocationEntry
objectsDfException
void addUnavailableAcsServer(java.lang.String urlString) throws DfException
urlString
- URL for the unavailable ACS server, expressed as a StringDfException
com.documentum.fc.client.transaction.IDfTransactionManager getTransactionManager()
com.documentum.operations.IDfOperationManager newOperationManager() throws DfException
DfException
com.documentum.fc.client.license.ILicenseManager getLicenseManager() throws DfException
DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.