net.sf.ehcache.management.service.EntityResourceFactoryV2 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of management-ehcache-v2 Show documentation
A library defining the ehcache management resource services and resource entities, version 2
The newest version!
package net.sf.ehcache.management.service;

import net.sf.ehcache.management.resource.CacheConfigEntityV2;
import net.sf.ehcache.management.resource.CacheEntityV2;
import net.sf.ehcache.management.resource.CacheManagerConfigEntityV2;
import net.sf.ehcache.management.resource.CacheManagerEntityV2;
import net.sf.ehcache.management.resource.CacheStatisticSampleEntityV2;

import org.terracotta.management.ServiceExecutionException;
import org.terracotta.management.resource.ResponseEntityV2;

import java.util.Collection;
import java.util.Set;

/**
 * A factory interface for resources related to Ehcache.
 *
 * @author brandony
 */
public interface EntityResourceFactoryV2 {

  /**
   * A factory method for {@link CacheManagerEntityV2} objects.
   *
   * @param cacheManagerNames a {@code Set} of names for the CacheManager objects to be represented by the
   *                          returned resources
   * @param attributes        a {@code Set} of specific cache manager attributes to include in the returned representations;
   *                          if null, all attributes will be included
   * @return a {@code ResponseEntityV2} containing {@code CacheManagerEntity} objects
   */
  ResponseEntityV2 createCacheManagerEntities(Set cacheManagerNames,
                                                            Set attributes) throws ServiceExecutionException;

  /**
   * A factory method for {@link CacheManagerConfigEntityV2} objects.
   *
   * @param cacheManagerNames a {@code Set} of names for the CacheManager configurations to be represented by the
   *                          returned resources
   * @return a {@code ResponseEntityV2} containing {@code CacheManagerConfigEntity} objects
   */
  ResponseEntityV2 createCacheManagerConfigEntities(Set cacheManagerNames) throws ServiceExecutionException;

  /**
   * A factory method for {@link CacheEntityV2} objects.
   *
   * @param cacheManagerNames a {@code Set} of names for the CacheManagers that manage the Cache
   *                          objects to be represented by the returned resources
   * @param cacheNames        a {@code Set} of names for the Cache objects to be represented by the
   *                          returned resources
   * @param attributes        a {@code Set} of specific cache manager attributes to include in the returned representations;
   *                          if null, all attributes will be included
   * @return a {@code ResponseEntityV2} containing {@code CacheEntity} objects
   */
  ResponseEntityV2 createCacheEntities(Set cacheManagerNames,
                                              Set cacheNames,
                                              Set attributes) throws ServiceExecutionException;

  /**
   * A factory method for {@link CacheConfigEntityV2} objects.
   *
   * @param cacheManagerNames a {@code Set} of names for the CacheManagers that manage the Cache
   *                          objects to be represented by the returned resources
   * @param cacheNames        a {@code Set} of names for the Cache objects to be represented by the
   *                          returned resources
   * @return a {@code ResponseEntityV2} containing {@code CacheConfigEntity} objects
   */
  ResponseEntityV2 createCacheConfigEntities(Set cacheManagerNames,
                                                          Set cacheNames) throws ServiceExecutionException;

  /**
   * A factory method for {@link CacheStatisticSampleEntityV2} objects.
   *
   * @param cacheManagerNames a {@code Set} of names for the CacheManagers that manage the Caches whose
   *                          sampled statistics are to be represented by the returned resources
   * @param cacheNames        a {@code Set} of names for the Caches whose sampled statistics are to be represented
   *                          by the returned resources
   * @param statNames         a {@code Set} of names for the sampled statistics to be represented by the returned resources
   * @return a {@code ResponseEntityV2} containing {@code CacheStatisticSampleEntity} objects
   */
  ResponseEntityV2 createCacheStatisticSampleEntity(Set cacheManagerNames,
                                                                          Set cacheNames,
                                                                          Set statNames) throws ServiceExecutionException;
}