Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.cache.internal.EnabledCaching

Modifier and Type	Field and Description
private final Map<NavigableRole, CollectionDataAccess>	collectionAccessMap
private final QueryResultsCache	defaultQueryResultsCache
private final Map<NavigableRole, EntityDataAccess>	entityAccessMap
private final Map<String, Set<NaturalIdDataAccess>>	legacyNaturalIdAccessesForRegion
private final Set<String>	legacySecondLevelCacheNames
private static final CoreMessageLogger	LOG
private final Map<String, QueryResultsCache>	namedQueryResultsCacheMap
private final Map<NavigableRole, NaturalIdDataAccess>	naturalIdAccessMap
private final Map<String, QueryResultsRegion>	queryResultsRegionsByDuplicateName
private final RegionFactory	regionFactory
private final Map<String, Region>	regionsByName
private final SessionFactoryImplementor	sessionFactory Deprecated as a consequence of `SessionFactoryImplementor` being deprecated.
private final TimestampsCache	timestampsCache

Access	Constructor and Description
public	EnabledCaching(SessionFactoryImplementor sessionFactory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements org.hibernate.cache.spi.CacheImplementor.close. Close this "cache", releasing all underlying resources.
public boolean	contains(Class<T> entity class cls, Object primary key primaryKey) Implements jakarta.persistence.Cache.contains. Whether the cache contains data for the given entity.
public boolean	containsCollection(String The name of the collection role in the form `package.OwnerEntityName.collectionPropertyName` role, Object The identifier of the owning entity ownerIdentifier) Implements org.hibernate.Cache.containsCollection. Determine whether the cache contains an item for the collection with the given role and given identifier.
public boolean	containsEntity(Class<?> The entity type entityClass, Object The entity identifier identifier) Implements org.hibernate.Cache.containsEntity. Determine whether the cache contains an item for the entity of the given type, and with the given identifier.
public boolean	containsEntity(String The entity name entityName, Object The entity identifier identifier) Implements org.hibernate.Cache.containsEntity. Determine whether the cache contains an item for the entity of the type with the given name, and with the given identifier.
public boolean	containsQuery(String The name of a cache region to which some query is assigned regionName) Implements org.hibernate.Cache.containsQuery. Determine whether the given region name contains cached query results.
public void	evict(Class<T> entity class cls, Object primary key primaryKey) Implements jakarta.persistence.Cache.evict. Remove the data for the given entity from the cache.
public void	evict(Class<T> entity class cls) Implements jakarta.persistence.Cache.evict. Remove the data for entities of the specified class (and its subclasses) from the cache.
public void	evictCollectionData(String The name of the collection role in the form `package.OwnerEntityName.collectionPropertyName` role, Object The identifier of the owning entity ownerIdentifier) Implements org.hibernate.Cache.evictCollectionData. Evict the cached item for the collection with the given role and given identifier, if there is any such item in the cache.
public void	evictCollectionData(String The name of the collection role in the form `package.OwnerEntityName.collectionPropertyName` role) Implements org.hibernate.Cache.evictCollectionData. Evict all cached data from the cache region to which the given collection role is assigned.
private void	evictCollectionData(CollectionPersister collectionDescriptor)
private void	evictCollectionData(NavigableRole navigableRole, CollectionDataAccess cacheAccess)
public void	evictCollectionData() Implements org.hibernate.Cache.evictCollectionData. Evict all cache data from every cache region to which some collection role is assigned.
public void	evictDefaultQueryRegion() Implements org.hibernate.Cache.evictDefaultQueryRegion. Evict all cached query results from the default region.
public void	evictEntityData(Class<?> The entity type entityClass, Object The entity identifier identifier) Implements org.hibernate.Cache.evictEntityData. Evicts the cached item for the entity of the given type, and with the given identifier, if there is any such item in the cache.
public void	evictEntityData(String The entity name entityName, Object The entity identifier identifier) Implements org.hibernate.Cache.evictEntityData. Evict the cached item for the entity of the type with the given name, and with the given identifier, if there is any such item in the cache.
public void	evictEntityData(Class<?> The entity type entityClass) Implements org.hibernate.Cache.evictEntityData. Evict all cached data from the cache region to which the given entity type is assigned.
public void	evictEntityData(String The entity name entityName) Implements org.hibernate.Cache.evictEntityData. Evict all cached data from the cache region to which the given named entity type is assigned.
protected void	evictEntityData(EntityPersister entityDescriptor)
private void	evictEntityData(NavigableRole navigableRole, EntityDataAccess cacheAccess)
public void	evictEntityData() Implements org.hibernate.Cache.evictEntityData. Evict all cached data from every cache region to which any entity type is assigned.
public void	evictNaturalIdData(Class<?> The entity type entityClass) Implements org.hibernate.Cache.evictNaturalIdData. Evict all cached natural id mappings for the given entity type.
public void	evictNaturalIdData(String The entity name entityName) Implements org.hibernate.Cache.evictNaturalIdData. Evict all cached natural id mappings for the entity type with the given name.
private void	evictNaturalIdData(EntityPersister rootEntityDescriptor)
public void	evictNaturalIdData() Implements org.hibernate.Cache.evictNaturalIdData. Evict all cached natural id mappings for every entity type.
private void	evictNaturalIdData(NavigableRole rootEntityRole, NaturalIdDataAccess cacheAccess)
public void	evictQueryRegion(String The cache name associated to the queries being cached. regionName) Implements org.hibernate.Cache.evictQueryRegion. Evict all cached query results from the region with the given name.
public void	evictQueryRegions() Implements org.hibernate.Cache.evictQueryRegions. Evict all cached query results from every region.
private void	evictQueryResultRegion(QueryResultsCache cache)
public void	evictRegion(String regionName) Implements org.hibernate.Cache.evictRegion. Evict all cached data from the named cache region.
public Set<String>	getCacheRegionNames() Implements org.hibernate.cache.spi.CacheImplementor.getCacheRegionNames. The unqualified name of all regions.
public CollectionDataAccess	getCollectionRegionAccess(NavigableRole collectionRole) Implements org.hibernate.cache.spi.CacheImplementor.getCollectionRegionAccess. Deprecated Find the cache data access strategy for the given collection.
public QueryResultsCache	getDefaultQueryResultsCache() Implements org.hibernate.cache.spi.CacheImplementor.getDefaultQueryResultsCache. Access to the "default" region used to store query results when caching was requested but no region was explicitly named.
public CacheKeysFactory	getEnforcedCacheKeysFactory() Implements org.hibernate.cache.cfg.spi.DomainDataRegionBuildingContext.getEnforcedCacheKeysFactory. The `CacheKeysFactory` explicitly specified as part of the bootstrap by the user, by some "container", etc. If this method returns a non-null value, it is expected that `RegionFactory` implementors will use to be its `CacheKeysFactory` and return it when asked later.
public EntityDataAccess	getEntityRegionAccess(NavigableRole The NavigableRole representation of the root entity rootEntityName) Implements org.hibernate.cache.spi.CacheImplementor.getEntityRegionAccess. Deprecated Find the cache data access strategy for an entity.
public NaturalIdDataAccess	getNaturalIdCacheRegionAccessStrategy(NavigableRole The NavigableRole representation of the root entity rootEntityName) Implements org.hibernate.cache.spi.CacheImplementor.getNaturalIdCacheRegionAccessStrategy. Deprecated Find the cache data access strategy for the given entity's natural-id cache.
public QueryResultsCache	getQueryResultsCache(String regionName) Implements org.hibernate.cache.spi.CacheImplementor.getQueryResultsCache. Get query cache by `region name` or create a new one if none exist.
public QueryResultsCache	getQueryResultsCacheStrictly(String regionName) Implements org.hibernate.cache.spi.CacheImplementor.getQueryResultsCacheStrictly. Get the named QueryResultRegionAccess but not creating one if it does not already exist.
public Region	getRegion(String regionName) Implements org.hibernate.cache.spi.CacheImplementor.getRegion. Get a cache Region by name.
public RegionFactory	getRegionFactory() Implements org.hibernate.cache.spi.CacheImplementor.getRegionFactory. The underlying RegionFactory in use.
public SessionFactoryImplementor	getSessionFactory() Implements org.hibernate.cache.spi.CacheImplementor.getSessionFactory, org.hibernate.cache.cfg.spi.DomainDataRegionBuildingContext.getSessionFactory. Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. Access to the SessionFactory for which a Region is being built.
public TimestampsCache	getTimestampsCache() Implements org.hibernate.cache.spi.CacheImplementor.getTimestampsCache. Find the cache data access strategy for Hibernate's timestamps cache.
protected QueryResultsRegion	makeQueryResultsRegion(String regionName)
protected QueryResultsCache	makeQueryResultsRegionAccess(String regionName)
public void	prime(Set<DomainDataRegionConfig> cacheRegionConfigs) Implements org.hibernate.cache.spi.CacheImplementor.prime. An initialization phase allowing the caching provider to prime itself from the passed configs
public <T> T	unwrap(Class<T> the class of the object to be returned. This is normally either the underlying Cache implementation class or an interface that it implements. cls) Implements jakarta.persistence.Cache.unwrap. Return an object of the specified type to allow access to the provider-specific API.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

collectionAccessMap	back to summary
private final Map<NavigableRole, CollectionDataAccess> collectionAccessMap

defaultQueryResultsCache	back to summary
private final QueryResultsCache defaultQueryResultsCache

entityAccessMap	back to summary
private final Map<NavigableRole, EntityDataAccess> entityAccessMap

legacyNaturalIdAccessesForRegion	back to summary
private final Map<String, Set<NaturalIdDataAccess>> legacyNaturalIdAccessesForRegion

legacySecondLevelCacheNames	back to summary
private final Set<String> legacySecondLevelCacheNames

LOG	back to summary
private static final CoreMessageLogger LOG

namedQueryResultsCacheMap	back to summary
private final Map<String, QueryResultsCache> namedQueryResultsCacheMap

naturalIdAccessMap	back to summary
private final Map<NavigableRole, NaturalIdDataAccess> naturalIdAccessMap

queryResultsRegionsByDuplicateName	back to summary
private final Map<String, QueryResultsRegion> queryResultsRegionsByDuplicateName

regionFactory	back to summary
private final RegionFactory regionFactory

regionsByName	back to summary
private final Map<String, Region> regionsByName

sessionFactory	back to summary
private final SessionFactoryImplementor sessionFactory Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information.

timestampsCache	back to summary
private final TimestampsCache timestampsCache

EnabledCaching	back to summary
public EnabledCaching(SessionFactoryImplementor sessionFactory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information.

Method Detail

close	back to summary
public void close() Implements org.hibernate.cache.spi.CacheImplementor.close. Doc from org.hibernate.cache.spi.CacheImplementor.close. Close this "cache", releasing all underlying resources. Annotations @Override

back to summary

public void close()

Implements org.hibernate.cache.spi.CacheImplementor.close.

Doc from org.hibernate.cache.spi.CacheImplementor.close.

Close this "cache", releasing all underlying resources.

Annotations

@Override

contains	back to summary
public boolean contains(Class<T> cls, Object primaryKey) Implements jakarta.persistence.Cache.contains. Doc from jakarta.persistence.Cache.contains. Whether the cache contains data for the given entity. Parameters cls:Class<T> entity class primaryKey:Object primary key Returns:boolean boolean indicating whether the entity is in the cache Annotations @Override

contains

back to summary

public boolean contains(Class<T> cls, Object primaryKey)

Implements jakarta.persistence.Cache.contains.

Doc from jakarta.persistence.Cache.contains.

Whether the cache contains data for the given entity.

Parameters

cls:Class<T>: entity class
primaryKey:Object: primary key

Returns:boolean

boolean indicating whether the entity is in the cache

Annotations

@Override

containsCollection back to summary

containsCollection	back to summary
public boolean containsCollection(String role, Object ownerIdentifier) Implements org.hibernate.Cache.containsCollection. Doc from org.hibernate.Cache.containsCollection. Determine whether the cache contains an item for the collection with the given role and given identifier. Parameters role:String The name of the collection role in the form `package.OwnerEntityName.collectionPropertyName` ownerIdentifier:Object The identifier of the owning entity Returns:boolean True if the underlying cache contains corresponding data; false otherwise. Annotations @Override

public boolean containsCollection(String role, Object ownerIdentifier)

Implements org.hibernate.Cache.containsCollection.

Doc from org.hibernate.Cache.containsCollection.

Determine whether the cache contains an item for the collection with the given role and given identifier.

Parameters

role:String: The name of the collection role in the form package.OwnerEntityName.collectionPropertyName
ownerIdentifier:Object: The identifier of the owning entity

Returns:boolean

True if the underlying cache contains corresponding data; false otherwise.

Annotations

@Override

containsEntity	back to summary
public boolean containsEntity(Class<?> entityClass, Object identifier) Implements org.hibernate.Cache.containsEntity. Doc from org.hibernate.Cache.containsEntity. Determine whether the cache contains an item for the entity of the given type, and with the given identifier. Parameters entityClass:Class<?> The entity type identifier:Object The entity identifier Returns:boolean True if the underlying cache contains corresponding data; false otherwise. Annotations @Override

containsEntity

back to summary

public boolean containsEntity(Class<?> entityClass, Object identifier)

Implements org.hibernate.Cache.containsEntity.

Doc from org.hibernate.Cache.containsEntity.

Determine whether the cache contains an item for the entity of the given type, and with the given identifier.

Parameters

entityClass:Class<?>: The entity type
identifier:Object: The entity identifier

Returns:boolean

True if the underlying cache contains corresponding data; false otherwise.

Annotations

@Override

containsEntity	back to summary
public boolean containsEntity(String entityName, Object identifier) Implements org.hibernate.Cache.containsEntity. Doc from org.hibernate.Cache.containsEntity. Determine whether the cache contains an item for the entity of the type with the given name, and with the given identifier. Parameters entityName:String The entity name identifier:Object The entity identifier Returns:boolean True if the underlying cache contains corresponding data; false otherwise. Annotations @Override

containsEntity

back to summary

public boolean containsEntity(String entityName, Object identifier)

Implements org.hibernate.Cache.containsEntity.

Doc from org.hibernate.Cache.containsEntity.

Determine whether the cache contains an item for the entity of the type with the given name, and with the given identifier.

Parameters

entityName:String: The entity name
identifier:Object: The entity identifier

Returns:boolean

True if the underlying cache contains corresponding data; false otherwise.

Annotations

@Override

containsQuery	back to summary
public boolean containsQuery(String regionName) Implements org.hibernate.Cache.containsQuery. Doc from org.hibernate.Cache.containsQuery. Determine whether the given region name contains cached query results. Parameters regionName:String The name of a cache region to which some query is assigned Returns:boolean True if the underlying cache contains corresponding data; false otherwise. Annotations @Override

containsQuery

back to summary

public boolean containsQuery(String regionName)

Implements org.hibernate.Cache.containsQuery.

Doc from org.hibernate.Cache.containsQuery.

Determine whether the given region name contains cached query results.

Parameters

regionName:String: The name of a cache region to which some query is assigned

Returns:boolean

True if the underlying cache contains corresponding data; false otherwise.

Annotations

@Override

evict	back to summary
public void evict(Class<T> cls, Object primaryKey) Implements jakarta.persistence.Cache.evict. Doc from jakarta.persistence.Cache.evict. Remove the data for the given entity from the cache. Parameters cls:Class<T> entity class primaryKey:Object primary key Annotations @Override

evict

back to summary

public void evict(Class<T> cls, Object primaryKey)

Implements jakarta.persistence.Cache.evict.

Doc from jakarta.persistence.Cache.evict.

Remove the data for the given entity from the cache.

Parameters

cls:Class<T>: entity class
primaryKey:Object: primary key

Annotations

@Override

evict	back to summary
public void evict(Class<T> cls) Implements jakarta.persistence.Cache.evict. Doc from jakarta.persistence.Cache.evict. Remove the data for entities of the specified class (and its subclasses) from the cache. Parameters cls:Class<T> entity class Annotations @Override

evict

back to summary

public void evict(Class<T> cls)

Implements jakarta.persistence.Cache.evict.

Doc from jakarta.persistence.Cache.evict.

Remove the data for entities of the specified class (and its subclasses) from the cache.

Parameters

cls:Class<T>: entity class

Annotations

@Override

evictCollectionData back to summary

evictCollectionData	back to summary
public void evictCollectionData(String role, Object ownerIdentifier) Implements org.hibernate.Cache.evictCollectionData. Doc from org.hibernate.Cache.evictCollectionData. Evict the cached item for the collection with the given role and given identifier, if there is any such item in the cache. Parameters role:String The name of the collection role in the form `package.OwnerEntityName.collectionPropertyName` ownerIdentifier:Object The identifier of the owning entity Annotations @Override

public void evictCollectionData(String role, Object ownerIdentifier)

Implements org.hibernate.Cache.evictCollectionData.

Doc from org.hibernate.Cache.evictCollectionData.

Evict the cached item for the collection with the given role and given identifier, if there is any such item in the cache.

Parameters

role:String: The name of the collection role in the form package.OwnerEntityName.collectionPropertyName
ownerIdentifier:Object: The identifier of the owning entity

Annotations

@Override

evictCollectionData back to summary

evictCollectionData	back to summary
public void evictCollectionData(String role) Implements org.hibernate.Cache.evictCollectionData. Doc from org.hibernate.Cache.evictCollectionData. Evict all cached data from the cache region to which the given collection role is assigned. Parameters role:String The name of the collection role in the form `package.OwnerEntityName.collectionPropertyName` Annotations @Override

public void evictCollectionData(String role)

Implements org.hibernate.Cache.evictCollectionData.

Doc from org.hibernate.Cache.evictCollectionData.

Evict all cached data from the cache region to which the given collection role is assigned.

Parameters

role:String: The name of the collection role in the form package.OwnerEntityName.collectionPropertyName

Annotations

@Override

evictCollectionData	back to summary
private void evictCollectionData(CollectionPersister collectionDescriptor)

evictCollectionData	back to summary
private void evictCollectionData(NavigableRole navigableRole, CollectionDataAccess cacheAccess)

evictCollectionData	back to summary
public void evictCollectionData() Implements org.hibernate.Cache.evictCollectionData. Doc from org.hibernate.Cache.evictCollectionData. Evict all cache data from every cache region to which some collection role is assigned. Annotations @Override

evictCollectionData

back to summary

public void evictCollectionData()

Implements org.hibernate.Cache.evictCollectionData.

Doc from org.hibernate.Cache.evictCollectionData.

Evict all cache data from every cache region to which some collection role is assigned.

Annotations

@Override

evictDefaultQueryRegion	back to summary
public void evictDefaultQueryRegion() Implements org.hibernate.Cache.evictDefaultQueryRegion. Doc from org.hibernate.Cache.evictDefaultQueryRegion. Evict all cached query results from the default region. Annotations @Override

evictDefaultQueryRegion

back to summary

public void evictDefaultQueryRegion()

Implements org.hibernate.Cache.evictDefaultQueryRegion.

Doc from org.hibernate.Cache.evictDefaultQueryRegion.

Evict all cached query results from the default region.

Annotations

@Override

evictEntityData	back to summary
public void evictEntityData(Class<?> entityClass, Object identifier) Implements org.hibernate.Cache.evictEntityData. Doc from org.hibernate.Cache.evictEntityData. Evicts the cached item for the entity of the given type, and with the given identifier, if there is any such item in the cache. Parameters entityClass:Class<?> The entity type identifier:Object The entity identifier Annotations @Override

evictEntityData

back to summary

public void evictEntityData(Class<?> entityClass, Object identifier)

Implements org.hibernate.Cache.evictEntityData.

Doc from org.hibernate.Cache.evictEntityData.

Evicts the cached item for the entity of the given type, and with the given identifier, if there is any such item in the cache.

Parameters

entityClass:Class<?>: The entity type
identifier:Object: The entity identifier

Annotations

@Override

evictEntityData	back to summary
public void evictEntityData(String entityName, Object identifier) Implements org.hibernate.Cache.evictEntityData. Doc from org.hibernate.Cache.evictEntityData. Evict the cached item for the entity of the type with the given name, and with the given identifier, if there is any such item in the cache. Parameters entityName:String The entity name identifier:Object The entity identifier Annotations @Override

evictEntityData

back to summary

public void evictEntityData(String entityName, Object identifier)

Implements org.hibernate.Cache.evictEntityData.

Doc from org.hibernate.Cache.evictEntityData.

Evict the cached item for the entity of the type with the given name, and with the given identifier, if there is any such item in the cache.

Parameters

entityName:String: The entity name
identifier:Object: The entity identifier

Annotations

@Override

evictEntityData	back to summary
public void evictEntityData(Class<?> entityClass) Implements org.hibernate.Cache.evictEntityData. Doc from org.hibernate.Cache.evictEntityData. Evict all cached data from the cache region to which the given entity type is assigned. Thus, every cached item for the given entity type will be evicted, along with any cached items for any other entity type assigned to the same cache region. Parameters entityClass:Class<?> The entity type Annotations @Override

evictEntityData

back to summary

public void evictEntityData(Class<?> entityClass)

Implements org.hibernate.Cache.evictEntityData.

Doc from org.hibernate.Cache.evictEntityData.

Evict all cached data from the cache region to which the given entity type is assigned. Thus, every cached item for the given entity type will be evicted, along with any cached items for any other entity type assigned to the same cache region.

Parameters

entityClass:Class<?>: The entity type

Annotations

@Override

evictEntityData	back to summary
public void evictEntityData(String entityName) Implements org.hibernate.Cache.evictEntityData. Doc from org.hibernate.Cache.evictEntityData. Evict all cached data from the cache region to which the given named entity type is assigned. Thus, every cached item for the given entity type will be evicted, along with any cached items for any other entity type assigned to the same cache region. Parameters entityName:String The entity name Annotations @Override

evictEntityData

back to summary

public void evictEntityData(String entityName)

Implements org.hibernate.Cache.evictEntityData.

Doc from org.hibernate.Cache.evictEntityData.

Evict all cached data from the cache region to which the given named entity type is assigned. Thus, every cached item for the given entity type will be evicted, along with any cached items for any other entity type assigned to the same cache region.

Parameters

entityName:String: The entity name

Annotations

@Override

evictEntityData	back to summary
protected void evictEntityData(EntityPersister entityDescriptor)

evictEntityData	back to summary
private void evictEntityData(NavigableRole navigableRole, EntityDataAccess cacheAccess)

evictEntityData	back to summary
public void evictEntityData() Implements org.hibernate.Cache.evictEntityData. Doc from org.hibernate.Cache.evictEntityData. Evict all cached data from every cache region to which any entity type is assigned. Annotations @Override

evictEntityData

back to summary

public void evictEntityData()

Implements org.hibernate.Cache.evictEntityData.

Doc from org.hibernate.Cache.evictEntityData.

Evict all cached data from every cache region to which any entity type is assigned.

Annotations

@Override

evictNaturalIdData	back to summary
public void evictNaturalIdData(Class<?> entityClass) Implements org.hibernate.Cache.evictNaturalIdData. Doc from org.hibernate.Cache.evictNaturalIdData. Evict all cached natural id mappings for the given entity type. Parameters entityClass:Class<?> The entity type Annotations @Override

evictNaturalIdData

back to summary

public void evictNaturalIdData(Class<?> entityClass)

Implements org.hibernate.Cache.evictNaturalIdData.

Doc from org.hibernate.Cache.evictNaturalIdData.

Evict all cached natural id mappings for the given entity type.

Parameters

entityClass:Class<?>: The entity type

Annotations

@Override

evictNaturalIdData	back to summary
public void evictNaturalIdData(String entityName) Implements org.hibernate.Cache.evictNaturalIdData. Doc from org.hibernate.Cache.evictNaturalIdData. Evict all cached natural id mappings for the entity type with the given name. Parameters entityName:String The entity name Annotations @Override

evictNaturalIdData

back to summary

public void evictNaturalIdData(String entityName)

Implements org.hibernate.Cache.evictNaturalIdData.

Doc from org.hibernate.Cache.evictNaturalIdData.

Evict all cached natural id mappings for the entity type with the given name.

Parameters

entityName:String: The entity name

Annotations

@Override

evictNaturalIdData	back to summary
private void evictNaturalIdData(EntityPersister rootEntityDescriptor)

evictNaturalIdData	back to summary
public void evictNaturalIdData() Implements org.hibernate.Cache.evictNaturalIdData. Doc from org.hibernate.Cache.evictNaturalIdData. Evict all cached natural id mappings for every entity type. Annotations @Override

evictNaturalIdData

back to summary

public void evictNaturalIdData()

Implements org.hibernate.Cache.evictNaturalIdData.

Doc from org.hibernate.Cache.evictNaturalIdData.

Evict all cached natural id mappings for every entity type.

Annotations

@Override

evictNaturalIdData	back to summary
private void evictNaturalIdData(NavigableRole rootEntityRole, NaturalIdDataAccess cacheAccess)

evictQueryRegion	back to summary
public void evictQueryRegion(String regionName) Implements org.hibernate.Cache.evictQueryRegion. Doc from org.hibernate.Cache.evictQueryRegion. Evict all cached query results from the region with the given name. Parameters regionName:String The cache name associated to the queries being cached. Annotations @Override

evictQueryRegion

back to summary

public void evictQueryRegion(String regionName)

Implements org.hibernate.Cache.evictQueryRegion.

Doc from org.hibernate.Cache.evictQueryRegion.

Evict all cached query results from the region with the given name.

Parameters

regionName:String: The cache name associated to the queries being cached.

Annotations

@Override

evictQueryRegions	back to summary
public void evictQueryRegions() Implements org.hibernate.Cache.evictQueryRegions. Doc from org.hibernate.Cache.evictQueryRegions. Evict all cached query results from every region. Annotations @Override

evictQueryRegions

back to summary

public void evictQueryRegions()

Implements org.hibernate.Cache.evictQueryRegions.

Doc from org.hibernate.Cache.evictQueryRegions.

Evict all cached query results from every region.

Annotations

@Override

evictQueryResultRegion	back to summary
private void evictQueryResultRegion(QueryResultsCache cache)

evictRegion	back to summary
public void evictRegion(String regionName) Implements org.hibernate.Cache.evictRegion. Doc from org.hibernate.Cache.evictRegion. Evict all cached data from the named cache region. Annotations @Override

evictRegion

back to summary

public void evictRegion(String regionName)

Implements org.hibernate.Cache.evictRegion.

Doc from org.hibernate.Cache.evictRegion.

Evict all cached data from the named cache region.

Annotations

@Override

getCacheRegionNames back to summary

getCacheRegionNames	back to summary
public Set<String> getCacheRegionNames() Implements org.hibernate.cache.spi.CacheImplementor.getCacheRegionNames. Doc from org.hibernate.cache.spi.CacheImplementor.getCacheRegionNames. The unqualified name of all regions. Intended for use with `getRegion` Annotations @Override

public Set<String> getCacheRegionNames()

Implements org.hibernate.cache.spi.CacheImplementor.getCacheRegionNames.

Doc from org.hibernate.cache.spi.CacheImplementor.getCacheRegionNames.

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

Annotations

@Override

getCollectionRegionAccess back to summary

getCollectionRegionAccess	back to summary
public CollectionDataAccess getCollectionRegionAccess(NavigableRole collectionRole) Implements org.hibernate.cache.spi.CacheImplementor.getCollectionRegionAccess. Doc from org.hibernate.cache.spi.CacheImplementor.getCollectionRegionAccess. Deprecated Find the cache data access strategy for the given collection. Will return `null` when the collection is not configured for caching. Annotations @Override @Deprecated

public CollectionDataAccess getCollectionRegionAccess(NavigableRole collectionRole)

Implements org.hibernate.cache.spi.CacheImplementor.getCollectionRegionAccess.

Doc from org.hibernate.cache.spi.CacheImplementor.getCollectionRegionAccess.

Deprecated

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

Annotations

@Override
@Deprecated

getDefaultQueryResultsCache back to summary

getDefaultQueryResultsCache	back to summary
public QueryResultsCache getDefaultQueryResultsCache() Implements org.hibernate.cache.spi.CacheImplementor.getDefaultQueryResultsCache. Doc from org.hibernate.cache.spi.CacheImplementor.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 Annotations @Override

public QueryResultsCache getDefaultQueryResultsCache()

Implements org.hibernate.cache.spi.CacheImplementor.getDefaultQueryResultsCache.

Doc from org.hibernate.cache.spi.CacheImplementor.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

Annotations

@Override

getEnforcedCacheKeysFactory back to summary

public CacheKeysFactory getEnforcedCacheKeysFactory()

Implements org.hibernate.cache.cfg.spi.DomainDataRegionBuildingContext.getEnforcedCacheKeysFactory.

Doc from org.hibernate.cache.cfg.spi.DomainDataRegionBuildingContext.getEnforcedCacheKeysFactory.

The CacheKeysFactory explicitly specified as part of the bootstrap by the user, by some "container", etc. If this method returns a non-null value, it is expected that RegionFactory implementors will use to be its CacheKeysFactory and return it when asked later.

Annotations

@Override

getEntityRegionAccess back to summary

public EntityDataAccess getEntityRegionAccess(NavigableRole rootEntityName)

Implements org.hibernate.cache.spi.CacheImplementor.getEntityRegionAccess.

Doc from org.hibernate.cache.spi.CacheImplementor.getEntityRegionAccess.

Deprecated

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

Parameters

rootEntityName:NavigableRole: The NavigableRole representation of the root entity

Annotations

@Override
@Deprecated

getNaturalIdCacheRegionAccessStrategy back to summary

public NaturalIdDataAccess getNaturalIdCacheRegionAccessStrategy(NavigableRole rootEntityName)

Implements org.hibernate.cache.spi.CacheImplementor.getNaturalIdCacheRegionAccessStrategy.

Doc from org.hibernate.cache.spi.CacheImplementor.getNaturalIdCacheRegionAccessStrategy.

Deprecated

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.

Parameters

rootEntityName:NavigableRole: The NavigableRole representation of the root entity

Annotations

@Override
@Deprecated

getQueryResultsCache back to summary

public QueryResultsCache getQueryResultsCache(String regionName) throws HibernateException

Implements org.hibernate.cache.spi.CacheImplementor.getQueryResultsCache.

Doc from org.hibernate.cache.spi.CacheImplementor.getQueryResultsCache.

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

Annotations

@Override

getQueryResultsCacheStrictly back to summary

public QueryResultsCache getQueryResultsCacheStrictly(String regionName)

Implements org.hibernate.cache.spi.CacheImplementor.getQueryResultsCacheStrictly.

Doc from org.hibernate.cache.spi.CacheImplementor.getQueryResultsCacheStrictly.

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

Annotations

@Override

getRegion back to summary

public Region getRegion(String regionName)

Implements org.hibernate.cache.spi.CacheImplementor.getRegion.

Doc from org.hibernate.cache.spi.CacheImplementor.getRegion.

Get a cache Region by name. If there is both a DomainDataRegion and a QueryResultsRegion with the specified name, then the DomainDataRegion will be returned.

Annotations

@Override

getRegionFactory

back to summary

public RegionFactory getRegionFactory()

Implements org.hibernate.cache.spi.CacheImplementor.getRegionFactory.

Doc from org.hibernate.cache.spi.CacheImplementor.getRegionFactory.

The underlying RegionFactory in use.

Annotations

@Override

getSessionFactory back to summary

public SessionFactoryImplementor getSessionFactory()

Implements org.hibernate.cache.spi.CacheImplementor.getSessionFactory, org.hibernate.cache.cfg.spi.DomainDataRegionBuildingContext.getSessionFactory.

Doc from org.hibernate.cache.cfg.spi.DomainDataRegionBuildingContext.getSessionFactory.

Deprecated

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

Access to the SessionFactory for which a Region is being built.

Returns:SessionFactoryImplementor

Doc from org.hibernate.Cache.getSessionFactory.

The SessionFactory

Annotations

@Override

getTimestampsCache back to summary

public TimestampsCache getTimestampsCache()

Implements org.hibernate.cache.spi.CacheImplementor.getTimestampsCache.

Doc from org.hibernate.cache.spi.CacheImplementor.getTimestampsCache.

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

Annotations

@Override

makeQueryResultsRegion	back to summary
protected QueryResultsRegion makeQueryResultsRegion(String regionName)

makeQueryResultsRegionAccess	back to summary
protected QueryResultsCache makeQueryResultsRegionAccess(String regionName)

prime

back to summary

public void prime(Set<DomainDataRegionConfig> cacheRegionConfigs)

Implements org.hibernate.cache.spi.CacheImplementor.prime.

Doc from org.hibernate.cache.spi.CacheImplementor.prime.

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

Annotations

@Override

unwrap

back to summary

public <T> T unwrap(Class<T> cls)

Implements jakarta.persistence.Cache.unwrap.

Doc from jakarta.persistence.Cache.unwrap.

Return an object of the specified type to allow access to the provider-specific API. If the provider's Cache implementation does not support the specified class, the PersistenceException is thrown.

Parameters

cls:Class<T>: the class of the object to be returned. This is normally either the underlying Cache implementation class or an interface that it implements.

Returns:T

an instance of the specified class

Annotations

@Override
@SuppressWarnings:unchecked

public Class EnabledCaching

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail