HTTP Session Cache (httpSessionCache)

Controls how HTTP sessions are persisted using JCache.

NameTypeDefaultDescription

cacheManagerRef

A reference to top level cacheManager element (string).

The JCache CacheManager reference that is used to get the HTTP session JCache caches.

libraryRef

A reference to top level library element (string).

Identifies JCache provider files.

uri

A file, directory or url.

Vendor-specific JCache configuration URI, which is passed to the JCache provider when the CacheManager is obtained. This setting is ignored when cacheManagerRef is used.

Performance

appInCacheName

boolean

false

By default, per-application JCache session cache names are generated by using the context root. When the JCache session caches are distributed across multiple servers, multiple applications with the same context root might exist that must not share a session cache. When this option is enabled, application names are included in JCache cache names to help avoid conflicting JCache cache names. The default value is false.

cacheSeparator

string

%

The single character used to separate the session meta cache name. The default value should usually be used.

scheduleInvalidationFirstHour

int
Min: 0
Max: 23

Enable this option to reduce the number of cache updates required to remove invalidated HTTP sessions. Specify an hour of the day when there is the least activity. When this option is disabled, the invalidator process runs every few minutes to remove invalidated HTTP sessions.

scheduleInvalidationSecondHour

int
Min: 0
Max: 23

Enable this option to reduce the number of cache updates required to remove invalidated HTTP sessions. Specify an hour of the day when there is the least activity. When this option is disabled, the invalidator process runs every few minutes to remove invalidated HTTP sessions.

writeContents

  • ALL_SESSION_ATTRIBUTES

  • GET_AND_SET_ATTRIBUTES

  • ONLY_SET_ATTRIBUTES

ONLY_SET_ATTRIBUTES

Specifies which session data is written to the persistent store.
ALL_SESSION_ATTRIBUTES
All attributes are written to the persistent store regardless of whether getAttribute or setAttribute are invoked.
GET_AND_SET_ATTRIBUTES
Attributes for which getAttribute or setAttribute is invoked are written to the persistent store. This can be useful for applications that use getAttribute to obtain and mutate attribute values without using setAttribute to explicitly request that they be written to the persistent store.
ONLY_SET_ATTRIBUTES
Only attributes for which setAttribute is invoked are written to the persistent store.

writeFrequency

  • END_OF_SERVLET_SERVICE

  • MANUAL_UPDATE

  • TIME_BASED_WRITE

END_OF_SERVLET_SERVICE

Specifies when session data is written to the persistent store.
END_OF_SERVLET_SERVICE
Session data is written to the persistent store after the servlet completes execution.
MANUAL_UPDATE
Session data is written to the persistent store upon programmatic sync of the IBMSession object.
TIME_BASED_WRITE
Session data is written to the persistent store according to the write interval.

writeInterval

A period of time with second precision

2m

Specifies how often to write session data to the persistent store. This value is used when a time-based write frequency is enabled. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

cacheManager

The JCache CacheManager reference that is used to get the HTTP session JCache caches.

NameTypeDefaultDescription

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.

NameTypeDefaultDescription

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.

NameTypeDefaultDescription

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

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

Path to a file
Required

Fully qualified filename

cacheManager > cachingProvider > commonLibrary > fileset

Id of referenced Fileset

NameTypeDefaultDescription

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

NameTypeDefaultDescription

dir

Path to a directory
Required

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.

NameTypeDefaultDescription

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

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

Path to a file
Required

Fully qualified filename

cacheManager > cachingProvider > jCacheLibrary > fileset

Id of referenced Fileset

NameTypeDefaultDescription

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

NameTypeDefaultDescription

dir

Path to a directory
Required

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.

library

Identifies JCache provider files.

NameTypeDefaultDescription

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

library > file

Id of referenced File

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

Path to a file
Required

Fully qualified filename

library > fileset

Id of referenced Fileset

NameTypeDefaultDescription

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.

library > folder

Id of referenced folder

NameTypeDefaultDescription

dir

Path to a directory
Required

Directory or folder to be included in the library classpath for locating resource files

id

string

A unique configuration ID.

properties

List of vendor-specific JCache configuration properties, which are passed to the JCache provider when the CacheManager is obtained. This setting is ignored when cacheManagerRef is used.