org.hibernate.cache.spi

Class AbstractRegionFactory

java.lang.Object

org.hibernate.cache.spi.AbstractRegionFactory

All Implemented Interfaces:

Serializable, RegionFactory, Service, Stoppable

Direct Known Subclasses:

RegionFactoryTemplate

public abstract class AbstractRegionFactory
extends Object
implements RegionFactory

Author:

Steve Ebersole

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	LEGACY_QUERY_RESULTS_REGION_UNQUALIFIED_NAMES Legacy names that used to be the default for the query results region.
static List<String>	LEGACY_UPDATE_TIMESTAMPS_REGION_UNQUALIFIED_NAMES Legacy names that used to be the default for the update timestamps region.

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

DEFAULT_QUERY_RESULTS_REGION_UNQUALIFIED_NAME, DEFAULT_UPDATE_TIMESTAMPS_REGION_UNQUALIFIED_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractRegionFactory()

Method Summary

Modifier and Type	Method and Description
CacheTransactionSynchronization	createTransactionContext(SharedSessionContractImplementor session)
AccessType	getDefaultAccessType() Get the default access type for any "user model" data
protected SessionFactoryOptions	getOptions()
long	getTimeout()
boolean	isMinimalPutsEnabledByDefault() By default should we perform "minimal puts" when using this second level cache implementation?
protected boolean	isStarted()
long	nextTimestamp() Generate a timestamp.
protected abstract void	prepareForUse(SessionFactoryOptions settings, Map configValues)
String	qualify(String regionName)
protected abstract void	releaseFromUse()
void	start(SessionFactoryOptions settings, Map configValues) Lifecycle callback to perform any necessary initialization of the underlying cache provider.
void	stop() Stop phase notification
protected boolean	verifiedStartStatus()
protected void	verifyStarted()

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

buildDomainDataRegion, buildQueryResultsRegion, buildTimestampsRegion

Field Detail

LEGACY_QUERY_RESULTS_REGION_UNQUALIFIED_NAMES

public static final List<String> LEGACY_QUERY_RESULTS_REGION_UNQUALIFIED_NAMES

Legacy names that used to be the default for the query results region.

LEGACY_UPDATE_TIMESTAMPS_REGION_UNQUALIFIED_NAMES

public static final List<String> LEGACY_UPDATE_TIMESTAMPS_REGION_UNQUALIFIED_NAMES

Legacy names that used to be the default for the update timestamps region.

Constructor Detail

AbstractRegionFactory

public AbstractRegionFactory()

Method Detail

isStarted

protected boolean isStarted()

verifyStarted

protected void verifyStarted()

verifiedStartStatus

protected boolean verifiedStartStatus()

getOptions

protected SessionFactoryOptions getOptions()

start

public final void start(SessionFactoryOptions settings,
                        Map configValues)
                 throws CacheException

Description copied from interface: RegionFactory

Lifecycle callback to perform any necessary initialization of the underlying cache provider. Called exactly once during the construction of a SessionFactoryImpl.

Specified by:

start in interface RegionFactory

Parameters:

settings - The settings in effect.

configValues - The available config values

Throws:

CacheException - Indicates problems starting the L2 cache impl; considered as a sign to stop SessionFactory building.

prepareForUse

protected abstract void prepareForUse(SessionFactoryOptions settings,
                                      Map configValues)

stop

public final void stop()

Description copied from interface: Stoppable

Stop phase notification

Specified by:

stop in interface Stoppable

releaseFromUse

protected abstract void releaseFromUse()

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 any "user model" data

Specified by:

getDefaultAccessType in interface RegionFactory

qualify

public String qualify(String regionName)

Specified by:

qualify in interface RegionFactory

createTransactionContext

public CacheTransactionSynchronization createTransactionContext(SharedSessionContractImplementor session)

Specified by:

createTransactionContext in interface RegionFactory

nextTimestamp

public long nextTimestamp()

Description copied from interface: RegionFactory

Generate a timestamp. This value is generally used for purpose of locking/unlocking cache content depending upon the access-strategy being used. The intended consumer of this method is the Session to manage its SharedSessionContractImplementor.getTransactionStartTimestamp() value. It is also expected that this be the value used for this's RegionFactory's CacheTransactionContext

Specified by:

nextTimestamp in interface RegionFactory

getTimeout

public long getTimeout()

Specified by:

getTimeout in interface RegionFactory