Package org.hibernate.cache.spi

package org.hibernate.cache.spi

Defines the integration aspect of Hibernate's second-level caching, allowing a "caching backend" to be plugged in as a cache provider.

RegionFactory is the main integration contract that defines how Hibernate interacts with the provider. Its main contract is the generation of Region references with some requested intent (what will be stored there).

A provider will integrate with Hibernate by implementing either:

1. the contracts in org.hibernate.cache.spi,
2. the contracts in org.hibernate.cache.spi.support, or
3. a mix of the above.

The first approach allows for more control over the setup, but also requires more work. The second approach minimizes the work needed to integrate with a cache provider: the integrator is only required to implement the contracts StorageAccess and DomainDataStorageAccess, which are basic read/write abstractions of the underlying cache. That is to say, org.hibernate.cache.spi.support comes with a nearly complete implementation, except for these "storage access" objects.

Alternatively, providers may integrate with Hibernate via Hibernate's support for JCache, which is defined by the hibernate-jcache module. No custom code is necessary, just an implementation of JCache, properly registered via the JCache spec.

Related Packages

Package	Description
org.hibernate.cache	This package defines the API of the second-level cache service.
org.hibernate.cache.spi.access	Defines contracts for transactional and concurrent access to cached entity and collection data.
org.hibernate.cache.spi.entry	This package defines formats for disassembled state kept in the second level cache.
org.hibernate.cache.spi.support	This package provides a framework intended to reduce the work needed to implement a caching provider.
org.hibernate.cache.internal	Internal implementations and support for second-level caching.

Class	Description
AbstractCacheTransactionSynchronization
AbstractRegionFactory
CacheImplementor	An SPI supported by any Hibernate service that provides an implementation of the Cache API.
CacheKeysFactory	A factory for keys into the second-level cache.
CacheTransactionSynchronization	Defines a context object that a RegionFactory is asked to create (RegionFactory.createTransactionContext(org.hibernate.engine.spi.SharedSessionContractImplementor)}) when a Hibernate Session is created.
DirectAccessRegion	Specialized Region whose data is accessed directly, without the need for key/item wrapping.
DomainDataRegion	A second-level cache region that holds cacheable domain data: the destructured state of entity instances and collections, and mappings from natural id to primary key.
ExtendedStatisticsSupport	Optional contract for a Region defining support for extra statistic information.
QueryKey	A key that identifies a particular query with bound parameter values.
QueryKey.ParameterBindingsMemento	todo (6.0) : integrate work from original 6.0 branch
QueryResultsCache	Responsible for managing query result list caching in a specific query cache region.
QueryResultsRegion	Defines the contract for a cache region that stores query results.
Region	Contract for a named cache "region".
RegionFactory	Contract for building second-level cache regions, including regions dedicated to storing: entity and collection instances, query result sets, and timestamps used to determine when a cached query result set is stale.
SecondLevelCacheLogger
StandardCacheTransactionSynchronization
TimestampsCache	Tracks invalidation of "query spaces" (tables) for the purpose of determining if a cached query result set is stale.
TimestampsCacheFactory	Responsible for building the TimestampsCache to use for managing query results with respect to staleness of the underlying tables (sometimes called "query spaces" or "table spaces").
TimestampsRegion	Defines the contract for a cache region that stores timestamps.