cacheinstances.properties file
Use the information in this document as a reference of the names, values, and explanations that we can use in the cacheinstances.properties file.
The following list provides the property names, associated values, and explanations for the cacheinstance.properties file.
Property name - x is the instance number, which starts with 0 Version Scope Possible value Description Cache core properties 5.1.x and later Per cache instance any string (no default set) Specifies cache instance name or JNDI name. 5.1.x and later Per cache instance > 0 (default=2000) Maximum number of entries that are held in memory cache. 6.0.2.x and later Per cache instance True or false (default=false) The dynamic cache service supports cache entry dependency IDs. Disable this option if we do not need to use dependency IDs. Dependency IDs specify additional cache group identifiers that associate multiple cache entries to the same group identifier in the cache policy. 6.0.2.x and later Per cache instance True or false (default=false) Whether template support feature is enabled. 5.1.x and later Per cache instance True or false (default=false) Set this value to true to have invalidation events sent to registered invalidation listeners, using the Java EE context of the listener. To use listener Java EE context for callback, set this value to true. To use the caller thread context for callback, set this value to false. 6.0.2.x and later Per cache instance True or false (default=false) Whether DistributedMap or DistributedNioMap is used. 7.0 Per cache instance > 0 (default: -1 limit does not exist) M memory cache size in megabytes (MB) 7.0 Per cache instance > 0 % (default=95) Specifies when the eviction policy runs. The threshold is expressed in terms of the percentage of the memory cache size in MB. The higher value is used when limit memory cache size in MB is specified. 7.0 Per cache instance > 0 % (default=80) Specifies when the eviction policy runs. The threshold is expressed in terms of the percentage of the memory cache size in MB. The lower value is used when limit memory cache size in MB is specified. 7.0 Per cache instance True or false (default=false) Whether the configured cache instance is created during the server startup. This is useful when cache replication feature is used. However, the time for server startup will take long. Cache servlet/JSPs caching properties 6.0.2.19, 6.1.0.9 and later Per cache instance True or false (default=false) A configurable change in the behavior of the cache so that the child pages and fragments inherit the cache spec properties of their parent pages and fragments. If the request for a fragment does not match a defined cache policy, the fragment will inherit the save-attributes and the store-cookies properties from its parent fragment. Enable this cascade of save-attributes and store-cookies properties by setting the value to true. 6.0.2.9, 6.1.x and later Per cache instance "none", "ALL","All", cache instance name, comma delineated list of cookie names, (default="none") Whether disable store cookies is NONE or ALL. Stores cookies as part of the response by default unless configured otherwise on a per request basis in cachespec.xml file. There is a risk of sharing cookies between users, which violates security. 6.0.2.x and later Per cache instance True or false (default=false) Whether the cache instance is servlet cache or object cache. Cache disk offload properties 5.1.x and later Per cache instance True or false (default=false) Whether disk offload is enabled. 5.1.x and later Per cache instance String – For example: . $(APP_ROOT) /diskOffloadLocation on the disk to save cache entries when disk offload is enabled. 5.1.1.13, 6.0.2.17, 6.1.x and later Per cache instance >= 0 (0=limit does not exist) M disk cache size in number of entries. 5.1.1.13, 6.0.2.17, 6.1.x and later Per cache instance 0 or > 2 in GB (0=limit does not exist) M disk cache size in gigabytes (GB). 5.1.1.13, 6.0.2.17, 6.1.x and later Per cache instance >= 0 in MB (0=limit does not exist) M size of an individual cache entry in megabytes (MB). Any cache entry that is larger than this, when evicted from memory, will not be offloaded to disk. 5.1.x and later Per cache instance True or false (default = false) Specifies if in-memory cached objects are saved to disk when the server stops. 5.1.1.13, 6.0.2.17, 6.1.x and later Per cache instance 0=low 1=balance 2=custom 3=high (default=1) Specifies the performance level to tune the performance of the disk cache. 5.1.1.2 and later Per cache instance 0 <= x <= 1440 in minutes (0=cleanup at midnight) Specifies a value for the disk cache cleanup frequency, in minutes. If this value is set to 0, the cleanup runs only at midnight. This setting applies only when the Disk Offload Performance Level is low, balanced, or custom. The high performance level does not require disk cleanup, and this value is ignored. 5.1.1.13, 6.0.2.17, 6.1.x and later Per cache instance > 0 (default=1000) M number of dependency identifier buckets in the disk cache metadata in memory. If this limit is exceeded, the information is offloaded to the disk. This setting applies only when the disk cache performance level is custom. 5.1.1.13, 6.0.2.17, 6.1.x and later Per cache instance > 0 (default=100) M number of template buckets that are in the disk cache metadata in memory. If this limit is exceeded, the information is offloaded to the disk. This setting applies only when the disk cache performance level is custom. 5.1.1.2 and later Per cache instance > 0 (default=1000) M number of cache identifiers that are stored for an individual dependency ID or template in the disk cache metadata in memory. If this limit is exceeded, the information is offloaded to the disk. This setting applies only when the disk offload performance level is custom. 5.1.1.13, 6.0.2.17, 6.1.x and later Per cache instance 0=disable 1=random 2:size (default=0) Eviction algorithm that the disk cache will use to evict entries once the high threshold is reached. 5.1.1.13, 6.0.2.17, 6.1.x and later Per cache instance > 0 % (default=80) Specifies when the eviction policy runs. The threshold is expressed in terms of the percentage of the disk cache size in GB or entries. The high value is used when limit disk cache size in GB and limit disk cache size in entries are specified. 5.1.1.13, 6.0.2.17, 6.1.x and later Per cache instance > 0 % (default=70) Specifies when the eviction policy runs. The threshold is expressed in terms of the percentage of the disk cache size in GB or entries. The lower value is used when limit disk cache size in GB and limit disk cache size in entries are specified. Cache replication properties 6.0.2.x and later Per cache instance True or false (default=false) Whether cache replication is enabled. Use cache replication to have cache entries copied to multiple appservers configured in the same replication domain. 5.1.x and later Per cache instance 1 (Not shared, 2 (Push), 4 (Push and pull) Global sharing policy for this appserver. 6.0.2.x and later Per cache instance String – For example: DynamicCacheDomain Specifies a replication domain from which the data is replicated. 5.1.1.9, 6.0.2.9, 6.1.x and later Per cache instance True or false (default=false) Whether using server class loader is enabled. Setting this value to true, deserializes the InvalidationEvent using system classloader first and then using application classloader, if that fails. This improves performance. 5.1.1.13, 6.0.2.17, 6.1.0.7 and later Per cache instance > 0 (default=50) Limit on the total number of cache entries that are sent by the data replication service (DRS) in terms of number of entries. 5.1.1.13, 6.0.2.17, 6.1.0.7 and later Per cache instance > 0 % (default=2) Limit on the number of cache entries that are sent by DRS in terms of the percentage of total cache in memory. 5.1.1.14, 6.0.2.19, 6.1.0.7 and later Per cache instance > 0 (default=50) Limit on the total number of invalidation events that are sent by DRS in terms of number of entries. 5.1.1.14, 6.0.2.19, 6.1.0.7 and later Per cache instance > 0 % (default=2) Limit on the number of invalidation events that are sent by DRS in terms of the percentage of total cache in memory. 6.0.2.13, 6.1.x and later Per cache instance True or false (default=false) Whether sending invalidations that are based on timeout eviction is enabled. 6.0.2.13, 6.1.x and later Per cache instance True or false (default=false) Whether sending invalidations that are based on LRU eviction is enabled. 5.1.1.13, 6.0.2.17, 6.1.x or later Per cache instance True or false (default=false) Whether the cache value of Invalidation event is ignored. If it is true, the cache value of Invalidation event is set to NULL when the code is returned to the caller.
Related tasks
Use the DistributedMap and DistributedObjectCache interfaces for the dynamic cache