org.hibernate.cache.impl

Class NoCachingRegionFactory

Implemented Interfaces:
RegionFactory

public class NoCachingRegionFactory
extends java.lang.Object
implements RegionFactory

Factory used if no caching enabled in config...
Author:
Steve Ebersole

Constructor Summary

NoCachingRegionFactory(Properties properties)

Method Summary

CollectionRegion
buildCollectionRegion(String regionName, Properties properties, CacheDataDescription metadata)
Build a cache region specialized for storing collection data.
EntityRegion
buildEntityRegion(String regionName, Properties properties, CacheDataDescription metadata)
Build a cache region specialized for storing entity data.
QueryResultsRegion
buildQueryResultsRegion(String regionName, Properties properties)
Build a cache region specialized for storing query results
TimestampsRegion
buildTimestampsRegion(String regionName, Properties properties)
Build a cache region specialized for storing update-timestamps data.
boolean
isMinimalPutsEnabledByDefault()
By default should we perform "minimal puts" when using this second level cache implementation?
long
nextTimestamp()
Generate a timestamp.
void
start(Settings settings, Properties properties)
Lifecycle callback to perform any necessary initialization of the underlying cache implementation(s).
void
stop()
Lifecycle callback to perform any necessary cleanup of the underlying cache implementation(s).

Constructor Details

NoCachingRegionFactory

public NoCachingRegionFactory(Properties properties)

Method Details

buildCollectionRegion

public CollectionRegion buildCollectionRegion(String regionName,
                                              Properties properties,
                                              CacheDataDescription metadata)
            throws CacheException
Build a cache region specialized for storing collection data.
Specified by:
buildCollectionRegion in interface RegionFactory
Parameters:
regionName - The name of the region.
properties - Configuration properties.
metadata - Information regarding the type of data to be cached
Returns:
The built region
Throws:
CacheException - Indicates problems building the region.

buildEntityRegion

public EntityRegion buildEntityRegion(String regionName,
                                      Properties properties,
                                      CacheDataDescription metadata)
            throws CacheException
Build a cache region specialized for storing entity data.
Specified by:
buildEntityRegion in interface RegionFactory
Parameters:
regionName - The name of the region.
properties - Configuration properties.
metadata - Information regarding the type of data to be cached
Returns:
The built region
Throws:
CacheException - Indicates problems building the region.

buildQueryResultsRegion

public QueryResultsRegion buildQueryResultsRegion(String regionName,
                                                  Properties properties)
            throws CacheException
Build a cache region specialized for storing query results
Specified by:
buildQueryResultsRegion in interface RegionFactory
Parameters:
regionName - The name of the region.
properties - Configuration properties.
Returns:
The built region
Throws:
CacheException - Indicates problems building the region.

buildTimestampsRegion

public TimestampsRegion buildTimestampsRegion(String regionName,
                                              Properties properties)
            throws CacheException
Build a cache region specialized for storing update-timestamps data.
Specified by:
buildTimestampsRegion in interface RegionFactory
Parameters:
regionName - The name of the region.
properties - Configuration properties.
Returns:
The built region
Throws:
CacheException - Indicates problems building the region.

isMinimalPutsEnabledByDefault

public boolean isMinimalPutsEnabledByDefault()
By default should we perform "minimal puts" when using this second level cache implementation?
Specified by:
isMinimalPutsEnabledByDefault in interface RegionFactory
Returns:
True if "minimal puts" should be performed by default; false otherwise.

nextTimestamp

public long nextTimestamp()
Generate a timestamp.

This is generally used for cache content locking/unlocking purposes depending upon the access-strategy being used.

Specified by:
nextTimestamp in interface RegionFactory
Returns:
The generated timestamp.

start

public void start(Settings settings,
                  Properties properties)
            throws CacheException
Lifecycle callback to perform any necessary initialization of the underlying cache implementation(s). Called exactly once during the construction of a SessionFactoryImpl.
Specified by:
start in interface RegionFactory
Parameters:
settings - The settings in effect.
properties - The defined cfg properties
Throws:
CacheException - Indicates problems starting the L2 cache impl; considered as a sign to stop SessionFactory building.

stop

public void stop()
Specified by:
stop in interface RegionFactory