org.hibernate.cache.jcache

Class JCacheRegionFactory

java.lang.Object

org.hibernate.cache.jcache.JCacheRegionFactory

All Implemented Interfaces:

java.io.Serializable, RegionFactory, Service

public class JCacheRegionFactory
extends java.lang.Object
implements RegionFactory

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_URI
static java.lang.String	PROVIDER

Constructor Summary

Constructors

Constructor and Description
JCacheRegionFactory()

Method Summary

Modifier and Type	Method and Description
CollectionRegion	buildCollectionRegion(java.lang.String regionName, java.util.Properties properties, CacheDataDescription metadata) Build a cache region specialized for storing collection data.
EntityRegion	buildEntityRegion(java.lang.String regionName, java.util.Properties properties, CacheDataDescription metadata) Build a cache region specialized for storing entity data.
NaturalIdRegion	buildNaturalIdRegion(java.lang.String regionName, java.util.Properties properties, CacheDataDescription metadata) Build a cache region specialized for storing NaturalId to Primary Key mappings.
QueryResultsRegion	buildQueryResultsRegion(java.lang.String regionName, java.util.Properties properties) Build a cache region specialized for storing query results.
TimestampsRegion	buildTimestampsRegion(java.lang.String regionName, java.util.Properties properties) Build a cache region specialized for storing update-timestamps data.
protected void	checkStatus()
protected javax.cache.Cache<java.lang.Object,java.lang.Object>	createCache(java.lang.String regionName, java.util.Properties properties, CacheDataDescription metadata)
protected javax.cache.CacheManager	getCacheManager()
protected javax.cache.CacheManager	getCacheManager(java.util.Properties properties)
protected javax.cache.spi.CachingProvider	getCachingProvider(java.util.Properties properties)
AccessType	getDefaultAccessType() Get the default access type for entity and collection regions.
protected SessionFactoryOptions	getOptions()
protected javax.cache.Cache<java.lang.Object,java.lang.Object>	getOrCreateCache(java.lang.String regionName, java.util.Properties properties, CacheDataDescription metadata)
protected java.lang.String	getProp(java.util.Properties properties, java.lang.String prop)
boolean	isMinimalPutsEnabledByDefault() By default should we perform "minimal puts" when using this second level cache implementation?
protected javax.cache.configuration.Configuration<java.lang.Object,java.lang.Object>	newDefaultConfig(java.util.Properties properties, CacheDataDescription metadata)
long	nextTimestamp() Generate a timestamp.
void	start(SessionFactoryOptions options, java.util.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).

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.cache.spi.RegionFactory

buildCollectionRegion, buildEntityRegion, buildNaturalIdRegion, buildQueryResultsRegion, buildTimestampsRegion, start

Field Detail

PROVIDER

public static final java.lang.String PROVIDER

See Also:

Constant Field Values

CONFIG_URI

public static final java.lang.String CONFIG_URI

See Also:

Constant Field Values

Constructor Detail

JCacheRegionFactory

public JCacheRegionFactory()

Method Detail

start

public void start(SessionFactoryOptions options,
                  java.util.Properties properties)
           throws CacheException

Description copied from interface: RegionFactory

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:

options - 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()

Description copied from interface: RegionFactory

Lifecycle callback to perform any necessary cleanup of the underlying cache implementation(s). Called exactly once during SessionFactory.close().

Specified by:

stop in interface RegionFactory

isMinimalPutsEnabledByDefault

public boolean isMinimalPutsEnabledByDefault()

Description copied from interface: RegionFactory

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.

getDefaultAccessType

public AccessType getDefaultAccessType()

Description copied from interface: RegionFactory

Get the default access type for entity and collection regions.

Specified by:

getDefaultAccessType in interface RegionFactory

Returns:

This factory's default access type.

nextTimestamp

public long nextTimestamp()

Description copied from interface: RegionFactory

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.

buildEntityRegion

public EntityRegion buildEntityRegion(java.lang.String regionName,
                                      java.util.Properties properties,
                                      CacheDataDescription metadata)
                               throws CacheException

Description copied from interface: RegionFactory

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.

buildNaturalIdRegion

public NaturalIdRegion buildNaturalIdRegion(java.lang.String regionName,
                                            java.util.Properties properties,
                                            CacheDataDescription metadata)
                                     throws CacheException

Description copied from interface: RegionFactory

Build a cache region specialized for storing NaturalId to Primary Key mappings.

Specified by:

buildNaturalIdRegion 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.

buildCollectionRegion

public CollectionRegion buildCollectionRegion(java.lang.String regionName,
                                              java.util.Properties properties,
                                              CacheDataDescription metadata)
                                       throws CacheException

Description copied from interface: RegionFactory

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.

buildQueryResultsRegion

public QueryResultsRegion buildQueryResultsRegion(java.lang.String regionName,
                                                  java.util.Properties properties)
                                           throws CacheException

Description copied from interface: RegionFactory

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(java.lang.String regionName,
                                              java.util.Properties properties)
                                       throws CacheException

Description copied from interface: RegionFactory

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.

getOptions

protected SessionFactoryOptions getOptions()

getCachingProvider

protected javax.cache.spi.CachingProvider getCachingProvider(java.util.Properties properties)

getCacheManager

protected javax.cache.CacheManager getCacheManager(java.util.Properties properties)

getOrCreateCache

protected javax.cache.Cache<java.lang.Object,java.lang.Object> getOrCreateCache(java.lang.String regionName,
                                                                                java.util.Properties properties,
                                                                                CacheDataDescription metadata)

createCache

protected javax.cache.Cache<java.lang.Object,java.lang.Object> createCache(java.lang.String regionName,
                                                                           java.util.Properties properties,
                                                                           CacheDataDescription metadata)

newDefaultConfig

protected javax.cache.configuration.Configuration<java.lang.Object,java.lang.Object> newDefaultConfig(java.util.Properties properties,
                                                                                                      CacheDataDescription metadata)

getCacheManager

protected javax.cache.CacheManager getCacheManager()

getProp

protected java.lang.String getProp(java.util.Properties properties,
                                   java.lang.String prop)

checkStatus

protected void checkStatus()