Releases: optimizely/java-sdk
Release 4.3.0
[4.3.0]
Dec 10th, 2025
New Features
- CMAB (Contextual Multi-Armed Bandit) Support: Added support for CMAB experiments with new configuration options and cache control (#577, #578, #579, #582, #583, #584, #585, #590, #593)
- Add Holdouts Feature: Add Holdout support for feature experimentation (#572, #576)
- Multi-Region Support for Data Hosting: Added SDK support for multi-region data hosting (#573)
API Changes
-
OptimizelyUserContext: New asynchronous decision-making methods
decideAsync(): Asynchronous method to make a decision for a single flag with CMAB supportdecideAllAsync(): Asynchronous method to make decisions for all flagsdecideForKeysAsync(): Asynchronous method to make decisions for multiple flag keys
-
Client Initialization:
CmabClientConfigcan be injected when initializing the client for custom CMAB configurationCmabServicecan be provided toOptimizelyFactoryfor custom CMAB service implementation
-
New Decide Options: Added cache control options for CMAB
IGNORE_CMAB_CACHE: Skip reading from CMAB cacheRESET_CMAB_CACHE: Clear and reset CMAB cache before decisionINVALIDATE_USER_CMAB_CACHE: Invalidate cache entries for specific user
Release 4.2.2
Release 4.2.1
Release 4.2.0
[4.2.0]
November 6th, 2024
New Features
- Batch UPS lookup and save calls in decideAll and decideForKeys methods (#549).
Release 4.1.1
[4.1.1]
May 8th, 2024
Fixes
- Fix logx events discarded for staled connections with httpclient connection pooling (#545).
Release 4.1.0
[4.1.0]
April 12th, 2024
New Features
Release 4.0.0
[4.0.0]
January 16th, 2024
New Features
The 4.0.0 release introduces a new primary feature, Advanced Audience Targeting
enabled through integration with Optimizely Data Platform (ODP) (#474,#481,#482,#483,#484,#485,#487,#489,#490,#494).
You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.
With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.
This version includes the following changes:
- New API added to
OptimizelyUserContext:fetchQualifiedSegments(): this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.- When an
OptimizelyUserContextis created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.
- New APIs added to
OptimizelyClient:sendOdpEvent(): customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.
For details, refer to our documentation pages:
- Advanced Audience Targeting
- Server SDK Support
- Initialize Java SDK
- OptimizelyUserContext Java SDK
- Advanced Audience Targeting segment qualification methods
- Send Optimizely Data Platform data using Advanced Audience Targeting
Breaking Changes
OdpManagerin the SDK is enabled by default, if initialized using OptimizelyFactory. Unless an ODP account is integrated into the Optimizely projects, mostOdpManagerfunctions will be ignored. If needed, ODP features can be disabled by initializingOptimizelyClientwithout passingOdpManager.ProjectConfigManagerinterface has been changed to add 2 more methodsgetCachedConfig()andgetSDKKey(). Custom ProjectConfigManager should implement these new methods. SeePollingProjectConfigManagerfor reference. This change is required to support ODPManager updated on datafile download (#501).
Fixes
- Fix thread leak from httpClient in HttpProjectConfigManager (#530).
- Fix issue when vuid is passed as userid for
AsyncGetQualifiedSegments(#527). - Fix to support arbitrary client names to be included in logx and odp events (#524).
- Add evict timeout to logx connections (#518).
Functionality Enhancements
- Update Github Issue Templates (#531)
Release 4.0.0-beta2
[4.0.0-beta2]
August 28th, 2023
Fixes
- Fix thread leak from httpClient in HttpProjectConfigManager (#530).
- Fix issue when vuid is passed as userid for
AsyncGetQualifiedSegments(#527). - Fix to support arbitrary client names to be included in logx and odp events (#524).
- Add evict timeout to logx connections (#518).
Functionality Enhancements
- Update Github Issue Templates (#531)
Release 3.10.4
[3.10.4]
June 8th, 2023
Fixes
- Fix intermittent logx event dispatch failures possibly caused by reusing stale connections. Add
evictIdleConnections(1min) toOptimizelyHttpClientinAsyncEventHandlerto force close persistent connections after 1min idle time (#518).
Release 4.0.0-beta
[4.0.0-beta]
May 5th, 2023
New Features
The 4.0.0-beta release introduces a new primary feature, Advanced Audience Targeting
enabled through integration with Optimizely Data Platform (ODP) (#474,#481,#482,#483,#484,#485,#487,#489,#490,#494).
You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex
real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important
for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can
be used as a single source of truth for these segments in any Optimizely or 3rd party tool.
With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and
make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.
This version includes the following changes:
- New API added to
OptimizelyUserContext:fetchQualifiedSegments(): this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.- When an
OptimizelyUserContextis created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.
- New APIs added to
OptimizelyClient:sendOdpEvent(): customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.
For details, refer to our documentation pages:
- Advanced Audience Targeting
- Server SDK Support
- Initialize Java SDK
- OptimizelyUserContext Java SDK
- Advanced Audience Targeting segment qualification methods
- Send Optimizely Data Platform data using Advanced Audience Targeting
Breaking Changes
OdpManagerin the SDK is enabled by default, if initialized using OptimizelyFactory. Unless an ODP account is integrated into the Optimizely projects, mostOdpManagerfunctions will be ignored. If needed,OdpManagerto be disabled initializeOptimizelyClientwithout passingOdpManager.ProjectConfigManagerinterface has been changed to add 2 more methodsgetCachedConfig()andgetSDKKey(). Custom ProjectConfigManager should implement these new methods. SeePollingProjectConfigManagerfor reference. This change is required to support ODPManager updated on datafile download (#501).