oracle.toplink.descriptors.invalidation
Class CacheInvalidationPolicy

java.lang.Object
  oracle.toplink.descriptors.invalidation.CacheInvalidationPolicy

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DailyCacheInvalidationPolicy, NoExpiryCacheInvalidationPolicy, TimeToLiveCacheInvalidationPolicy

public abstract class CacheInvalidationPolicy
extends java.lang.Object
implements java.io.Serializable

A CacheInvalidationPolicy is used to set objects in TopLink's identity maps to be invalid following given rules. CacheInvalidationPolicy is the abstract superclass for all policies used for cache invalidation. By default in TopLink, objects do not expire in the cache. Several different policies are available to allow objects to expire. These can be set on the ClassDescriptor.

See Also:

ClassDescriptor, NoExpiryCacheInvalidationPolicy, DailyCacheInvalidationPolicy, TimeToLiveCacheInvalidationPolicy, Serialized Form

Field Summary

static long

NO_EXPIRY

Constructor Summary

CacheInvalidationPolicy()

Method Summary

void	setShouldRefreshInvalidObjectsInUnitOfWork(boolean shouldRefreshInvalidObjectsInUnitOfWork) Set if expired object registered in the unit of work should be refreshed, default is true.
void	setShouldUpdateReadTimeOnUpdate(boolean shouldUpdateReadTime) Set whether to update the stored time an object was read when an object is updated.
boolean	shouldRefreshInvalidObjectsInUnitOfWork() Return if expired object registered in the unit of work should be refreshed.
boolean	shouldUpdateReadTimeOnUpdate() Return whether objects affected by this CacheInvalidationPolicy should have the read time on their cache keys updated when an update occurs.

Methods inherited from class java.lang.Object

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

Field Detail

NO_EXPIRY

public static final long NO_EXPIRY

See Also:

Constant Field Values

Constructor Detail

CacheInvalidationPolicy

public CacheInvalidationPolicy()

Method Detail

setShouldUpdateReadTimeOnUpdate

public void setShouldUpdateReadTimeOnUpdate(boolean shouldUpdateReadTime)

Set whether to update the stored time an object was read when an object is updated. When the read time is updated, it indicates to TopLink that the data in the object is up to date. This means that cache invalidation checks will occur relative to the new read time. By default, the read time will not be updated when an object is updated. Often it is possible to be confident that the object is up to date after an update because otherwise the update will fail because of the locking policies in use.

shouldUpdateReadTimeOnUpdate

public boolean shouldUpdateReadTimeOnUpdate()

Return whether objects affected by this CacheInvalidationPolicy should have the read time on their cache keys updated when an update occurs.

setShouldRefreshInvalidObjectsInUnitOfWork

public void setShouldRefreshInvalidObjectsInUnitOfWork(boolean shouldRefreshInvalidObjectsInUnitOfWork)

Set if expired object registered in the unit of work should be refreshed, default is true.

shouldRefreshInvalidObjectsInUnitOfWork

public boolean shouldRefreshInvalidObjectsInUnitOfWork()

Return if expired object registered in the unit of work should be refreshed.