org.springframework.cache.interceptor

Interface CacheErrorHandler

  • All Known Implementing Classes:
    SimpleCacheErrorHandler


    public interface CacheErrorHandler
    A strategy for handling cache-related errors. In most cases, any exception thrown by the provider should simply be thrown back at the client but, in some circumstances, the infrastructure may need to handle cache-provider exceptions in a different way.

    Typically, failing to retrieve an object from the cache with a given id can be transparently managed as a cache miss by not throwing back such exception.

    Since:
    4.1
    Author:
    Stephane Nicoll
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void handleCacheClearError(java.lang.RuntimeException exception, Cache cache)
      Handle the given runtime exception thrown by the cache provider when clearing the specified Cache, possibly rethrowing it as a fatal exception.
      void handleCacheEvictError(java.lang.RuntimeException exception, Cache cache, java.lang.Object key)
      Handle the given runtime exception thrown by the cache provider when clearing an item with the specified key, possibly rethrowing it as a fatal exception.
      void handleCacheGetError(java.lang.RuntimeException exception, Cache cache, java.lang.Object key)
      Handle the given runtime exception thrown by the cache provider when retrieving an item with the specified key, possibly rethrowing it as a fatal exception.
      void handleCachePutError(java.lang.RuntimeException exception, Cache cache, java.lang.Object key, java.lang.Object value)
      Handle the given runtime exception thrown by the cache provider when updating an item with the specified key and value, possibly rethrowing it as a fatal exception.
    • Method Detail

      • handleCacheGetError

        void handleCacheGetError(java.lang.RuntimeException exception,
                                 Cache cache,
                                 java.lang.Object key)
        Handle the given runtime exception thrown by the cache provider when retrieving an item with the specified key, possibly rethrowing it as a fatal exception.
        Parameters:
        exception - the exception thrown by the cache provider
        cache - the cache
        key - the key used to get the item
        See Also:
        Cache.get(Object)
      • handleCachePutError

        void handleCachePutError(java.lang.RuntimeException exception,
                                 Cache cache,
                                 java.lang.Object key,
                                 @Nullable
                                 java.lang.Object value)
        Handle the given runtime exception thrown by the cache provider when updating an item with the specified key and value, possibly rethrowing it as a fatal exception.
        Parameters:
        exception - the exception thrown by the cache provider
        cache - the cache
        key - the key used to update the item
        value - the value to associate with the key
        See Also:
        Cache.put(Object, Object)
      • handleCacheEvictError

        void handleCacheEvictError(java.lang.RuntimeException exception,
                                   Cache cache,
                                   java.lang.Object key)
        Handle the given runtime exception thrown by the cache provider when clearing an item with the specified key, possibly rethrowing it as a fatal exception.
        Parameters:
        exception - the exception thrown by the cache provider
        cache - the cache
        key - the key used to clear the item
      • handleCacheClearError

        void handleCacheClearError(java.lang.RuntimeException exception,
                                   Cache cache)
        Handle the given runtime exception thrown by the cache provider when clearing the specified Cache, possibly rethrowing it as a fatal exception.
        Parameters:
        exception - the exception thrown by the cache provider
        cache - the cache to clear