JCache Cache (cache)
Configuration for JCache Cache.
Name | Type | Default | Description |
---|---|---|---|
cacheManagerRef |
A reference to top level cacheManager element (string). |
The JCache CacheManager instance that manages this cache. |
|
id |
string |
A unique configuration ID. |
|
name |
string |
The JCache cache name to use for caching. If this cache does not exist, it is created at runtime. The name must be unique for a given CacheManager instance. |
cacheManager
The JCache CacheManager instance that manages this cache.
Name | Type | Default | Description |
---|---|---|---|
cachingProviderRef |
A reference to top level cachingProvider element (string). |
The JCache CachingProvider that this JCache CacheManager instance uses. |
|
uri |
A file, directory or url. |
Vendor-specific JCache configuration URI, which is passed to the CachingProvider when the CacheManager instance is obtained. |
cacheManager > cachingProvider
The JCache CachingProvider that this JCache CacheManager instance uses.
Name | Type | Default | Description |
---|---|---|---|
commonLibraryRef |
List of references to top level library elements (comma-separated string). |
A library or libraries that contain any classes that might be stored in the cache. |
|
jCacheLibraryRef |
A reference to top level library element (string). |
A library that contains the JCache implementation. |
|
providerClass |
string |
The fully-qualified class name of the JCache javax.cache.CachingProvider instance. |
cacheManager > cachingProvider > commonLibrary
A library or libraries that contain any classes that might be stored in the cache.
Name | Type | Default | Description |
---|---|---|---|
apiTypeVisibility |
string |
spec,ibm-api,api,stable |
The types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party. |
description |
string |
Description of shared library for administrators |
|
filesetRef |
List of references to top level fileset elements (comma-separated string). |
Id of referenced Fileset |
|
id |
string |
A unique configuration ID. |
|
name |
string |
Name of shared library for administrators |
cacheManager > cachingProvider > commonLibrary > file
Id of referenced File
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
Path to a file |
Fully qualified filename |
cacheManager > cachingProvider > commonLibrary > fileset
Id of referenced Fileset
Name | Type | Default | Description |
---|---|---|---|
caseSensitive |
boolean |
true |
Boolean to indicate whether or not the search should be case sensitive (default: true). |
dir |
Path to a directory |
${server.config.dir} |
The base directory to search for files. |
excludes |
string |
The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded. |
|
id |
string |
A unique configuration ID. |
|
includes |
string |
* |
The comma or space separated list of file name patterns to include in the search results (default: *). |
scanInterval |
A period of time with millisecond precision |
0 |
The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. 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. |
cacheManager > cachingProvider > commonLibrary > folder
Id of referenced folder
Name | Type | Default | Description |
---|---|---|---|
dir |
Path to a directory |
Directory or folder to be included in the library classpath for locating resource files |
|
id |
string |
A unique configuration ID. |
cacheManager > cachingProvider > jCacheLibrary
A library that contains the JCache implementation.
Name | Type | Default | Description |
---|---|---|---|
apiTypeVisibility |
string |
spec,ibm-api,api,stable |
The types of API packages that this class loader supports. This value is a comma-separated list of any combination of the following API packages: spec, ibm-api, api, stable, third-party. |
description |
string |
Description of shared library for administrators |
|
filesetRef |
List of references to top level fileset elements (comma-separated string). |
Id of referenced Fileset |
|
name |
string |
Name of shared library for administrators |
cacheManager > cachingProvider > jCacheLibrary > file
Id of referenced File
Name | Type | Default | Description |
---|---|---|---|
id |
string |
A unique configuration ID. |
|
name |
Path to a file |
Fully qualified filename |
cacheManager > cachingProvider > jCacheLibrary > fileset
Id of referenced Fileset
Name | Type | Default | Description |
---|---|---|---|
caseSensitive |
boolean |
true |
Boolean to indicate whether or not the search should be case sensitive (default: true). |
dir |
Path to a directory |
${server.config.dir} |
The base directory to search for files. |
excludes |
string |
The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded. |
|
id |
string |
A unique configuration ID. |
|
includes |
string |
* |
The comma or space separated list of file name patterns to include in the search results (default: *). |
scanInterval |
A period of time with millisecond precision |
0 |
The scanning interval to determine whether files are added or removed from the fileset. The individual files are not scanned. The suffix for the interval of time is h-hour, m-minute, s-second, and ms-millisecond, for example, 2ms or 5s. The scanning interval is disabled by default and is disabled manually by setting the scan interval, scanInterval, to 0. 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. |
cacheManager > cachingProvider > jCacheLibrary > folder
Id of referenced folder
Name | Type | Default | Description |
---|---|---|---|
dir |
Path to a directory |
Directory or folder to be included in the library classpath for locating resource files |
|
id |
string |
A unique configuration ID. |
cacheManager > properties
Vendor-specific JCache configuration properties, which are passed to the CachingProvider when the CacheManager instance is obtained.