Package com.sapportals.wcm.util.cache

Contains interfaces and classes for caches that are in memory or persistent.

See: Description

Interface Summary

Interface	Description
ICache	Generic cache interface.
ICacheEntry	Represents a cache entry.
ICacheNode	Keeps information about dependencies between cache entries.
ICacheStatistics	Provides basic statistical information about a cache instance.
IClusterCacheArea	Represents a cacheable area.
IExtendedCacheStatistics	Provides some additional statistical information about a cache instance.

Class Summary

Class	Description
CacheEntryList	Represents a list of cache entries.
CacheEntryListIterator	An iterator to access elements in a cache entry list.
CacheFactory	Create caches (singleton)

Exception Summary

Exception	Description
CacheException	Base class for exceptions in this cache package.

Package com.sapportals.wcm.util.cache Description

Contains interfaces and classes for caches that are in memory or persistent.

Package Specification

Purpose

Two kinds of caches are supported: memory caches and persistent caches. Persistent caches store their content in a filessystem.
Cache templates are supported, which can be used to define default cache configurations.

Configuration

In the CM configuration UI:

Configuration of a memory cache:

Property	Required	Description
Capacity	yes	The capacity of the cache (i.e. the max. number of cache entries)
Maximum cache size	yes	The max. value for the sum of the size of all cache entries in bytes (0 means no limit)
Maximum entry size	yes	The max. size of a cache entry in bytes (0 means no limit)
Entry default time to live	yes	The default time in seconds after which a cache entry is removed from the cache automatically (0 means no expiration)
Average entry size	yes	The size in bytes a new cache entry is assumed to have if no other size is specified
Singleton	yes	The instantiation type of the cache (true for singleton, false otherwise)

Configuration of a persistent cache:

Property	Required	Description
Capacity	yes	The capacity of the cache (i.e. the max. number of cache entries)
Maximum Cache Size	yes	The max. value for the sum of the size of all cache entries in bytes (0 means no limit)
Maximum Entry Size	yes	The max. size of a cache entry in bytes (0 means no limit)
Entry default time to live	yes	The default time in seconds after which a cache entry is removed from the cache automatically (0 means no expiration)
Folder	yes	The folder in which the cache files are stored (must exist already)
Filename prefix	yes	The prefix which is preceded the names of the cache files
Secure	yes	The desired security type of the cache (true for encrypted cache, false otherwise)
Clear cache on init	yes	The desired initialization type of the cache (true if the cache is cleared during initialization, false otherwise)