public interface IDfDocbrokerClient
Modifier and Type | Method and Description |
---|---|
void |
addDocbroker(java.lang.String hostName,
int portNumber)
Dynamically adds a connection broker to the list of known connection brokers.
|
IDfTypedObject |
getAcsServerMap(java.lang.String docbaseName)
Returns information about the ACS servers that are known to the set of connection brokers
currently configured for this IDfDocbrokerClient instance.
|
IDfTypedObject |
getAcsServerMapFromSpecificDocbroker(java.lang.String docbaseName,
java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber)
Returns information about the ACS servers that are known to a specific connection broker.
|
IDfDocbaseMap |
getDocbaseMap()
Returns information about the repositories that are known to the set of connection brokers currently configured for this
IDfDocbrokerClient instance.
|
IDfDocbaseMap |
getDocbaseMapFromSpecificDocbroker(java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber)
Returns information about the repositories that are known to a specific connection broker.
|
java.lang.String |
getDocbaseNameFromDocbaseId(long docbaseId)
Returns the name of the repository from its numeric id.
|
java.lang.String |
getDocbaseNameFromId(IDfId objectId)
Returns the name of the repository from which the object and its
IDfId originated. |
IDfTypedObject |
getDocbrokerMap()
Returns information about the connection brokers known to this IDfDocbrokerClient instance.
|
IDfTypedObject |
getServerMap(java.lang.String docbaseName)
Returns information about the servers that are known to the set of connection brokers currently configured for this
IDfDocbrokerClient instance.
|
IDfTypedObject |
getServerMapFromSpecificDocbroker(java.lang.String docbaseName,
java.lang.String protocol,
java.lang.String hostName,
java.lang.String portNumber)
Returns information about the servers that are known to a specific connection broker.
|
boolean |
isDocbrokerModificationEnabled()
Indicates whether connection brokers can be dynamically added or removed.
|
void |
removeDocbroker(java.lang.String hostName,
int portNumber)
Dynamically removes a connection broker that was added using
addDocbroker(java.lang.String, int) . |
void |
setDocbrokerModificationEnabled(boolean enable,
IDfSession session)
Enables or disables the dynamic adding and removing of connection brokers.
|
IDfTypedObject getDocbrokerMap() throws DfException
DfException
- if a server error occursvoid addDocbroker(java.lang.String hostName, int portNumber) throws DfException
IDfClient
interface will not see dynamically added connection brokers.DfException
removeDocbroker(java.lang.String, int)
void removeDocbroker(java.lang.String hostName, int portNumber) throws DfException
addDocbroker(java.lang.String, int)
.DfException
addDocbroker(java.lang.String, int)
IDfDocbaseMap getDocbaseMap() throws DfException
DfException
- if a server error occursgetDocbaseMapFromSpecificDocbroker(java.lang.String, java.lang.String, java.lang.String)
IDfDocbaseMap getDocbaseMapFromSpecificDocbroker(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 repostories that are known to
a connection brokerDfException
- if a server error occursgetDocbaseMap()
IDfTypedObject getServerMap(java.lang.String docbaseName) throws DfException
docbaseName
- the name of the repository for which you are requesting server informationDfException
- if a server error occursgetServerMapFromSpecificDocbroker(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
,
getDocbaseMap()
IDfTypedObject getAcsServerMap(java.lang.String docbaseName) throws DfException
docbaseName
- the name of the repository for which you are requesting server informationDfException
- if a server error occursgetAcsServerMapFromSpecificDocbroker(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
IDfTypedObject getServerMapFromSpecificDocbroker(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 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 communicationsDfException
- if a server error occursgetServerMap(java.lang.String)
IDfTypedObject getAcsServerMapFromSpecificDocbroker(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 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 communicationsDfException
- if a server error occursgetAcsServerMap(java.lang.String)
java.lang.String getDocbaseNameFromId(IDfId objectId) throws DfException
IDfId
originated.objectId
- the object idDfException
- if a server error occursjava.lang.String getDocbaseNameFromDocbaseId(long docbaseId) throws DfException
docbaseId
- the numeric repository nameDfException
- if a server error occursvoid setDocbrokerModificationEnabled(boolean enable, IDfSession session) throws DfException
enable
- an indication of whether to enable or disable connection broker modificationsession
- an existing session for a user that has administrative privileges.DfException
addDocbroker(String, int)
,
removeDocbroker(String, int)
,
isDocbrokerModificationEnabled()
boolean isDocbrokerModificationEnabled()
Copyright 1994-2023 OpenText Corporation. All rights reserved.