Defines configuration options for all server caches that do not have object store-specific characteristics. The options apply to the following caches: code module cache, GCD cache, marking set cache, metadata cache, subject cache, and user token cache. Options include a time-to-live (TTL) value for managing cache entry residency and a value that, when exceeded, triggers cache refresh activity on a least-recently-used basis. (Object store-related cache options, such as folder cache TTL and object security cache attributes, are set at the object store level.)

The ServerCacheConfiguration object is contained in the SubsystemConfigurationList property of the server hierarchy objects (Domain, Site, Virtual Server, and ServerInstance). To access a ServerCacheConfiguration object, call Get_SubsystemConfigurations to retrieve the SubsystemConfigurationList from the "host" independent object, then iterate the returned list.

To create a new instance, call Factory.ServerCacheConfiguration.CreateInstance and add the new object to the SubsystemConfigurationList of the appropriate server hierarchy object. (Note: The SubsystemConfigurationList of the Domain object cannot be modified. To update its ServerCacheConfiguration object, locate the pre-existing object in the list and update it.) The created object is a dependent object and is only persisted when its parent object (the independently persistable object that references it) is persisted.

The ServerCacheConfiguration object is associated with a Domain, Site, Virtual Server, or ServerInstance object. The values of the cache configuration properties are used while the FileNet P8 system is running and override the default values defined at installation time.


The following tables list the members exposed by IServerCacheConfiguration.

Public Properties

 NameDescription
Public propertyCodeModuleCacheEntryTTLSpecifies the Time-To-Live (TTL) in seconds that an entry may remain in the code module cache.
Public propertyCodeModuleCacheMaxFileSpaceSpecifies the maximum file space (in MB) to allocate for code module cache entries that overflow from memory to disk. The default value is 10 GB.
Public propertyCodeModuleCacheMaxMemorySpecifies the maximum memory to allocate for code module cache entries as a percentage of the maximum memory configured for the current Java™ Virtual Machine (JVM). The default is 5%.
Public propertyGCDCacheTTLSpecifies the Time-To-Live value (TTL) value (in seconds) for the Global Configuration Database (GCD) cache. The range of values is 1 to 3600 seconds with a default of 30 seconds. The cache is flushed following the completion of a transaction (update) and automatically reloaded on the updating server. Following the expiration of this TTL value a database query is issued, at which time the software determines whether the cached data is stale or not.

Multiple server configurations might require a more frequent cache update polling interval (that is, a smaller TTL value) if GCD updates are a normal occurrence. However, since objects residing in the GCD are designed to be static in nature, updates to GCDCacheTTL are unlikely.

.
Public propertyMarkingSetCacheEntryTTLSpecifies the Time-To-Live (TTL) in milliseconds for entries in the marking set cache. Once the TTL has elapsed, cached information that has become stale is discarded and fresh data is obtained.
Public propertyMarkingSetCacheMaxEntriesSpecifies the maximum number of entries in the marking set cache. When the maximum number is exceeded, the least recently used marking set elements are removed to allow more recently used elements to be cached.
Public propertyMetadataMergedScopeCacheMaxEntriesThe maximum number of metadata merged scope caches to be retained in memory. The default is 20 caches.

Use of this property can assist you in preventing excessive memory usage on the Content Engine server. When a merged scope cache is created and the class descriptions are loaded in the cache, the names of the classes are mapped to the first instance of the class encountered in the ordering sequence of the object stores to be merged. As an example, let's say that a class in object store A is named X and has the same GUID as a class named Y in object store B. If you merge object stores A and B, the class name of the merged scope cache (A,B) will be X, whereas the class name of the merged scope cache (B,A) will be Y. As you can see from this example, specifying many different orders of merged object stores could result in an excessive number of merged scope caches being created, and can exceed the server's memory capacity. Set the value of this property to limit the number of metadata merged scope caches that can reside in memory.

Public propertyNonPagedQueryMaxSizeThe maximum size in rows of a non-paged query result set. This value cannot be overridden by an individual query.
Public propertyPrincipalCacheEntryTTLSpecifies the Time-To-Live (TTL) in seconds for entries in the principal cache. Once the TTL has elapsed, cached information that has become stale is discarded and fresh data is obtained.

For more information about this cache, see Security Caching.

Public propertyPrincipalCacheMaxEntriesSpecifies the maximum number of entries allowed in the principal cache. When the maximum number is exceeded, the least recently principal elements are removed to allow more recently used elements to be cached.

For more information about this cache, see Security Caching.

Public propertyQueryPageDefaultSizeThe default size in rows of a query page in a result set.
Public propertyQueryPageMaxSizeThe maximum size in rows for a query page in a result set. This value cannot be overridden by an individual query.
Public propertySubjectCacheEntryTTLSpecifies the Time-To-Live (TTL) in seconds for entries in the subject cache. The default is one hour. Once the TTL has elapsed, cached information that has become stale is discarded and fresh data is obtained.
Public propertySubjectCacheMaxEntriesSpecifies the maximum number of entries allowed in the subject cache. When the maximum number is exceeded, the least recently used Subject elements are removed to allow more recently used elements to be cached.
Public propertyUserTokenCacheEntryTTLSpecifies the Time-To-Live (TTL) in seconds for entries in the user token cache. Once the TTL has elapsed, cached information that has become stale is discarded and fresh data is obtained.

For more information about this cache, see Security Caching.

Public propertyUserTokenCacheMaxEntriesSpecifies the maximum number of entries allowed in the user token cache. When the maximum number is exceeded, the least recently used user token elements are removed to allow more recently used elements to be cached.

For more information about this cache, see Security Caching.

Top

See Also