|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ContentCacheArea
Represents a file storage area that stores duplicates of the document content most frequently requested, and permits those duplicates to be accessed in lieu of the originals in order to enhance the document retrieval performance of local servers. For example, a content cache area can be shared by several servers on a LAN to minimize the number of times they need to access a main storage area on the WAN. For information on configuring a content cache for a server or group of servers, see the ContentCacheConfiguration interface.
Document content consists of the content elements associated with documents (as specified by the
ContentElements property on the Document
object). The cache receives new
content in the following circumstances:
In both circumstances, new content can be added to the cache only when its storage capacity (as defined by the MaximumContentElements and MaximumSizeKBytes properties) exceeds the current amount of content (as indicated by the ContentElementCount and ContentElementKBytes properties). Cache content, however, can end up slightly exceeding the designated storage capacity, as statistics are managed on a delayed basis, and multiple servers can be adding content.
Cache pruning is the process of deleting the content least frequently requested from the cache. Pruning deletes three main categories of files: abandoned, expired, and old. An abandoned file is an incomplete file that has been not properly added to the cache as a result of a server failure of some sort (such as a power failure). An expired file is a file that has remained in an unaccessed state longer than the maximum-time-to-live (as specified by the MaximumTimeToLive property). An old file is a file that, compared to other files in the same directory, has been accessed less recently. Note that these categories are not mutually exclusive; an abandoned file might also be an expired file, and an expired file an old file.
Pruning considers the most recent access time for a file equivalent to its time-of-last-use. This time gets updated to the current time when the file first gets added to the cache, and also whenever the file gets retrieved, provided more than 10 minutes have elapsed since the previous time-of-last-use update. Consequently, the accuracy of the time-of-last-use for a file is within 10 minutes.
Prune actions--specific instances of pruning--operate on the cache directory by directory. For a general discussion on the advantages of this approach, see the DirectoryStructure property. For a detailed discussion on prune action behavior, see the PruneAmount property.
Prune actions get triggered in three different ways:
Cache sweeping does not update the count of content element creations (the ContentElementsCreated property) or the count of content element deletions (the ContentElementsDeleted property). These statistics can become inaccurate over time, but can be optionally reset by clearing the cache. For more information on cache clearing, see the CacheStatus property.
Metadata
Auditable: false
Method Summary | |
---|---|
CacheStatus |
get_CacheStatus()
Returns the value of the CacheStatus property. |
java.lang.Double |
get_ContentElementCount()
Returns the value of the ContentElementCount property. |
java.lang.Double |
get_ContentElementKBytes()
Returns the value of the ContentElementKBytes property. |
java.lang.Double |
get_ContentElementsCreated()
Returns the value of the ContentElementsCreated property. |
java.lang.Double |
get_ContentElementsDeleted()
Returns the value of the ContentElementsDeleted property. |
java.lang.String |
get_Creator()
Returns the value of the Creator property. |
java.util.Date |
get_DateCreated()
Returns the value of the DateCreated property. |
java.util.Date |
get_DateLastModified()
Returns the value of the DateLastModified property. |
AreaDeleteMethod |
get_DeleteMethod()
Returns the value of the DeleteMethod property. |
java.lang.String |
get_DescriptiveText()
Returns the value of the DescriptiveText property. |
DirectoryStructure |
get_DirectoryStructure()
Returns the value of the DirectoryStructure property. |
java.lang.String |
get_DisplayName()
Returns the value of the DisplayName property. |
Id |
get_Id()
Returns the value of the Id property. |
java.lang.String |
get_LastModifier()
Returns the value of the LastModifier property. |
java.lang.Double |
get_MaximumContentElements()
Returns the value of the MaximumContentElements property. |
java.lang.Double |
get_MaximumSizeKBytes()
Returns the value of the MaximumSizeKBytes property. |
java.lang.Integer |
get_MaximumTimeToLive()
Returns the value of the MaximumTimeToLive property. |
java.lang.Boolean |
get_PreloadOnCreate()
Returns the value of the PreloadOnCreate property. |
java.lang.Integer |
get_PruneAmount()
Returns the value of the PruneAmount property. |
java.lang.Double |
get_PruneThresholdContentElements()
Returns the value of the PruneThresholdContentElements property. |
java.lang.Double |
get_PruneThresholdSizeKBytes()
Returns the value of the PruneThresholdSizeKBytes property. |
java.lang.String |
get_RootDirectoryPath()
Returns the value of the RootDirectoryPath property. |
Site |
get_Site()
Returns the value of the Site property. |
void |
set_CacheStatus(CacheStatus value)
Sets the value of the CacheStatus property. |
void |
set_Creator(java.lang.String value)
Sets the value of the Creator property. |
void |
set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property. |
void |
set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property. |
void |
set_DeleteMethod(AreaDeleteMethod value)
Sets the value of the DeleteMethod property. |
void |
set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property. |
void |
set_DirectoryStructure(DirectoryStructure value)
Sets the value of the DirectoryStructure property. |
void |
set_DisplayName(java.lang.String value)
Sets the value of the DisplayName property. |
void |
set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. |
void |
set_MaximumContentElements(java.lang.Double value)
Sets the value of the MaximumContentElements property. |
void |
set_MaximumSizeKBytes(java.lang.Double value)
Sets the value of the MaximumSizeKBytes property. |
void |
set_MaximumTimeToLive(java.lang.Integer value)
Sets the value of the MaximumTimeToLive property. |
void |
set_PreloadOnCreate(java.lang.Boolean value)
Sets the value of the PreloadOnCreate property. |
void |
set_PruneAmount(java.lang.Integer value)
Sets the value of the PruneAmount property. |
void |
set_PruneThresholdContentElements(java.lang.Double value)
Sets the value of the PruneThresholdContentElements property. |
void |
set_PruneThresholdSizeKBytes(java.lang.Double value)
Sets the value of the PruneThresholdSizeKBytes property. |
void |
set_RootDirectoryPath(java.lang.String value)
Sets the value of the RootDirectoryPath property. |
void |
set_Site(Site value)
Sets the value of the Site property. |
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject |
---|
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber |
Methods inherited from interface com.filenet.api.core.IndependentObject |
---|
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh |
Methods inherited from interface com.filenet.api.core.EngineObject |
---|
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses |
Method Detail |
---|
java.lang.String get_Creator()
void set_Creator(java.lang.String value)
java.util.Date get_DateCreated()
void set_DateCreated(java.util.Date value)
java.lang.String get_LastModifier()
void set_LastModifier(java.lang.String value)
java.util.Date get_DateLastModified()
void set_DateLastModified(java.util.Date value)
Id get_Id()
java.lang.String get_DisplayName()
void set_DisplayName(java.lang.String value)
java.lang.String get_RootDirectoryPath()
void set_RootDirectoryPath(java.lang.String value)
Site get_Site()
void set_Site(Site value)
CacheStatus get_CacheStatus()
void set_CacheStatus(CacheStatus value)
java.lang.Double get_PruneThresholdSizeKBytes()
void set_PruneThresholdSizeKBytes(java.lang.Double value)
java.lang.Double get_PruneThresholdContentElements()
void set_PruneThresholdContentElements(java.lang.Double value)
java.lang.Integer get_PruneAmount()
void set_PruneAmount(java.lang.Integer value)
java.lang.Integer get_MaximumTimeToLive()
void set_MaximumTimeToLive(java.lang.Integer value)
AreaDeleteMethod get_DeleteMethod()
void set_DeleteMethod(AreaDeleteMethod value)
java.lang.Boolean get_PreloadOnCreate()
void set_PreloadOnCreate(java.lang.Boolean value)
java.lang.Double get_MaximumSizeKBytes()
void set_MaximumSizeKBytes(java.lang.Double value)
java.lang.Double get_MaximumContentElements()
void set_MaximumContentElements(java.lang.Double value)
java.lang.Double get_ContentElementCount()
java.lang.Double get_ContentElementKBytes()
java.lang.Double get_ContentElementsCreated()
java.lang.Double get_ContentElementsDeleted()
java.lang.String get_DescriptiveText()
void set_DescriptiveText(java.lang.String value)
DirectoryStructure get_DirectoryStructure()
void set_DirectoryStructure(DirectoryStructure value)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |