org.hibernate.cache.internal

Class DisabledCaching

java.lang.Object

org.hibernate.cache.internal.DisabledCaching

All Implemented Interfaces:

Serializable, Cache, CacheImplementor, Service

public class DisabledCaching
extends Object
implements CacheImplementor

CacheImplementor implementation for disabled caching

Author:

Steve Ebersole

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DisabledCaching(SessionFactoryImplementor sessionFactory)

Method Summary

Modifier and Type	Method and Description
void	close() Close this "cache", releasing all underlying resources.
boolean	contains(Class cls, Object primaryKey) Whether the cache contains data for the given entity.
boolean	containsCollection(String role, Serializable ownerIdentifier) Determine whether the cache contains data for the given collection.
boolean	containsEntity(Class entityClass, Serializable identifier) Determine whether the cache contains data for the given entity "instance".
boolean	containsEntity(String entityName, Serializable identifier) Determine whether the cache contains data for the given entity "instance".
boolean	containsQuery(String regionName) Determine whether the cache contains data for the given query.
void	evict(Class cls) Remove the data for entities of the specified class (and its subclasses) from the cache.
void	evict(Class cls, Object primaryKey) Remove the data for the given entity from the cache.
void	evictCollectionData() Evict cache data for all collections
void	evictCollectionData(String role) Evicts cached data for the given collection role
void	evictCollectionData(String role, Serializable ownerIdentifier) Evicts the cache data for the given identified collection "instance"
void	evictDefaultQueryRegion() Evicts all cached query results from the default region.
void	evictEntityData() Evict data from all entity regions.
void	evictEntityData(Class entityClass) Evicts all entity data from the given region (i.e.
void	evictEntityData(Class entityClass, Serializable identifier) Evicts the entity data for a particular entity "instance".
void	evictEntityData(String entityName) Evicts all entity data from the given region (i.e.
void	evictEntityData(String entityName, Serializable identifier) Evicts the entity data for a particular entity "instance".
void	evictNaturalIdData() Evict cached data for all natural-ids (for all entities)
void	evictNaturalIdData(Class entityClass) Evict cached data for the given entity's natural-id
void	evictNaturalIdData(String entityName) Evict cached data for the given entity's natural-id
void	evictQueryRegion(String regionName) Evicts all cached query results under the given name.
void	evictQueryRegions() Evict data from all query regions.
void	evictRegion(String regionName) Evict all data from the named cache region
Set<String>	getCacheRegionNames() The unqualified name of all regions.
CollectionDataAccess	getCollectionRegionAccess(NavigableRole collectionRole) Find the cache data access strategy for the given collection.
QueryResultsCache	getDefaultQueryResultsCache() Access to the "default" region used to store query results when caching was requested but no region was explicitly named.
EntityDataAccess	getEntityRegionAccess(NavigableRole rootEntityName) Find the cache data access strategy for an entity.
Set<NaturalIdDataAccess>	getNaturalIdAccessesInRegion(String regionName)
NaturalIdDataAccess	getNaturalIdCacheRegionAccessStrategy(NavigableRole rootEntityName) Find the cache data access strategy for the given entity's natural-id cache.
QueryResultsCache	getQueryResultsCache(String regionName) Get query cache by region name or create a new one if none exist.
QueryResultsCache	getQueryResultsCacheStrictly(String regionName) Get the named QueryResultRegionAccess but not creating one if it does not already exist.
Region	getRegion(String fullRegionName) Get a cache Region by name
RegionFactory	getRegionFactory() The underlying RegionFactory in use.
String[]	getSecondLevelCacheRegionNames() Get the *qualified* names of all regions caching entity and collection data.
SessionFactoryImplementor	getSessionFactory() Access to the SessionFactory this Cache is bound to.
TimestampsCache	getTimestampsCache() Find the cache data access strategy for Hibernate's timestamps cache.
void	prime(Set<DomainDataRegionConfig> cacheRegionConfigs) An initialization phase allowing the caching provider to prime itself from the passed configs
<T> T	unwrap(Class<T> cls) Return an object of the specified type to allow access to the provider-specific API.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.cache.spi.CacheImplementor

evictQueries, getDefaultQueryCache, getQueryCache, getQueryCache, getRegionByLegacyName, getUpdateTimestampsCache, unqualifyRegionName

Methods inherited from interface org.hibernate.Cache

evictAll, evictAllRegions, evictCollection, evictCollectionRegion, evictCollectionRegions, evictEntity, evictEntity, evictEntityRegion, evictEntityRegion, evictEntityRegions, evictNaturalIdRegion, evictNaturalIdRegion, evictNaturalIdRegions

Constructor Detail

DisabledCaching

public DisabledCaching(SessionFactoryImplementor sessionFactory)

Method Detail

getSessionFactory

public SessionFactoryImplementor getSessionFactory()

Description copied from interface: Cache

Access to the SessionFactory this Cache is bound to.

Specified by:

getSessionFactory in interface CacheImplementor

Returns:

The SessionFactory

getRegionFactory

public RegionFactory getRegionFactory()

Description copied from interface: CacheImplementor

The underlying RegionFactory in use.

Specified by:

getRegionFactory in interface CacheImplementor

prime

public void prime(Set<DomainDataRegionConfig> cacheRegionConfigs)

Description copied from interface: CacheImplementor

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

Specified by:

prime in interface CacheImplementor

containsEntity

public boolean containsEntity(Class entityClass,
                              Serializable identifier)

Description copied from interface: Cache

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 - The entity class.

identifier - The entity identifier

Returns:

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

containsEntity

public boolean containsEntity(String entityName,
                              Serializable identifier)

Description copied from interface: Cache

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 - The entity name.

identifier - The entity identifier

Returns:

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

evictEntityData

public void evictEntityData(Class entityClass,
                            Serializable identifier)

Description copied from interface: Cache

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

Parameters:

entityClass - The entity class.

identifier - The entity identifier

evictEntityData

public void evictEntityData(String entityName,
                            Serializable identifier)

Description copied from interface: Cache

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

Parameters:

entityName - The entity name.

identifier - The entity identifier

evictEntityData

public void evictEntityData(Class entityClass)

Description copied from interface: Cache

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

Parameters:

entityClass - The entity class.

evictEntityData

public void evictEntityData(String entityName)

Description copied from interface: Cache

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

Parameters:

entityName - The entity name.

evictEntityData

public void evictEntityData()

Description copied from interface: Cache

Evict data from all entity regions.

evictNaturalIdData

public void evictNaturalIdData(Class entityClass)

Description copied from interface: Cache

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

Parameters:

entityClass - The entity class.

evictNaturalIdData

public void evictNaturalIdData(String entityName)

Description copied from interface: Cache

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

Parameters:

entityName - The entity name.

evictNaturalIdData

public void evictNaturalIdData()

Description copied from interface: Cache

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

containsCollection

public boolean containsCollection(String role,
                                  Serializable ownerIdentifier)

Description copied from interface: Cache

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 - The name of the collection role (in form [owner-entity-name].[collection-property-name]) whose regions should be evicted.

ownerIdentifier - The identifier of the owning entity

Returns:

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

evictCollectionData

public void evictCollectionData(String role,
                                Serializable ownerIdentifier)

Description copied from interface: Cache

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

Parameters:

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

ownerIdentifier - The identifier of the owning entity

evictCollectionData

public void evictCollectionData(String role)

Description copied from interface: Cache

Evicts cached data for the given collection role

Parameters:

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

evictCollectionData

public void evictCollectionData()

Description copied from interface: Cache

Evict cache data for all collections

containsQuery

public boolean containsQuery(String regionName)

Description copied from interface: Cache

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 - The cache name given to the query.

Returns:

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

evictDefaultQueryRegion

public void evictDefaultQueryRegion()

Description copied from interface: Cache

Evicts all cached query results from the default region.

evictQueryRegion

public void evictQueryRegion(String regionName)

Description copied from interface: Cache

Evicts all cached query results under the given name.

Parameters:

regionName - The cache name associated to the queries being cached.

evictQueryRegions

public void evictQueryRegions()

Description copied from interface: Cache

Evict data from all query regions.

evictRegion

public void evictRegion(String regionName)

Description copied from interface: Cache

Evict all data from the named cache region

getRegion

public Region getRegion(String fullRegionName)

Description copied from interface: CacheImplementor

Get a cache Region by name

Specified by:

getRegion in interface CacheImplementor

getTimestampsCache

public TimestampsCache getTimestampsCache()

Description copied from interface: CacheImplementor

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

Specified by:

getTimestampsCache in interface CacheImplementor

getDefaultQueryResultsCache

public QueryResultsCache getDefaultQueryResultsCache()

Description copied from interface: CacheImplementor

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

Specified by:

getDefaultQueryResultsCache in interface CacheImplementor

getQueryResultsCache

public QueryResultsCache getQueryResultsCache(String regionName)

Description copied from interface: CacheImplementor

Get query cache by region name or create a new one if none exist. If the region name is null, then default query cache region will be returned. Will return null if Hibernate is not configured for query result caching

Specified by:

getQueryResultsCache in interface CacheImplementor

getQueryResultsCacheStrictly

public QueryResultsCache getQueryResultsCacheStrictly(String regionName)

Description copied from interface: CacheImplementor

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

Specified by:

getQueryResultsCacheStrictly in interface CacheImplementor

close

public void close()

Description copied from interface: CacheImplementor

Close this "cache", releasing all underlying resources.

Specified by:

close in interface CacheImplementor

getSecondLevelCacheRegionNames

public String[] getSecondLevelCacheRegionNames()

Description copied from interface: CacheImplementor

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

Specified by:

getSecondLevelCacheRegionNames in interface CacheImplementor

Returns:

All cache region names

getCacheRegionNames

public Set<String> getCacheRegionNames()

Description copied from interface: CacheImplementor

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

Specified by:

getCacheRegionNames in interface CacheImplementor

getEntityRegionAccess

public EntityDataAccess getEntityRegionAccess(NavigableRole rootEntityName)

Description copied from interface: CacheImplementor

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

Specified by:

getEntityRegionAccess in interface CacheImplementor

Parameters:

rootEntityName - The NavigableRole representation of the root entity

getNaturalIdCacheRegionAccessStrategy

public NaturalIdDataAccess getNaturalIdCacheRegionAccessStrategy(NavigableRole rootEntityName)

Description copied from interface: CacheImplementor

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

Specified by:

getNaturalIdCacheRegionAccessStrategy in interface CacheImplementor

Parameters:

rootEntityName - The NavigableRole representation of the root entity

getCollectionRegionAccess

public CollectionDataAccess getCollectionRegionAccess(NavigableRole collectionRole)

Description copied from interface: CacheImplementor

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

Specified by:

getCollectionRegionAccess in interface CacheImplementor

contains

public boolean contains(Class cls,
                        Object primaryKey)

Description copied from interface: Cache

Whether the cache contains data for the given entity.

Specified by:

contains in interface Cache

Parameters:

cls - entity class

primaryKey - primary key

Returns:

boolean indicating whether the entity is in the cache

evict

public void evict(Class cls,
                  Object primaryKey)

Description copied from interface: Cache

Remove the data for the given entity from the cache.

Specified by:

evict in interface Cache

Parameters:

cls - entity class

primaryKey - primary key

evict

public void evict(Class cls)

Description copied from interface: Cache

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

Specified by:

evict in interface Cache

Parameters:

cls - entity class

unwrap

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

Description copied from interface: Cache

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.

Specified by:

unwrap in interface Cache

Parameters:

cls - the class of the object to be returned. This is normally either the underlying Cache implementation class or an interface that it implements.

Returns:

an instance of the specified class

getNaturalIdAccessesInRegion

public Set<NaturalIdDataAccess> getNaturalIdAccessesInRegion(String regionName)

Specified by:

getNaturalIdAccessesInRegion in interface CacheImplementor