Miscellaneous Upgrade Steps
Visitor Cookie Name Change
In brXM 15.0, the default visitor cookie name has changed from _visitor to visitor. This change improves compatibility with Bloomreach Cloud and single-page application (SPA) frontends.
If your implementation does not use an SPA frontend and you want to maintain existing visitor profiles, you can continue using _visitor. To do this, set the following configuration on /targeting:targeting:
/targeting:targeting: targeting:visitorCookieName: _visitor
For additional details, see Visitor, Visits, and Cookies.
HST Enterprise Caching Removed
brXM 15.0 removes the HST Enterprise Caching addon. If your project uses this module, you must remove it.
Follow these steps to remove the module:
- Remove the dependency from your project, typically in the
site/pom.xmlfile:<dependency> <groupId>com.onehippo.cms7</groupId> <artifactId>hippo-addon-caching-hst</artifactId> </dependency> - Delete the following entries from
context.xml(usually located at/site/webapp/src/main/webapp/META-INF/context.xml):<Environment name="stalePageCache"<Environment name="secondLevelPageCache"<Environment name="clusterCache" - Remove any code that references these caches. Look for code similar to:
HippoRedisCacheManager cacheManager = HstServices .getComponentManager() .getComponent(HippoRedisCacheManager.class.getName(), "com.onehippo.cms.spring.cache"); Cache cache = cacheManager.getCache("clusterCache"); - In your local Cargo-based development environment, remove the JNDI
<Environment />variable for Redis configuration from the globalconf/context.xmlfile, if present:
The cache-specific context configuration above is defined in the<Environment name="redis/hippoJedisConnectionFactory"sitewebapp'scontext.xml, while the Redis connection is typically in the global container configuration. - If you used cache key prefixing to prevent cache key collisions, remove these entries from the global container
conf/context.xml:<Environment name="env" type="java.lang.String" value="foo" /> <Environment name="stack" type="java.lang.String" value="bar"/> - If the Redis instance was only used for this feature, you can remove it from your environment.
Upgraded Third-Party Libraries
brXM 15.0 includes significant upgrades to several third-party libraries. If your project code depends on these libraries, you may need to update your code to ensure compatibility. The following libraries have been upgraded to new major versions, which may introduce breaking changes according to Semantic Versioning:
| Library | Previous version (used by v14) | Upgraded version (used by v15) |
|---|---|---|
Guava (com.google.guava/guava) | 30.1-jre | 31.1-jre |
Groovy (org.codehaus.groovy/groovy, groovy-xml, groovy-json) | 2.5.14 | 3.0.9 |
| Wicket (multiple artifacts) | 7.18.0 | 9.7.0 |
Refer to the Wicket upgrade guide for details on updating Wicket code and configuration. For a complete list of upgraded libraries and artifacts, see the v15 release notes.