ehcache-core 2.10.9.2 · net.sf.ehcache.hibernate.regions.EhcacheTransactionalDataRegion

Modifier and Type	Field and Description
private static final int	LOCAL_LOCK_PROVIDER_CONCURRENCY
private final CacheLockProvider	lockProvider
protected final CacheDataDescription	metadata Metadata associated with the objects stored in the region.
protected final Settings	settings Hibernate settings associated with the persistence unit.

Access	Constructor and Description
pack-priv	EhcacheTransactionalDataRegion(EhcacheAccessStrategyFactory accessStrategyFactory, Ehcache cache, Settings settings, CacheDataDescription metadata, Properties properties) Construct an transactional Hibernate cache region around the given Ehcache instance.

Method Summary

Modifier and Type	Method and Description
public final void	clear() Remove all mapping from this cache region.
public final Object	get(Object key) Get the value mapped to this key, or null if no value is mapped to this key.
public CacheDataDescription	getCacheDataDescription() Implements org.hibernate.cache.TransactionalDataRegion.getCacheDataDescription.
public Settings	Returns: settings getSettings() Return the hibernate settings
public boolean	isTransactionAware() Implements org.hibernate.cache.TransactionalDataRegion.isTransactionAware. Is the underlying cache implementation aware of (and "participating in") ongoing JTA transactions?
public final boolean	locksAreIndependentOfCache() Returns `true` if the locks used by the locking methods of this region are the independent of the cache.
public final void	put(Object key, Object value) Map the given value to the given key, replacing any existing mapping for this key this unpins the key in the cache should it be currently pinned
private void	put(Object key, Object value, boolean eternal)
public final void	putEternal(Object key, Object value) Map the given value to the given key, replacing any existing mapping for this key, pinning the key in the cache
public final void	readLock(Object key) Attempts to read lock the mapping for the given key.
public final void	readUnlock(Object key) Attempts to read unlock the mapping for the given key.
public final void	remove(Object key) Remove the mapping for this key (if any exists).
public final void	writeLock(Object key) Attempts to write lock the mapping for the given key.
public final void	writeUnlock(Object key) Attempts to write unlock the mapping for the given key.

Inherited from net.sf.ehcache.hibernate.regions.EhcacheDataRegion:: contains destroy getEhcache getElementCountInMemory getElementCountOnDisk getName getSizeInMemory getTimeout nextTimestamp toMap

LOCAL_LOCK_PROVIDER_CONCURRENCY	back to summary
private static final int LOCAL_LOCK_PROVIDER_CONCURRENCY

lockProvider	back to summary
private final CacheLockProvider lockProvider

settings	back to summary
protected final Settings settings Hibernate settings associated with the persistence unit.

EhcacheTransactionalDataRegion	back to summary
pack-priv EhcacheTransactionalDataRegion(EhcacheAccessStrategyFactory accessStrategyFactory, Ehcache cache, Settings settings, CacheDataDescription metadata, Properties properties) Construct an transactional Hibernate cache region around the given Ehcache instance.

Method Detail

clear	back to summary
public final void clear() throws CacheException Remove all mapping from this cache region.

get	back to summary
public final Object get(Object key) Get the value mapped to this key, or null if no value is mapped to this key.

getCacheDataDescription	back to summary
public CacheDataDescription getCacheDataDescription() Implements org.hibernate.cache.TransactionalDataRegion.getCacheDataDescription.

getSettings	back to summary
public Settings getSettings() Return the hibernate settings Returns:Settings settings

getSettings

back to summary

public Settings getSettings()

Return the hibernate settings

Returns:Settings: settings

isTransactionAware	back to summary
public boolean isTransactionAware() Implements org.hibernate.cache.TransactionalDataRegion.isTransactionAware. Doc from org.hibernate.cache.TransactionalDataRegion.isTransactionAware. Is the underlying cache implementation aware of (and "participating in") ongoing JTA transactions? Regions which report that they are transaction-aware are considered "synchronous", in that we assume we can immediately (i.e. synchronously) write the changes to the cache and that the cache will properly manage application of the written changes within the bounds of ongoing JTA transactions. Conversely, regions reporting false are considered "asynchronous", where it is assumed that changes must be manually delayed by Hibernate until we are certain that the current transaction is successful (i.e. maintaining READ_COMMITTED isolation). Returns:boolean True if transaction aware; false otherwise.

isTransactionAware

back to summary

public boolean isTransactionAware()

Implements org.hibernate.cache.TransactionalDataRegion.isTransactionAware.

Doc from org.hibernate.cache.TransactionalDataRegion.isTransactionAware.

Is the underlying cache implementation aware of (and "participating in") ongoing JTA transactions?

Regions which report that they are transaction-aware are considered "synchronous", in that we assume we can immediately (i.e. synchronously) write the changes to the cache and that the cache will properly manage application of the written changes within the bounds of ongoing JTA transactions. Conversely, regions reporting false are considered "asynchronous", where it is assumed that changes must be manually delayed by Hibernate until we are certain that the current transaction is successful (i.e. maintaining READ_COMMITTED isolation).

Returns:boolean: True if transaction aware; false otherwise.

locksAreIndependentOfCache back to summary

locksAreIndependentOfCache	back to summary
public final boolean locksAreIndependentOfCache() Returns `true` if the locks used by the locking methods of this region are the independent of the cache. Independent locks are not locked by the cache when the cache is accessed directly. This means that for an independent lock lock holds taken through a region method will not block direct access to the cache via other means.

public final boolean locksAreIndependentOfCache()

Returns true if the locks used by the locking methods of this region are the independent of the cache.

Independent locks are not locked by the cache when the cache is accessed directly. This means that for an independent lock lock holds taken through a region method will not block direct access to the cache via other means.

put	back to summary
public final void put(Object key, Object value) throws CacheException Map the given value to the given key, replacing any existing mapping for this key this unpins the key in the cache should it be currently pinned

put	back to summary
private void put(Object key, Object value, boolean eternal) throws CacheException

putEternal	back to summary
public final void putEternal(Object key, Object value) throws CacheException Map the given value to the given key, replacing any existing mapping for this key, pinning the key in the cache

readLock	back to summary
public final void readLock(Object key) Attempts to read lock the mapping for the given key.

readUnlock	back to summary
public final void readUnlock(Object key) Attempts to read unlock the mapping for the given key.

remove	back to summary
public final void remove(Object key) throws CacheException Remove the mapping for this key (if any exists).

writeLock	back to summary
public final void writeLock(Object key) Attempts to write lock the mapping for the given key.

writeUnlock	back to summary
public final void writeUnlock(Object key) Attempts to write unlock the mapping for the given key.

public Class EhcacheTransactionalDataRegion

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail