EclipseLink Core 4.0.2 · org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy

Modifier and Type	Field and Description
protected boolean	isInvalidationRandomized Allows the timeToLive to be randomized to avoid bottlenecks.
public static final long	NO_EXPIRY
protected Random	random Random used for randomized invalidation.
protected boolean	shouldRefreshInvalidObjectsOnClone Determines if expired object registered in the unit of work should be refreshed, default true.
protected boolean	shouldUpdateReadTimeOnUpdate This will represent objects that do not expire.

Access	Constructor and Description
public	CacheInvalidationPolicy()

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public abstract long	getExpiryTimeInMillis(CacheKey key) INTERNAL: Get the next time when this object will become invalid
public long	getRemainingValidTime(CacheKey key) INTERNAL: Return the remaining life of this object
public void	initialize(ClassDescriptor descriptor, AbstractSession session) INTERNAL: Allow initialization with the descriptor.
public boolean	isInvalidated(CacheKey key) INTERNAL: return true if this object is expire, false otherwise.
public abstract boolean	isInvalidated(CacheKey key, long currentTimeMillis) INTERNAL: return true if this object is expire, false otherwise.
public boolean	isInvalidationRandomized() PUBLIC: Allows the timeToLive to be randomized to avoid bottlenecks.
public void	setIsInvalidationRandomized(boolean isInvalidationRandomized) PUBLIC: Allows the timeToLive to be randomized to avoid bottlenecks.
public void	setShouldRefreshInvalidObjectsOnClone(boolean shouldRefreshInvalidObjectsOnClone) PUBLIC: Set if expired object should be refreshed prior to cloning, default is true.
public void	setShouldUpdateReadTimeOnUpdate(boolean shouldUpdateReadTime) PUBLIC: Set whether to update the stored time an object was read when an object is updated.
public boolean	shouldRefreshInvalidObjectsOnClone() PUBLIC: Return if expired object should be refreshed prior to cloning.
public boolean	shouldUpdateReadTimeOnUpdate() PUBLIC: Return whether objects affected by this CacheInvalidationPolicy should have the read time on their cache keys updated when an update occurs.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

isInvalidationRandomized	back to summary
protected boolean isInvalidationRandomized Allows the timeToLive to be randomized to avoid bottlenecks.

NO_EXPIRY	back to summary
public static final long NO_EXPIRY

random	back to summary
protected Random random Random used for randomized invalidation.

shouldRefreshInvalidObjectsOnClone	back to summary
protected boolean shouldRefreshInvalidObjectsOnClone Determines if expired object registered in the unit of work should be refreshed, default true.

shouldUpdateReadTimeOnUpdate	back to summary
protected boolean shouldUpdateReadTimeOnUpdate This will represent objects that do not expire.

CacheInvalidationPolicy	back to summary
public CacheInvalidationPolicy()

Method Detail

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override

public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

getExpiryTimeInMillis	back to summary
public abstract long getExpiryTimeInMillis(CacheKey key) INTERNAL: Get the next time when this object will become invalid

getRemainingValidTime	back to summary
public long getRemainingValidTime(CacheKey key) INTERNAL: Return the remaining life of this object

initialize	back to summary
public void initialize(ClassDescriptor descriptor, AbstractSession session) INTERNAL: Allow initialization with the descriptor.

isInvalidated	back to summary
public boolean isInvalidated(CacheKey key) INTERNAL: return true if this object is expire, false otherwise.

isInvalidated	back to summary
public abstract boolean isInvalidated(CacheKey key, long currentTimeMillis) INTERNAL: return true if this object is expire, false otherwise.

isInvalidationRandomized	back to summary
public boolean isInvalidationRandomized() PUBLIC: Allows the timeToLive to be randomized to avoid bottlenecks.

setIsInvalidationRandomized	back to summary
public void setIsInvalidationRandomized(boolean isInvalidationRandomized) PUBLIC: Allows the timeToLive to be randomized to avoid bottlenecks.

setShouldRefreshInvalidObjectsOnClone	back to summary
public void setShouldRefreshInvalidObjectsOnClone(boolean shouldRefreshInvalidObjectsOnClone) PUBLIC: Set if expired object should be refreshed prior to cloning, default is true. Applies to Protected Entities and UnitOfWork registration.

setShouldUpdateReadTimeOnUpdate	back to summary
public void setShouldUpdateReadTimeOnUpdate(boolean shouldUpdateReadTime) PUBLIC: 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 EclipseLink 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.

setShouldUpdateReadTimeOnUpdate

back to summary

public void setShouldUpdateReadTimeOnUpdate(boolean shouldUpdateReadTime)

PUBLIC: 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 EclipseLink 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.

shouldRefreshInvalidObjectsOnClone	back to summary
public boolean shouldRefreshInvalidObjectsOnClone() PUBLIC: Return if expired object should be refreshed prior to cloning. Applies to Protected Entities and UnitOfWork registration.

shouldUpdateReadTimeOnUpdate	back to summary
public boolean shouldUpdateReadTimeOnUpdate() PUBLIC: Return whether objects affected by this CacheInvalidationPolicy should have the read time on their cache keys updated when an update occurs.

public abstract Class CacheInvalidationPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail