org.hibernate.cache.spi

Interface CacheImplementor

All Superinterfaces:

Cache, CacheImplementor, Serializable, Service

public interface CacheImplementor
extends Service, Cache, CacheImplementor, Serializable

SPI contract for Hibernate's second-level cache engine

Since:

4.1

Author:

Strong Liu, Steve Ebersole

Method Summary

Modifier and Type	Method and Description
void	close() Close this "cache", releasing all underlying resources.
default void	evictQueries() Clean up the default query cache
Set<String>	getCacheRegionNames() The unqualified name of all regions.
CollectionDataAccess	getCollectionRegionAccess(NavigableRole collectionRole) Deprecated. Use EntityPersister.getNaturalIdCacheAccessStrategy() ()} instead
default QueryCache	getDefaultQueryCache() Deprecated. Use getDefaultQueryResultsCache() instead.
QueryResultsCache	getDefaultQueryResultsCache() Access to the "default" region used to store query results when caching was requested but no region was explicitly named.
EntityDataAccess	getEntityRegionAccess(NavigableRole rootEntityName) Deprecated. Use EntityPersister.getCacheAccessStrategy() instead
Set<NaturalIdDataAccess>	getNaturalIdAccessesInRegion(String legacyQualifiedRegionName) Deprecated. No replacement - added just for support of the newly deprecated methods expecting a qualified region name
NaturalIdDataAccess	getNaturalIdCacheRegionAccessStrategy(NavigableRole rootEntityName) Deprecated. Use EntityPersister.getNaturalIdCacheAccessStrategy() ()} instead
default QueryCache	getQueryCache() Deprecated. Use getDefaultQueryResultsCache() instead.
default QueryCache	getQueryCache(String regionName) Deprecated. Use getQueryResultsCache(String) instead, but using unqualified name
QueryResultsCache	getQueryResultsCache(String regionName) Get query cache by region name or create a new one if none exist.
QueryResultsCache	getQueryResultsCacheStrictly(String regionName) Get the named QueryResultRegionAccess but not creating one if it does not already exist.
Region	getRegion(String regionName) Get a cache Region by name
default Region	getRegionByLegacyName(String legacyName) Deprecated. No replacement - added just for support of the newly deprecated methods expecting a qualified region name
RegionFactory	getRegionFactory() The underlying RegionFactory in use.
String[]	getSecondLevelCacheRegionNames() Deprecated. (since 5.3) Use getCacheRegionNames() instead
SessionFactoryImplementor	getSessionFactory() Access to the SessionFactory this Cache is bound to.
TimestampsCache	getTimestampsCache() Find the cache data access strategy for Hibernate's timestamps cache.
default UpdateTimestampsCache	getUpdateTimestampsCache() Deprecated. Use getTimestampsCache() instead
void	prime(Set<DomainDataRegionConfig> cacheRegionConfigs) An initialization phase allowing the caching provider to prime itself from the passed configs
default String	unqualifyRegionName(String name) Deprecated. (since 5.3) No replacement - added just to continue some backwards compatibility in supporting the newly deprecated methods expecting a qualified (prefix +) region name

Methods inherited from interface org.hibernate.Cache

containsCollection, containsEntity, containsEntity, containsQuery, evictAll, evictAllRegions, evictCollection, evictCollectionData, evictCollectionData, evictCollectionData, evictCollectionRegion, evictCollectionRegions, evictDefaultQueryRegion, evictEntity, evictEntity, evictEntityData, evictEntityData, evictEntityData, evictEntityData, evictEntityData, evictEntityRegion, evictEntityRegion, evictEntityRegions, evictNaturalIdData, evictNaturalIdData, evictNaturalIdData, evictNaturalIdRegion, evictNaturalIdRegion, evictNaturalIdRegions, evictQueryRegion, evictQueryRegions, evictRegion

Methods inherited from interface javax.persistence.Cache

contains, evict, evict, unwrap

Method Detail

getSessionFactory

SessionFactoryImplementor getSessionFactory()

Description copied from interface: Cache

Access to the SessionFactory this Cache is bound to.

Specified by:

getSessionFactory in interface CacheImplementor

Returns:

The SessionFactory

getRegionFactory

RegionFactory getRegionFactory()

The underlying RegionFactory in use.

Specified by:

getRegionFactory in interface CacheImplementor

prime

void prime(Set<DomainDataRegionConfig> cacheRegionConfigs)

An initialization phase allowing the caching provider to prime itself from the passed configs

Specified by:

prime in interface CacheImplementor

Since:

5.3

getRegion

Region getRegion(String regionName)

Get a cache Region by name

Specified by:

getRegion in interface CacheImplementor

Since:

5.3

getCacheRegionNames

Set<String> getCacheRegionNames()

The unqualified name of all regions. Intended for use with getRegion(java.lang.String)

Specified by:

getCacheRegionNames in interface CacheImplementor

Since:

5.3

getTimestampsCache

TimestampsCache getTimestampsCache()

Find the cache data access strategy for Hibernate's timestamps cache. Will return null if Hibernate is not configured for query result caching

Specified by:

getTimestampsCache in interface CacheImplementor

Since:

5.3

getDefaultQueryResultsCache

QueryResultsCache getDefaultQueryResultsCache()

Access to the "default" region used to store query results when caching was requested but no region was explicitly named. Will return null if Hibernate is not configured for query result caching

Specified by:

getDefaultQueryResultsCache in interface CacheImplementor

getQueryResultsCache

QueryResultsCache getQueryResultsCache(String regionName)

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. Will return null if Hibernate is not configured for query result caching

Specified by:

getQueryResultsCache in interface CacheImplementor

getQueryResultsCacheStrictly

QueryResultsCache getQueryResultsCacheStrictly(String regionName)

Get the named QueryResultRegionAccess but not creating one if it does not already exist. This is intended for use by statistics. Will return null if Hibernate is not configured for query result caching or if no such region (yet) exists

Specified by:

getQueryResultsCacheStrictly in interface CacheImplementor

Since:

5.3

evictQueries

default void evictQueries()
                   throws HibernateException

Clean up the default query cache

Specified by:

evictQueries in interface CacheImplementor

Throws:

HibernateException

close

void close()

Close this "cache", releasing all underlying resources.

Specified by:

close in interface CacheImplementor

getSecondLevelCacheRegionNames

@Deprecated
String[] getSecondLevelCacheRegionNames()

Deprecated. (since 5.3) Use getCacheRegionNames() instead

Get the *qualified* names of all regions caching entity and collection data.

Specified by:

getSecondLevelCacheRegionNames in interface CacheImplementor

Returns:

All cache region names

getEntityRegionAccess

@Deprecated
EntityDataAccess getEntityRegionAccess(NavigableRole rootEntityName)

Deprecated. Use EntityPersister.getCacheAccessStrategy() instead

Find the cache data access strategy for an entity. Will return null when the entity is not configured for caching.

Specified by:

getEntityRegionAccess in interface CacheImplementor

Parameters:

rootEntityName - The NavigableRole representation of the root entity

getNaturalIdCacheRegionAccessStrategy

@Deprecated
NaturalIdDataAccess getNaturalIdCacheRegionAccessStrategy(NavigableRole rootEntityName)

Deprecated. Use EntityPersister.getNaturalIdCacheAccessStrategy() ()} instead

Find the cache data access strategy for the given entity's natural-id cache. Will return null when the entity does not define a natural-id, or its natural-id is not configured for caching.

Specified by:

getNaturalIdCacheRegionAccessStrategy in interface CacheImplementor

Parameters:

rootEntityName - The NavigableRole representation of the root entity

getCollectionRegionAccess

@Deprecated
CollectionDataAccess getCollectionRegionAccess(NavigableRole collectionRole)

Deprecated. Use EntityPersister.getNaturalIdCacheAccessStrategy() ()} instead

Find the cache data access strategy for the given collection. Will return null when the collection is not configured for caching.

Specified by:

getCollectionRegionAccess in interface CacheImplementor

getUpdateTimestampsCache

@Deprecated
default UpdateTimestampsCache getUpdateTimestampsCache()

Deprecated. Use getTimestampsCache() instead

Get UpdateTimestampsCache instance managed by the SessionFactory.

Specified by:

getUpdateTimestampsCache in interface CacheImplementor

getQueryCache

@Deprecated
default QueryCache getQueryCache()

Deprecated. Use getDefaultQueryResultsCache() instead.

Get the default QueryCache.

Specified by:

getQueryCache in interface CacheImplementor

getDefaultQueryCache

@Deprecated
default QueryCache getDefaultQueryCache()

Deprecated. Use getDefaultQueryResultsCache() instead.

Get the default QueryCache.

Specified by:

getDefaultQueryCache in interface CacheImplementor

getQueryCache

@Deprecated
default QueryCache getQueryCache(String regionName)
                                      throws HibernateException

Deprecated. Use getQueryResultsCache(String) instead, but using unqualified name

Specified by:

getQueryCache in interface CacheImplementor

Throws:

HibernateException

unqualifyRegionName

@Deprecated
default String unqualifyRegionName(String name)

Deprecated. (since 5.3) No replacement - added just to continue some backwards compatibility in supporting the newly deprecated methods expecting a qualified (prefix +) region name

Specified by:

unqualifyRegionName in interface CacheImplementor

getRegionByLegacyName

@Deprecated
default Region getRegionByLegacyName(String legacyName)

Deprecated. No replacement - added just for support of the newly deprecated methods expecting a qualified region name

Specified by:

getRegionByLegacyName in interface CacheImplementor

getNaturalIdAccessesInRegion

@Deprecated
Set<NaturalIdDataAccess> getNaturalIdAccessesInRegion(String legacyQualifiedRegionName)

Deprecated. No replacement - added just for support of the newly deprecated methods expecting a qualified region name

Specified by:

getNaturalIdAccessesInRegion in interface CacheImplementor