/*
 * Copyright 2002-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.cache.interceptor;

import org.springframework.cache.Cache;
import org.springframework.lang.Nullable;
import org.springframework.util.function.SingletonSupplier;

A base component for invoking Cache operations and using a configurable CacheErrorHandler when an exception occurs.
Author:Stephane Nicoll, Juergen Hoeller
See Also:
Since:4.1
/** * A base component for invoking {@link Cache} operations and using a * configurable {@link CacheErrorHandler} when an exception occurs. * * @author Stephane Nicoll * @author Juergen Hoeller * @since 4.1 * @see org.springframework.cache.interceptor.CacheErrorHandler */
public abstract class AbstractCacheInvoker { protected SingletonSupplier<CacheErrorHandler> errorHandler; protected AbstractCacheInvoker() { this.errorHandler = SingletonSupplier.of(SimpleCacheErrorHandler::new); } protected AbstractCacheInvoker(CacheErrorHandler errorHandler) { this.errorHandler = SingletonSupplier.of(errorHandler); }
Set the CacheErrorHandler instance to use to handle errors thrown by the cache provider. By default, a SimpleCacheErrorHandler is used who throws any exception as is.
/** * Set the {@link CacheErrorHandler} instance to use to handle errors * thrown by the cache provider. By default, a {@link SimpleCacheErrorHandler} * is used who throws any exception as is. */
public void setErrorHandler(CacheErrorHandler errorHandler) { this.errorHandler = SingletonSupplier.of(errorHandler); }
Return the CacheErrorHandler to use.
/** * Return the {@link CacheErrorHandler} to use. */
public CacheErrorHandler getErrorHandler() { return this.errorHandler.obtain(); }
Execute Cache.get(Object) on the specified Cache and invoke the error handler if an exception occurs. Return null if the handler does not throw any exception, which simulates a cache miss in case of error.
See Also:
/** * Execute {@link Cache#get(Object)} on the specified {@link Cache} and * invoke the error handler if an exception occurs. Return {@code null} * if the handler does not throw any exception, which simulates a cache * miss in case of error. * @see Cache#get(Object) */
@Nullable protected Cache.ValueWrapper doGet(Cache cache, Object key) { try { return cache.get(key); } catch (RuntimeException ex) { getErrorHandler().handleCacheGetError(ex, cache, key); return null; // If the exception is handled, return a cache miss } }
Execute Cache.put(Object, Object) on the specified Cache and invoke the error handler if an exception occurs.
/** * Execute {@link Cache#put(Object, Object)} on the specified {@link Cache} * and invoke the error handler if an exception occurs. */
protected void doPut(Cache cache, Object key, @Nullable Object result) { try { cache.put(key, result); } catch (RuntimeException ex) { getErrorHandler().handleCachePutError(ex, cache, key, result); } }
Execute Cache.evict(Object) on the specified Cache and invoke the error handler if an exception occurs.
/** * Execute {@link Cache#evict(Object)} on the specified {@link Cache} and * invoke the error handler if an exception occurs. */
protected void doEvict(Cache cache, Object key) { try { cache.evict(key); } catch (RuntimeException ex) { getErrorHandler().handleCacheEvictError(ex, cache, key); } }
Execute Cache.clear() on the specified Cache and invoke the error handler if an exception occurs.
/** * Execute {@link Cache#clear()} on the specified {@link Cache} and * invoke the error handler if an exception occurs. */
protected void doClear(Cache cache) { try { cache.clear(); } catch (RuntimeException ex) { getErrorHandler().handleCacheClearError(ex, cache); } } }