Top Fields Constructors Methods
org.hibernate.cache.spi

public abstract Class AbstractRegionFactory

extends Object
implements RegionFactory
Class Inheritance
All Implemented Interfaces
org.hibernate.cache.spi.RegionFactory, org.hibernate.service.spi.Stoppable, org.hibernate.service.Service, java.io.Serializable
Known Direct Subclasses
org.hibernate.cache.spi.support.RegionFactoryTemplate
Imports
java.util.Arrays, .Collections, .List, .Map, java.util.concurrent.atomic.AtomicBoolean, org.hibernate.boot.spi.SessionFactoryOptions, org.hibernate.cache.CacheException, org.hibernate.cache.spi.access.AccessType, org.hibernate.cache.spi.support.RegionNameQualifier, .SimpleTimestamper, org.hibernate.engine.spi.SharedSessionContractImplementor
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
public static final List<String>
LEGACY_QUERY_RESULTS_REGION_UNQUALIFIED_NAMES

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

public static final List<String>
LEGACY_UPDATE_TIMESTAMPS_REGION_UNQUALIFIED_NAMES

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

private SessionFactoryOptions
options

private final AtomicBoolean
started

private Exception
startingException

Constructor Summary

AccessConstructor and Description
public
AbstractRegionFactory()

Method Summary

Modifier and TypeMethod and Description
public CacheTransactionSynchronization
createTransactionContext(SharedSessionContractImplementor session)

Overrides default org.hibernate.cache.spi.RegionFactory.createTransactionContext.

public AccessType
getDefaultAccessType()

Implements org.hibernate.cache.spi.RegionFactory.getDefaultAccessType.

Get the default access type for any "user model" data
protected SessionFactoryOptions
getOptions()

public long
getTimeout()

Overrides default org.hibernate.cache.spi.RegionFactory.getTimeout.

public boolean
isMinimalPutsEnabledByDefault()

Implements org.hibernate.cache.spi.RegionFactory.isMinimalPutsEnabledByDefault.

By default should we perform "minimal puts" when using this second level cache implementation?
protected boolean
isStarted()

public long
nextTimestamp()

Implements org.hibernate.cache.spi.RegionFactory.nextTimestamp.

Generate a timestamp.
protected abstract void
prepareForUse(SessionFactoryOptions settings, Map<K, V> configValues)

public String
qualify(String regionName)

Implements org.hibernate.cache.spi.RegionFactory.qualify.

protected abstract void
releaseFromUse()

public final void
start(SessionFactoryOptions
The settings in effect.
settings, Map<K, V>
The available config values
configValues)

Implements org.hibernate.cache.spi.RegionFactory.start.

Lifecycle callback to perform any necessary initialization of the underlying cache provider.
public final void
stop()

Implements org.hibernate.service.spi.Stoppable.stop.

Stop phase notification
protected boolean
verifiedStartStatus()

protected void
verifyStarted()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

LEGACY_QUERY_RESULTS_REGION_UNQUALIFIED_NAMESback to summary
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_NAMESback to summary
public static final List<String> LEGACY_UPDATE_TIMESTAMPS_REGION_UNQUALIFIED_NAMES

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

optionsback to summary
private SessionFactoryOptions options
startedback to summary
private final AtomicBoolean started
startingExceptionback to summary
private Exception startingException

Constructor Detail

AbstractRegionFactoryback to summary
public AbstractRegionFactory()

Method Detail

createTransactionContextback to summary
public CacheTransactionSynchronization createTransactionContext(SharedSessionContractImplementor session)

Overrides default org.hibernate.cache.spi.RegionFactory.createTransactionContext.

Annotations
@Override
getDefaultAccessTypeback to summary
public AccessType getDefaultAccessType()

Implements org.hibernate.cache.spi.RegionFactory.getDefaultAccessType.

Doc from org.hibernate.cache.spi.RegionFactory.getDefaultAccessType.

Get the default access type for any "user model" data

Annotations
@Override
getOptionsback to summary
protected SessionFactoryOptions getOptions()
getTimeoutback to summary
public long getTimeout()

Overrides default org.hibernate.cache.spi.RegionFactory.getTimeout.

Annotations
@Override
isMinimalPutsEnabledByDefaultback to summary
public boolean isMinimalPutsEnabledByDefault()

Implements org.hibernate.cache.spi.RegionFactory.isMinimalPutsEnabledByDefault.

Doc from org.hibernate.cache.spi.RegionFactory.isMinimalPutsEnabledByDefault.

By default should we perform "minimal puts" when using this second level cache implementation?

Returns:boolean

True if "minimal puts" should be performed by default; false otherwise.

Annotations
@Override
isStartedback to summary
protected boolean isStarted()
nextTimestampback to summary
public long nextTimestamp()

Implements org.hibernate.cache.spi.RegionFactory.nextTimestamp.

Doc from org.hibernate.cache.spi.RegionFactory.nextTimestamp.

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

Annotations
@Override
prepareForUseback to summary
protected abstract void prepareForUse(SessionFactoryOptions settings, Map<K, V> configValues)
qualifyback to summary
public String qualify(String regionName)

Implements org.hibernate.cache.spi.RegionFactory.qualify.

Annotations
@Override
releaseFromUseback to summary
protected abstract void releaseFromUse()
startback to summary
public final void start(SessionFactoryOptions settings, Map<K, V> configValues) throws CacheException

Implements org.hibernate.cache.spi.RegionFactory.start.

Doc from org.hibernate.cache.spi.RegionFactory.start.

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

Parameters
settings:SessionFactoryOptions

The settings in effect.

configValues:Map<K, V>

The available config values

Annotations
@Override
Exceptions
CacheException:
Indicates problems starting the L2 cache impl; considered as a sign to stop org.hibernate.SessionFactory building.
stopback to summary
public final void stop()

Implements org.hibernate.service.spi.Stoppable.stop.

Doc from org.hibernate.service.spi.Stoppable.stop.

Stop phase notification

Annotations
@Override
verifiedStartStatusback to summary
protected boolean verifiedStartStatus()
verifyStartedback to summary
protected void verifyStarted()