Content Engine Java API: ContentCacheArea

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, java.io.Serializable
```
public interface ContentCacheArea
extends IndependentlyPersistableObject
```
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:
- Cache miss: When the cache receives a request for a file not currently residing in the cache, the cache receives a duplicate of that file as part of the document retrieval process.
- Content preloading: When content preloading has been enabled (via the PreloadOnCreate property), the cache receives duplicates of any new content added to the main storage area.
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:
- Mandatory Prune: Ensures that cache content remains under prune threshold levels. For more information, see the PruneThresholdContentElements property.
- Periodic Prune: Ensures that expired files get deleted on a timely basis. For more information, see the MaximumTimeToLive property.
- Sweeping: Ensures that the statistics concerning content element count (the ContentElementCount property) and content element size (the ContentElementKBytes property) remain reasonably accurate. A prune action occurs as part of this statistical update. For more information on the sweep action, see the ContentElementCount property.
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
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: GenericObject

Method Summary

Methods
Modifier and Type	Method and Description
`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
  - get_Creator
```
java.lang.String get_Creator()
```
    Returns the value of the Creator property. For more information, see Creator Property.
  - set_Creator
```
void set_Creator(java.lang.String value)
```
    Sets the value of the Creator property. For more information, see Creator Property.
  - get_DateCreated
```
java.util.Date get_DateCreated()
```
    Returns the value of the DateCreated property. For more information, see DateCreated Property.
  - set_DateCreated
```
void set_DateCreated(java.util.Date value)
```
    Sets the value of the DateCreated property. For more information, see DateCreated Property.
  - get_LastModifier
```
java.lang.String get_LastModifier()
```
    Returns the value of the LastModifier property. For more information, see LastModifier Property.
  - set_LastModifier
```
void set_LastModifier(java.lang.String value)
```
    Sets the value of the LastModifier property. For more information, see LastModifier Property.
  - get_DateLastModified
```
java.util.Date get_DateLastModified()
```
    Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
  - set_DateLastModified
```
void set_DateLastModified(java.util.Date value)
```
    Sets the value of the DateLastModified property. For more information, see DateLastModified Property.
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_DisplayName
```
java.lang.String get_DisplayName()
```
    Returns the value of the DisplayName property. For more information, see DisplayName Property.
  - set_DisplayName
```
void set_DisplayName(java.lang.String value)
```
    Sets the value of the DisplayName property. For more information, see DisplayName Property.
  - get_RootDirectoryPath
```
java.lang.String get_RootDirectoryPath()
```
    Returns the value of the RootDirectoryPath property. For more information, see RootDirectoryPath Property.
  - set_RootDirectoryPath
```
void set_RootDirectoryPath(java.lang.String value)
```
    Sets the value of the RootDirectoryPath property. For more information, see RootDirectoryPath Property.
  - get_Site
```
Site get_Site()
```
    Returns the value of the Site property. For more information, see Site Property.
  - set_Site
```
void set_Site(Site value)
```
    Sets the value of the Site property. For more information, see Site Property.
  - get_CacheStatus
```
CacheStatus get_CacheStatus()
```
    Returns the value of the CacheStatus property. For more information, see CacheStatus Property.
  - set_CacheStatus
```
void set_CacheStatus(CacheStatus value)
```
    Sets the value of the CacheStatus property. For more information, see CacheStatus Property.
  - get_PruneThresholdSizeKBytes
```
java.lang.Double get_PruneThresholdSizeKBytes()
```
    Returns the value of the PruneThresholdSizeKBytes property. For more information, see PruneThresholdSizeKBytes Property.
  - set_PruneThresholdSizeKBytes
```
void set_PruneThresholdSizeKBytes(java.lang.Double value)
```
    Sets the value of the PruneThresholdSizeKBytes property. For more information, see PruneThresholdSizeKBytes Property.
  - get_PruneThresholdContentElements
```
java.lang.Double get_PruneThresholdContentElements()
```
    Returns the value of the PruneThresholdContentElements property. For more information, see PruneThresholdContentElements Property.
  - set_PruneThresholdContentElements
```
void set_PruneThresholdContentElements(java.lang.Double value)
```
    Sets the value of the PruneThresholdContentElements property. For more information, see PruneThresholdContentElements Property.
  - get_PruneAmount
```
java.lang.Integer get_PruneAmount()
```
    Returns the value of the PruneAmount property. For more information, see PruneAmount Property.
  - set_PruneAmount
```
void set_PruneAmount(java.lang.Integer value)
```
    Sets the value of the PruneAmount property. For more information, see PruneAmount Property.
  - get_MaximumTimeToLive
```
java.lang.Integer get_MaximumTimeToLive()
```
    Returns the value of the MaximumTimeToLive property. For more information, see MaximumTimeToLive Property.
  - set_MaximumTimeToLive
```
void set_MaximumTimeToLive(java.lang.Integer value)
```
    Sets the value of the MaximumTimeToLive property. For more information, see MaximumTimeToLive Property.
  - get_DeleteMethod
```
AreaDeleteMethod get_DeleteMethod()
```
    Returns the value of the DeleteMethod property. For more information, see DeleteMethod Property.
  - set_DeleteMethod
```
void set_DeleteMethod(AreaDeleteMethod value)
```
    Sets the value of the DeleteMethod property. For more information, see DeleteMethod Property.
  - get_PreloadOnCreate
```
java.lang.Boolean get_PreloadOnCreate()
```
    Returns the value of the PreloadOnCreate property. For more information, see PreloadOnCreate Property.
  - set_PreloadOnCreate
```
void set_PreloadOnCreate(java.lang.Boolean value)
```
    Sets the value of the PreloadOnCreate property. For more information, see PreloadOnCreate Property.
  - get_MaximumSizeKBytes
```
java.lang.Double get_MaximumSizeKBytes()
```
    Returns the value of the MaximumSizeKBytes property. For more information, see MaximumSizeKBytes Property.
  - set_MaximumSizeKBytes
```
void set_MaximumSizeKBytes(java.lang.Double value)
```
    Sets the value of the MaximumSizeKBytes property. For more information, see MaximumSizeKBytes Property.
  - get_MaximumContentElements
```
java.lang.Double get_MaximumContentElements()
```
    Returns the value of the MaximumContentElements property. For more information, see MaximumContentElements Property.
  - set_MaximumContentElements
```
void set_MaximumContentElements(java.lang.Double value)
```
    Sets the value of the MaximumContentElements property. For more information, see MaximumContentElements Property.
  - get_ContentElementCount
```
java.lang.Double get_ContentElementCount()
```
    Returns the value of the ContentElementCount property. For more information, see ContentElementCount Property.
  - get_ContentElementKBytes
```
java.lang.Double get_ContentElementKBytes()
```
    Returns the value of the ContentElementKBytes property. For more information, see ContentElementKBytes Property.
  - get_ContentElementsCreated
```
java.lang.Double get_ContentElementsCreated()
```
    Returns the value of the ContentElementsCreated property. For more information, see ContentElementsCreated Property.
  - get_ContentElementsDeleted
```
java.lang.Double get_ContentElementsDeleted()
```
    Returns the value of the ContentElementsDeleted property. For more information, see ContentElementsDeleted Property.
  - get_DescriptiveText
```
java.lang.String get_DescriptiveText()
```
    Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - set_DescriptiveText
```
void set_DescriptiveText(java.lang.String value)
```
    Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.
  - get_DirectoryStructure
```
DirectoryStructure get_DirectoryStructure()
```
    Returns the value of the DirectoryStructure property. For more information, see DirectoryStructure Property.
  - set_DirectoryStructure
```
void set_DirectoryStructure(DirectoryStructure value)
```
    Sets the value of the DirectoryStructure property. For more information, see DirectoryStructure Property.

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

Methods inherited from interface com.filenet.api.core.IndependentObject

Methods inherited from interface com.filenet.api.core.EngineObject

get_Creator

set_Creator

get_DateCreated

set_DateCreated

get_LastModifier

set_LastModifier

get_DateLastModified

set_DateLastModified

get_Id

get_DisplayName

set_DisplayName

get_RootDirectoryPath

set_RootDirectoryPath

get_Site

set_Site

get_CacheStatus

set_CacheStatus

get_PruneThresholdSizeKBytes

set_PruneThresholdSizeKBytes

get_PruneThresholdContentElements

set_PruneThresholdContentElements

get_PruneAmount

set_PruneAmount

get_MaximumTimeToLive

set_MaximumTimeToLive

get_DeleteMethod

set_DeleteMethod

get_PreloadOnCreate

set_PreloadOnCreate

get_MaximumSizeKBytes

set_MaximumSizeKBytes

get_MaximumContentElements

set_MaximumContentElements

get_ContentElementCount

get_ContentElementKBytes

get_ContentElementsCreated

get_ContentElementsDeleted

get_DescriptiveText

set_DescriptiveText

get_DirectoryStructure

set_DirectoryStructure