org.hibernate.cache.infinispan.impl

Class BaseRegion

java.lang.Object

org.hibernate.cache.infinispan.impl.BaseRegion

All Implemented Interfaces:

Region

Direct Known Subclasses:

BaseGeneralDataRegion, BaseTransactionalDataRegion

public abstract class BaseRegion
extends Object
implements Region

Support for Infinispan Regions. Handles common "utility" methods for an underlying named Cache. In other words, this implementation doesn't actually read or write data. Subclasses are expected to provide core cache interaction appropriate to the semantics needed.

Since:

3.5

Field Summary

Fields

Modifier and Type	Field and Description
protected org.infinispan.AdvancedCache	cache

Constructor Summary

Constructors

Constructor and Description
BaseRegion(org.infinispan.AdvancedCache cache, String name, RegionFactory factory) Base region constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkValid() Checks if the region is valid for operations such as storing new data in the region, or retrieving data from the region.
boolean	contains(Object key) Determine whether this region contains data for the given key.
void	destroy() The "end state" contract of the region's lifecycle.
org.infinispan.AdvancedCache	getCache()
long	getElementCountInMemory() The count of entries currently contained in the regions in-memory store.
long	getElementCountOnDisk() The count of entries currently contained in the regions disk store.
String	getName() Retrieve the name of this region.
long	getSizeInMemory() The number of bytes is this cache region currently consuming in memory.
int	getTimeout() Get a timeout value.
TransactionManager	getTransactionManager()
void	invalidateRegion() Invalidates the region.
boolean	isRegionInvalidatedInCurrentTx()
boolean	isTransactionAware()
protected boolean	isValid()
long	nextTimestamp() Get the next timestamp according to the underlying cache implementor.
void	resume(Transaction tx) Tell the TransactionManager to resume the given transaction
Transaction	suspend() Tell the TransactionManager to suspend any ongoing transaction.
Map	toMap() Get the contents of this region as a map.

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected final org.infinispan.AdvancedCache cache

Constructor Detail

BaseRegion

public BaseRegion(org.infinispan.AdvancedCache cache,
          String name,
          RegionFactory factory)

Base region constructor.

Parameters:

cache - instance for the region

name - of the region

factory - for this region

Method Detail

getName

public String getName()

Description copied from interface: Region

Retrieve the name of this region.

Specified by:

getName in interface Region

Returns:

The region name

getElementCountInMemory

public long getElementCountInMemory()

Description copied from interface: Region

The count of entries currently contained in the regions in-memory store.

Specified by:

getElementCountInMemory in interface Region

Returns:

The count of entries in memory; -1 if unknown or unsupported.

getElementCountOnDisk

public long getElementCountOnDisk()

The count of entries currently contained in the regions disk store.

Not supported; returns -1

Specified by:

getElementCountOnDisk in interface Region

Returns:

The count of entries on disk; -1 if unknown or unsupported.

getSizeInMemory

public long getSizeInMemory()

The number of bytes is this cache region currently consuming in memory.

Not supported; returns -1

Specified by:

getSizeInMemory in interface Region

Returns:

The number of bytes consumed by this region; -1 if unknown or unsupported.

getTimeout

public int getTimeout()

Description copied from interface: Region

Get a timeout value.

Specified by:

getTimeout in interface Region

Returns:

The time out value

nextTimestamp

public long nextTimestamp()

Description copied from interface: Region

Get the next timestamp according to the underlying cache implementor.

Specified by:

nextTimestamp in interface Region

Returns:

The next timestamp

toMap

public Map toMap()

Description copied from interface: Region

Get the contents of this region as a map.

Implementors which do not support this notion should simply return an empty map.

Specified by:

toMap in interface Region

Returns:

The content map.

destroy

public void destroy()
             throws CacheException

Description copied from interface: Region

The "end state" contract of the region's lifecycle. Called during SessionFactory.close() to give the region a chance to cleanup.

Specified by:

destroy in interface Region

Throws:

CacheException - Indicates problem shutting down

contains

public boolean contains(Object key)

Description copied from interface: Region

Determine whether this region contains data for the given key.

The semantic here is whether the cache contains data visible for the current call context. This should be viewed as a "best effort", meaning blocking should be avoid if possible.

Specified by:

contains in interface Region

Parameters:

key - The cache key

Returns:

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

checkValid

public boolean checkValid()

Checks if the region is valid for operations such as storing new data in the region, or retrieving data from the region.

Returns:

true if the region is valid, false otherwise

isValid

protected boolean isValid()

suspend

public Transaction suspend()

Tell the TransactionManager to suspend any ongoing transaction.

Returns:

the transaction that was suspended, or null if there wasn't one

resume

public void resume(Transaction tx)

Tell the TransactionManager to resume the given transaction

Parameters:

tx - the transaction to suspend. May be null.

invalidateRegion

public void invalidateRegion()

Invalidates the region.

getTransactionManager

public TransactionManager getTransactionManager()

isTransactionAware

public boolean isTransactionAware()

getCache

public org.infinispan.AdvancedCache getCache()

isRegionInvalidatedInCurrentTx

public boolean isRegionInvalidatedInCurrentTx()