Skip to content

Documentation, Custom cache name configuration for Liberty session cache #8490

Description

@riyaaroraa

Feature epic details

Operating systems

Does the documentation apply to all operating systems?

  • Yes
  • No; specify operating systems: ______

Summary

Provide a concise summary of your feature. What is the update, why does it matter, and to whom? What do 80% of target users need to know to be most easily productive using your runtime update?

Adds a new optional cacheNamePrefix attribute to the httpSessionCache config element. This lets users prepend a custom prefix to Liberty-generated JCache session cache names (com.ibm.ws.session.meta.* and com.ibm.ws.session.attr.*).

This matters for anyone running multiple Liberty instances that share the same Infinispan or Hazelcast cluster — for example, multiple pods on OpenShift, blue-green deployments, or multiple environments sharing cache infrastructure. Without a way to customize the cache name, all instances create caches with identical names, causing collisions in the shared cache store.

Most users (single-instance deployments, or deployments not sharing a cache store) don't need this attribute at all — it defaults to empty and existing cache naming is unchanged. Users who do share a cache store across instances need to know: set a unique cacheNamePrefix per instance to avoid collisions.

Configuration

List any new or changed properties, parameters, elements, attributes, etc. Include default values and configuration examples where relevant:

New attribute: cacheNamePrefix on <httpSessionCache>

  • Type: String
  • Default: "" (empty string — no prefix, existing behavior preserved)
  • Description: An optional prefix for Liberty-generated cache names, useful for preventing conflicts when multiple Liberty instances share a cache store.

Example:

<!-- Pod 1 -->
<httpSessionCache cacheRef="InfinispanCacheManager" cacheNamePrefix="pod1_"/>

<!-- Pod 2 -->
<httpSessionCache cacheRef="InfinispanCacheManager" cacheNamePrefix="pod2_"/>

<!-- Results in distinct caches:
     pod1_com.ibm.ws.session.attr.default_host/myapp
     pod2_com.ibm.ws.session.attr.default_host/myapp
-->

Updates to existing topics

To update existing topics, specify a link to the topics that are affected. Include a copy of the current text and the exact text to which it will change. For example: Change ABC to XYZ

Add the cacheNamePrefix attribute to the httpSessionCache config element reference, alongside the existing appInCacheName and cacheSeparator attributes.
https://openliberty.io/docs/latest/reference/config/httpSessionCache.html — should go in the "Performance" section, alongside appInCacheName and cacheSeparator.

Create a new topic

To create a topic, specify a first draft of the topic that you want added and the section in the navigation where the topic should go.

N/A — this is a one-line attribute addition to an existing topic, not a new topic.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions