org.hibernate.cache.spi

Class UpdateTimestampsCache

java.lang.Object

org.hibernate.cache.spi.UpdateTimestampsCache

public class UpdateTimestampsCache
extends Object

Tracks the timestamps of the most recent updates to particular tables. It is important that the cache timeout of the underlying cache implementation be set to a higher value than the timeouts of any of the query caches. In fact, we recommend that the the underlying cache not be configured for expiry at all. Note, in particular, that an LRU cache expiry policy is never appropriate.

Author:

Gavin King, Mikheil Kapanadze

Field Summary

Fields

Modifier and Type	Field and Description
static String	REGION_NAME The region name of the update-timestamps cache.

Constructor Summary

Constructors

Constructor and Description
UpdateTimestampsCache(SessionFactoryOptions settings, Properties props) Constructs an UpdateTimestampsCache.
UpdateTimestampsCache(SessionFactoryOptions settings, Properties props, SessionFactoryImplementor factory) Constructs an UpdateTimestampsCache.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the update-timestamps data.
void	destroy() Destroys the cache.
TimestampsRegion	getRegion() Get the underlying cache region where data is stored..
void	invalidate(Serializable[] spaces, SessionImplementor session) Perform invalidation.
boolean	isUpToDate(Set<Serializable> spaces, Long timestamp, SessionImplementor session) Perform an up-to-date check for the given set of query spaces.
void	preInvalidate(Serializable[] spaces, SessionImplementor session) Perform pre-invalidation.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

REGION_NAME

public static final String REGION_NAME

The region name of the update-timestamps cache.

Constructor Detail

UpdateTimestampsCache

public UpdateTimestampsCache(SessionFactoryOptions settings,
                             Properties props,
                             SessionFactoryImplementor factory)

Constructs an UpdateTimestampsCache.

Parameters:

settings - The SessionFactory settings

props - Any properties

factory - The SessionFactory

UpdateTimestampsCache

public UpdateTimestampsCache(SessionFactoryOptions settings,
                             Properties props)

Constructs an UpdateTimestampsCache.

Parameters:

settings - The SessionFactory settings

props - Any properties

Method Detail

preInvalidate

public void preInvalidate(Serializable[] spaces,
                          SessionImplementor session)
                   throws CacheException

Perform pre-invalidation.

Parameters:

spaces - The spaces to pre-invalidate

session -

Throws:

CacheException - Indicated problem delegating to underlying region.

invalidate

public void invalidate(Serializable[] spaces,
                       SessionImplementor session)
                throws CacheException

Perform invalidation.

Parameters:

spaces - The spaces to pre-invalidate

session -

Throws:

CacheException - Indicated problem delegating to underlying region.

isUpToDate

public boolean isUpToDate(Set<Serializable> spaces,
                          Long timestamp,
                          SessionImplementor session)
                   throws CacheException

Perform an up-to-date check for the given set of query spaces.

Parameters:

spaces - The spaces to check

timestamp - The timestamp against which to check.

session -

Returns:

Whether all those spaces are up-to-date

Throws:

CacheException - Indicated problem delegating to underlying region.

clear

public void clear()
           throws CacheException

Clear the update-timestamps data.

Throws:

CacheException - Indicates problem delegating call to underlying region.

destroy

public void destroy()

Destroys the cache.

Throws:

CacheException - Indicates problem delegating call to underlying region.

getRegion

public TimestampsRegion getRegion()

Get the underlying cache region where data is stored..

Returns:

The underlying region.

toString

public String toString()

Overrides:

toString in class Object