CacheInstance

CacheInstance

This type is a class for model objects.

A Cache Instance is a location, in addition to the default shared Dynamic Cache, where any J2EE application can store, distribute, and share data. This gives application greater flexibility and greater tuning of the cache resources. The programming interface to access this cache instance is called DistributedMap. See the DistributedMap API documentation in the WebSphere javadoc for more information.
Package: dynacache
Supertype: ResourceEnvEntry

Known subtypes:
    ObjectCacheInstance
    ServletCacheInstance

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *

Attributes Summary

defaultPriority : EInt The default priority for servlets that can be cached. It determines how long an entry will stay in a full cache. The recommended value is 1.

hashSize : EInt Specifies a hash size when disk offload is enabled. Valid values are powers of 2 (1, 2, 4, 8, ...).

cacheSize : EInt A positive integer defining the maximum number of entries the cache will hold. Values are usually in the thousands, with no set maximum or minimum.

enableCacheReplication : EBoolean @since 6.0.0

replicationType : DynamicCacheReplicationKind Specifies the sharing policy of replicated objects across application servers. The value may be PUSH, PULL, PUSH_PULL or NONE, the default being NONE.

pushFrequency : EInt A time interval, specified in seconds, which is used when replication type is PUSH. Default value is 1.

useListenerContext : EBoolean Set this value to true to have invalidation events fired to registered invalidation listeners using the listener's J2EE context. Applicable only to Object Cache Instances (not Servlet Cache Instances).

enableDiskOffload : EBoolean Enables disk offloading.

diskOffloadLocation : EString Specifies a directory used for disk offload. This value is ignored if Enable Disk Offload is false.

flushToDiskOnStop : EBoolean Set this value to true to have in memory cached objects saved to disk when the server is stopped. This value is ignored if Enable Disk Offload is false.

diskCachePerformanceLevel : DiskCachePerformanceKind Specifies the level of performance required by this disk cache. This setting is applicable only if "enableDiskOffload" is specified for the cache. Performance levels determine how memory resources should should be used on background activity such as cache cleanup, expiration, garbage collection etc.. High performance indicates that all metadata will be kept in memory. Medium performance 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 indicates that limited metadata will be kept in memory. Custom performance indicates that the Administrator will explicitly configure the memory settings that will be used to support the above background activity. The Administrator will set these values via the "DiskCacheCustomPerformanceSettings" object.

diskCacheSizeInGB : EInt M disk cache size in GB. A value of 0 indicates unlimited size. Valid values are 0 or 3 to MAXINT.

diskCacheSizeInEntries : EInt M disk cache size in number of entries. A value of 0 indicates unlimited size. Valid values are 0 to MAXINT

diskCacheEntrySizeInMB : EInt M size of an individual cache entry in MB. Any cache entry larger than this, when evicted from memory, will not be offloaded to disk. A value of 0 indicates unlimited size. Valid values are 0 to MAXINT

diskCacheCleanupFrequency : EInt Specifies a value for the disk cache cleanup frequency in minutes. If this value is set to 0, the cleanup is run only at midnight. This setting applies only when the Disk Offload Performance Level is LOW, BALANCED or CUSTOM. The HIGH performance level will not require disk cleanup at all, and this value will be ignored. Valid values are 0 to 1440

memoryCacheSizeInMB : EInt @since 7.0.0 M memory cache size in MB.

cacheReplication : DRSSettings @ Configure distributed cache replication settings in order to maintain cache consistency across cache instances on different application servers. This object will store replication related settings for a Data Replication Service end point.

diskCacheCustomPerformanceSettings : DiskCacheCustomPerformanceSettings @ * No description is available *

diskCacheEvictionPolicy : DiskCacheEvictionPolicy @ * No description is available *

memoryCacheEvictionPolicy : MemoryCacheEvictionPolicy @ * No description is available *

Attribute Details

defaultPriority  -  The default priority for servlets that can be cached. It determines how long an entry will stay in a full cache. The recommended value is 1.
    Data Type: EInt
    Default value:  1
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

hashSize  -  Specifies a hash size when disk offload is enabled. Valid values are powers of 2 (1, 2, 4, 8, ...).
    Data Type: EInt
    Default value:  1024
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

cacheSize  -  A positive integer defining the maximum number of entries the cache will hold. Values are usually in the thousands, with no set maximum or minimum.
    Data Type: EInt
    Default value:  2000
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableCacheReplication  -  @since 6.0.0
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

replicationType  -  Specifies the sharing policy of replicated objects across application servers. The value may be PUSH, PULL, PUSH_PULL or NONE, the default being NONE.
    Data Type: DynamicCacheReplicationKind
    Default value:  NONE
    Allowed values:
        0 - NONE
        1 - PUSH
        2 - PULL
        3 - PUSH_PULL
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

pushFrequency  -  A time interval, specified in seconds, which is used when replication type is PUSH. Default value is 1.
    Data Type: EInt
    Default value:  1
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

useListenerContext  -  Set this value to true to have invalidation events fired to registered invalidation listeners using the listener's J2EE context. Applicable only to Object Cache Instances (not Servlet Cache Instances).
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableDiskOffload  -  Enables disk offloading.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

diskOffloadLocation  -  Specifies a directory used for disk offload. This value is ignored if Enable Disk Offload is false.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

flushToDiskOnStop  -  Set this value to true to have in memory cached objects saved to disk when the server is stopped. This value is ignored if Enable Disk Offload is false.
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

diskCachePerformanceLevel  -  Specifies the level of performance required by this disk cache. This setting is applicable only if "enableDiskOffload" is specified for the cache. Performance levels determine how memory resources should should be used on background activity such as cache cleanup, expiration, garbage collection etc.. High performance indicates that all metadata will be kept in memory. Medium performance 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 indicates that limited metadata will be kept in memory. Custom performance indicates that the Administrator will explicitly configure the memory settings that will be used to support the above background activity. The Administrator will set these values via the "DiskCacheCustomPerformanceSettings" object.
    Data Type: DiskCachePerformanceKind
    Default value:  BALANCED
    Allowed values:
        0 - LOW
        1 - BALANCED
        2 - HIGH
        3 - CUSTOM
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

diskCacheSizeInGB  -  M disk cache size in GB. A value of 0 indicates unlimited size. Valid values are 0 or 3 to MAXINT.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

diskCacheSizeInEntries  -  M disk cache size in number of entries. A value of 0 indicates unlimited size. Valid values are 0 to MAXINT
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

diskCacheEntrySizeInMB  -  M size of an individual cache entry in MB. Any cache entry larger than this, when evicted from memory, will not be offloaded to disk. A value of 0 indicates unlimited size. Valid values are 0 to MAXINT
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

diskCacheCleanupFrequency  -  Specifies a value for the disk cache cleanup frequency in minutes. If this value is set to 0, the cleanup is run only at midnight. This setting applies only when the Disk Offload Performance Level is LOW, BALANCED or CUSTOM. The HIGH performance level will not require disk cleanup at all, and this value will be ignored. Valid values are 0 to 1440
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

memoryCacheSizeInMB  -  @since 7.0.0 M memory cache size in MB.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

cacheReplication  -  Configure distributed cache replication settings in order to maintain cache consistency across cache instances on different application servers. This object will store replication related settings for a Data Replication Service end point.
    Reference Type: DRSSettings @
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

diskCacheCustomPerformanceSettings  -  * No description is available *
    Reference Type: DiskCacheCustomPerformanceSettings @
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

diskCacheEvictionPolicy  -  * No description is available *
    Reference Type: DiskCacheEvictionPolicy @
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

memoryCacheEvictionPolicy  -  * No description is available *
    Reference Type: MemoryCacheEvictionPolicy @
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

(C) COPYRIGHT International Business Machines Corp. 1996-2006

Attributes Summary
defaultPriority : EInt	The default priority for servlets that can be cached. It determines how long an entry will stay in a full cache. The recommended value is 1.
hashSize : EInt	Specifies a hash size when disk offload is enabled. Valid values are powers of 2 (1, 2, 4, 8, ...).
cacheSize : EInt	A positive integer defining the maximum number of entries the cache will hold. Values are usually in the thousands, with no set maximum or minimum.
enableCacheReplication : EBoolean	@since 6.0.0
replicationType : DynamicCacheReplicationKind	Specifies the sharing policy of replicated objects across application servers. The value may be PUSH, PULL, PUSH_PULL or NONE, the default being NONE.
pushFrequency : EInt	A time interval, specified in seconds, which is used when replication type is PUSH. Default value is 1.
useListenerContext : EBoolean	Set this value to true to have invalidation events fired to registered invalidation listeners using the listener's J2EE context. Applicable only to Object Cache Instances (not Servlet Cache Instances).
enableDiskOffload : EBoolean	Enables disk offloading.
diskOffloadLocation : EString	Specifies a directory used for disk offload. This value is ignored if Enable Disk Offload is false.
flushToDiskOnStop : EBoolean	Set this value to true to have in memory cached objects saved to disk when the server is stopped. This value is ignored if Enable Disk Offload is false.
diskCachePerformanceLevel : DiskCachePerformanceKind	Specifies the level of performance required by this disk cache. This setting is applicable only if "enableDiskOffload" is specified for the cache. Performance levels determine how memory resources should should be used on background activity such as cache cleanup, expiration, garbage collection etc.. High performance indicates that all metadata will be kept in memory. Medium performance 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 indicates that limited metadata will be kept in memory. Custom performance indicates that the Administrator will explicitly configure the memory settings that will be used to support the above background activity. The Administrator will set these values via the "DiskCacheCustomPerformanceSettings" object.
diskCacheSizeInGB : EInt	M disk cache size in GB. A value of 0 indicates unlimited size. Valid values are 0 or 3 to MAXINT.
diskCacheSizeInEntries : EInt	M disk cache size in number of entries. A value of 0 indicates unlimited size. Valid values are 0 to MAXINT
diskCacheEntrySizeInMB : EInt	M size of an individual cache entry in MB. Any cache entry larger than this, when evicted from memory, will not be offloaded to disk. A value of 0 indicates unlimited size. Valid values are 0 to MAXINT
diskCacheCleanupFrequency : EInt	Specifies a value for the disk cache cleanup frequency in minutes. If this value is set to 0, the cleanup is run only at midnight. This setting applies only when the Disk Offload Performance Level is LOW, BALANCED or CUSTOM. The HIGH performance level will not require disk cleanup at all, and this value will be ignored. Valid values are 0 to 1440
memoryCacheSizeInMB : EInt	@since 7.0.0 M memory cache size in MB.
cacheReplication : DRSSettings @	Configure distributed cache replication settings in order to maintain cache consistency across cache instances on different application servers. This object will store replication related settings for a Data Replication Service end point.
diskCacheCustomPerformanceSettings : DiskCacheCustomPerformanceSettings @	* No description is available *
diskCacheEvictionPolicy : DiskCacheEvictionPolicy @	* No description is available *
memoryCacheEvictionPolicy : MemoryCacheEvictionPolicy @	* No description is available *