public interface IDfAcsConfig extends IDfSysObject
Modifier and Type | Interface and Description |
---|---|
static interface |
IDfAcsConfig.ProjectionEntry
ProjectionEntry interface encapsulates projection target parameters.
|
static interface |
IDfAcsConfig.StoreEntry
StoreEntry interface encapsulates store type, encryption mode, and compression mode.
|
static interface |
IDfAcsConfig.UrlEntry
UrlEntry interface encapsulates base url and protocol.
|
Modifier and Type | Field and Description |
---|---|
static int |
CONFIG_TYPE_ACS |
static int |
CONFIG_TYPE_CS |
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
void |
addProjectionEntry(IDfAcsConfig.ProjectionEntry projectionEntry)
Adds ProjectionEntry object.
|
void |
addStoreEntry(IDfAcsConfig.StoreEntry storeEntry)
Adds StoreEntry object.
|
void |
addUrlEntry(IDfAcsConfig.UrlEntry urlEntry)
Adds UrlEntry object.
|
IDfList |
getAcsNetworkLocationIdentifiers()
Returns a list of the ACS network location identifiers.
|
int |
getConfigType()
Returns type of the config.
0 - no projections, i.e.
|
java.lang.String |
getDormancyStatus()
Gets the dormancy status for this ACS
|
IDfList |
getNearStores()
Returns list of names of stores that are near the ACS.
|
java.lang.String |
getObjectName()
Returns the ACS name.
|
IDfList |
getProjectionEntries()
Returns list of ProjectionEntry objects.
|
int |
getRWCapability()
Deprecated.
use isEnabled and isSurrogateGetEnabled methods
|
IDfId |
getServerConfigId()
Returns the ID of the Content Server config object for the ACS.
|
java.lang.String |
getServerMajorVersion()
Returns server major version
|
java.lang.String |
getServerMinorVersion()
Returns the server minor version
|
IDfList |
getStoreEntries()
Returns list of StoreEntry objects.
|
IDfList |
getUrlEntries()
Returns list of UrlEntry objects.
|
boolean |
isCacheAcs()
Deprecated.
as of version D6,
use
IDfBocsConfig for cache server config objects. |
boolean |
isEnabled()
Returns a flag indicating whether ACS is enabled
|
boolean |
isSurrogateGetEnabled()
Returns a flag indicating whether both read and a "surrogate get" is enabled
|
IDfAcsConfig.ProjectionEntry |
newProjectionEntry(java.lang.String networkLocationIdentifier,
int proximity)
Creates ProjectionEntry object.
|
IDfAcsConfig.ProjectionEntry |
newProjectionEntry(java.lang.String host,
int port,
int proximity)
Creates ProjectionEntry object.
|
IDfAcsConfig.ProjectionEntry |
newProjectionEntry(java.lang.String host,
int port,
int proximity,
boolean isEnabled,
java.lang.String networkLocationIdentifier,
boolean isNetworkLocationEnabled)
Creates ProjectionEntry object.
|
IDfAcsConfig.StoreEntry |
newStoreEntry(int storeType,
int cryptoMode,
int compressionMode)
Creates StoreEntry object.
|
IDfAcsConfig.UrlEntry |
newUrlEntry(java.lang.String url,
java.lang.String protocol)
Creates UrlEntry object.
|
void |
setAcsNetworkLocationIdentifiers(IDfList acsNetworkLocationIdentifiers)
Sets the ACS network location identifiers.
|
void |
setCacheAcs(boolean isCacheAcs)
Deprecated.
as of version D6,
use
IDfBocsConfig for cache server config objects. |
void |
setConfigType(int configType)
Sets type of the config.
|
void |
setEnabled(boolean isEnabled)
Sets a flag indicating whether ACS is enabled
|
void |
setNearStores(IDfList nearStores)
Sets list of names of stores that are near the ACS.
|
void |
setObjectName(java.lang.String objectName)
Sets the ACS name.
|
void |
setProjectionEntries(IDfList projectionEntries)
Replace all ProjectionEntry objects.
|
void |
setRWCapability(int capability)
Deprecated.
use setEnabled and setSurrogateGetEnabled methods
|
void |
setServerConfigId(IDfId serverConfigId)
Sets the ID of the Content Server config object for the ACS.
|
void |
setServerMajorVersion(java.lang.String majorVersion)
Sets server major version
|
void |
setServerMinorVersion(java.lang.String minorVersion)
Sets the server minor version
|
void |
setStoreEntries(IDfList storeEntries)
Replaces all StoreEntry objects.
|
void |
setSurrogateGetEnabled(boolean isEnabled)
Sets a flag indicating whether both read and a "surrogate get" is enabled.
|
void |
setUrlEntries(IDfList urlEntries)
Replaces all UrlEntry objects.
|
addDigitalSignature, addESignature, addNote, addReference, addRendition, addRenditionEx, addRenditionEx2, addRenditionEx3, appendContent, appendContentEx, appendFile, appendFileEx, appendPart, areAttributesModifiable, assemble, asVirtualDocument, attachPolicy, bindFile, branch, cancelCheckout, cancelCheckoutEx, cancelScheduledDemote, cancelScheduledPromote, cancelScheduledResume, cancelScheduledSuspend, canDemote, canPromote, canResume, canSuspend, checkin, checkinEx, checkout, checkoutEx, demote, destroyAllVersions, detachPolicy, disassemble, freeze, getAccessDate, getAccessorApplicationPermit, getAccessorCount, getAccessorName, getAccessorPermit, getAccessorPermitType, getAccessorXPermit, getAccessorXPermitNames, getACL, getACLDomain, getACLName, getAclRefValid, getAcsRequests, getAliasSet, getAliasSetId, getAntecedentId, getApplicationType, getAssembledFromId, getAuthors, getAuthorsCount, getBranchCount, getCabinetId, getChronicleId, getCollectionForContent, getCollectionForContentEx2, getCollectionForContentEx3, getCollectionForContentEx4, getComponentId, getComponentIdCount, getCompoundArchitecture, getContainId, getContainIdCount, getContent, getContentAvailability, getContentEx, getContentEx2, getContentEx3, getContentsId, getContentSize, getContentSize, getContentState, getContentStateCount, getContentType, getCreationDate, getCreatorName, getCurrentState, getCurrentStateName, getDirectDescendant, getDoubleContentAttr, getExceptionStateName, getFile, getFileEx, getFileEx2, getFolderId, getFolderIdCount, getFormat, getFrozenAssemblyCount, getFullText, getGroupName, getGroupPermit, getHasEvents, getHasFolder, getHasFrozenAssembly, getImplicitVersionLabel, getKeywords, getKeywordsCount, getLatestFlag, getLinkCount, getLinkHighCount, getLocations, getLockDate, getLockMachine, getLockOwner, getLogEntry, getMasterDocbase, getModifier, getModifyDate, getNextStateName, getOtherFileSize, getOwnerName, getOwnerPermit, getPageCount, getPath, getPathEx, getPathEx2, getPermissions, getPermit, getPermitEx, getPolicyId, getPolicyName, getPreviousStateName, getReferenceCount, getRemoteId, getRenditions, getResolutionLabel, getResumeState, getResumeStateName, getRetainerCount, getRetainerId, getRetainUntilDate, getRetentionDate, getRouters, getSpecialApp, getStatus, getStorageType, getStringContentAttr, getSubject, getTimeContentAttr, getTitle, getTypeName, getVdmPath, getVdmPathDQL, getVersionLabel, getVersionLabelCount, getVersionLabels, getVersionPolicy, getVersions, getWorkflows, getWorldPermit, getXPermit, getXPermitList, getXPermitNames, grant, grantPermit, hasPermission, insertContent, insertContentEx, insertFile, insertFileEx, insertPart, isArchived, isCheckedOut, isCheckedOutBy, isContentTransferCapabilityEnabled, isFrozen, isHidden, isImmutable, isLinkResolved, isPublic, isReference, isSuspended, isVirtualDocument, link, mark, mount, print, promote, prune, queue, refreshReference, removeContent, removeNote, removePart, removeRendition, removeRenditionEx, removeRenditionEx2, resolveAlias, resume, revertACL, revoke, revokePermit, saveAsNew, saveLock, scheduleDemote, schedulePromote, scheduleResume, scheduleSuspend, setACL, setACLDomain, setACLName, setApplicationType, setArchived, setAuthors, setCompoundArchitecture, setContent, setContentEx, setContentEx2, setContentType, setDoubleContentAttribute, setFile, setFileEx, setFullText, setGroupName, setGroupPermit, setHidden, setIsVirtualDocument, setKeywords, setLinkResolved, setLogEntry, setOwnerName, setOwnerPermit, setPath, setResolutionLabel, setSpecialApp, setStatus, setStorageType, setStringContentAttribute, setSubject, setTimeContentAttribute, setTitle, setWorldPermit, suspend, unfreeze, unlink, unmark, updatePart, updatePartEx, useACL, verifyESignature
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
static final int CONFIG_TYPE_CS
static final int CONFIG_TYPE_ACS
java.lang.String getObjectName() throws DfException
getObjectName
in interface IDfSysObject
DfException
void setObjectName(java.lang.String objectName) throws DfException
setObjectName
in interface IDfSysObject
objectName
- specifies the name of the ACS.DfException
- if a server error occurs.IDfId getServerConfigId() throws DfException
DfException
- if a server error occurs.void setServerConfigId(IDfId serverConfigId) throws DfException
serverConfigId
- ID of the Content Server config object for the ACS.DfException
- if a server error occurs.int getConfigType() throws DfException
DfException
- if a server error occurs.void setConfigType(int configType) throws DfException
configType
- type of the config.DfException
- if a server error occurs.boolean isEnabled() throws DfException
DfException
- if a server error occurs.boolean isSurrogateGetEnabled() throws DfException
DfException
- if a server error occurs.void setEnabled(boolean isEnabled) throws DfException
isEnabled
- if true, ACS is enabled, false otherwiseDfException
- if a server error occurs.void setSurrogateGetEnabled(boolean isEnabled) throws DfException
isEnabled
- if true, both read and a "surrogate get" are enabled, false otherwiseDfException
- if a server error occurs.int getRWCapability() throws DfException
0 = Unconfigured ACS 1 = read 2 = read+surrogateGet (for CS 5.3) 3 = read+surrogateGet (for CS D6)
DfException
- if a server error occurs.void setRWCapability(int capability) throws DfException
0 = Unconfigured ACS 1 = read 2 = read+surrogateGet (for CS 5.3) 3 = read+surrogateGet (for CS D6)
capability
- read/write ACS capability.DfException
- if a server error occurs.IDfList getAcsNetworkLocationIdentifiers() throws DfException
DfException
- if a server error occurs.void setAcsNetworkLocationIdentifiers(IDfList acsNetworkLocationIdentifiers) throws DfException
acsNetworkLocationIdentifiers
- list of the ACS network location identifiers.DfException
- if a server error occurs.boolean isCacheAcs() throws DfException
IDfBocsConfig
for cache server config objects.DfException
- if a server error occurs.void setCacheAcs(boolean isCacheAcs) throws DfException
IDfBocsConfig
for cache server config objects.isCacheAcs
- true if ACS is BOCS, false otherwise.DfException
- if a server error occurs.IDfList getNearStores() throws DfException
DfException
- if a server error occurs.void setNearStores(IDfList nearStores) throws DfException
nearStores
- list of names of stores that are near the ACS.DfException
- if a server error occurs.IDfAcsConfig.UrlEntry newUrlEntry(java.lang.String url, java.lang.String protocol) throws DfException
url
- url.protocol
- protocol.DfException
- if a server error occurs.IDfList getUrlEntries() throws DfException
DfException
- if a server error occurs.void addUrlEntry(IDfAcsConfig.UrlEntry urlEntry) throws DfException
urlEntry
- UrlEntry object to be added.DfException
- if a server error occurs.void setUrlEntries(IDfList urlEntries) throws DfException
urlEntries
- list of UrlEntry objects.DfException
- if a server error occurs.IDfAcsConfig.StoreEntry newStoreEntry(int storeType, int cryptoMode, int compressionMode) throws DfException
storeType
- type of a store to be added.cryptoMode
- 1 if this ACS supports encryption for this store type, 0 if the ACS does not.compressionMode
- 1 if this ACS supports compression for this store type, 0 if the ACS does not.DfException
- if a server error occurs.IDfList getStoreEntries() throws DfException
DfException
- if a server error occurs.void addStoreEntry(IDfAcsConfig.StoreEntry storeEntry) throws DfException
storeEntry
- StoreEntry object to be added.DfException
- if a server error occurs.void setStoreEntries(IDfList storeEntries) throws DfException
storeEntries
- list of StoreEntry objects.DfException
- if a server error occurs.java.lang.String getServerMajorVersion() throws DfException
DfException
- if a server error occursvoid setServerMajorVersion(java.lang.String majorVersion) throws DfException
majorVersion
- server major versionDfException
- if a server error occursjava.lang.String getServerMinorVersion() throws DfException
DfException
- if a server error occursvoid setServerMinorVersion(java.lang.String minorVersion) throws DfException
minorVersion
- server minor versionDfException
- if a server error occursIDfAcsConfig.ProjectionEntry newProjectionEntry(java.lang.String host, int port, int proximity) throws DfException
host
- The host.port
- The port.proximity
- The proximity of the host.DfException
- if a server error occurs.IDfAcsConfig.ProjectionEntry newProjectionEntry(java.lang.String networkLocationIdentifier, int proximity) throws DfException
networkLocationIdentifier
- Network location identifier.proximity
- The proximity of the host.DfException
- if a server error occurs.IDfAcsConfig.ProjectionEntry newProjectionEntry(java.lang.String host, int port, int proximity, boolean isEnabled, java.lang.String networkLocationIdentifier, boolean isNetworkLocationEnabled) throws DfException
host
- The host.port
- The port.proximity
- The proximity of the host.isEnabled
- Indicates if the host is enabled.networkLocationIdentifier
- Network location identifier.isNetworkLocationEnabled
- Indicates if the network location is enabled.DfException
- if a server error occurs.IDfList getProjectionEntries() throws DfException
DfException
- if a server error occurs.void addProjectionEntry(IDfAcsConfig.ProjectionEntry projectionEntry) throws DfException
projectionEntry
- ProjectionEntry object to be added.DfException
- if a server error occurs.void setProjectionEntries(IDfList projectionEntries) throws DfException
projectionEntries
- list of ProjectionEntry objects.DfException
- if a server error occurs.java.lang.String getDormancyStatus() throws DfException
DfException
- if an error occurs while retrieving this attributeCopyright 1994-2023 OpenText Corporation. All rights reserved.