Open Source Repository

Home /hibernate/hibernate-3.2.7.ga | Repository Home


org/hibernate/cache/CacheProvider.java
//$Id: CacheProvider.java 5685 2005-02-12 07:19:50Z steveebersole $
package org.hibernate.cache;

import java.util.Properties;

/**
 * Support for pluggable caches.
 *
 @author Gavin King
 */
public interface CacheProvider {

  /**
   * Configure the cache
   *
   @param regionName the name of the cache region
   @param properties configuration settings
   @throws CacheException
   */
  public Cache buildCache(String regionName, Properties propertiesthrows CacheException;

  /**
   * Generate a timestamp
   */
  public long nextTimestamp();

  /**
   * Callback to perform any necessary initialization of the underlying cache implementation
   * during SessionFactory construction.
   *
   @param properties current configuration settings.
   */
  public void start(Properties propertiesthrows CacheException;

  /**
   * Callback to perform any necessary cleanup of the underlying cache implementation
   * during SessionFactory.close().
   */
  public void stop();
  
  public boolean isMinimalPutsEnabledByDefault();

}