Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.cache.spi.RegionFactory

Contract for building second-level cache regions, including regions dedicated to storing:

entity and collection instances,
query result sets, and
timestamps used to determine when a cached query result set is stale.

Implementors should define a constructor in one of two forms:

MyRegionFactoryImpl(java.util.Properties)
MyRegionFactoryImpl()

Use the first when we need to read config properties prior to start being called.

A RegionFactory may be selected using the property hibernate.cache.region.factory_class.

Field Summary

Modifier and Type	Field and Description
public static final String	DEFAULT_QUERY_RESULTS_REGION_UNQUALIFIED_NAME
public static final String	DEFAULT_UPDATE_TIMESTAMPS_REGION_UNQUALIFIED_NAME

Method Summary

Modifier and Type	Method and Description
public DomainDataRegion	buildDomainDataRegion(DomainDataRegionConfig The user requested caching configuration for this Region regionConfig, DomainDataRegionBuildingContext Access to delegates useful in building the Region buildingContext) Create a named `Region` for holding domain model data
public QueryResultsRegion	buildQueryResultsRegion(String regionName, SessionFactoryImplementor sessionFactory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. Create a named `Region` for holding query result sets.
public TimestampsRegion	buildTimestampsRegion(String regionName, SessionFactoryImplementor sessionFactory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. Create a named `Region` for holding timestamps used to determine when a cached query result set is stale.
public default CacheTransactionSynchronization	createTransactionContext(SharedSessionContractImplementor session)
public AccessType	getDefaultAccessType() Get the default access type for any "user model" data.
public default long	getTimeout()
public boolean	Returns: True if "minimal puts" should be performed by default; false otherwise. isMinimalPutsEnabledByDefault() By default, should we perform "minimal puts" when using this second level cache implementation?
public long	nextTimestamp() Generate a timestamp.
public String	qualify(String regionName)
public void	start(SessionFactoryOptions The settings in effect. settings, Map<String, Object> The available config values configValues) Lifecycle callback to perform any necessary initialization of the underlying cache provider.

Inherited from org.hibernate.service.spi.Stoppable:: stop

Field Detail

DEFAULT_QUERY_RESULTS_REGION_UNQUALIFIED_NAME	back to summary
public static final String DEFAULT_QUERY_RESULTS_REGION_UNQUALIFIED_NAME

DEFAULT_UPDATE_TIMESTAMPS_REGION_UNQUALIFIED_NAME	back to summary
public static final String DEFAULT_UPDATE_TIMESTAMPS_REGION_UNQUALIFIED_NAME

Method Detail

buildDomainDataRegion back to summary

buildDomainDataRegion	back to summary
public DomainDataRegion buildDomainDataRegion(DomainDataRegionConfig regionConfig, DomainDataRegionBuildingContext buildingContext) Create a named `Region` for holding domain model data Parameters regionConfig:DomainDataRegionConfig The user requested caching configuration for this Region buildingContext:DomainDataRegionBuildingContext Access to delegates useful in building the Region

public DomainDataRegion buildDomainDataRegion(DomainDataRegionConfig regionConfig, DomainDataRegionBuildingContext buildingContext)

Create a named Region for holding domain model data

Parameters

regionConfig:DomainDataRegionConfig: The user requested caching configuration for this Region
buildingContext:DomainDataRegionBuildingContext: Access to delegates useful in building the Region

buildQueryResultsRegion	back to summary
public QueryResultsRegion buildQueryResultsRegion(String regionName, SessionFactoryImplementor sessionFactory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information. Create a named `Region` for holding query result sets.

buildTimestampsRegion	back to summary
public TimestampsRegion buildTimestampsRegion(String regionName, SessionFactoryImplementor sessionFactory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information. Create a named `Region` for holding timestamps used to determine when a cached query result set is stale.

createTransactionContext	back to summary
public default CacheTransactionSynchronization createTransactionContext(SharedSessionContractImplementor session)

getDefaultAccessType	back to summary
public AccessType getDefaultAccessType() Get the default access type for any "user model" data.

getTimeout	back to summary
public default long getTimeout()

isMinimalPutsEnabledByDefault	back to summary
public boolean 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.

isMinimalPutsEnabledByDefault

back to summary

public boolean 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.

nextTimestamp back to summary

nextTimestamp	back to summary
public long nextTimestamp() Generate a timestamp. This value is generally used for purpose of locking/unlocking cache content depending upon the access strategy being used. It's also expected that this be the value used by the `CacheTransactionSynchronization` created by this `RegionFactory`. API Note This "timestamp" need not be related to timestamp in the `java.util.Date#getTime()`/`System#currentTimeMillis()` sense. It just needs to be an incrementing value.

public long nextTimestamp()

Generate a timestamp. This value is generally used for purpose of locking/unlocking cache content depending upon the access strategy being used. It's also expected that this be the value used by the CacheTransactionSynchronization created by this RegionFactory.

API Note

This "timestamp" need not be related to timestamp in the java.util.Date#getTime()/System#currentTimeMillis() sense. It just needs to be an incrementing value.

qualify	back to summary
public String qualify(String regionName)

start back to summary

start	back to summary
public void start(SessionFactoryOptions settings, Map<String, Object> configValues) throws CacheException 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<String, Object> The available config values Exceptions CacheException: Indicates problems starting the L2 cache impl; considered as a sign to stop `org.hibernate.SessionFactory` building.

public void start(SessionFactoryOptions settings, Map<String, Object> configValues) throws CacheException

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<String, Object>: The available config values

Exceptions

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

public Interface RegionFactory

Field Summary

Method Summary

Field Detail

Method Detail