org.hibernate.cache.spi.support

Class AbstractCollectionDataAccess

java.lang.Object

org.hibernate.cache.spi.support.AbstractCachedDomainDataAccess

org.hibernate.cache.spi.support.AbstractCollectionDataAccess

All Implemented Interfaces:

CachedDomainDataAccess, CollectionDataAccess, AbstractDomainDataRegion.Destructible

Direct Known Subclasses:

CollectionNonStrictReadWriteAccess, CollectionReadOnlyAccess, CollectionTransactionAccess

public abstract class AbstractCollectionDataAccess
extends AbstractCachedDomainDataAccess
implements CollectionDataAccess

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor and Description
AbstractCollectionDataAccess(DomainDataRegion region, CacheKeysFactory keysFactory, DomainDataStorageAccess storageAccess, CollectionDataCachingConfig config)

Method Summary

Modifier and Type	Method and Description
Object	generateCacheKey(Object id, CollectionPersister persister, SessionFactoryImplementor factory, String tenantIdentifier) To create instances of CollectionCacheKey for this region, Hibernate will invoke this method exclusively so that generated implementations can generate optimised keys.
Object	getCacheKeyId(Object cacheKey) Performs reverse operation to CollectionDataAccess.generateCacheKey(java.lang.Object, org.hibernate.persister.collection.CollectionPersister, org.hibernate.engine.spi.SessionFactoryImplementor, java.lang.String)
SoftLock	lockItem(SharedSessionContractImplementor session, Object key, Object version) We are going to attempt to update/delete the keyed object.
SoftLock	lockRegion() Lock the entire region
void	unlockItem(SharedSessionContractImplementor session, Object key, SoftLock lock) Called when we have finished the attempted update/delete (which may or may not have been successful), after transaction completion.
void	unlockRegion(SoftLock lock) Called after we have finished the attempted invalidation of the entire region

Methods inherited from class org.hibernate.cache.spi.support.AbstractCachedDomainDataAccess

clearCache, contains, destroy, evict, evictAll, get, getRegion, getStorageAccess, putFromLoad, putFromLoad, remove, removeAll

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.access.CachedDomainDataAccess

contains, evict, evictAll, get, getAccessType, getRegion, putFromLoad, putFromLoad, remove, removeAll

Constructor Detail

AbstractCollectionDataAccess

public AbstractCollectionDataAccess(DomainDataRegion region,
                                    CacheKeysFactory keysFactory,
                                    DomainDataStorageAccess storageAccess,
                                    CollectionDataCachingConfig config)

Method Detail

generateCacheKey

public Object generateCacheKey(Object id,
                               CollectionPersister persister,
                               SessionFactoryImplementor factory,
                               String tenantIdentifier)

Description copied from interface: CollectionDataAccess

To create instances of CollectionCacheKey for this region, Hibernate will invoke this method exclusively so that generated implementations can generate optimised keys.

Specified by:

generateCacheKey in interface CollectionDataAccess

Parameters:

id - the primary identifier of the Collection

persister - the descriptor of the collection for which a key is being generated

factory - a reference to the current SessionFactory

tenantIdentifier - the tenant id, or null if multi-tenancy is not being used.

Returns:

a key which can be used to identify this collection on this same region

getCacheKeyId

public Object getCacheKeyId(Object cacheKey)

Description copied from interface: CollectionDataAccess

Performs reverse operation to CollectionDataAccess.generateCacheKey(java.lang.Object, org.hibernate.persister.collection.CollectionPersister, org.hibernate.engine.spi.SessionFactoryImplementor, java.lang.String)

Specified by:

getCacheKeyId in interface CollectionDataAccess

Parameters:

cacheKey - key previously returned from CollectionDataAccess.generateCacheKey(java.lang.Object, org.hibernate.persister.collection.CollectionPersister, org.hibernate.engine.spi.SessionFactoryImplementor, java.lang.String)

Returns:

original key passed to CollectionDataAccess.generateCacheKey(java.lang.Object, org.hibernate.persister.collection.CollectionPersister, org.hibernate.engine.spi.SessionFactoryImplementor, java.lang.String)

lockItem

public SoftLock lockItem(SharedSessionContractImplementor session,
                         Object key,
                         Object version)

Description copied from interface: CachedDomainDataAccess

We are going to attempt to update/delete the keyed object. This method is used by "asynchronous" concurrency strategies.

The returned object must be passed back to CachedDomainDataAccess.unlockItem(org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object, org.hibernate.cache.spi.access.SoftLock), to release the lock. Concurrency strategies which do not support client-visible locks may silently return null.

Specified by:

lockItem in interface CachedDomainDataAccess

Parameters:

session - Current session.

key - The key of the item to lock

version - The item's current version value

Returns:

A representation of our lock on the item; or null.

unlockItem

public void unlockItem(SharedSessionContractImplementor session,
                       Object key,
                       SoftLock lock)

Description copied from interface: CachedDomainDataAccess

Called when we have finished the attempted update/delete (which may or may not have been successful), after transaction completion. This method is used by "asynchronous" concurrency strategies.

Specified by:

unlockItem in interface CachedDomainDataAccess

Parameters:

session - Current session.

key - The item key

lock - The lock previously obtained from CachedDomainDataAccess.lockItem(org.hibernate.engine.spi.SharedSessionContractImplementor, java.lang.Object, java.lang.Object)

lockRegion

public SoftLock lockRegion()

Description copied from interface: CachedDomainDataAccess

Lock the entire region

Specified by:

lockRegion in interface CachedDomainDataAccess

Overrides:

lockRegion in class AbstractCachedDomainDataAccess

Returns:

A representation of our lock on the item; or null.

unlockRegion

public void unlockRegion(SoftLock lock)

Description copied from interface: CachedDomainDataAccess

Called after we have finished the attempted invalidation of the entire region

Specified by:

unlockRegion in interface CachedDomainDataAccess

Overrides:

unlockRegion in class AbstractCachedDomainDataAccess

Parameters:

lock - The lock previously obtained from CachedDomainDataAccess.lockRegion()