io.ebean.cache.ServerCacheManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebean-api Show documentation
ebean api
There is a newer version: 15.8.0
package io.ebean.cache;

import io.ebean.meta.MetricVisitor;

import java.util.List;

/**
 * The cache service for server side caching of beans and query results.
 */
public interface ServerCacheManager {

  /**
   * Visit the metrics for all the server caches.
   */
  void visitMetrics(MetricVisitor visitor);

  /**
   * Return true if the L2 caching is local.
   * 
   * Local L2 caching means that the cache updates should occur in foreground
   * rather than background processing.
   * 
   */
  boolean localL2Caching();

  /**
   * Return all the cache regions.
   */
  List allRegions();

  /**
   * Set the regions that are enabled.
   * 
   * Typically this is set on startup and at runtime (via dynamic configuration).
   * 
   *
   * @param regions A region name or comma delimited list of region names.
   */
  void enabledRegions(String regions);

  /**
   * Enable or disable all the cache regions.
   */
  void allRegionsEnabled(boolean enabled);

  /**
   * Return the cache region by name. Typically, to enable or disable the region.
   */
  ServerCacheRegion region(String name);

  /**
   * Return the cache for mapping natural keys to id values.
   */
  ServerCache naturalKeyCache(Class beanType);

  /**
   * Return the cache for beans of a particular type.
   */
  ServerCache beanCache(Class beanType);

  /**
   * Return the cache for associated many properties of a bean type.
   */
  ServerCache collectionIdsCache(Class beanType, String propertyName);

  /**
   * Return the cache for query results of a particular type of bean.
   */
  ServerCache queryCache(Class beanType);

  /**
   * This clears both the bean and query cache for a given type.
   */
  void clear(Class beanType);

  /**
   * Clear all the caches.
   */
  void clearAll();

  /**
   * Clear all the local caches.
   * 
   * This is used when the L2 Cache is based on clustered near-caches (Like Ebean-K8s-L2Cache).
   * It is not used when the L2 cache is a distributed cache such as HazelCast or Ignite etc.
   */
  void clearAllLocal();

  /**
   * Clear the local caches for this bean type.
   * 
   * This is used when the L2 Cache is based on clustered near-caches (Like Ebean-K8s-L2Cache).
   * It is not used when the L2 cache is a distributed cache such as HazelCast or Ignite etc.
   */
  void clearLocal(Class beanType);
}