Top Description Fields Constructors Methods
net.sf.ehcache.hibernate

public final Class SingletonEhCacheProvider

extends AbstractEhcacheProvider
Class Inheritance
Annotations
@Deprecated
Imports
java.net.MalformedURLException, .URL, java.util.Properties, net.sf.ehcache.CacheManager, net.sf.ehcache.config.Configuration, .ConfigurationFactory, net.sf.ehcache.hibernate.management.impl.ProviderMBeanRegistrationHelper, org.hibernate.cache.CacheException, org.slf4j.Logger, .LoggerFactory

Deprecated

Singleton cache Provider plugin for Hibernate 3.2 and ehcache-1.2. New in this provider is support for non Serializable keys and values. This provider works as a Singleton. No matter how many Hibernate Configurations you have, only one ehcache CacheManager is used. See EhCacheProvider for a non-singleton implementation.

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.SingletonEhCacheProvider in the Hibernate configuration to enable this provider for Hibernate's second level cache.

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.org for documentation on ehcache

Authors
Greg Luck, Emmanuel Bernard
Version
$Id: SingletonEhCacheProvider.java 10789 2018-04-26 02:08:13Z adahanne $

Field Summary

Modifier and TypeField and Description
private static final Logger
LOG

Hides net.sf.ehcache.hibernate.AbstractEhcacheProvider.LOG.

private final ProviderMBeanRegistrationHelper
mbeanRegistrationHelper

public static final String
NET_SF_EHCACHE_CONFIGURATION_RESOURCE_NAME

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

private static int
referenceCount

To be backwardly compatible with a lot of Hibernate code out there, allow multiple starts and stops on the one singleton CacheManager.

Inherited from net.sf.ehcache.hibernate.AbstractEhcacheProvider:
manager

Constructor Summary

AccessConstructor and Description
public
SingletonEhCacheProvider()

Method Summary

Modifier and TypeMethod and Description
public final void
start(Properties
current configuration settings.
properties)

Implements org.hibernate.cache.CacheProvider.start.

Callback to perform any necessary initialization of the underlying cache implementation during SessionFactory construction.
public void
stop()

Implements org.hibernate.cache.CacheProvider.stop.

Callback to perform any necessary cleanup of the underlying cache implementation during SessionFactory.close().
Inherited from net.sf.ehcache.hibernate.AbstractEhcacheProvider:
buildCacheisMinimalPutsEnabledByDefaultloadResourcenextTimestamp

Field Detail

LOGback to summary
private static final Logger LOG

Hides net.sf.ehcache.hibernate.AbstractEhcacheProvider.LOG.

mbeanRegistrationHelperback to summary
private final ProviderMBeanRegistrationHelper mbeanRegistrationHelper
NET_SF_EHCACHE_CONFIGURATION_RESOURCE_NAMEback to summary
public static final String NET_SF_EHCACHE_CONFIGURATION_RESOURCE_NAME

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

If not set, ehcache.xml will be looked for in the root of the classpath.

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

referenceCountback to summary
private static int referenceCount

To be backwardly compatible with a lot of Hibernate code out there, allow multiple starts and stops on the one singleton CacheManager. Keep a count of references to only stop on when only one reference is held.

Constructor Detail

SingletonEhCacheProviderback to summary
public SingletonEhCacheProvider()

Method Detail

startback to summary
public final void start(Properties properties) throws CacheException

Implements org.hibernate.cache.CacheProvider.start.

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

Parameters
properties:Properties

current configuration settings.

stopback to summary
public void stop()

Implements org.hibernate.cache.CacheProvider.stop.

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