Package org.hibernate.cache.spi.support

Package intended for simplifying the worked needed to implement a caching provider.

See: Description

Interface Summary

Interface	Description
AbstractDomainDataRegion.Destructible	Optional interface caching implementors can implement in their CachedDomainDataAccess impls to automatically have them destroyed when this region is destroyed
AbstractReadWriteAccess.Lockable	Interface type implemented by all wrapper objects in the cache.
DomainDataStorageAccess	Specialization of StorageAccess for domain data regions
StorageAccess	A general read/write abstraction over the specific "cache" object from the caching provider.

Class Summary

Class	Description
AbstractCachedDomainDataAccess
AbstractCollectionDataAccess
AbstractDomainDataRegion
AbstractEntityDataAccess
AbstractNaturalIdDataAccess
AbstractReadWriteAccess
AbstractReadWriteAccess.Item	Wrapper type representing unlocked items.
AbstractReadWriteAccess.SoftLockImpl	Wrapper type representing locked items.
AbstractRegion
CacheUtils
CollectionNonStrictReadWriteAccess	Standard support for CollectionDataAccess using the AccessType.NONSTRICT_READ_WRITE access type.
CollectionReadOnlyAccess	Standard support for CollectionDataAccess using the AccessType.READ_ONLY access type.
CollectionReadWriteAccess	Standard support for CollectionDataAccess using the AccessType.READ_WRITE access type.
DirectAccessRegionTemplate	Bridge between DirectAccessRegion and StorageAccess
DomainDataRegionTemplate	Abstract implementation of DomainDataRegion based on implementations just needing to provide a DomainDataStorageAccess reference for basic caching support - DomainDataStorageAccess acts as a simple wrapper around some generalized cache actions such as put or get.
EntityNonStrictReadWriteAccess	Standard support for EntityDataAccess using the AccessType.NONSTRICT_READ_WRITE access type.
EntityReadOnlyAccess	Standard support for EntityDataAccess using the AccessType.READ_ONLY access type.
EntityReadWriteAccess	Standard support for EntityDataAccess using the AccessType.READ_WRITE access type.
NaturalIdNonStrictReadWriteAccess	Standard support for NaturalIdDataAccess using the AccessType.NONSTRICT_READ_WRITE access type.
NaturalIdReadOnlyAccess	Standard support for NaturalIdDataAccess using the AccessType.READ_ONLY access type.
NaturalIdReadWriteAccess	Standard support for NaturalIdDataAccess using the AccessType.READ_WRITE access type.
QueryResultsRegionTemplate
RegionFactoryTemplate
RegionNameQualifier
SimpleTimestamper	Generates increasing identifiers (in a single VM only).
TimestampsRegionTemplate

Enum Summary

Enum	Description
AccessedDataClassification

Package org.hibernate.cache.spi.support Description

Package intended for simplifying the worked needed to implement a caching provider. Centers around the concept of StorageAccess and DomainDataStorageAccess too implement most of the "grunt work" associated with the implementation.

Most integrations would just:

1. implement a custom StorageAccess/DomainDataStorageAccess

2. implement a custom RegionFactoryTemplate, implementing specifically:

   1. RegionFactoryTemplate#createDomainDataStorageAccess

   2. RegionFactoryTemplate#createQueryResultsRegionStorageAccess

   3. RegionFactoryTemplate#createTimestampsRegionStorageAccess

Voila.. functioning cache provider

The preferred approach to "provide a integration" is through a custom StrategyRegistrationProvider

Both hibernate-testing (org.hibernate.testing.cache.CachingRegionFactory) and hibernate-jcache (org.hibernate.cache.jcache.internal.JCacheRegionFactory) provide examples of using this support package to implement a caching provider.