Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.engine.spi.CacheImplementor

Method Summary

Modifier and Type	Method and Description
public void	close() Close this "cache", releasing all underlying resources.
public default void	evictQueries() Clean up the default query cache
public Set<String>	getCacheRegionNames() The unqualified name of all regions.
public CollectionDataAccess	getCollectionRegionAccess(NavigableRole collectionRole) Deprecated Use `EntityPersister#getNaturalIdCacheAccessStrategy()` ()} instead Find the cache data access strategy for the given collection.
public default QueryCache	getDefaultQueryCache() Deprecated Use `getDefaultQueryResultsCache` instead. Get the default `QueryCache`.
public QueryResultsCache	getDefaultQueryResultsCache() Deprecated as a consequence of `QueryResultsCache` being deprecated. Access to the "default" region used to store query results when caching was requested but no region was explicitly named.
public EntityDataAccess	getEntityRegionAccess(NavigableRole The NavigableRole representation of the root entity rootEntityName) Deprecated Use `EntityPersister#getCacheAccessStrategy()` instead Find the cache data access strategy for an entity.
public Set<NaturalIdDataAccess>	getNaturalIdAccessesInRegion(String legacyQualifiedRegionName) Deprecated No replacement - added just for support of the newly deprecated methods expecting a qualified region name
public NaturalIdDataAccess	getNaturalIdCacheRegionAccessStrategy(NavigableRole The NavigableRole representation of the root entity rootEntityName) Deprecated Use `EntityPersister#getNaturalIdCacheAccessStrategy()` ()} instead Find the cache data access strategy for the given entity's natural-id cache.
public default QueryCache	getQueryCache() Deprecated Use `getDefaultQueryResultsCache` instead. Get the default `QueryCache`.
public default QueryCache	getQueryCache(String regionName) Deprecated Use `getQueryResultsCache(String)` instead, but using unqualified name
public QueryResultsCache	getQueryResultsCache(String regionName) Deprecated as a consequence of `QueryResultsCache` being deprecated. Get query cache by `region name` or create a new one if none exist.
public QueryResultsCache	getQueryResultsCacheStrictly(String regionName) Deprecated as a consequence of `QueryResultsCache` being deprecated. Get the named QueryResultRegionAccess but not creating one if it does not already exist.
public Region	getRegion(String regionName) Get a cache Region by name
public default Region	getRegionByLegacyName(String legacyName) Deprecated No replacement - added just for support of the newly deprecated methods expecting a qualified region name
public RegionFactory	getRegionFactory() The underlying RegionFactory in use.
public String[]	Returns: All cache region names getSecondLevelCacheRegionNames() Deprecated (since 5.3) Use `CacheImplementor#getCacheRegionNames()` instead Get the qualified names of all regions caching entity and collection data.
public SessionFactoryImplementor	getSessionFactory() Redeclares org.hibernate.Cache.getSessionFactory. Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. Access to the SessionFactory this Cache is bound to.
public TimestampsCache	getTimestampsCache() Deprecated as a consequence of `TimestampsCache` being deprecated. Find the cache data access strategy for Hibernate's timestamps cache.
public default UpdateTimestampsCache	getUpdateTimestampsCache() Deprecated Use `getTimestampsCache` instead Get `UpdateTimestampsCache` instance managed by the `SessionFactory`.
public void	prime(Set<DomainDataRegionConfig> cacheRegionConfigs) An initialization phase allowing the caching provider to prime itself from the passed configs
public 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

Method Detail

close	back to summary
public void close() Close this "cache", releasing all underlying resources.

evictQueries	back to summary
public default void evictQueries() throws HibernateException Clean up the default query cache

getCacheRegionNames back to summary

getCacheRegionNames	back to summary
public Set<String> getCacheRegionNames() The unqualified name of all regions. Intended for use with `getRegion` Since 5.3

public Set<String> getCacheRegionNames()

The unqualified name of all regions. Intended for use with getRegion

Since: 5.3

getCollectionRegionAccess back to summary

getCollectionRegionAccess	back to summary
public 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. API Note It is only valid to call this method after `prime` has been performed Annotations @Deprecated

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

API Note

It is only valid to call this method after prime has been performed

Annotations

@Deprecated

getDefaultQueryCache back to summary

getDefaultQueryCache	back to summary
public default QueryCache getDefaultQueryCache() Deprecated Use `getDefaultQueryResultsCache` instead. Get the default `QueryCache`. Annotations @Deprecated

public default QueryCache getDefaultQueryCache()

Deprecated

Use getDefaultQueryResultsCache instead.

Get the default QueryCache.

Annotations

@Deprecated

getDefaultQueryResultsCache	back to summary
public QueryResultsCache getDefaultQueryResultsCache() Deprecated as a consequence of `QueryResultsCache` being deprecated. See corresponding docs for further information. 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

getEntityRegionAccess back to summary

getEntityRegionAccess	back to summary
public 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. API Note It is only valid to call this method after `prime` has been performed Parameters rootEntityName:NavigableRole The NavigableRole representation of the root entity Annotations @Deprecated

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

API Note

It is only valid to call this method after prime has been performed

Parameters

rootEntityName:NavigableRole: The NavigableRole representation of the root entity

Annotations

@Deprecated

getNaturalIdAccessesInRegion	back to summary
public Set<NaturalIdDataAccess> getNaturalIdAccessesInRegion(String legacyQualifiedRegionName) Deprecated No replacement - added just for support of the newly deprecated methods expecting a qualified region name Annotations @Deprecated

getNaturalIdCacheRegionAccessStrategy back to summary

getNaturalIdCacheRegionAccessStrategy	back to summary
public 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. API Note It is only valid to call this method after `prime` has been performed Parameters rootEntityName:NavigableRole The NavigableRole representation of the root entity Annotations @Deprecated

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

API Note

It is only valid to call this method after prime has been performed

Parameters

rootEntityName:NavigableRole: The NavigableRole representation of the root entity

Annotations

@Deprecated

getQueryCache back to summary

getQueryCache	back to summary
public default QueryCache getQueryCache() Deprecated Use `getDefaultQueryResultsCache` instead. Get the default `QueryCache`. Annotations @Deprecated

public default QueryCache getQueryCache()

Deprecated

Use getDefaultQueryResultsCache instead.

Get the default QueryCache.

Annotations

@Deprecated

getQueryCache	back to summary
public default QueryCache getQueryCache(String regionName) throws HibernateException Deprecated Use `getQueryResultsCache(String)` instead, but using unqualified name Annotations @Deprecated

getQueryResultsCache back to summary

getQueryResultsCache	back to summary
public QueryResultsCache getQueryResultsCache(String regionName) Deprecated as a consequence of `QueryResultsCache` being deprecated. See corresponding docs for further information. 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

public QueryResultsCache getQueryResultsCache(String regionName)

Deprecated

as a consequence of QueryResultsCache being deprecated. See corresponding docs for further information.

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

getQueryResultsCacheStrictly back to summary

getQueryResultsCacheStrictly	back to summary
public QueryResultsCache getQueryResultsCacheStrictly(String regionName) Deprecated as a consequence of `QueryResultsCache` being deprecated. See corresponding docs for further information. 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 Since 5.3

public QueryResultsCache getQueryResultsCacheStrictly(String regionName)

Deprecated

as a consequence of QueryResultsCache being deprecated. See corresponding docs for further information.

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

Since: 5.3

getRegion back to summary

getRegion	back to summary
public Region getRegion(String regionName) Get a cache Region by name API Note It is only valid to call this method after `prime` has been performed Since 5.3

public Region getRegion(String regionName)

Get a cache Region by name

API Note

It is only valid to call this method after prime has been performed

Since: 5.3

getRegionByLegacyName	back to summary
public default Region getRegionByLegacyName(String legacyName) Deprecated No replacement - added just for support of the newly deprecated methods expecting a qualified region name Annotations @Deprecated

getRegionFactory	back to summary
public RegionFactory getRegionFactory() The underlying RegionFactory in use. API Note CacheImplementor acts partially as a wrapper for details of interacting with the configured RegionFactory. Care should be taken when accessing the RegionFactory directly.

getSecondLevelCacheRegionNames back to summary

getSecondLevelCacheRegionNames	back to summary
public String[] getSecondLevelCacheRegionNames() Deprecated (since 5.3) Use `CacheImplementor#getCacheRegionNames()` instead Get the qualified names of all regions caching entity and collection data. Returns:String[] All cache region names Annotations @Deprecated

public String[] getSecondLevelCacheRegionNames()

Deprecated

(since 5.3) Use CacheImplementor#getCacheRegionNames() instead

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

Returns:String[]

All cache region names

Annotations

@Deprecated

getSessionFactory back to summary

getSessionFactory	back to summary
public SessionFactoryImplementor getSessionFactory() Redeclares org.hibernate.Cache.getSessionFactory. Doc from org.hibernate.Cache.getSessionFactory. Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information. Access to the SessionFactory this Cache is bound to. Returns:SessionFactoryImplementor The SessionFactory Annotations @Override

public SessionFactoryImplementor getSessionFactory()

Redeclares org.hibernate.Cache.getSessionFactory.

Doc from org.hibernate.Cache.getSessionFactory.

Deprecated

as a consequence of SessionFactoryImplementor being deprecated. See corresponding docs for further information.

Access to the SessionFactory this Cache is bound to.

Returns:SessionFactoryImplementor

The SessionFactory

Annotations

@Override

getTimestampsCache back to summary

getTimestampsCache	back to summary
public TimestampsCache getTimestampsCache() Deprecated as a consequence of `TimestampsCache` being deprecated. See corresponding docs for further information. Find the cache data access strategy for Hibernate's timestamps cache. Will return `null` if Hibernate is not configured for query result caching Since 5.3

public TimestampsCache getTimestampsCache()

Deprecated

as a consequence of TimestampsCache being deprecated. See corresponding docs for further information.

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

Since: 5.3

getUpdateTimestampsCache back to summary

getUpdateTimestampsCache	back to summary
public default UpdateTimestampsCache getUpdateTimestampsCache() Deprecated Use `getTimestampsCache` instead Get `UpdateTimestampsCache` instance managed by the `SessionFactory`. Annotations @Deprecated

public default UpdateTimestampsCache getUpdateTimestampsCache()

Deprecated

Use getTimestampsCache instead

Get UpdateTimestampsCache instance managed by the SessionFactory.

Annotations

@Deprecated

prime	back to summary
public void prime(Set<DomainDataRegionConfig> cacheRegionConfigs) An initialization phase allowing the caching provider to prime itself from the passed configs Since 5.3

prime

back to summary

public void prime(Set<DomainDataRegionConfig> cacheRegionConfigs)

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

Since: 5.3

unqualifyRegionName	back to summary
public 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 Annotations @Deprecated

public Interface CacheImplementor

Method Summary

Method Detail