net.sf.ehcache.hibernate
Class EhCacheProvider

java.lang.Object
  net.sf.ehcache.hibernate.EhCacheProvider

All Implemented Interfaces:

org.hibernate.cache.CacheProvider

public final class EhCacheProvider
extends java.lang.Object
implements org.hibernate.cache.CacheProvider

Cache Provider plugin for Hibernate 3.2 and ehcache-1.2. New in this provider are ehcache support for multiple Hibernate session factories, each with its own ehcache configuration, and non Serializable keys and values. Ehcache-1.2 also has many other features such as cluster support and listeners, which can be used seamlessly simply by configurion in ehcache.xml.

Use hibernate.cache.provider_class=net.sf.ehcache.hibernate.EhCacheProvider in the Hibernate configuration to enable this provider for Hibernate's second level cache.

When configuring multiple ehcache CacheManagers, as you would where you have multiple Hibernate Configurations and multiple SessionFactories, specify in each Hibernate configuration the ehcache configuration using the property net.sf.ehcache.configurationResourceName An example to set an ehcach configuration called ehcache-2.xml would be net.sf.ehcache.configurationResourceName=/ehcache-2.xml. If the leading slash is not there one will be added. The configuration file will be looked for in the root of the classpath.

Updated for ehcache-1.2. Note this provider requires ehcache-1.2.jar. Make sure ehcache-1.1.jar or earlier is not in the classpath or it will not work.

See http://ehcache.sf.net for documentation on ehcache

Version:

$Id: EhCacheProvider.java 699 2008-07-10 07:32:00Z gregluck $

Author:

Greg Luck, Emmanuel Bernard

Field Summary

static java.lang.String

NET_SF_EHCACHE_CONFIGURATION_RESOURCE_NAME The Hibernate system property specifying the location of the ehcache configuration file name.

Constructor Summary

EhCacheProvider()

Method Summary

org.hibernate.cache.Cache	buildCache(java.lang.String name, java.util.Properties properties) Builds a Cache.
boolean	isMinimalPutsEnabledByDefault() Not sure what this is supposed to do.
long	nextTimestamp() Returns the next timestamp.
void	start(java.util.Properties properties) Callback to perform any necessary initialization of the underlying cache implementation during SessionFactory construction.
void	stop() Callback to perform any necessary cleanup of the underlying cache implementation during SessionFactory.close().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NET_SF_EHCACHE_CONFIGURATION_RESOURCE_NAME

public static final java.lang.String NET_SF_EHCACHE_CONFIGURATION_RESOURCE_NAME

The Hibernate system property specifying the location of the ehcache configuration file name.

If set to say ehcache-1.xml, ehcache-1.xml will be looked for in the root of the classpath.

See Also:

Constant Field Values

Constructor Detail

EhCacheProvider

public EhCacheProvider()

Method Detail

buildCache

public final org.hibernate.cache.Cache buildCache(java.lang.String name,
                                                  java.util.Properties properties)
                                           throws org.hibernate.cache.CacheException

Builds a Cache.

Even though this method provides properties, they are not used. Properties for EHCache are specified in the ehcache.xml file. Configuration will be read from ehcache.xml for a cache declaration where the name attribute matches the name parameter in this builder.

Specified by:

buildCache in interface org.hibernate.cache.CacheProvider

Parameters:

name - the name of the cache. Must match a cache configured in ehcache.xml

properties - not used

Returns:

a newly built cache will be built and initialised

Throws:

org.hibernate.cache.CacheException - inter alia, if a cache of the same name already exists

nextTimestamp

public final long nextTimestamp()

Returns the next timestamp.

Specified by:

nextTimestamp in interface org.hibernate.cache.CacheProvider

start

public final void start(java.util.Properties properties)
                 throws org.hibernate.cache.CacheException

Callback to perform any necessary initialization of the underlying cache implementation during SessionFactory construction.

Specified by:

start in interface org.hibernate.cache.CacheProvider

Parameters:

properties - current configuration settings.

Throws:

org.hibernate.cache.CacheException

stop

public final void stop()

Callback to perform any necessary cleanup of the underlying cache implementation during SessionFactory.close().

Specified by:

stop in interface org.hibernate.cache.CacheProvider

isMinimalPutsEnabledByDefault

public final boolean isMinimalPutsEnabledByDefault()

Not sure what this is supposed to do.

Specified by:

isMinimalPutsEnabledByDefault in interface org.hibernate.cache.CacheProvider

Returns:

false to be safe