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

Modifier and Type	Field and Description
private final Map<NavigableRole, CollectionDataAccess>	collectionAccessMap
private final QueryResultsCache	defaultQueryResultsCache Deprecated as a consequence of `QueryResultsCache` being deprecated.
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 Deprecated as a consequence of `TimestampsCache` being deprecated.

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 javax.persistence.Cache.contains. Whether the cache contains data for the given entity.
public boolean	containsCollection(String The name of the collection role (in form [owner-entity-name].[collection-property-name]) whose regions should be evicted. role, Serializable The identifier of the owning entity ownerIdentifier) Implements org.hibernate.Cache.containsCollection. Determine whether the cache contains data for the given collection.
public boolean	containsEntity(Class<T> The entity class. entityClass, Serializable The entity identifier identifier) Implements org.hibernate.Cache.containsEntity. Determine whether the cache contains data for the given entity "instance".
public boolean	containsEntity(String The entity name. entityName, Serializable The entity identifier identifier) Implements org.hibernate.Cache.containsEntity. Determine whether the cache contains data for the given entity "instance".
public boolean	containsQuery(String The cache name given to the query. regionName) Implements org.hibernate.Cache.containsQuery. Determine whether the cache contains data for the given query.
public void	evict(Class<T> entity class cls, Object primary key primaryKey) Implements javax.persistence.Cache.evict. Remove the data for the given entity from the cache.
public void	evict(Class<T> entity class cls) Implements javax.persistence.Cache.evict. Remove the data for entities of the specified class (and its subclasses) from the cache.
public void	evictCollectionData(String The "collection role" (in form [owner-entity-name].[collection-property-name]). role, Serializable The identifier of the owning entity ownerIdentifier) Implements org.hibernate.Cache.evictCollectionData. Evicts the cache data for the given identified collection "instance"
public void	evictCollectionData(String The "collection role" (in form [owner-entity-name].[collection-property-name]). role) Implements org.hibernate.Cache.evictCollectionData. Evicts cached data for the given collection role
private void	evictCollectionData(CollectionPersister collectionDescriptor)
private void	evictCollectionData(NavigableRole navigableRole, CollectionDataAccess cacheAccess)
public void	evictCollectionData() Implements org.hibernate.Cache.evictCollectionData. Evict cache data for all collections
public void	evictDefaultQueryRegion() Implements org.hibernate.Cache.evictDefaultQueryRegion. Evicts all cached query results from the default region.
public void	evictEntityData(Class<T> The entity class. entityClass, Serializable The entity identifier identifier) Implements org.hibernate.Cache.evictEntityData. Evicts the entity data for a particular entity "instance".
public void	evictEntityData(String The entity name. entityName, Serializable The entity identifier identifier) Implements org.hibernate.Cache.evictEntityData. Evicts the entity data for a particular entity "instance".
public void	evictEntityData(Class<T> The entity class. entityClass) Implements org.hibernate.Cache.evictEntityData. Evicts all entity data from the given region (i.e. for all entities of type).
public void	evictEntityData(String The entity name. entityName) Implements org.hibernate.Cache.evictEntityData. Evicts all entity data from the given region (i.e. for all entities of type).
protected void	evictEntityData(EntityPersister entityDescriptor)
private void	evictEntityData(NavigableRole navigableRole, EntityDataAccess cacheAccess)
public void	evictEntityData() Implements org.hibernate.Cache.evictEntityData. Evict data from all entity regions.
public void	evictNaturalIdData(Class<T> The entity class. entityClass) Implements org.hibernate.Cache.evictNaturalIdData. Evict cached data for the given entity's natural-id
public void	evictNaturalIdData(String The entity name. entityName) Implements org.hibernate.Cache.evictNaturalIdData. Evict cached data for the given entity's natural-id
private void	evictNaturalIdData(EntityPersister rootEntityDescriptor)
public void	evictNaturalIdData() Implements org.hibernate.Cache.evictNaturalIdData. Evict cached data for all natural-ids (for all entities)
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. Evicts all cached query results under the given name.
public void	evictQueryRegions() Implements org.hibernate.Cache.evictQueryRegions. Evict data from all query regions.
private void	evictQueryResultRegion(QueryResultsCache cache) Deprecated as a consequence of `QueryResultsCache` being deprecated.
public void	evictRegion(String regionName) Implements org.hibernate.Cache.evictRegion. Evict all 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. Find the cache data access strategy for the given collection.
public QueryResultsCache	getDefaultQueryResultsCache() Implements org.hibernate.cache.spi.CacheImplementor.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 CacheKeysFactory	getEnforcedCacheKeysFactory() Implements org.hibernate.cache.cfg.spi.DomainDataRegionBuildingContext.getEnforcedCacheKeysFactory. The CacheKeyFactory 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 CacheKeyFactory 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. Find the cache data access strategy for an entity.
public Set<NaturalIdDataAccess>	getNaturalIdAccessesInRegion(String regionName) Implements org.hibernate.cache.spi.CacheImplementor.getNaturalIdAccessesInRegion.
public NaturalIdDataAccess	getNaturalIdCacheRegionAccessStrategy(NavigableRole The NavigableRole representation of the root entity rootEntityName) Implements org.hibernate.cache.spi.CacheImplementor.getNaturalIdCacheRegionAccessStrategy. 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. 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) Implements org.hibernate.cache.spi.CacheImplementor.getQueryResultsCacheStrictly. 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) 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 String[]	getSecondLevelCacheRegionNames() Implements org.hibernate.cache.spi.CacheImplementor.getSecondLevelCacheRegionNames. Get the qualified names of all regions caching entity and collection data.
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. Deprecated as a consequence of `TimestampsCache` being deprecated. Find the cache data access strategy for Hibernate's timestamps cache.
protected QueryResultsRegion	makeQueryResultsRegion(String regionName)
protected QueryResultsCache	makeQueryResultsRegionAccess(String regionName) Deprecated as a consequence of `QueryResultsCache` being deprecated.
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 javax.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 Deprecated as a consequence of `QueryResultsCache` being deprecated. See corresponding docs for further information.

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 Deprecated as a consequence of `TimestampsCache` being deprecated. See corresponding docs for further information.

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 javax.persistence.Cache.contains. Doc from javax.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 javax.persistence.Cache.contains.

Doc from javax.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
public boolean containsCollection(String role, Serializable ownerIdentifier) Implements org.hibernate.Cache.containsCollection. Doc from org.hibernate.Cache.containsCollection. Determine whether the cache contains data for the given collection. The semantic here is whether the cache contains data visible for the current call context. Parameters role:String The name of the collection role (in form [owner-entity-name].[collection-property-name]) whose regions should be evicted. ownerIdentifier:Serializable The identifier of the owning entity Returns:boolean True if the underlying cache contains corresponding data; false otherwise. Annotations @Override

containsCollection

back to summary

public boolean containsCollection(String role, Serializable ownerIdentifier)

Implements org.hibernate.Cache.containsCollection.

Doc from org.hibernate.Cache.containsCollection.

Determine whether the cache contains data for the given collection.

The semantic here is whether the cache contains data visible for the current call context.

Parameters

role:String: The name of the collection role (in form [owner-entity-name].[collection-property-name]) whose regions should be evicted.
ownerIdentifier:Serializable: 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<T> entityClass, Serializable identifier) Implements org.hibernate.Cache.containsEntity. Doc from org.hibernate.Cache.containsEntity. Determine whether the cache contains data for the given entity "instance". The semantic here is whether the cache contains data visible for the current call context. Parameters entityClass:Class<T> The entity class. identifier:Serializable 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<T> entityClass, Serializable identifier)

Implements org.hibernate.Cache.containsEntity.

Doc from org.hibernate.Cache.containsEntity.

Determine whether the cache contains data for the given entity "instance".

The semantic here is whether the cache contains data visible for the current call context.

Parameters

entityClass:Class<T>: The entity class.
identifier:Serializable: 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, Serializable identifier) Implements org.hibernate.Cache.containsEntity. Doc from org.hibernate.Cache.containsEntity. Determine whether the cache contains data for the given entity "instance". The semantic here is whether the cache contains data visible for the current call context. Parameters entityName:String The entity name. identifier:Serializable 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, Serializable identifier)

Implements org.hibernate.Cache.containsEntity.

Doc from org.hibernate.Cache.containsEntity.

Determine whether the cache contains data for the given entity "instance".

The semantic here is whether the cache contains data visible for the current call context.

Parameters

entityName:String: The entity name.
identifier:Serializable: 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 cache contains data for the given query. The semantic here is whether the cache contains any data for the given region name since query result caches are not transactionally isolated. Parameters regionName:String The cache name given to the query. 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 cache contains data for the given query.

The semantic here is whether the cache contains any data for the given region name since query result caches are not transactionally isolated.

Parameters

regionName:String: The cache name given to the query.

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 javax.persistence.Cache.evict. Doc from javax.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 javax.persistence.Cache.evict.

Doc from javax.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 javax.persistence.Cache.evict. Doc from javax.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 javax.persistence.Cache.evict.

Doc from javax.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
public void evictCollectionData(String role, Serializable ownerIdentifier) Implements org.hibernate.Cache.evictCollectionData. Doc from org.hibernate.Cache.evictCollectionData. Evicts the cache data for the given identified collection "instance" Parameters role:String The "collection role" (in form [owner-entity-name].[collection-property-name]). ownerIdentifier:Serializable The identifier of the owning entity Annotations @Override

evictCollectionData

back to summary

public void evictCollectionData(String role, Serializable ownerIdentifier)

Implements org.hibernate.Cache.evictCollectionData.

Doc from org.hibernate.Cache.evictCollectionData.

Evicts the cache data for the given identified collection "instance"

Parameters

role:String: The "collection role" (in form [owner-entity-name].[collection-property-name]).
ownerIdentifier:Serializable: The identifier of the owning entity

Annotations

@Override

evictCollectionData	back to summary
public void evictCollectionData(String role) Implements org.hibernate.Cache.evictCollectionData. Doc from org.hibernate.Cache.evictCollectionData. Evicts cached data for the given collection role Parameters role:String The "collection role" (in form [owner-entity-name].[collection-property-name]). Annotations @Override

evictCollectionData

back to summary

public void evictCollectionData(String role)

Implements org.hibernate.Cache.evictCollectionData.

Doc from org.hibernate.Cache.evictCollectionData.

Evicts cached data for the given collection role

Parameters

role:String: The "collection role" (in form [owner-entity-name].[collection-property-name]).

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 cache data for all collections Annotations @Override

evictCollectionData

back to summary

public void evictCollectionData()

Implements org.hibernate.Cache.evictCollectionData.

Doc from org.hibernate.Cache.evictCollectionData.

Evict cache data for all collections

Annotations

@Override

evictDefaultQueryRegion	back to summary
public void evictDefaultQueryRegion() Implements org.hibernate.Cache.evictDefaultQueryRegion. Doc from org.hibernate.Cache.evictDefaultQueryRegion. Evicts 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.

Evicts all cached query results from the default region.

Annotations

@Override

evictEntityData	back to summary
public void evictEntityData(Class<T> entityClass, Serializable identifier) Implements org.hibernate.Cache.evictEntityData. Doc from org.hibernate.Cache.evictEntityData. Evicts the entity data for a particular entity "instance". Parameters entityClass:Class<T> The entity class. identifier:Serializable The entity identifier Annotations @Override

evictEntityData

back to summary

public void evictEntityData(Class<T> entityClass, Serializable identifier)

Implements org.hibernate.Cache.evictEntityData.

Doc from org.hibernate.Cache.evictEntityData.

Evicts the entity data for a particular entity "instance".

Parameters

entityClass:Class<T>: The entity class.
identifier:Serializable: The entity identifier

Annotations

@Override

evictEntityData	back to summary
public void evictEntityData(String entityName, Serializable identifier) Implements org.hibernate.Cache.evictEntityData. Doc from org.hibernate.Cache.evictEntityData. Evicts the entity data for a particular entity "instance". Parameters entityName:String The entity name. identifier:Serializable The entity identifier Annotations @Override

evictEntityData

back to summary

public void evictEntityData(String entityName, Serializable identifier)

Implements org.hibernate.Cache.evictEntityData.

Doc from org.hibernate.Cache.evictEntityData.

Evicts the entity data for a particular entity "instance".

Parameters

entityName:String: The entity name.
identifier:Serializable: The entity identifier

Annotations

@Override

evictEntityData	back to summary
public void evictEntityData(Class<T> entityClass) Implements org.hibernate.Cache.evictEntityData. Doc from org.hibernate.Cache.evictEntityData. Evicts all entity data from the given region (i.e. for all entities of type). Parameters entityClass:Class<T> The entity class. Annotations @Override

evictEntityData

back to summary

public void evictEntityData(Class<T> entityClass)

Implements org.hibernate.Cache.evictEntityData.

Doc from org.hibernate.Cache.evictEntityData.

Evicts all entity data from the given region (i.e. for all entities of type).

Parameters

entityClass:Class<T>: The entity class.

Annotations

@Override

evictEntityData	back to summary
public void evictEntityData(String entityName) Implements org.hibernate.Cache.evictEntityData. Doc from org.hibernate.Cache.evictEntityData. Evicts all entity data from the given region (i.e. for all entities of type). 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.

Evicts all entity data from the given region (i.e. for all entities of type).

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 data from all entity regions. Annotations @Override

evictEntityData

back to summary

public void evictEntityData()

Implements org.hibernate.Cache.evictEntityData.

Doc from org.hibernate.Cache.evictEntityData.

Evict data from all entity regions.

Annotations

@Override

evictNaturalIdData	back to summary
public void evictNaturalIdData(Class<T> entityClass) Implements org.hibernate.Cache.evictNaturalIdData. Doc from org.hibernate.Cache.evictNaturalIdData. Evict cached data for the given entity's natural-id Parameters entityClass:Class<T> The entity class. Annotations @Override

evictNaturalIdData

back to summary

public void evictNaturalIdData(Class<T> entityClass)

Implements org.hibernate.Cache.evictNaturalIdData.

Doc from org.hibernate.Cache.evictNaturalIdData.

Evict cached data for the given entity's natural-id

Parameters

entityClass:Class<T>: The entity class.

Annotations

@Override

evictNaturalIdData	back to summary
public void evictNaturalIdData(String entityName) Implements org.hibernate.Cache.evictNaturalIdData. Doc from org.hibernate.Cache.evictNaturalIdData. Evict cached data for the given entity's natural-id 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 cached data for the given entity's natural-id

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 cached data for all natural-ids (for all entities) Annotations @Override

evictNaturalIdData

back to summary

public void evictNaturalIdData()

Implements org.hibernate.Cache.evictNaturalIdData.

Doc from org.hibernate.Cache.evictNaturalIdData.

Evict cached data for all natural-ids (for all entities)

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. Evicts all cached query results under 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.

Evicts all cached query results under 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 data from all query regions. Annotations @Override

evictQueryRegions

back to summary

public void evictQueryRegions()

Implements org.hibernate.Cache.evictQueryRegions.

Doc from org.hibernate.Cache.evictQueryRegions.

Evict data from all query regions.

Annotations

@Override

evictQueryResultRegion	back to summary
private void evictQueryResultRegion(QueryResultsCache cache) Deprecated as a consequence of `QueryResultsCache` being deprecated. See corresponding docs for further information.

evictRegion	back to summary
public void evictRegion(String regionName) Implements org.hibernate.Cache.evictRegion. Doc from org.hibernate.Cache.evictRegion. Evict all 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 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. Find the cache data access strategy for the given collection. Will return `null` when the collection is not configured for caching. Annotations @Override

public CollectionDataAccess getCollectionRegionAccess(NavigableRole collectionRole)

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

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

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

Annotations

@Override

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. 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 Annotations @Override

public QueryResultsCache getDefaultQueryResultsCache()

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

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

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

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

getNaturalIdAccessesInRegion

back to summary

public Set<NaturalIdDataAccess> getNaturalIdAccessesInRegion(String regionName)

Implements org.hibernate.cache.spi.CacheImplementor.getNaturalIdAccessesInRegion.

Annotations

@Override

getNaturalIdCacheRegionAccessStrategy back to summary

public NaturalIdDataAccess getNaturalIdCacheRegionAccessStrategy(NavigableRole rootEntityName)

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

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

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

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.

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

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.

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

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

getSecondLevelCacheRegionNames

back to summary

public String[] getSecondLevelCacheRegionNames()

Implements org.hibernate.cache.spi.CacheImplementor.getSecondLevelCacheRegionNames.

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

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

Returns:String[]

All cache region names

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.

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

Annotations

@Override

makeQueryResultsRegion	back to summary
protected QueryResultsRegion makeQueryResultsRegion(String regionName)

makeQueryResultsRegionAccess	back to summary
protected QueryResultsCache makeQueryResultsRegionAccess(String regionName) Deprecated as a consequence of `QueryResultsCache` being deprecated. See corresponding docs for further information.

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 javax.persistence.Cache.unwrap.

Doc from javax.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