Servlet cache instance settings

Servlet cache instance settings

Overview

A servlet cache instance is a location, in addition to the default shared dynamic cache, where dynamic cache can store, distribute, and share data. By using servlet cache instances, the applications have greater flexibility and better tuning of the cache resources.
The JNDI name specified for the cache instance is mapped to the name attribute in the <cache-instance> tag in cachespec.xml.
To view this admin console page, click...
Resources | Cache instances | Servlet cache instances | cache_instance_name

Settings

Name

Required display name for the resource.

JNDI name

JNDI name for the resource. Specify this name in the name attribute field in the <cache-instance> tag in cachespec.xml. This tag is used to find the particular cache instance in which to store cache entries.

Description

Description for the resource. This field is optional.

Category

Category string to classify or group the resource. This field is optional.

Cache size

Specifies a positive integer for the maximum number of entries the cache holds. The cache size is usually in the thousands.

Default 2000
Range 100 - no set maximum value

Default priority

Default priority for servlets that can be cached. This value determines how long an entry stays in a full cache.
The recommended value is one.

Enable disk offload

Specifies if disk offload is enabled.
If disabled, when a new entry is created while the cache is full, a least recently used algorithm is used to remove entries from the memory cache.
If we enable disk offload, the entry that would be removed from the cache is copied to the local file system.
Location of the file is specified by the disk offload location.

Default false

Offload location

Directory used for disk offload.
If disk offload location is not specified, the default location will be used...
${WAS_TEMP_DIR}/node/server name/_dynacache/cache_JNDI_name

If disk offload location is specified, the node, server name, and cache instance name are appended. For example...
${USER_INSTALL_ROOT}/diskoffload

...generates the location as...
${USER_INSTALL_ROOT}/diskoffload/node/server name/cache_JNDI_name

This value is ignored if disk offload is not enabled.
The default value of ${WAS_TEMP_DIR} is...
${USER_INSTALL_ROOT}/temp

If we change the value ${WAS_TEMP_DIR} after starting WAS, but do not move the disk cache contents to the new location:

The Application Server creates a new disk cache file at the new disk offload location.
If the Flush to disk setting is enabled, all the disk cache content at the old location is lost when you restart the appserver

Flush to disk

Specifies if in-memory cached objects are saved to disk when the server is stopped. This value is ignored if Enable Disk Offload is not selected.

Default false

Limit disk cache size in GB

Maximum disk cache size in GB. When you select this option, we can specify a positive integer value. Leaving this option blank indicates an unlimited size. This setting applies only if enable disk offload is specified for the cache.

Value 0 to MAXINT. A value of 0 indicates unlimited size.

Limit disk cache size in entries

Maximum disk cache size in number of entries. When you select this option, we can specify a positive integer value. Leaving this option blank indicates an unlimited size. This setting applies only if enable disk offload is specified for the cache.

Value 0 to MAXINT. A value of 0 indicates unlimited size.

Limit disk cache entry size

Maximum size of an individual cache entry in MB. Any cache entry larger than this, when evicted from memory, will not be offloaded to disk. When you select this option, we can specify a positive integer value. Leaving this option blank indicates an unlimited size. This setting applies only if enable disk offload is specified for the cache.

Value 0 to MAXINT. A value of 0 indicates unlimited size.

Performance settings

Level of performance required by the disk cache. This setting applies only if enableDiskOffload is specified for the cache. Performance levels determine how memory resources should be used on background activity such as cache cleanup, expiration, garbage collection, and so on. This setting applies only if enable disk offload is specified for the cache.

High performance and high memory usage Indicates that all metadata will be kept in memory.
Balanced performance and balanced memory usage Indicates some metadata will be kept in memory. This is the default performance setting and will provide an optimal balance of performance and memory usage for most users.
Low performance and low memory usage Indicates that limited metadata will be kept in memory.
Custom Indicates that the administrator will explicitly configure the memory settings that will be used to support the above background activity. The administrator sets these values using the DiskCacheCustomPerformanceSettings object.

Disk cache cleanup frequency

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.

Value 0 to 1440

Maximum buffer for cache identifiers per metaentry

Maximum 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.

Value 100 to MAXINT

Maximum buffer for dependency identifiers

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.

Value 100 to MAXINT

Maximum buffer for templates

Maximum 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 cusotm.

Value 10 to MAXINT

Eviction policy algorithm

Eviction algorithm that the disk cache will use to evict entries once the high threshold is reached. This setting applies only if enable disk offload is specified for the cache.

None No eviction policy, so the disk cache can grow until it reaches its limit at which time the dynamic cache service stops writing to disk
Random When the disk size reaches a high threshold limit, the disk cache garbage collector wakes up and randomly picks entries on the disk and evicts them until the size reaches a low threshold limit.
Size When the disk size reaches a high threshold limit, the disk cache garbge collector wakes up and picks the largest entries on the disk and evicts them until the disk size reaches a low threshold limit.

High threshold

Specifies when the eviction policy starts. The threshold is expressed in terms of the percentage of the disk cache size in GB or entries. The disk cache garbage collector is awaken when the disk size exceeds high threshold limit. The lower value limits disk cache size in GB and disk cache size in entries. This setting does not apply when the disk cache eviction policy is set to none.

Values 1 to 100

Low threshold

Specifies when the eviction policy ends. The threshold is expressed in terms of the percentage of the disk cache size in GB or entries. The lower value limits disk cache size in GB and disk cache size in entries. The disk cache garbage collector, when awaken, evicts entries until the disk size reaches the low threshold limit. This setting does not apply when the disk cache eviction policy is set to none.

Values 1 to 100

Enable cache replication

Use cache replication to enable sharing of cache IDs, cache entries, and cache invalidations with other servers in the same replication domain.
This option might be unavailable for cache instances created with a previous version of WAS.

Full group replication domain

Specifies a replication domain from which the data is replicated.
Specifies a replication domain from which the data is replicated. Choose from any replication domains that have been defined. If there are no replication domains listed, create one during cluster creation or manually in the admin console by clicking...
Environment | Internal replication domains | New

The replication domain you choose to use with the dynamic cache service must be using a Full group replica. Do not share replication domains between replication consumers. Dynamic cache should use a different replication domain from session manager or stateful session beans.

Replication type

Global sharing policy for this cache instance.

The following settings are available:

Both push and pull sends the cache ID of newly updated content to other servers in the replication domain. Then, if one of the other servers requests the content, and that server has the ID of the cache entry for the previously updated content, it will retrieve the content from the publishing server. If a request is made for an ID which has not been previously published, the server assumes it does not exist in the cluster and creates a new entry.
Pull only shares cache entries for this object between application servers on demand. If an appserver gets a cache miss for this object, it queries the cooperating appservers to see if they have the object. If no appserver has a cached copy of the object, the original application server runs the request and generates the object. These entries cannot store non-serializable data. This mode of sharing is not recommended.
Push only sends the cache ID and cache content of new content to all other servers in the replication domain.
The sharing policy of Not Shared results in the cache ID and cache content not being shared with other servers in the replication domain.

The default setting for a an environment without clustering is Not Shared. When enabling replication, the default value is Not Shared.

Push frequency

Time, in seconds, to wait before pushing new or modified cache entries to other servers.
A value of 0 (zero) sends the cache entries immediately. Setting this property to a value greater than 0 (zero) results in a "batch" push of all cache entries that are created or modified during the time period. The default is 1 (one).

Related tasks

Use the DistributedMap and DistributedObjectCache interfaces for the dynamic cache

Related
Object cache instance collection Object cache instance settings Servlet cache instance collection

High performance and high memory usage	Indicates that all metadata will be kept in memory.
Balanced performance and balanced memory usage	Indicates some metadata will be kept in memory. This is the default performance setting and will provide an optimal balance of performance and memory usage for most users.
Low performance and low memory usage	Indicates that limited metadata will be kept in memory.
Custom	Indicates that the administrator will explicitly configure the memory settings that will be used to support the above background activity. The administrator sets these values using the DiskCacheCustomPerformanceSettings object.

None	No eviction policy, so the disk cache can grow until it reaches its limit at which time the dynamic cache service stops writing to disk
Random	When the disk size reaches a high threshold limit, the disk cache garbage collector wakes up and randomly picks entries on the disk and evicts them until the size reaches a low threshold limit.
Size	When the disk size reaches a high threshold limit, the disk cache garbge collector wakes up and picks the largest entries on the disk and evicts them until the disk size reaches a low threshold limit.