/*
 * Copyright Terracotta, Inc.
 *
 * 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.ehcache.spi.resilience;

import org.ehcache.config.CacheConfiguration;
import org.ehcache.spi.loaderwriter.CacheLoaderWriter;
import org.ehcache.spi.service.Service;
import org.ehcache.spi.service.ServiceConfiguration;

/**
 * A {@link Service} that creates {@link ResilienceStrategy} instances.
 * <p>
 * A {@code CacheManager} will use the {@link #createResilienceStrategy(String, CacheConfiguration, RecoveryStore)} and
 * {@link #createResilienceStrategy(String, CacheConfiguration, RecoveryStore, CacheLoaderWriter)} methods to create
 * {@code ResilienceStrategy} instances for each {@code Cache} it manages.
 */
public interface ResilienceStrategyProvider extends Service {

  
Creates a ResilienceStrategy for the Cache with the given alias and configuration using the given RecoveryStore.
Params:
  • alias – the Cache alias in the CacheManager
  • configuration – the configuration for the associated cache
  • recoveryStore – the associated recovery store
Type parameters:
  • <K> – the stores key type
  • <V> – the stores value type
Returns:the ResilienceStrategy to be used by the Cache
/** * Creates a {@code ResilienceStrategy} for the {@link org.ehcache.Cache Cache} with the given alias and configuration * using the given {@link RecoveryStore}. * * @param alias the {@code Cache} alias in the {@code CacheManager} * @param configuration the configuration for the associated cache * @param recoveryStore the associated recovery store * @param <K> the stores key type * @param <V> the stores value type * @return the {@code ResilienceStrategy} to be used by the {@code Cache} */
<K, V> ResilienceStrategy<K, V> createResilienceStrategy(String alias, CacheConfiguration<K, V> configuration, RecoveryStore<K> recoveryStore);
Creates a ResilienceStrategy for the Cache with the given alias and configuration using the given RecoveryStore and CacheLoaderWriter
Params:
  • alias – the Cache alias in the CacheManager
  • configuration – the configuration for the associated cache
  • recoveryStore – the associated recovery store
  • loaderWriter – the associated loader-writer
Type parameters:
  • <K> – the stores key type
  • <V> – the stores value type
Returns:the ResilienceStrategy to be used by the Cache
/** * Creates a {@code ResilienceStrategy} for the {@link org.ehcache.Cache Cache} with the given alias and configuration * using the given {@link RecoveryStore} and {@link CacheLoaderWriter} * * @param alias the {@code Cache} alias in the {@code CacheManager} * @param configuration the configuration for the associated cache * @param recoveryStore the associated recovery store * @param loaderWriter the associated loader-writer * @param <K> the stores key type * @param <V> the stores value type * @return the {@code ResilienceStrategy} to be used by the {@code Cache} */
<K, V> ResilienceStrategy<K, V> createResilienceStrategy(String alias, CacheConfiguration<K, V> configuration, RecoveryStore<K> recoveryStore, CacheLoaderWriter<? super K, V> loaderWriter); }