Dynamic cache custom properties

Use this table as a reference to help you set custom properties for a default dynamic cache instance or a servlet or object cache instance.

Table 1. Dynamic cache custom properties
Property name Required Scope Possible value Description
com.ibm.websphere.xs.dynacache.topology Yes (After WebSphere® Application Server APAR PM71992 is applied, this property is no longer required.) Per cache instance remote Indicates the topology for the cache instance. The remote topology is the only valid topology to use with WebSphere DataPower® XC10 Appliance.
com.ibm.ws.cache.CacheConfig.ignoreValueInInvalidationEvent No Per cache instance true or false

Default: true

Specifies whether the cache value of the Invalidation event is ignored. If it is true, the cache value of Invalidation event is set to NULL when the code is returned to the caller.
com.ibm.websphere.xs.dynacache.ignore_value_in_change_event No Per cache instance true or false

Default: true

Specifies whether the cache value of the Change event is ignored. If it is true, the cache value of Change event is set to NULL when the code is returned to the caller.
com.ibm.websphere.xs.dynacache.cs_override No Per cache instance Catalog service endpoint

Example: 9.5.12.345:2819

Specifies the catalog service endpoint for the data grid to associate with this cache instance. This field is required if it is not specified inWebSphere Application Server administrative console.
com.ibm.websphere.xs.dynacache.grid_name No Per cache instance Any String

Default: JNDI name of the cache instance

Specifies the name of the data grid that you created.
com.ibm.websphere.xs.dynacache.map_template_name No Per cache instance
You can use one of the following map templates:
  • IBM_DC_PARTITIONED_.* (default)
  • IBM_DC_NCI_PARTITIONED_.* (Indicates that this cache uses a near cache.)
Specifies the name of the template map prefix.
com.ibm.websphere.xs.dynacache.cache_name No Per cache instance Any String

Default: value in cache.instance.x

Specifies the name of the unique suffix that is used as the name of the template map. For example, IBM_DC_PARTITIONED.<cache_name>
com.ibm.websphere.xs.dynacache.near_cache_size No Per cache instance Value greater than zero.

Default: value that is specified in cache.instance.x.cacheSize

Specifies the maximum number of entries that are allowed in a near cache instance. By default this value is the same as the maximum number of entries that are allowed in a single partition in the remote ObjectGrid for this cache instance.
com.ibm.websphere.xs.dynacache.request_retry_timeout_override No Per cache instance
Integer value in milliseconds:
  • -1: Infinite. Requests never time out.
  • 0: Requests time out immediately.
  • >0: Amount of time, in milliseconds, that requests run before they time out.
  • 2000: Default value if you do not use this custom property or the client properties file to specify this value.

Specifies how long, in milliseconds, a request can run before timing out. This property overrides the requestRetryTimeout property if it is set in the client properties file. For more information, see the Client properties file.

The request retry timeout default value for dynamic cache instances is 2000 milliseconds, if it is not set with this custom property and it is not set in the client properties file.