com.tangosol.coherence.hibernate
Class CoherenceCacheProvider

java.lang.Object
  com.tangosol.util.Base
      com.tangosol.coherence.hibernate.CoherenceCacheProvider

All Implemented Interfaces:

org.hibernate.cache.CacheProvider

public class CoherenceCacheProvider
extends Base
implements org.hibernate.cache.CacheProvider

Serves as the integration point for the Coherence Cache Provider for Hibernate.

Author:

jp, jh 2005.08.31

Field Summary

static String	CACHE_CONFIG_PATH The system property specifying the path to the cache configuration used to configure the hibernate L2 caches.
protected static String	DEFAULT_CACHE_CONFIG_PATH The cache configuration file that defines Coherence caches for Hibernate
protected static String	PREFIX The prefix for all provider-specific system properties

Constructor Summary

CoherenceCacheProvider()

Method Summary

org.hibernate.cache.Cache	buildCache(String sRegionName, Properties properties) Returns a Hibernate cache region (creating a clustered NamedCache instance if necessary).
protected ConfigurableCacheFactory	getCacheFactory() Get the ConfigurableCacheFactory instance
protected NamedCache	getNamedCache(String sName) Get a NamedCache instance given a cache name.
boolean	isMinimalPutsEnabledByDefault() Indicates whether minimal puts are enabled by default.
long	nextTimestamp() Returns the current timestamp.
protected void	setCacheFactory(ConfigurableCacheFactory factory) Set the ConfigurableCacheFactory instance
void	start(Properties properties) Initializes the Coherence cache provider and pre-starts Coherence.
void	stop() Stops the Coherence cache provider and frees local resources.

Field Detail

PREFIX

protected static final String PREFIX

The prefix for all provider-specific system properties

See Also:

Constant Field Values

CACHE_CONFIG_PATH

public static final String CACHE_CONFIG_PATH

The system property specifying the path to the cache configuration used to configure the hibernate L2 caches. Uses the default cache configuration file unless specified otherwise.

See Also:

Constant Field Values

DEFAULT_CACHE_CONFIG_PATH

protected static final String DEFAULT_CACHE_CONFIG_PATH

The cache configuration file that defines Coherence caches for Hibernate

See Also:

Constant Field Values

Constructor Detail

CoherenceCacheProvider

public CoherenceCacheProvider()

Method Detail

buildCache

public org.hibernate.cache.Cache buildCache(String sRegionName,
                                            Properties properties)

Returns a Hibernate cache region (creating a clustered NamedCache instance if necessary).

Specified by:

buildCache in interface org.hibernate.cache.CacheProvider

Parameters:

sRegionName - a Hibernate cache region name

properties - not used by this implementation

Returns:

a Hibernate cache region reference

nextTimestamp

public long nextTimestamp()

Returns the current timestamp.

Specified by:

nextTimestamp in interface org.hibernate.cache.CacheProvider

Returns:

the current timestamp

start

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

Initializes the Coherence cache provider and pre-starts Coherence.

Specified by:

start in interface org.hibernate.cache.CacheProvider

Parameters:

properties - configuration properties

Throws:

org.hibernate.cache.CacheException - thrown if there are configuration errors

stop

public void stop()

Stops the Coherence cache provider and frees local resources.

Specified by:

stop in interface org.hibernate.cache.CacheProvider

isMinimalPutsEnabledByDefault

public boolean isMinimalPutsEnabledByDefault()

Indicates whether minimal puts are enabled by default. This allows Hibernate to use extra gets to minimize the number of puts.

Specified by:

isMinimalPutsEnabledByDefault in interface org.hibernate.cache.CacheProvider

Returns:

a boolean indicating whether minimal puts are the default

getCacheFactory

protected ConfigurableCacheFactory getCacheFactory()

Get the ConfigurableCacheFactory instance

Returns:

the ConfigurableCacheFactory

setCacheFactory

protected void setCacheFactory(ConfigurableCacheFactory factory)

Set the ConfigurableCacheFactory instance

Parameters:

factory - the ConfigurableCacheFactory instance

getNamedCache

protected NamedCache getNamedCache(String sName)

Get a NamedCache instance given a cache name.

Parameters:

sName - the name of the NamedCache

Returns:

the NamedCache instance