cacheinstances.properties file

cacheinstances.properties file

The following lists properties in the cacheinstance.properties file. *.xx is the instance number, which starts with 0.

Property Earlist
Version Values Defaults Description
Cache core properties
cache.instance.x 5.1.x any string No default Specifies cache instance name or JNDI name.
cache.instance.x.cacheSize 5.1.x > 0 2000 Maximum number of entries that are held in memory cache.
cache.instance.x.disableDependencyId 6.0.2.x True or false false That 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.
cache.instance.x.disableTemplatesSupport 6.0.2.x True or false false Specifies whether template support feature is enabled.
cache.instance.x.useListenerContext 5.1.x True or false 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.
cache.instance.x.enableNioSupport 6.0.2.x True or false false Specifies whether DistributedMap or DistributedNioMap is used.
cache.instance.x.memoryCacheSizeInMB 7.0 > 0 default: -1 limit does not exist) Maximum memory cache size in megabytes (MB)
cache.instance.x.memoryCacheHighThreshold 7.0 > 0 % 95 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.
cache.instance.x.memoryCacheLowThreshold 7.0 > 0 % 80 When the eviction policy runs. The threshold is expressed in terms of the percentage of the memory cache size in MB. The lesser value is used when limit memory cache size in MB is specified.
cache.instance.x.createCacheAtServerStartup 7.0 True or false false Specifies 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/JSP caching properties
cache.instance.x.cascadeCachespec Properties 6.0.2.19, 6.1.0.9 True or false false A configurable change in the behavior of the cache so that the child pages and fragments inherit the cache specification 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.
cache.instance.x.disableStoreCookies 6.0.2.9, 6.1.x "none", "ALL","All", cache instance name, comma delineated list of cookie names, "none" Specifies 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.
cache.instance.x.enableServletSupport 6.0.2.x True or false false Specifies whether the cache instance is servlet cache or object cache.
Cache disk offload properties
cache.instance.x.enableDiskOffload 5.1.x True or false false Specifies whether disk offload is enabled.
cache.instance.x.diskOffloadLocation 5.1.x String Example: $(app_server_root)/diskOffload Location on the disk to save cache entries when disk offload is enabled.
cache.instance.x.diskCacheSize 5.1.1.13, 6.0.2.17, 6.1.x >= 0 0=limit does not exist Maximum disk cache size in number of entries.
cache.instance.x.diskCacheSizeInGB 5.1.1.13, 6.0.2.17, 6.1.x 0 or > 2 in GB (0=limit does not exist)
Maximum disk cache size in gigabytes (GB).
cache.instance.x.diskCacheEntrySize InMB 5.1.1.13, 6.0.2.17, 6.1.x >= 0 in MB (0=limit does not exist)
Maximum 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.
cache.instance.x.flushToDiskOnStop 5.1.x True or false false Specifies if in-memory cached objects are saved to disk when the server stops.
cache.instance.x.diskCache PerformanceLevel 5.1.1.13, 6.0.2.17, 6.1.x 0=low 1=balance 2=custom 3=high 1 Performance level to tune the performance of the disk cache.
cache.instance.x.htodCleanup Frequency 5.1.1.2 0 <= x <= 1440 in minutes (0=cleanup at midnight)
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.
cache.instance.x.htodDelayOffloadDepIdBuckets 5.1.1.13, 6.0.2.17, 6.1.x > 0 1000 Maximum 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.
cache.instance.x.htodDelayOffloadTemplateBuckets 5.1.1.13, 6.0.2.17, 6.1.x > 0 100 Maximum number of template 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.
cache.instance.x htodDelayOffloadEntriesLimit 5.1.1.2 > 0 1000 Maximum number of cache identifiers 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.
cache.instance.x.diskCacheEvictionPolicy 5.1.1.13, 6.0.2.17, 6.1.x 0=disable 1=random 2:size 0 Eviction algorithm that the disk cache will use to evict entries once the high threshold is reached.
cache.instance.x.diskCacheHighThreshold 5.1.1.13, 6.0.2.17, 6.1.x > 0 % 80 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.
cache.instance.x.diskCacheLowThreshold 5.1.1.13, 6.0.2.17, 6.1.x > 0 % 70 When the eviction policy runs. The threshold is expressed in terms of the percentage of the disk cache size in GB or entries. The lesser value is used when limit disk cache size in GB and limit disk cache size in entries are specified.
Cache replication properties
cache.instance.x.enableCacheReplication 6.0.2.x True or false false Specifies whether cache replication is enabled. Use cache replication to have cache entries copied to multiple application servers configured in the same replication domain.
cache.instance.x.replicationType 5.1.x 1 (Not shared, 2 (Push), 4 (Push and pull)
The global sharing policy for this application server.
cache.instance.x.replicationDomain 6.0.2.x String - For example: DynamicCacheDomain Specifies a replication domain from which the data is replicated.
cache.instance.x.useServerClassLoader 5.1.1.9, 6.0.2.9, 6.1.x True or false false Specifies 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.
cache.instance.x.cacheEntryWindow 5.1.1.13, 6.0.2.17, 6.1.0.7 > 0 50 Limit on the total number of cache entries sent by the data replication service (DRS) in terms of number of entries.
cache.instance.x.cachePercentageWindow 5.1.1.13, 6.0.2.17, 6.1.0.7 > 0 % 2 Limit on the number of cache entries that are sent by DRS in terms of the percentage of total cache in memory.
cache.instance.x.cacheInvalidateEntryWindow 5.1.1.14, 6.0.2.19, 6.1.0.7 > 0 50 Limit on the total number of invalidation events sent by DRS in terms of number of entries.
cache.instance.x.cacheInvalidatePercentWindow 5.1.1.14, 6.0.2.19, 6.1.0.7 > 0 % 2 Limit on the number of invalidation events sent by DRS in terms of the percentage of total cache in memory.
cache.instance.x.filterTimeOutInvalidation 6.0.2.13, 6.1.x True or false false Enable sending invalidations are based on timeout eviction.
cache.instance.x.filterLRUInvalidation 6.0.2.13, 6.1.x True or false false Enable sending invalidations based on LRU eviction.
cache.instance.x.ignoreValueInInvalidationEvent 5.1.1.13, 6.0.2.17, 6.1.x or later True or false false Specifies 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.

Use the DistributedMap and DistributedObjectCache interfaces for the dynamic cache

Property	Earlist Version	Values	Defaults	Description
Cache core properties
cache.instance.x	5.1.x	any string	No default	Specifies cache instance name or JNDI name.
cache.instance.x.cacheSize	5.1.x	> 0	2000	Maximum number of entries that are held in memory cache.
cache.instance.x.disableDependencyId	6.0.2.x	True or false	false	That 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.
cache.instance.x.disableTemplatesSupport	6.0.2.x	True or false	false	Specifies whether template support feature is enabled.
cache.instance.x.useListenerContext	5.1.x	True or false	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.
cache.instance.x.enableNioSupport	6.0.2.x	True or false	false	Specifies whether DistributedMap or DistributedNioMap is used.
cache.instance.x.memoryCacheSizeInMB	7.0	> 0	default: -1 limit does not exist)	Maximum memory cache size in megabytes (MB)
cache.instance.x.memoryCacheHighThreshold	7.0	> 0 %	95	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.
cache.instance.x.memoryCacheLowThreshold	7.0	> 0 %	80	When the eviction policy runs. The threshold is expressed in terms of the percentage of the memory cache size in MB. The lesser value is used when limit memory cache size in MB is specified.
cache.instance.x.createCacheAtServerStartup	7.0	True or false	false	Specifies 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/JSP caching properties
cache.instance.x.cascadeCachespec Properties	6.0.2.19, 6.1.0.9	True or false	false	A configurable change in the behavior of the cache so that the child pages and fragments inherit the cache specification 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.
cache.instance.x.disableStoreCookies	6.0.2.9, 6.1.x	"none", "ALL","All", cache instance name, comma delineated list of cookie names,	"none"	Specifies 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.
cache.instance.x.enableServletSupport	6.0.2.x	True or false	false	Specifies whether the cache instance is servlet cache or object cache.
Cache disk offload properties
cache.instance.x.enableDiskOffload	5.1.x	True or false	false	Specifies whether disk offload is enabled.
cache.instance.x.diskOffloadLocation	5.1.x	String	Example: $(app_server_root)/diskOffload	Location on the disk to save cache entries when disk offload is enabled.
cache.instance.x.diskCacheSize	5.1.1.13, 6.0.2.17, 6.1.x	>= 0	0=limit does not exist	Maximum disk cache size in number of entries.
cache.instance.x.diskCacheSizeInGB	5.1.1.13, 6.0.2.17, 6.1.x	0 or > 2 in GB (0=limit does not exist)		Maximum disk cache size in gigabytes (GB).
cache.instance.x.diskCacheEntrySize InMB	5.1.1.13, 6.0.2.17, 6.1.x	>= 0 in MB (0=limit does not exist)		Maximum 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.
cache.instance.x.flushToDiskOnStop	5.1.x	True or false	false	Specifies if in-memory cached objects are saved to disk when the server stops.
cache.instance.x.diskCache PerformanceLevel	5.1.1.13, 6.0.2.17, 6.1.x	0=low 1=balance 2=custom 3=high	1	Performance level to tune the performance of the disk cache.
cache.instance.x.htodCleanup Frequency	5.1.1.2	0 <= x <= 1440 in minutes (0=cleanup at midnight)		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.
cache.instance.x.htodDelayOffloadDepIdBuckets	5.1.1.13, 6.0.2.17, 6.1.x	> 0	1000	Maximum 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.
cache.instance.x.htodDelayOffloadTemplateBuckets	5.1.1.13, 6.0.2.17, 6.1.x	> 0	100	Maximum number of template 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.
cache.instance.x htodDelayOffloadEntriesLimit	5.1.1.2	> 0	1000	Maximum number of cache identifiers 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.
cache.instance.x.diskCacheEvictionPolicy	5.1.1.13, 6.0.2.17, 6.1.x	0=disable 1=random 2:size	0	Eviction algorithm that the disk cache will use to evict entries once the high threshold is reached.
cache.instance.x.diskCacheHighThreshold	5.1.1.13, 6.0.2.17, 6.1.x	> 0 %	80	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.
cache.instance.x.diskCacheLowThreshold	5.1.1.13, 6.0.2.17, 6.1.x	> 0 %	70	When the eviction policy runs. The threshold is expressed in terms of the percentage of the disk cache size in GB or entries. The lesser value is used when limit disk cache size in GB and limit disk cache size in entries are specified.
Cache replication properties
cache.instance.x.enableCacheReplication	6.0.2.x	True or false	false	Specifies whether cache replication is enabled. Use cache replication to have cache entries copied to multiple application servers configured in the same replication domain.
cache.instance.x.replicationType	5.1.x	1 (Not shared, 2 (Push), 4 (Push and pull)		The global sharing policy for this application server.
cache.instance.x.replicationDomain	6.0.2.x	String - For example: DynamicCacheDomain	Specifies a replication domain from which the data is replicated.
cache.instance.x.useServerClassLoader	5.1.1.9, 6.0.2.9, 6.1.x	True or false	false	Specifies 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.
cache.instance.x.cacheEntryWindow	5.1.1.13, 6.0.2.17, 6.1.0.7	> 0	50	Limit on the total number of cache entries sent by the data replication service (DRS) in terms of number of entries.
cache.instance.x.cachePercentageWindow	5.1.1.13, 6.0.2.17, 6.1.0.7	> 0 %	2	Limit on the number of cache entries that are sent by DRS in terms of the percentage of total cache in memory.
cache.instance.x.cacheInvalidateEntryWindow	5.1.1.14, 6.0.2.19, 6.1.0.7	> 0	50	Limit on the total number of invalidation events sent by DRS in terms of number of entries.
cache.instance.x.cacheInvalidatePercentWindow	5.1.1.14, 6.0.2.19, 6.1.0.7	> 0 %	2	Limit on the number of invalidation events sent by DRS in terms of the percentage of total cache in memory.
cache.instance.x.filterTimeOutInvalidation	6.0.2.13, 6.1.x	True or false	false	Enable sending invalidations are based on timeout eviction.
cache.instance.x.filterLRUInvalidation	6.0.2.13, 6.1.x	True or false	false	Enable sending invalidations based on LRU eviction.
cache.instance.x.ignoreValueInInvalidationEvent	5.1.1.13, 6.0.2.17, 6.1.x or later	True or false	false	Specifies 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.