Class JCacheCacheManager

java.lang.Object
org.springframework.cache.support.AbstractCacheManager
org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager
org.springframework.cache.jcache.JCacheCacheManager
All Implemented Interfaces:
InitializingBean, CacheManager
public class JCacheCacheManager extends AbstractTransactionSupportingCacheManager
CacheManager implementation backed by a JCache javax.cache.CacheManager.
Since:
3.2
Author:
Juergen Hoeller, Stephane Nicoll
See Also:

  • Constructor Details

    • JCacheCacheManager

      public JCacheCacheManager()
      Create a new JCacheCacheManager without a backing JCache javax.cache.CacheManager.

      The backing JCache javax.cache.CacheManager can be set via the setCacheManager(CacheManager) bean property.

    • JCacheCacheManager

      public JCacheCacheManager(javax.cache.CacheManager cacheManager)
      Create a new JCacheCacheManager for the given backing JCache javax.cache.CacheManager.
      Parameters:
      cacheManager - the backing JCache javax.cache.CacheManager

  • Method Details

    • setCacheManager

      public void setCacheManager(@Nullable javax.cache.CacheManager cacheManager)
      Set the backing JCache javax.cache.CacheManager.

    • getCacheManager

      public @Nullable javax.cache.CacheManager getCacheManager()
      Return the backing JCache javax.cache.CacheManager.

    • setAllowNullValues

      public void setAllowNullValues(boolean allowNullValues)
      Specify whether to accept and convert null values for all caches in this cache manager.

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

    • isAllowNullValues

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

    • afterPropertiesSet

      public void afterPropertiesSet()
      Description copied from interface: InitializingBean
      Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

      This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

      Specified by:
      afterPropertiesSet in interface InitializingBean
      Overrides:
      afterPropertiesSet in class AbstractCacheManager

    • loadCaches

      protected Collection<Cache> loadCaches()
      Description copied from class: AbstractCacheManager
      Load the initial caches for this cache manager.

      Called by AbstractCacheManager.afterPropertiesSet() on startup. The returned collection may be empty but must not be null.

      Specified by:
      loadCaches in class AbstractCacheManager

    • getMissingCache

      protected @Nullable Cache getMissingCache(String name)
      Description copied from class: AbstractCacheManager
      Return a missing cache with the specified name, or null if such a cache does not exist or could not be created on demand.

      Caches may be lazily created at runtime if the native provider supports it. If a lookup by name does not yield any result, an AbstractCacheManager subclass gets a chance to register such a cache at runtime. The returned cache will be automatically added to this cache manager.

      Overrides:
      getMissingCache in class AbstractCacheManager
      Parameters:
      name - the name of the cache to retrieve
      Returns:
      the missing cache, or null if no such cache exists or could be created on demand
      See Also:

    • resetCaches

      public void resetCaches()
      Description copied from interface: CacheManager
      Remove all registered caches from this cache manager if possible, re-creating them on demand. After this call, CacheManager.getCacheNames() will possibly be empty and the cache provider will have dropped all cache management state.

      Alternatively, an implementation may perform an equivalent reset on fixed existing cache regions without actually dropping the cache. This behavior will be indicated by CacheManager.getCacheNames() still exposing a non-empty set of names, whereas the corresponding cache regions will not contain cache entries anymore.

      The default implementation calls Cache.clear() on all registered caches, retaining all caches as registered, satisfying the alternative implementation path above. Custom implementations may either drop the actual caches (re-creating them on demand) or perform a more exhaustive reset at the actual cache provider level.

      Specified by:
      resetCaches in interface CacheManager
      Overrides:
      resetCaches in class AbstractCacheManager
      See Also: