HTTP Session Cache (httpSessionCache)

Controls how HTTP sessions are persisted using JCache.

Name	Type	Default	Description
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.

Name

Type

Default

Description

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

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

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.

httpSessionCache > cacheManager

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

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.

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.

httpSessionCache > cacheManager > cachingProvider

The JCache CachingProvider that this JCache CacheManager instance uses.

Name	Type	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.

httpSessionCache > 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).		Specifies a set of JAR or ZIP files to include in the class path for this library
id	string		A unique configuration ID.
name	string		Name of shared library for administrators

httpSessionCache > cacheManager > cachingProvider > commonLibrary > file

Add a JAR or ZIP file to include in the class path for this library. Classes and resources that are contained in the specified JAR or ZIP are available to load for this library.

Name	Type	Default	Description
id	string		A unique configuration ID.
name	Path to a file Required		The path to a file can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.

httpSessionCache > cacheManager > cachingProvider > commonLibrary > fileset

Specifies a set of JAR or ZIP files to include in the class path for this library

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.

httpSessionCache > cacheManager > cachingProvider > commonLibrary > folder

Add a folder to include in the class path for this library. Classes and resources that are contained in the specified folder and its subfolders are available to load for this library. JAR and ZIP files that are contained in the specified folder are not added to the class path for this library.

Name	Type	Default	Description
dir	Path to a directory Required		The path to a folder can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.
id	string		A unique configuration ID.

httpSessionCache > cacheManager > cachingProvider > commonLibrary > path

Add a JAR file, ZIP file or folder to include in the class path for this library. If the specified path is a JAR or ZIP file, then classes and resources that are contained in the specified JAR or ZIP file are available to load for this library. If the specified path is a folder, then classes and resources that are contained in the specified folder and its subfolders are available to load for this library. JAR and ZIP files contained in the specified folder are not added to the class path for this library.

Name	Type	Default	Description
id	string		A unique configuration ID.
name	A file, directory or url. Required		The path can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.

httpSessionCache > 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).		Specifies a set of JAR or ZIP files to include in the class path for this library
name	string		Name of shared library for administrators

httpSessionCache > cacheManager > cachingProvider > jCacheLibrary > file

Add a JAR or ZIP file to include in the class path for this library. Classes and resources that are contained in the specified JAR or ZIP are available to load for this library.

Name	Type	Default	Description
id	string		A unique configuration ID.
name	Path to a file Required		The path to a file can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.

httpSessionCache > cacheManager > cachingProvider > jCacheLibrary > fileset

Specifies a set of JAR or ZIP files to include in the class path for this library

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.

httpSessionCache > cacheManager > cachingProvider > jCacheLibrary > folder

Name	Type	Default	Description
dir	Path to a directory Required		The path to a folder can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.
id	string		A unique configuration ID.

httpSessionCache > cacheManager > cachingProvider > jCacheLibrary > path

Name	Type	Default	Description
id	string		A unique configuration ID.
name	A file, directory or url. Required		The path can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.

httpSessionCache > cacheManager > properties

Vendor-specific JCache configuration properties, which are passed to the CachingProvider when the CacheManager instance is obtained.

httpSessionCache > library

Identifies JCache provider files.

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).		Specifies a set of JAR or ZIP files to include in the class path for this library
name	string		Name of shared library for administrators

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

Specifies a set of JAR or ZIP files to include in the class path for this library

name

string

Name of shared library for administrators

httpSessionCache > library > file

Add a JAR or ZIP file to include in the class path for this library. Classes and resources that are contained in the specified JAR or ZIP are available to load for this library.

Name	Type	Default	Description
id	string		A unique configuration ID.
name	Path to a file Required		The path to a file can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.

httpSessionCache > library > fileset

Specifies a set of JAR or ZIP files to include in the class path for this library

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.

httpSessionCache > library > folder

Name	Type	Default	Description
dir	Path to a directory Required		The path to a folder can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.
id	string		A unique configuration ID.

httpSessionCache > library > path

Name	Type	Default	Description
id	string		A unique configuration ID.
name	A file, directory or url. Required		The path can be a fully qualified path or a relative path. Relative paths are relative to the value of the ${server.config.dir} property.

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