Spring Framework 6.1.4 · org.springframework.cache.caffeine.CaffeineCacheManager

Modifier and Type	Field and Description
private boolean	allowNullValues
private boolean	asyncCacheMode
private Caffeine<Object, Object>	cacheBuilder
private AsyncCacheLoader<Object, Object>	cacheLoader
private final Map<String, Cache>	cacheMap
private final Collection<String>	customCacheNames
private boolean	dynamic

Access	Constructor and Description
public	CaffeineCacheManager() Construct a dynamic CaffeineCacheManager, lazily creating cache instances as they are being requested.
public	CaffeineCacheManager(String... cacheNames) Construct a static CaffeineCacheManager, managing caches for the specified cache names only.

Method Summary

Modifier and Type	Method and Description
protected Cache	Returns: the Spring CaffeineCache adapter (or a decorator thereof) adaptCaffeineCache(String the name of the cache name, Cache<Object, Object> the native Caffeine Cache instance cache) Adapt the given new native Caffeine Cache instance to Spring's `Cache` abstraction for the specified cache name.
protected Cache	Returns: the Spring CaffeineCache adapter (or a decorator thereof) adaptCaffeineCache(String the name of the cache name, AsyncCache<Object, Object> the Caffeine AsyncCache instance cache) Adapt the given new Caffeine AsyncCache instance to Spring's `Cache` abstraction for the specified cache name.
protected AsyncCache<Object, Object>	Returns: the Caffeine AsyncCache instance createAsyncCaffeineCache(String the name of the cache name) Build a common Caffeine AsyncCache instance for the specified cache name, using the common Caffeine configuration specified on this cache manager.
protected Cache	Returns: the Spring CaffeineCache adapter (or a decorator thereof) createCaffeineCache(String the name of the cache name) Build a common `CaffeineCache` instance for the specified cache name, using the common Caffeine configuration specified on this cache manager.
protected Cache<Object, Object>	Returns: the native Caffeine Cache instance createNativeCaffeineCache(String the name of the cache name) Build a common Caffeine Cache instance for the specified cache name, using the common Caffeine configuration specified on this cache manager.
private void	doSetCaffeine(Caffeine<Object, Object> cacheBuilder)
public Cache	getCache(String the cache identifier (must not be `null`) name) Implements org.springframework.cache.CacheManager.getCache. Get the cache associated with the given name.
public Collection<String>	getCacheNames() Implements org.springframework.cache.CacheManager.getCacheNames. Get a collection of the cache names known by this manager.
public boolean	isAllowNullValues() Return whether this cache manager accepts and converts `null` values for all of its caches.
private void	refreshCommonCaches() Recreate the common caches with the current state of this manager.
public void	registerCustomCache(String the name of the cache name, Cache<Object, Object> the custom Caffeine Cache instance to register cache) Register the given native Caffeine Cache instance with this cache manager, adapting it to Spring's cache API for exposure through `getCache`.
public void	registerCustomCache(String the name of the cache name, AsyncCache<Object, Object> the custom Caffeine AsyncCache instance to register cache) Register the given Caffeine AsyncCache instance with this cache manager, adapting it to Spring's cache API for exposure through `getCache`.
public void	setAllowNullValues(boolean allowNullValues) Specify whether to accept and convert `null` values for all caches in this cache manager.
public void	setAsyncCacheLoader(AsyncCacheLoader<Object, Object> cacheLoader) Set the Caffeine AsyncCacheLoader to use for building each individual `CaffeineCache` instance, turning it into a LoadingCache.
public void	setAsyncCacheMode(boolean asyncCacheMode) Set the common cache type that this cache manager builds to async.
public void	setCacheLoader(CacheLoader<Object, Object> cacheLoader) Set the Caffeine CacheLoader to use for building each individual `CaffeineCache` instance, turning it into a LoadingCache.
public void	setCacheNames(Collection<String> cacheNames) Specify the set of cache names for this CacheManager's 'static' mode.
public void	setCacheSpecification(String cacheSpecification) Set the Caffeine cache specification String to use for building each individual `CaffeineCache` instance.
public void	setCaffeine(Caffeine<Object, Object> caffeine) Set the Caffeine to use for building each individual `CaffeineCache` instance.
public void	setCaffeineSpec(CaffeineSpec caffeineSpec) Set the `CaffeineSpec` to use for building each individual `CaffeineCache` instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

allowNullValues	back to summary
private boolean allowNullValues

asyncCacheMode	back to summary
private boolean asyncCacheMode

cacheBuilder	back to summary
private Caffeine<Object, Object> cacheBuilder

cacheLoader	back to summary
private AsyncCacheLoader<Object, Object> cacheLoader Annotations @Nullable

cacheMap	back to summary
private final Map<String, Cache> cacheMap

customCacheNames	back to summary
private final Collection<String> customCacheNames

dynamic	back to summary
private boolean dynamic

CaffeineCacheManager	back to summary
public CaffeineCacheManager() Construct a dynamic CaffeineCacheManager, lazily creating cache instances as they are being requested.

CaffeineCacheManager	back to summary
public CaffeineCacheManager(String... cacheNames) Construct a static CaffeineCacheManager, managing caches for the specified cache names only.

Method Detail

adaptCaffeineCache back to summary

adaptCaffeineCache	back to summary
protected Cache adaptCaffeineCache(String name, Cache<Object, Object> cache) Adapt the given new native Caffeine Cache instance to Spring's `Cache` abstraction for the specified cache name. Parameters name:String the name of the cache cache:Cache<Object, Object> the native Caffeine Cache instance Returns:Cache the Spring CaffeineCache adapter (or a decorator thereof) Since 5.2.8 See Also `CaffeineCache#CaffeineCache(String, com.github.benmanes.caffeine.cache.Cache, boolean)`, `isAllowNullValues()`

protected Cache adaptCaffeineCache(String name, Cache<Object, Object> cache)

Adapt the given new native Caffeine Cache instance to Spring's Cache abstraction for the specified cache name.

Parameters

name:String: the name of the cache
cache:Cache<Object, Object>: the native Caffeine Cache instance

Returns:Cache

the Spring CaffeineCache adapter (or a decorator thereof)

Since

5.2.8

adaptCaffeineCache back to summary

adaptCaffeineCache	back to summary
protected Cache adaptCaffeineCache(String name, AsyncCache<Object, Object> cache) Adapt the given new Caffeine AsyncCache instance to Spring's `Cache` abstraction for the specified cache name. Parameters name:String the name of the cache cache:AsyncCache<Object, Object> the Caffeine AsyncCache instance Returns:Cache the Spring CaffeineCache adapter (or a decorator thereof) Since 6.1 See Also `CaffeineCache#CaffeineCache(String, AsyncCache, boolean)`, `isAllowNullValues()`

protected Cache adaptCaffeineCache(String name, AsyncCache<Object, Object> cache)

Adapt the given new Caffeine AsyncCache instance to Spring's Cache abstraction for the specified cache name.

Parameters

name:String: the name of the cache
cache:AsyncCache<Object, Object>: the Caffeine AsyncCache instance

Returns:Cache

the Spring CaffeineCache adapter (or a decorator thereof)

Since

6.1

createAsyncCaffeineCache back to summary

createAsyncCaffeineCache	back to summary
protected AsyncCache<Object, Object> createAsyncCaffeineCache(String name) Build a common Caffeine AsyncCache instance for the specified cache name, using the common Caffeine configuration specified on this cache manager. Parameters name:String the name of the cache Returns:AsyncCache<Object, Object> the Caffeine AsyncCache instance Since 6.1 See Also `createCaffeineCache`

protected AsyncCache<Object, Object> createAsyncCaffeineCache(String name)

Build a common Caffeine AsyncCache instance for the specified cache name, using the common Caffeine configuration specified on this cache manager.

Parameters

name:String: the name of the cache

Returns:AsyncCache<Object, Object>

the Caffeine AsyncCache instance

Since

6.1

See Also

createCaffeineCache

createCaffeineCache back to summary

createCaffeineCache	back to summary
protected Cache createCaffeineCache(String name) Build a common `CaffeineCache` instance for the specified cache name, using the common Caffeine configuration specified on this cache manager. Delegates to `adaptCaffeineCache` as the adaptation method to Spring's cache abstraction (allowing for centralized decoration etc.), passing in a freshly built native Caffeine Cache instance. Parameters name:String the name of the cache Returns:Cache the Spring CaffeineCache adapter (or a decorator thereof) See Also `adaptCaffeineCache`, `createNativeCaffeineCache`

protected Cache createCaffeineCache(String name)

Build a common CaffeineCache instance for the specified cache name, using the common Caffeine configuration specified on this cache manager.

Delegates to adaptCaffeineCache as the adaptation method to Spring's cache abstraction (allowing for centralized decoration etc.), passing in a freshly built native Caffeine Cache instance.

Parameters

name:String: the name of the cache

Returns:Cache

the Spring CaffeineCache adapter (or a decorator thereof)

createNativeCaffeineCache back to summary

createNativeCaffeineCache	back to summary
protected Cache<Object, Object> createNativeCaffeineCache(String name) Build a common Caffeine Cache instance for the specified cache name, using the common Caffeine configuration specified on this cache manager. Parameters name:String the name of the cache Returns:Cache<Object, Object> the native Caffeine Cache instance See Also `createCaffeineCache`

protected Cache<Object, Object> createNativeCaffeineCache(String name)

Build a common Caffeine Cache instance for the specified cache name, using the common Caffeine configuration specified on this cache manager.

Parameters

name:String: the name of the cache

Returns:Cache<Object, Object>

the native Caffeine Cache instance

See Also

createCaffeineCache

doSetCaffeine	back to summary
private void doSetCaffeine(Caffeine<Object, Object> cacheBuilder)

getCache back to summary

getCache	back to summary
public Cache getCache(String name) Implements org.springframework.cache.CacheManager.getCache. Doc from org.springframework.cache.CacheManager.getCache. Get the cache associated with the given name. Note that the cache may be lazily created at runtime if the native provider supports it. Parameters name:String the cache identifier (must not be `null`) Returns:Cache the associated cache, or `null` if such a cache does not exist or could be not created Annotations @Override @Nullable

public Cache getCache(String name)

Implements org.springframework.cache.CacheManager.getCache.

Doc from org.springframework.cache.CacheManager.getCache.

Get the cache associated with the given name.

Note that the cache may be lazily created at runtime if the native provider supports it.

Parameters

name:String: the cache identifier (must not be null)

Returns:Cache

the associated cache, or null if such a cache does not exist or could be not created

Annotations

@Override
@Nullable

getCacheNames	back to summary
public Collection<String> getCacheNames() Implements org.springframework.cache.CacheManager.getCacheNames. Doc from org.springframework.cache.CacheManager.getCacheNames. Get a collection of the cache names known by this manager. Returns:Collection<String> the names of all caches known by the cache manager Annotations @Override

getCacheNames

back to summary

public Collection<String> getCacheNames()

Implements org.springframework.cache.CacheManager.getCacheNames.

Doc from org.springframework.cache.CacheManager.getCacheNames.

Get a collection of the cache names known by this manager.

Returns:Collection<String>

the names of all caches known by the cache manager

Annotations

@Override

isAllowNullValues	back to summary
public boolean isAllowNullValues() Return whether this cache manager accepts and converts `null` values for all of its caches.

refreshCommonCaches	back to summary
private void refreshCommonCaches() Recreate the common caches with the current state of this manager.

registerCustomCache back to summary

registerCustomCache	back to summary
public void registerCustomCache(String name, Cache<Object, Object> cache) Register the given native Caffeine Cache instance with this cache manager, adapting it to Spring's cache API for exposure through `getCache`. Any number of such custom caches may be registered side by side. This allows for custom settings per cache (as opposed to all caches sharing the common settings in the cache manager's configuration) and is typically used with the Caffeine builder API: `registerCustomCache("myCache", Caffeine.newBuilder().maximumSize(10).build())` Note that any other caches, whether statically specified through `setCacheNames` or dynamically built on demand, still operate with the common settings in the cache manager's configuration. Parameters name:String the name of the cache cache:Cache<Object, Object> the custom Caffeine Cache instance to register Since 5.2.8 See Also `adaptCaffeineCache(String, com.github.benmanes.caffeine.cache.Cache)`

public void registerCustomCache(String name, Cache<Object, Object> cache)

Register the given native Caffeine Cache instance with this cache manager, adapting it to Spring's cache API for exposure through getCache. Any number of such custom caches may be registered side by side.

This allows for custom settings per cache (as opposed to all caches sharing the common settings in the cache manager's configuration) and is typically used with the Caffeine builder API: registerCustomCache("myCache", Caffeine.newBuilder().maximumSize(10).build())

Note that any other caches, whether statically specified through setCacheNames or dynamically built on demand, still operate with the common settings in the cache manager's configuration.

Parameters

name:String: the name of the cache
cache:Cache<Object, Object>: the custom Caffeine Cache instance to register

Since

5.2.8

registerCustomCache back to summary

registerCustomCache	back to summary
public void registerCustomCache(String name, AsyncCache<Object, Object> cache) Register the given Caffeine AsyncCache instance with this cache manager, adapting it to Spring's cache API for exposure through `getCache`. Any number of such custom caches may be registered side by side. This allows for custom settings per cache (as opposed to all caches sharing the common settings in the cache manager's configuration) and is typically used with the Caffeine builder API: `registerCustomCache("myCache", Caffeine.newBuilder().maximumSize(10).buildAsync())` Note that any other caches, whether statically specified through `setCacheNames` or dynamically built on demand, still operate with the common settings in the cache manager's configuration. Parameters name:String the name of the cache cache:AsyncCache<Object, Object> the custom Caffeine AsyncCache instance to register Since 6.1 See Also `adaptCaffeineCache(String, AsyncCache)`

public void registerCustomCache(String name, AsyncCache<Object, Object> cache)

Register the given Caffeine AsyncCache instance with this cache manager, adapting it to Spring's cache API for exposure through getCache. Any number of such custom caches may be registered side by side.

Note that any other caches, whether statically specified through setCacheNames or dynamically built on demand, still operate with the common settings in the cache manager's configuration.

Parameters

name:String: the name of the cache
cache:AsyncCache<Object, Object>: the custom Caffeine AsyncCache instance to register

Since

6.1

setAllowNullValues back to summary

setAllowNullValues	back to summary
public void setAllowNullValues(boolean allowNullValues) Specify whether to accept and convert `null` values for all caches in this cache manager. Default is "true", despite Caffeine itself not supporting `null` values. An internal holder object will be used to store user-level `null`s.

public void setAllowNullValues(boolean allowNullValues)

Specify whether to accept and convert null values for all caches in this cache manager.

Default is "true", despite Caffeine itself not supporting null values. An internal holder object will be used to store user-level nulls.

setAsyncCacheLoader back to summary

setAsyncCacheLoader	back to summary
public void setAsyncCacheLoader(AsyncCacheLoader<Object, Object> cacheLoader) Set the Caffeine AsyncCacheLoader to use for building each individual `CaffeineCache` instance, turning it into a LoadingCache. This implicitly switches the `"asyncCacheMode"` flag to `true`. Since 6.1 See Also `createAsyncCaffeineCache`, `Caffeine#buildAsync(AsyncCacheLoader)`, `com.github.benmanes.caffeine.cache.LoadingCache`

public void setAsyncCacheLoader(AsyncCacheLoader<Object, Object> cacheLoader)

Set the Caffeine AsyncCacheLoader to use for building each individual CaffeineCache instance, turning it into a LoadingCache.

This implicitly switches the "asyncCacheMode" flag to true.

Since: 6.1
See Also: createAsyncCaffeineCache, Caffeine#buildAsync(AsyncCacheLoader), com.github.benmanes.caffeine.cache.LoadingCache

setAsyncCacheMode back to summary

setAsyncCacheMode	back to summary
public void setAsyncCacheMode(boolean asyncCacheMode) Set the common cache type that this cache manager builds to async. This applies to `setCacheNames` as well as on-demand caches. Individual cache registrations (such as `registerCustomCache(String, AsyncCache)` and `registerCustomCache(String, com.github.benmanes.caffeine.cache.Cache)`) are not dependent on this setting. By default, this cache manager builds regular native Caffeine caches. To switch to async caches which can also be used through the synchronous API but come with support for `Cache#retrieve`, set this flag to `true`. Note that while null values in the cache are tolerated in async cache mode, the recommendation is to disallow null values through `setAllowNullValues(false)`. This makes the semantics of CompletableFuture-based access simpler and optimizes retrieval performance since a Caffeine-provided CompletableFuture handle does not have to get wrapped. If you come here for the adaptation of reactive types such as a Reactor `Mono` or `Flux` onto asynchronous caching, we recommend the standard arrangement for caching the produced values asynchronously in 6.1 through enabling this Caffeine mode. If this is not immediately possible/desirable for existing apps, you may set the system property "spring.cache.reactivestreams.ignore=true" to restore 6.0 behavior where reactive handles are treated as regular values. Since 6.1 See Also `Caffeine#buildAsync()`, `Cache#retrieve(Object)`, `Cache#retrieve(Object, Supplier)`, `org.springframework.cache.interceptor.CacheAspectSupport#IGNORE_REACTIVESTREAMS_PROPERTY_NAME`

public void setAsyncCacheMode(boolean asyncCacheMode)

Set the common cache type that this cache manager builds to async. This applies to setCacheNames as well as on-demand caches.

Individual cache registrations (such as registerCustomCache(String, AsyncCache) and registerCustomCache(String, com.github.benmanes.caffeine.cache.Cache)) are not dependent on this setting.

By default, this cache manager builds regular native Caffeine caches. To switch to async caches which can also be used through the synchronous API but come with support for Cache#retrieve, set this flag to true.

Note that while null values in the cache are tolerated in async cache mode, the recommendation is to disallow null values through setAllowNullValues(false). This makes the semantics of CompletableFuture-based access simpler and optimizes retrieval performance since a Caffeine-provided CompletableFuture handle does not have to get wrapped.

If you come here for the adaptation of reactive types such as a Reactor Mono or Flux onto asynchronous caching, we recommend the standard arrangement for caching the produced values asynchronously in 6.1 through enabling this Caffeine mode. If this is not immediately possible/desirable for existing apps, you may set the system property "spring.cache.reactivestreams.ignore=true" to restore 6.0 behavior where reactive handles are treated as regular values.

Since: 6.1
See Also: Caffeine#buildAsync(), Cache#retrieve(Object), Cache#retrieve(Object, Supplier), org.springframework.cache.interceptor.CacheAspectSupport#IGNORE_REACTIVESTREAMS_PROPERTY_NAME

setCacheLoader back to summary

setCacheLoader	back to summary
public void setCacheLoader(CacheLoader<Object, Object> cacheLoader) Set the Caffeine CacheLoader to use for building each individual `CaffeineCache` instance, turning it into a LoadingCache. See Also `createNativeCaffeineCache`, `Caffeine#build(CacheLoader)`, `com.github.benmanes.caffeine.cache.LoadingCache`

public void setCacheLoader(CacheLoader<Object, Object> cacheLoader)

Set the Caffeine CacheLoader to use for building each individual CaffeineCache instance, turning it into a LoadingCache.

See Also: createNativeCaffeineCache, Caffeine#build(CacheLoader), com.github.benmanes.caffeine.cache.LoadingCache

setCacheNames back to summary

setCacheNames	back to summary
public void setCacheNames(Collection<String> cacheNames) Specify the set of cache names for this CacheManager's 'static' mode. The number of caches and their names will be fixed after a call to this method, with no creation of further cache regions at runtime. Calling this with a `null` collection argument resets the mode to 'dynamic', allowing for further creation of caches again.

public void setCacheNames(Collection<String> cacheNames)

Specify the set of cache names for this CacheManager's 'static' mode.

The number of caches and their names will be fixed after a call to this method, with no creation of further cache regions at runtime.

Calling this with a null collection argument resets the mode to 'dynamic', allowing for further creation of caches again.

setCacheSpecification back to summary

setCacheSpecification	back to summary
public void setCacheSpecification(String cacheSpecification) Set the Caffeine cache specification String to use for building each individual `CaffeineCache` instance. The given value needs to comply with Caffeine's `CaffeineSpec` (see its javadoc). See Also `createNativeCaffeineCache`, `Caffeine#from(String)`

public void setCacheSpecification(String cacheSpecification)

Set the Caffeine cache specification String to use for building each individual CaffeineCache instance. The given value needs to comply with Caffeine's CaffeineSpec (see its javadoc).

See Also: createNativeCaffeineCache, Caffeine#from(String)

setCaffeine back to summary

setCaffeine	back to summary
public void setCaffeine(Caffeine<Object, Object> caffeine) Set the Caffeine to use for building each individual `CaffeineCache` instance. See Also `createNativeCaffeineCache`, `Caffeine#build()`

public void setCaffeine(Caffeine<Object, Object> caffeine)

Set the Caffeine to use for building each individual CaffeineCache instance.

See Also: createNativeCaffeineCache, Caffeine#build()

setCaffeineSpec back to summary

setCaffeineSpec	back to summary
public void setCaffeineSpec(CaffeineSpec caffeineSpec) Set the `CaffeineSpec` to use for building each individual `CaffeineCache` instance. See Also `createNativeCaffeineCache`, `Caffeine#from(CaffeineSpec)`

public void setCaffeineSpec(CaffeineSpec caffeineSpec)

Set the CaffeineSpec to use for building each individual CaffeineCache instance.

See Also: createNativeCaffeineCache, Caffeine#from(CaffeineSpec)

public Class CaffeineCacheManager

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail