io.ebeaninternal.server.cache.SpiCacheManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean Show documentation

composite of common runtime dependencies for all platforms

There is a newer version: 15.8.1

package io.ebeaninternal.server.cache;

import io.ebean.cache.ServerCache;

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

  /**
   * 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 isLocalL2Caching();

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

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

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

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

  /**
   * Clear the caches for the given bean type.
   */
  void clear(Class beanType);

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

  /**
   * Clear all local caches.
   */
  void clearAllLocal();

  /**
   * Clear local caches for the given bean type.
   */
  void clearLocal(Class beanType);

}