public interface IDfAcsClient
Modifier and Type | Interface and Description |
---|---|
static interface |
IDfAcsClient.AcsData |
Modifier and Type | Method and Description |
---|---|
void |
addUnavailableAcsServer(java.lang.String urlString)
Add the specified accelerated content store (ACS) server
to the list of unavailable ACS servers.
|
IDfEnumeration |
getAcsData(IDfSessionManager sessionManager,
java.lang.String docbaseName,
java.lang.String networkLocationIdentifier)
Returns an
IDfEnumeration object that lists all
AcsData objects for a given repository. |
IDfEnumeration |
getAcsData(IDfSession session,
java.lang.String networkLocationIdentifier)
Returns an
IDfEnumeration object that lists all
AcsData objects for a given repository. |
long |
getAcsRequestExpirationInterval()
Returns expiration interval being used for requests made to this ACS.
|
IDfEnumeration |
getAllNetworkLocations(java.lang.String locale)
Returns an
IDfEnumeration object that lists all IDfNetworkLocationEntry objects. |
IDfEnumeration |
getClientNetworkLocations(java.lang.String clientIPAddress,
java.lang.String locale)
Returns an
IDfEnumeration object that lists all IDfNetworkLocationEntry objects. |
IDfNetworkLocationEntry |
getNetworkLocation(java.lang.String locationId,
java.lang.String locale)
Returns an
IDfNetworkLocationEntry object by location identifier. |
boolean |
isContentTransferCapabilityEnabled(IDfSession session,
java.lang.String networkLocationIdentifier,
IDfContentTransferCapability capability)
Returns whether content transfer capability is enabled in a docbase
of a given session.
|
void |
setAcsRequestExpirationInterval(long expirationInterval)
Sets an expiration interval to be used for requests made to this ACS.
|
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
- if a server error occurs.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
- if a server error occurs.IDfEnumeration getAllNetworkLocations(java.lang.String locale) throws DfException
IDfEnumeration
object that lists all IDfNetworkLocationEntry
objects.locale
- identifies the locale (currently not supported)IDfNetworkLocationEntry
objectsDfException
- if a server error occurs.void addUnavailableAcsServer(java.lang.String urlString) throws DfException
urlString
- URL for the unavailable ACS server, expressed as a StringDfException
- if a server error occurs.IDfEnumeration getAcsData(IDfSessionManager sessionManager, java.lang.String docbaseName, java.lang.String networkLocationIdentifier) throws DfException
IDfEnumeration
object that lists all
AcsData
objects for a given repository.sessionManager
- session manager objectdocbaseName
- repository namenetworkLocationIdentifier
- network location identifierAcsData
objectsDfException
- if a server error occurs.IDfEnumeration getAcsData(IDfSession session, java.lang.String networkLocationIdentifier) throws DfException
IDfEnumeration
object that lists all
AcsData
objects for a given repository.
for a given networkLocationIdentifier
.
session
- session, which MUST point to a proper repository.networkLocationIdentifier
- network location identifierAcsData
objectsDfException
- if a server error occurs.boolean isContentTransferCapabilityEnabled(IDfSession session, java.lang.String networkLocationIdentifier, IDfContentTransferCapability capability) throws DfException
session
- session, which points to a correct docbasenetworkLocationIdentifier
- user network location identifiercapability
- content transfer capabilityDfException
- if a server error occurs.void setAcsRequestExpirationInterval(long expirationInterval)
expirationInterval
- Request expiration intervallong getAcsRequestExpirationInterval()
Copyright 1994-2023 OpenText Corporation. All rights reserved.