org.ehcache.spi.resilience.ResilienceStrategyProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache-api Show documentation
The API module of Ehcache 3
There is a newer version: 3.10.8
/*
 * 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.
 * 
 * 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 {@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  the stores key type
   * @param  the stores value type
   * @return the {@code ResilienceStrategy} to be used by the {@code Cache}
   */
   ResilienceStrategy createResilienceStrategy(String alias, CacheConfiguration configuration,
                                                           RecoveryStore recoveryStore);

  /**
   * 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  the stores key type
   * @param  the stores value type
   * @return the {@code ResilienceStrategy} to be used by the {@code Cache}
   */
   ResilienceStrategy createResilienceStrategy(String alias, CacheConfiguration configuration,
                                                           RecoveryStore recoveryStore, CacheLoaderWriter loaderWriter);
}