cache2k/CHANGELOG and cache2k Releases

All Versions

Latest Version

1.9.5.Beta

Avg Release Cycle

24 days

Latest Release

911 days ago

Changelog History

Page 1

v1.9.5.Beta Changes
December 11, 2020
🚀 This is a preview release for evaluation purposes and should not be used in production.

The preview is in preparation for version 2 which will have some major breaking
changes to the previous releases. The final release will be 2.0.0.Final - "North Atlantic".

🆕 New and Noteworthy
- 📚 Documentation fixes. This is the release candidate 2 of cache2k version 2.0
API Changes Possible Breakages
- 📦 Move Weigher to package org.cache2k.operation.
🛠 Fixes and Improvements
- 🛠 Fix site build for Java 11
- 📚 Documentation touch ups
- 🔄 Change configuration XML schema to version 2 and archive version 1
- Event listeners will be send the wrapped cache
v1.9.4.Beta Changes
December 07, 2020
🚀 This is a preview release for evaluation purposes and should not be used in production.

The preview is in preparation for version 2 which will have some major breaking
changes to the previous releases. The final release will be 2.0.0.Final - "North Atlantic".

🆕 New and Noteworthy
- 🚀 Last set of API changes. This is the release candidate 1 of cache2k version 2.0
Possible Breakages
- N/A
API Changes Possible Breakages
- Customizations can implement AutoCloseable, changed from Closeable, Java 8 improvement
- Cache and CacheManager implements AutoCloseable, changed from Closeable, Java 8 improvement
- ⏱ Scheduler and TimeReference available in base configuration and API
🛠 Fixes and Improvements
- Common timer threads are destroyed when last cache is closed, []GH#167](#167),
  Thanks Jingxiao Gu / @dawnwords for reporting!
- 0️⃣ Corner case: Don't drop a altered default name after all cache managers are closed
v1.9.3.Alpha Changes
November 28, 2020
🚀 This is a preview release for evaluation purposes and should not be used in production.

The preview is in preparation for version 2 which will have some major breaking changes to the previous releases. The final release will be 2.0.0.Final - "North Atlantic".

🆕 New and Noteworthy
- ⚡️ Update to enhance compatibility of client code between version 1.6 with 2.0 of cache2k
API Changes / Possible Breakages
- 🗄 Within alpha: Un deprecate KeyValueSource, that's simple and useful
- ⬇️ Drop ExpiryTimeValues.NO_CACHE. ExpiryTimeValues.NOW which has a value of 0 means no caching, and does not start a refresh. Introduced ExpiryTimeValues.REFRESH again, sinc logically everything between 0 (exclusive) and the current time, expires and starts a refresh, if refresh ahead is enabled.
- Within alpha: Reverse hierarchy for new CacheLoaderException, which enhanced compatibility with code doing an instanceof
🛠 Fixes and Improvements
- Cap suppression or caching of exceptions determined by ResiliencePolicy to the expireAfterWrite duration, if specified
v1.9.2.Alpha Changes
November 23, 2020
🚀 This is a preview release for evaluation purposes and should not be used in production.

The preview is in preparation for version 2 which will have some major breaking
changes to the previous releases. The final release will be 2.0.0.Final - "North Atlantic".

🆕 New and Noteworthy
- @nullable annotations
- 👍 General scheme to enable extra functionality, used for JMX and Micrometer support
- 0️⃣ No caching of exceptions by default. This has to be enabled explicitly by specifying
  0️⃣ ResiliencePolicy. Previous default resilience available as UniversalResiliencePolicy in
  cache2k-addon
Possible Breakages

🚀 Since this is a major release, some rarely used things in the API are
🔄 changed without backwards compatibility. Most code is supposed to run
without breaking.
- 🚚 Cache.getStatistics removed. Replaced by CacheManagement.of(Cache).sampleStatistics().
- 🚚 Cache.clearAndClose removed. Replaced by CacheManagement.destroy
- ✂ Removed deprecated MutableCacheEntry.getCurrentTime, replaced with getStartTime
- ✂ Remove MutableCacheEntry.wasExisting and MutableCacheEntry.getOldValue
- 📇 Rename MutableCacheEntry.getRefreshedTime to getModificationTime
- MutableCacheEntry.exists: Does not change the value after setValue or triggered load
- MutableCacheEntry.getValue: Does not change the value after setValue
- 🔧 Every class with Configuration shortened to Config and consequently changed the
  🔧 package name org.cache2k.configuration to org.cache2k.config.
- Cache2kBuilder.toConfiguration() renamed to config()
- 🔧 Lots restructuring around the extra configuration sections and customizations
- ✂ remove Cache2kBuilder.enableJmx. Replaced with Cache2kBuilder.enable(JmxSupport.class)
- 👍 Cache.requestInterface throws UnsupportedOperationException if the requested interface
  👍 is not supported instead of null
- 🔄 Change in special expiry values semantics: Remove ExpiryTimeValues.REFRESH.
  ExpiryTimeValues.NOW expires and starts a refresh if refresh ahead is enabled.
  ExpiryTimeValues.NO_CACHE expires and starts no refresh.
- 0️⃣ No caching of exceptions by default. This has to be enabled explicitly by specifying
  0️⃣ ResiliencePolicy. Previous default resilience available as UniversalResiliencePolicy in
  cache2k-addon
API Changes
- 📇 Renamed ExceptionInformation to LoadExceptionInfo
- 🆕 New method CacheEntry.getExceptionInfo()
- 🚚 org.cache2k.jmx, API for JMX MXBeans removed
- 🆕 New interfaces CacheManagement, CacheControl and CacheInfo in org.cache2k.management
- 🆕 New method: MutableCacheEntry.lock
- 📇 Rename MutableCacheEntry.reload to MutableCacheEntry.load
- ✂ Remove TimeReference interface from public API and make that local to cache2k-core
- 🆕 New method: MutableCacheEntry.getExpiryTime()
- ✂ Remove Cache2kBuilder.enableJmx
- Cache2kBuilder: New methods `set
- 🆕 New methods: Cache.mutate, Cache.mutateAll
🛠 Fixes and Improvements
- 👻 Cache.loadAll() and Cache.reloadAll() complete with exception if a a loader
  👻 exception happened. If more than one exception happened the one is propagated.
- 👌 Improved interface of ExceptionPropagator and LoadExceptionInfo,
  👻 A CacheEntry may be cast to LoadExceptionInfo if an exception is present
- Cache.invoke, EntryProcessor: Make expiry calculations and listeners calls more consistent
  if expiry event races with the start of the operation
- 🔒 MutableCacheEntry.lock allows to lock an entry for mutation explicitly
- Cache.asMap / ConcurrentMap implementation implements compute methods
  and runs them only once
- 🏗 Introduced ConfigAugmenter which can make changed to the configuration before a cache is build
- 🔧 Cache2kBuilder: Methods setup, apply allow to execute a function on the configuration
  🏗 or builder, which can be used to factor out configuration fragments.
  We use this to provide enable and disable methods on policies.
- 👻 AdvancedCacheLoader, AsyncCacheLoader and ExpiryPolicy get null if current entry carries exception, #163
- ✂ Remove ServiceLoader from JMX support in cache2k-jmx, cache2k-micrometer
- Introduce concept of CacheFeature and ToggleCacheFeature
- 🚚 CacheType: immutable instead of bean. CacheType.of moved from CacheTypeCapture
- ✂ Remove the need of serializable from the configuration objects, by doing a deep
  🔧 copy of the default configuration via bean setters and getters.
- Cache2kConfig: Make setEternal a separate flag.
  ✂ Remove logic from setters, so we can use setters and getter to copy the
  object
- Cache.mutate, Cache.mutateAll for a mutation only entry processor variant
- @Nullable, @NonNull annotations
- Within alpha: change new ExceptionPropagator from <K> to <K, V>, dito at LoadExceptionInfo
- @nullness annotations
- Lots of typing refinements
- Cache.entries and Cache.keys return a Set
- Cache.computeIfAbsent with function
- Ignore entryCapacity setting in case a weigher is specified
- 👍 Allow listeners to throw a checked exception
v1.9.1.Alpha Changes
October 13, 2020
🚀 This is a preview release for evaluation purposes and should not be used in production.

The preview is in preparation for version 2 which will have some major breaking changes to the previous releases. The final release will be 2.0.0.Final - "North Atlantic".

🆕 New and Noteworthy
- cache2k-api, cache2k-core, cache2k-jmx and cache2k-config are fully modularized
- Requires at least Java 8 to run
- 🔧 Adaptions to Java 8 on API level. E.g. use of Duration in the configuration
- 🆕 New interfaces for CacheLoader and CacheWriter
- 🗄 Removal of deprecated classes and methods
- 🔧 JMX and XML configuration support is no longer part of cache2k-core
- 👀 OSGi support with cache2k-osgi-all removed, see: #83
Possible Breakages

🚀 Since this is a major release, some rarely used things in the API are changed without backwards compatibility. Most code is supposed to run without breaking.
- Requires at least Java 8 to run
- ✂ Remove deprecated classes and methods: Cache.prefetch, Cache.prefetchAll, IntCache, LongCache,
  CacheEntry.getLastModification, AbstractCacheEntry
- Incompatible change of CustomizationSupplier interface
- 🚚 org.cache2k.integration.ResiliencePolicy removed. Replaced by: org.cache2k.io.ResiliencePolicy
- 🚚 JMX support moved from cache2k-core to cache2k-jmx to minimize module dependencies
- 🔧 XML configuration moved from cache2k-core to cache2k-config to minimize module dependencies
- ⬇️ Dropped apache commons logging support. Commons logging seems to be not
  👍 maintained any more and lacks Jigsaw/module support.
- ⬇️ Drop support for XML configuration on Android, removed XML pull dependency
  👍 (The Android will be potentially unsupported in cache2k V2 at first)
- 🔧 Moved JCache configuration classes in org.cache.jcache from cache2k-api to cache2k-jcache.
  If these are used, cache2k-jcache needs to be in compile scope.
- Cache2kConfiguration: Changed all parameters of type long, representing
  milliseconds to type Duration
API Changes
- 📦 org.cache2k.integration.CacheLoader and everything in package org.cache2k.integration
  🗄 is deprecated. Replacements are available in org.cache2k.io. This major change was done to
  🔄 change from abstract classes to interface. The new package was introduced for smoother transition
  🗄 to keep the previous classes and deprecated them.
- ➕ Add Cache.loadAll and Cache.reloadAll which return CompletableFuture
  🗄 Old methods which use CacheOperationCompletionListener are deprecated
- ✂ Remove deprecated classes and methods: Cache.prefetch, Cache.prefetchAll, IntCache, LongCache,
  CacheEntry.getLastModification, AbstractCacheEntry
🛠 Fixes and Improvements
- All cache customizations (e.g. CacheLoader) implement Customization.
- 🚚 Speedup of internal hash table, because compatibility for Java 6 could be removed
v1.6.0.Final Changes
October 08, 2020
🐎 cache2k is a high performance and light weight in-process caching library. Compared to other libraries
(EHCache, Guava and Caffeine) it achieves the highest throughput for cache hits while still providing
one of the best eviction efficiency. Advanced features of cache2k, like refresh ahead and resilience
can solve typical application problems with ease.

🌲 This change log lists the complete changes since the last stable version 1.4.1.Final.

🆕 New and Noteworthy
- 🆕 New timer based on hierarchical timer wheels, which is more performance and
  scales linear with more cache entries
- No more extra thread per cache, in cache timer is used, e.g. for expiry
Potential breakages
- 0️⃣ No separate executor for async listeners by default any more.
  If an async listener executor is not specified it uses the executor
  0️⃣ defined by Cache2kBuilder.executor which in turn defaults to the
  common ForkJoinPool in Java 8.
- Slightly more lag for operations triggered by time, e.g. cache
  cleanup after expiry, calls of expiry listeners, refreshing.
  The lag can be controlled by Cache2kBuilder.timerLag
API Changes
- 🗄 Deprecated ExpiryTimeValues.NO_CACHE
- 🗄 Deprecated Cache2kBuilder.prefetchExecutor, introduced Cache2kBuilder.refreshExecutor (rename)
- 🗄 Deprecated Cache.prefetch and Cache.prefetchAll
🛠 Fixes and Improvements
- ✂ Remove hash quality metric
- MutableCacheEntry.reload() does load the entry even if already cached
- 👀 After recovering from a load exception the expiry policy did not see the
  👻 correct previous entry value with the exception
- 👌 Improved internal structure and test coverage
Using this cache2k version

The binaries are available on maven central.

For Java SE/EE and Android environments

For Maven users:
```
    <dependency>
      <groupId>org.cache2k</groupId>
      <artifactId>cache2k-base-pom</artifactId>
      <version>1.6.0.Final</version>
      <type>pom</type>
    </dependency>
```
Recommended for Gradle users:
```
def cache2kVersion = '1.6.0.Final'

dependencies {
    implementation "org.cache2k:cache2k-api:${cache2kVersion}"
    runtimeOnly "org.cache2k:cache2k-core:${cache2kVersion}"
}
```
Note to Android users: The included jar files contain code that might only be needed in server environments (e.g. JMX support).
✅ It is possible to strip unnecessary code. Example ProGuard rules can be found at Andriod - cache2k User Guide

Using the JCache / JSR107 provider

Maven users include the cache2k JCache provider this way:
```
    <dependency>
      <groupId>org.cache2k</groupId>
      <artifactId>cache2k-jcache</artifactId>
      <version>1.6.0.Final</version>
      <scope>runtime</scope>
    </dependency>
```
For Gradle users:
```
dependencies {
    runtimeOnly "org.cache2k:cache2k-jcache:1.6.0.Final"
}
```
🔧 Implementation details, tuning tips and hints on configuration can be found at: [JCache - cache2k User Guide](https://cache2k.org/docs/latest/user-guide.html#jcache
v1.5.2.Beta Changes
October 08, 2020
🚀 This is a preview release for evaluation purposes and should not be used in production.
The final release is planed as "Gulf of Thailand 1.6.0.Final".

🆕 New and Noteworthy
- N/A
Possible Breakages
- N/A
API Changes
- 🗄 Deprecated Cache.prefetch and Cache.prefetchAll
🛠 Fixes and Improvements
- 👀 After recovering from a load exception the expiry policy did not see the
  👻 correct previous entry value with the exception
- 👌 Improved internal structure and test coverage
v1.5.1.Alpha Changes
October 04, 2020
🚀 This is a preview release for evaluation purposes and should not be used in production.
The final release is planed as "Gulf of Thailand 1.6.0.Final".

🆕 New and Noteworthy
- 🆕 New timer based on hierarchical timer wheels, which is more performance and
  scales linear with more cache entries
- No more extra thread per cache, in cache timer is used, e.g. for expiry
Possible Breakages
- 0️⃣ No separate executor for async listeners by default any more.
  If an async listener executor is not specified it uses the executor
  0️⃣ defined by Cache2kBuilder.executor which in turn defaults to the
  common ForkJoinPool in Java 8.
- Slightly more lag for operations triggered by time, e.g. cache
  cleanup after expiry, calls of expiry listeners, refreshing.
  The lag can be controlled by Cache2kBuilder.timerLag
API Changes
- 🗄 Deprecated ExpiryTimeValues.NO_CACHE
- 🗄 Deprecated Cache2kBuilder.prefetchExecutor, introduced Cache2kBuilder.refreshExecutor (rename)
🛠 Fixes and Improvements
- ✂ Remove hash quality metric
- MutableCacheEntry.reload() does load the entry even if already cached
v1.4.1.Final Changes
October 02, 2020
🐎 cache2k is a high performance and light weight in-process caching library. Compared to other libraries
(EHCache, Guava and Caffeine) it achieves the highest throughput for cache hits while still providing
one of the best eviction efficiency. Advanced features of cache2k, like refresh ahead and resilience
can solve typical application problems with ease.

🚑 Critical bug fix for 1.4.0.Final.

🛠 Fixes
- Race under special conditions in Cache.computeIfAbsent, Cache.peekAndPut, Cache.get with loader.
  👀 See: #155
Using this cache2k version

The binaries are available on maven central.

For Java SE/EE and Android environments

For Maven users:
```
    <dependency>
      <groupId>org.cache2k</groupId>
      <artifactId>cache2k-base-pom</artifactId>
      <version>1.4.1.Final</version>
      <type>pom</type>
    </dependency>
```
Recommended for Gradle users:
```
def cache2kVersion = '1.4.1.Final'

dependencies {
    implementation "org.cache2k:cache2k-api:${cache2kVersion}"
    runtimeOnly "org.cache2k:cache2k-core:${cache2kVersion}"
}
```
Note to Android users: The included jar files contain code that might only be needed in server environments (e.g. JMX support).
✅ It is possible to strip unnecessary code. Example ProGuard rules can be found at Andriod - cache2k User Guide

Using the JCache / JSR107 provider

Maven users include the cache2k JCache provider this way:
```
    <dependency>
      <groupId>org.cache2k</groupId>
      <artifactId>cache2k-jcache</artifactId>
      <version>1.4.1.Final</version>
      <scope>runtime</scope>
    </dependency>
```
For Gradle users:
```
dependencies {
    runtimeOnly "org.cache2k:cache2k-jcache:1.4.1.Final"
}
```
🔧 Implementation details, tuning tips and hints on configuration can be found at: JCache - cache2k User Guide
v1.4.0.Final Changes
September 12, 2020
🐎 cache2k is a high performance and light weight in-process caching library. Compared to other libraries
(EHCache, Guava and Caffeine) it achieves the highest throughput for cache hits while still providing
one of the best eviction efficiency. Advanced features of cache2k, like refresh ahead and resilience
can solve typical application problems with ease.

Highlights of the new version:

🌲 This change log lists the complete changes since the last stable version 1.2.4.Final.

🆕 New and Noteworthy
- Weigher
- AsyncCacheLoader
- Eviction listener and eviction improvements
- 🔀 Synchronous execution of expiry listener
- 👍 Micrometer support
- Online resize of caches
- 👌 Support for GraalVM native image build
API Changes

🆕 New methods / fields:
- 0️⃣ CacheManager.STANDARD_DEFAULT_MANAGER_NAME
- CacheInfoMXBean.isWeigherPresent()
- CacheInfoMXBean.isLoaderPresent()
- CacheInfoMXBean.getTotalWeight()
- CacheInfoMXBean.getMaximumWeight()
- CacheInfoMXBean.getCapacityLimit()
- Cache.getStatistics()
🆕 New interface:
- AsyncCacheLoader
🗄 Deprecation:
- IntCache, LongCache
- 🏗 Cache2kBuilder.buildIntCache(), Cache2kBuilder.buildLongCache()
API Changes and Potential breakages

🔀 Cache2kBuilder.addListener will execute an EntryExpiredLister synchronously. In version
1.2 an expiry listener was always executed asynchronously. This is an potentially incompatible
🔄 change, in case expiry listeners are used. Review the existing client code and
👉 make sure that addAsyncListeners is used for an EntryExpiredLister if that is wanted.

🛠 Fixes
- 🛠 Fix CacheManager.setDefaultName, see GH#108
- 🚚 race of refresh and delete: if an entry is deleted via Cache.remove it was not
  reappearing when refreshed concurrently
- 🛠 fix missing expiry listener call after a created listener call, in case expiry during the insert
- expiry, expireAfterWrite, refreshAhead: Fix race condition of a Cache.put and the
👌 Improvements
- ✂ Remove randomized hash seed and simplify the "rehashing" of hash codes identical to Java
  HashMap and ConcurrentHashMap
- Async Cacheloader GH#93
- CacheEntryEvictionListener added, GH#59
- 🔦 Expose cache statistics via Cache.getStatistics()
- 👀 Eviction: Efficiency improvements, see comment: #101 (comment)
- 🔀 Expiry listener supports synchronous operation
- 🗄 Deprecated IntCache and LongCache
- Internal: Improvement and simplification of ExceptionPropagator handling
  termination of the probation period after a refresh.
- Cache.invoke / EntryProcessor: Internal improvements when using listeners: avoid unnecessary
  entry reads
- internal cleanup: use common code for refresh in different cache variants
- eviction efficiency fix for a few special short traces
- 👌 Support for new cache methods from Spring Framework 5.2
- doc clarifications and improvements
- 0️⃣ SpringCache2kCacheManager.setAllowUnknownCache is true by default, to minimize initial setup
- 🖨 CacheEntry.toString output does not call toString on the value and print hashCode instead
- doc clarifications
- 💅 Code style improvements
Using this cache2k version

The binaries are available on maven central.

For Java SE/EE and Android environments

For Maven users:
```
    <dependency>
      <groupId>org.cache2k</groupId>
      <artifactId>cache2k-base-pom</artifactId>
      <version>1.4.0.Final</version>
      <type>pom</type>
    </dependency>
```
Recommended for Gradle users:
```
def cache2kVersion = '1.4.0.Final'

dependencies {
    implementation "org.cache2k:cache2k-api:${cache2kVersion}"
    runtimeOnly "org.cache2k:cache2k-core:${cache2kVersion}"
}
```
Note to Android users: The included jar files contain code that might only be needed in server environments (e.g. JMX support).
✅ It is possible to strip unnecessary code. Example ProGuard rules can be found at Andriod - cache2k User Guide

Using the JCache / JSR107 provider

Maven users include the cache2k JCache provider this way:
```
    <dependency>
      <groupId>org.cache2k</groupId>
      <artifactId>cache2k-jcache</artifactId>
      <version>1.4.0.Final</version>
      <scope>runtime</scope>
    </dependency>
```
For Gradle users:
```
dependencies {
    runtimeOnly "org.cache2k:cache2k-jcache:1.4.0.Final"
}
```
🔧 Implementation details, tuning tips and hints on configuration can be found at: JCache - cache2k User Guide

cache2k changelog

Lightweight, high performance Java caching

Changelog History Page 1

🆕 New and Noteworthy

API Changes Possible Breakages

🛠 Fixes and Improvements

🆕 New and Noteworthy

Possible Breakages

API Changes Possible Breakages

🛠 Fixes and Improvements

🆕 New and Noteworthy

API Changes / Possible Breakages

🛠 Fixes and Improvements

🆕 New and Noteworthy

Possible Breakages

API Changes

🛠 Fixes and Improvements

🆕 New and Noteworthy

Possible Breakages

API Changes

🛠 Fixes and Improvements

🆕 New and Noteworthy

Potential breakages

API Changes

🛠 Fixes and Improvements

Using this cache2k version

For Java SE/EE and Android environments

Using the JCache / JSR107 provider

🆕 New and Noteworthy

Possible Breakages

API Changes

🛠 Fixes and Improvements

🆕 New and Noteworthy

Possible Breakages

API Changes

🛠 Fixes and Improvements

🛠 Fixes

Using this cache2k version

For Java SE/EE and Android environments

Using the JCache / JSR107 provider

🆕 New and Noteworthy

API Changes

API Changes and Potential breakages

🛠 Fixes

👌 Improvements

Using this cache2k version

For Java SE/EE and Android environments

Using the JCache / JSR107 provider

Changelog History

Page 1