distributedMap - Distributed Map (distributedMap)

Distributed map configuration for a local cache.

NameTypeDefaultDescription
idstringA unique configuration ID.
jndiNamestring${id}JNDI name for a cache instance.
memorySizeInEntriesint
Min: 0
2000Specifies a positive integer that defines the maximum number of entries that the cache can hold. Values are usually in the thousands. The minimum value is 100, with no set maximum value. The default value is 2000.
memorySizeInMBint
Min: -1
-1Specifies a value for the maximum memory cache size in megabytes (MB).
highThresholdint
Min: -1

Max: 100
-1Specifies when the memory cache eviction policy starts. The threshold is expressed in terms of the percentage of the memory cache size in megabytes (MB).
lowThresholdint
Min: -1

Max: 100
-1Specifies when the memory cache eviction policy ends. The threshold is expressed in terms of the percentage of the memory cache size in megabytes (MB).
cacheProviderNamestringdefaultSpecifies the name of an alternate cache provider.
libraryRefA reference to top level library element (string).Specifies a reference to a shared library.

library

Specifies a reference to a shared library.

NameTypeDefaultDescription
namestringName of shared library for administrators
descriptionstringDescription of shared library for administrators
filesetRefList of references to top level fileset elements (comma-separated string).Id of referenced Fileset
apiTypeVisibilitystringspec,ibm-api,apiThe types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party.

library > fileset

Id of referenced Fileset

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directory${server.config.dir}The base directory to search for files.
caseSensitivebooleantrueBoolean to indicate whether or not the search should be case sensitive (default: true).
includesstring*The comma or space separated list of file name patterns to include in the search results (default: *).
excludesstringThe comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
scanIntervalA period of time with millisecond precision0Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

library > folder

Id of referenced folder

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directoryDirectory or folder to be included in the library classpath for locating resource files

library > file

Id of referenced File

NameTypeDefaultDescription
idstringA unique configuration ID.
namePath to a fileFully qualified filename

diskCache

Enable disk offload to specify that when the cache is full, cache entries are removed from the cache and saved to disk. The location is a fully-qualified directory location that is used by the disk offload function. The Flush to Disk on Stop option specifies that when the server stops, the contents of the memory cache are moved to disk.

NameTypeDefaultDescription
sizeInEntriesint
Min: 0
100000Specifies a value for the maximum disk cache size, in number of entries.
sizeInGBint
Min: 3
3Specifies a value for the maximum disk cache size, in gigabytes (GB).
evictionPolicy
  • RANDOM
  • SIZE
RANDOMSpecifies the eviction algorithm and thresholds that the disk cache uses to evict entries. When the disk size reaches a high threshold limit, the disk cache garbage collector wakes up and evicts randomly-selected (Random) or the largest (Size) entries on the disk until the disk size reaches a low threshold limit.
RANDOM
Random
SIZE
Size
highThresholdint
Min: 0

Max: 100
80Specifies when the eviction policy starts.
lowThresholdint
Min: 0

Max: 100
70Specifies when the eviction policy ends.
locationPath to a directorySpecifies a directory to use for disk offload.
flushToDiskOnStopEnabledbooleanfalseSet this value to true to have objects that are cached in memory saved to disk when the server stops. This value is ignored if Enable disk offload is set to false.

cacheGroup

Specifies sets of external caches that are controlled by WebSphere(R) Application Server on servers such as IBM(R) WebSphere(R) Edge Server and IBM(R) HTTP Server.

NameTypeDefaultDescription
namestringSpecifies a unique name for the external cache group. The external cache group name must match the ExternalCache property that is defined in the servlet or Java(TM) Server Pages (JSP) cachespec.xml file.

cacheGroup > member

Members of an external cache group that are controlled by WebSphere Application Server.

NameTypeDefaultDescription
hoststringFully qualified host name
portint
Min: 0
Port.

cacheGroup > member > adapterBeanName

Specifies the name of a class, which is located on the WebSphere Application Server class path, of the adapter between WebSphere Application Server and this external cache.