org.hibernate.engine.spi

Interface CacheImplementor

All Superinterfaces:

javax.persistence.Cache, java.io.Serializable, Service

All Known Implementing Classes:

CacheImpl

public interface CacheImplementor
extends Service, Cache, java.io.Serializable

Define internal contact of Cache API

Method Summary

Modifier and Type	Method and Description
void	close() Close all cache regions.
CollectionRegionAccessStrategy	determineCollectionRegionAccessStrategy(Collection model)
EntityRegionAccessStrategy	determineEntityRegionAccessStrategy(PersistentClass model)
NaturalIdRegionAccessStrategy	determineNaturalIdRegionAccessStrategy(PersistentClass model)
void	evictQueries() Clean up the default QueryCache.
CollectionRegionAccessStrategy	getCollectionRegionAccess(java.lang.String regionName) Find the "access strategy" for the named collection cache region.
QueryCache	getDefaultQueryCache() Get the default QueryCache.
EntityRegionAccessStrategy	getEntityRegionAccess(java.lang.String regionName) Find the "access strategy" for the named entity cache region.
NaturalIdRegionAccessStrategy	getNaturalIdCacheRegionAccessStrategy(java.lang.String regionName) Find the "access strategy" for the named natrual-id cache region.
default QueryCache	getQueryCache() Deprecated. Use getDefaultQueryCache() instead.
QueryCache	getQueryCache(java.lang.String regionName) Get query cache by region name or create a new one if none exist.
RegionFactory	getRegionFactory() The underlying RegionFactory in use.
java.lang.String[]	getSecondLevelCacheRegionNames() Get the names of all cache regions, including entity, collection, natural-id and query caches.
UpdateTimestampsCache	getUpdateTimestampsCache() Get UpdateTimestampsCache instance managed by the SessionFactory.
java.lang.String	qualifyRegionName(java.lang.String regionName) Applies any defined prefix, handling all null checks.

Methods inherited from interface org.hibernate.Cache

containsCollection, containsEntity, containsEntity, containsQuery, evictAllRegions, evictCollection, evictCollectionRegion, evictCollectionRegions, evictDefaultQueryRegion, evictEntity, evictEntity, evictEntityRegion, evictEntityRegion, evictEntityRegions, evictNaturalIdRegion, evictNaturalIdRegion, evictNaturalIdRegions, evictQueryRegion, evictQueryRegions, getSessionFactory

Methods inherited from interface javax.persistence.Cache

contains, evict, evict, evictAll, unwrap

Method Detail

close

void close()

Close all cache regions.

getQueryCache

QueryCache getQueryCache(java.lang.String regionName)
                  throws HibernateException

Get query cache by region name or create a new one if none exist.

If the region name is null, then default query cache region will be returned.

Parameters:

regionName - Query cache region name.

Returns:

The QueryCache associated with the region name, or default query cache if the region name is null.

Throws:

HibernateException - HibernateException maybe thrown when the creation of new QueryCache instance.

getQueryCache

@Deprecated
default QueryCache getQueryCache()

Deprecated. Use getDefaultQueryCache() instead.

Get the default QueryCache.

getDefaultQueryCache

QueryCache getDefaultQueryCache()

Get the default QueryCache.

getUpdateTimestampsCache

UpdateTimestampsCache getUpdateTimestampsCache()

Get UpdateTimestampsCache instance managed by the SessionFactory.

evictQueries

void evictQueries()
           throws HibernateException

Clean up the default QueryCache.

Throws:

HibernateException

getRegionFactory

RegionFactory getRegionFactory()

The underlying RegionFactory in use.

Returns:

The RegionFactory

qualifyRegionName

java.lang.String qualifyRegionName(java.lang.String regionName)

Applies any defined prefix, handling all null checks.

Parameters:

regionName - The region name to qualify

Returns:

The qualified name

getSecondLevelCacheRegionNames

java.lang.String[] getSecondLevelCacheRegionNames()

Get the names of all cache regions, including entity, collection, natural-id and query caches.

Returns:

All cache region names

getEntityRegionAccess

EntityRegionAccessStrategy getEntityRegionAccess(java.lang.String regionName)

Find the "access strategy" for the named entity cache region.

Parameters:

regionName - The name of the region

Returns:

That region's "access strategy"

getCollectionRegionAccess

CollectionRegionAccessStrategy getCollectionRegionAccess(java.lang.String regionName)

Find the "access strategy" for the named collection cache region.

Parameters:

regionName - The name of the region

Returns:

That region's "access strategy"

getNaturalIdCacheRegionAccessStrategy

NaturalIdRegionAccessStrategy getNaturalIdCacheRegionAccessStrategy(java.lang.String regionName)

Find the "access strategy" for the named natrual-id cache region.

Parameters:

regionName - The name of the region

Returns:

That region's "access strategy"

determineEntityRegionAccessStrategy

EntityRegionAccessStrategy determineEntityRegionAccessStrategy(PersistentClass model)

determineNaturalIdRegionAccessStrategy

NaturalIdRegionAccessStrategy determineNaturalIdRegionAccessStrategy(PersistentClass model)

determineCollectionRegionAccessStrategy

CollectionRegionAccessStrategy determineCollectionRegionAccessStrategy(Collection model)