EclipseLink Core 4.0.2 · org.eclipse.persistence.internal.identitymaps.CacheKey

Field Summary

Modifier and Type	Field and Description
public static final int	CACHE_KEY_INVALID
public static final int	CHECK_INVALIDATION_POLICY The following constants are used for the invalidationState variable
public final long	CREATION_THREAD_HASHCODE
public final long	CREATION_THREAD_ID
public final String	CREATION_THREAD_NAME
protected DataRecord	dataRecord This is used for Document Preservation to cache the record that this object was built from
protected int	invalidationState Invalidation State can be used to indicate whether this cache key is considered valid
protected boolean	isIsolated Set to true if this CacheKey comes from an IsolatedClientSession, or DatabaseSessionImpl.
protected boolean	isWrapper Stores if this CacheKey instance is a wrapper for the underlying CacheKey.
protected Object	key The key holds the vector of primary key values for the object.
protected long	lastUpdatedQueryId This attribute is the system time in milli seconds that the object was last refreshed on
protected IdentityMap	mapOwner
public static final int	MAX_WAIT_TRIES
protected Object	object
protected AbstractRecord	protectedForeignKeys Stores retrieved FK values for relationships that are not stored in the Entity
protected long	readTime The read time stores the millisecond value of the last time the object help by this cache key was confirmed as up to date.
protected Object	transactionId The ID of the database transaction that last wrote the object.
protected Object	wrapper The cached wrapper for the object, used in EJB.
protected Object	writeLockValue The writeLock value is being held as an object so that it might contain a number or timestamp.

Inherited from org.eclipse.persistence.internal.helper.ConcurrencyManager:: activeThread DEFERRED_LOCK_MANAGERS depth lockedByMergeManager numberOfReaders numberOfWritersWaiting shouldTrackStack stack

Constructor Summary

Access	Constructor and Description
protected	CacheKey() Internal: Only used by subclasses that may want to wrap the cache key.
public	CacheKey(Object primaryKey)
public	CacheKey(Object primaryKey, Object object, Object lockValue)
public	CacheKey(Object primaryKey, Object object, Object lockValue, long readTime, boolean isIsolated)

Method Summary

Modifier and Type	Method and Description
public void	acquire() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquire. Acquire the lock on the cache key object.
public void	acquire(boolean forMerge) Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquire. Acquire the lock on the cache key object.
public void	acquireDeferredLock() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireDeferredLock. Acquire the deferred lock.
public boolean	acquireIfUnownedNoWait() Acquire the lock on the cache key object.
public void	acquireLock(ObjectBuildingQuery query)
public boolean	acquireNoWait() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireNoWait. Acquire the lock on the cache key object.
public boolean	acquireNoWait(boolean forMerge) Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireNoWait. Acquire the lock on the cache key object.
public void	acquireReadLock() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireReadLock. Acquire the read lock on the cache key object.
public boolean	acquireReadLockNoWait() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireReadLockNoWait. Acquire the read lock on the cache key object.
public boolean	acquireWithWait(boolean forMerge, int wait) Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireWithWait. Acquire the lock on the cache key object.
public void	checkDeferredLock() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.checkDeferredLock. Check the deferred lock on the cache key object.
public void	checkReadLock() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.checkReadLock. Check the read lock on the cache key object.
public Object	clone() Overrides java.lang.Object.clone. INTERNAL: Clones itself.
public boolean	equals(Object the reference object with which to compare. object) Overrides java.lang.Object.equals. Determine if the receiver is equal to anObject.
public boolean	equals(CacheKey key) Determine if the receiver is equal to key.
public Thread	getActiveThread() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.getActiveThread. Return the active thread.
public int	getInvalidationState() INTERNAL: Return the value of the invalidationState Variable The return value will be a constant CHECK_INVALIDATION_POLICY - The Invalidation policy is must be checked for this cache key's sate CACHE_KEY_INVALID - This cache key has been labeled invalid.
public Object	getKey()
public long	getLastUpdatedQueryId() INTERNAL: This method returns the system time in millis seconds at which this object was last refreshed CR #4365 CR #2698903 ...
public Object	getObject()
public IdentityMap	getOwningMap()
public AbstractRecord	getProtectedForeignKeys() INTERNAL: Return the FK cache
public long	getReadTime() INTERNAL: Return the current value of the Read Time variable
public DataRecord	getRecord()
public Object	getTransactionId()
public CacheKey	getWrappedCacheKey() If a Wrapper subclasses this CacheKey this method will be used to unwrap the cache key.
public Object	getWrapper()
public Object	getWriteLockValue()
public int	hashCode() Overrides java.lang.Object.hashCode. Overrides hashCode() in Object to use the primaryKey's hashCode for storage in data structures.
public boolean	hasProtectedForeignKeys() Returns true if the protectedForeignKeys record is non-null and non-empty, false otherwise.
public boolean	isIsolated() Returns true if this CacheKey is from an IsolatedClientSession
public boolean	isWrapper() Returns true if this Instance of CacheKey is a wrapper and should be unwrapped before passing to IdentityMap APIs.
public void	release() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.release. Release the lock on the cache key object.
public void	releaseDeferredLock() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.releaseDeferredLock. Release the deferred lock
public void	releaseReadLock() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.releaseReadLock. Release the read lock on the cache key object.
public Object	removeFromOwningMap() Removes this cacheKey from the owning map
public void	setInvalidationState(int invalidationState) INTERNAL: Set the value of the invalidationState Variable The possible values are from an enumeration of constants CHECK_INVALIDATION_POLICY - The invalidation policy is must be checked for this cache key's sate CACHE_KEY_INVALID - This cache key has been labelled invalid.
public void	setIsolated(boolean isIsolated)
public void	setIsWrapper(boolean isWrapper)
public void	setKey(Object key)
public void	setLastUpdatedQueryId(long id) INTERNAL: This method sets the system time in millis seconds at which this object was last refreshed CR #4365 CR #2698903 ...
public void	setObject(Object object)
public void	setOwningMap(IdentityMap map)
public void	setProtectedForeignKeys(AbstractRecord protectedForeignKeys)
public void	setReadTime(long readTime) INTERNAL: Set the read time of this cache key
public void	setRecord(DataRecord newDataRecord)
public void	setTransactionId(Object transactionId)
public void	setWrapper(Object wrapper)
public void	setWriteLockValue(Object writeLockValue)
public String	toString() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.toString. Print the nested depth.
public void	updateAccess() Notifies that cache key that it has been accessed.
public synchronized Object	waitForObject()

Inherited from org.eclipse.persistence.internal.helper.ConcurrencyManager:: acquireIfUnownedNoWait addReadLockToReadLockManager clearJustificationWhyMethodIsBuildingObjectCompleteReturnsFalse enrichStringBuildingExplainWhyThreadIsStuckInIsBuildObjectOnThreadComplete getConcurrencyManagerCreationDate getConcurrencyManagerId getDeferredLockManager getDeferredLockManagers getDepth getNumberOfReaders getNumberOfWritersWaiting getReadLockManager getReadLockManagerEnsureResultIsNotNull getReadLockManagers getStack getThreadsToWaitOnAcquire getThreadsToWaitOnAcquireMethodName getThreadsToWaitOnAcquireReadLock getThreadsToWaitOnAcquireReadLockMethodName getThreadsWaitingToReleaseDeferredLocks getThreadsWaitingToReleaseDeferredLocksJustification getTotalNumberOfKeysAcquiredForReading getTotalNumberOfKeysReleasedForReading getTotalNumberOfKeysReleasedForReadingBlewUpExceptionDueToCacheKeyHavingReachedCounterZero initializeDeferredLockManagers isAcquired isBuildObjectOnThreadComplete isLockedByMergeManager isNested putDeferredLock putThreadAsWaitingToAcquireLockForReading putThreadAsWaitingToAcquireLockForWriting releaseAllLocksAcquiredByThread removeDeferredLockManager removeReadLockFromReadLockManager removeReadLockManagerIfEmpty removeThreadNoLongerWaitingToAcquireLockForReading removeThreadNoLongerWaitingToAcquireLockForWriting setActiveThread setDepth setIsLockedByMergeManager setJustificationWhyMethodIsBuildingObjectCompleteReturnsFalse setNumberOfReaders setNumberOfWritersWaiting setShouldTrackStack setStack shouldTrackStack transitionToDeferredLock

Field Detail

CACHE_KEY_INVALID	back to summary
public static final int CACHE_KEY_INVALID

CHECK_INVALIDATION_POLICY	back to summary
public static final int CHECK_INVALIDATION_POLICY The following constants are used for the invalidationState variable

CREATION_THREAD_HASHCODE	back to summary
public final long CREATION_THREAD_HASHCODE

CREATION_THREAD_ID	back to summary
public final long CREATION_THREAD_ID

CREATION_THREAD_NAME	back to summary
public final String CREATION_THREAD_NAME

dataRecord	back to summary
protected DataRecord dataRecord This is used for Document Preservation to cache the record that this object was built from

invalidationState	back to summary
protected int invalidationState Invalidation State can be used to indicate whether this cache key is considered valid

isIsolated	back to summary
protected boolean isIsolated Set to true if this CacheKey comes from an IsolatedClientSession, or DatabaseSessionImpl.

isWrapper	back to summary
protected boolean isWrapper Stores if this CacheKey instance is a wrapper for the underlying CacheKey. CacheKey wrappers may be used with cache interceptors.

key	back to summary
protected Object key The key holds the vector of primary key values for the object.

lastUpdatedQueryId	back to summary
protected long lastUpdatedQueryId This attribute is the system time in milli seconds that the object was last refreshed on

mapOwner	back to summary
protected IdentityMap mapOwner

MAX_WAIT_TRIES	back to summary
public static final int MAX_WAIT_TRIES

object	back to summary
protected Object object

protectedForeignKeys	back to summary
protected AbstractRecord protectedForeignKeys Stores retrieved FK values for relationships that are not stored in the Entity

readTime	back to summary
protected long readTime The read time stores the millisecond value of the last time the object help by this cache key was confirmed as up to date.

transactionId	back to summary
protected Object transactionId The ID of the database transaction that last wrote the object. This is used for database change notification.

wrapper	back to summary
protected Object wrapper The cached wrapper for the object, used in EJB.

wrapper

back to summary

protected Object wrapper

The cached wrapper for the object, used in EJB.

writeLockValue	back to summary
protected Object writeLockValue The writeLock value is being held as an object so that it might contain a number or timestamp.

Constructor Detail

CacheKey	back to summary
protected CacheKey() Internal: Only used by subclasses that may want to wrap the cache key. Could be replaced by switching to an interface.

CacheKey	back to summary
public CacheKey(Object primaryKey)

CacheKey	back to summary
public CacheKey(Object primaryKey, Object object, Object lockValue)

CacheKey	back to summary
public CacheKey(Object primaryKey, Object object, Object lockValue, long readTime, boolean isIsolated)

Method Detail

acquire	back to summary
public void acquire() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquire. Acquire the lock on the cache key object. Annotations @Override

acquire

back to summary

public void acquire()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquire.

Acquire the lock on the cache key object.

Annotations

@Override

acquire	back to summary
public void acquire(boolean forMerge) Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquire. Acquire the lock on the cache key object. For the merge process called with true from the merge process, if true then the refresh will not refresh the object Annotations @Override

acquire

back to summary

public void acquire(boolean forMerge)

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquire.

Acquire the lock on the cache key object. For the merge process called with true from the merge process, if true then the refresh will not refresh the object

Annotations

@Override

acquireDeferredLock	back to summary
public void acquireDeferredLock() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireDeferredLock. Acquire the deferred lock. Annotations @Override

acquireDeferredLock

back to summary

public void acquireDeferredLock()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireDeferredLock.

Acquire the deferred lock.

Annotations

@Override

acquireIfUnownedNoWait	back to summary
public boolean acquireIfUnownedNoWait() Acquire the lock on the cache key object. Only acquire a lock if the cache key's active thread is not set. Added for Bug 5840635

acquireLock	back to summary
public void acquireLock(ObjectBuildingQuery query)

acquireNoWait	back to summary
public boolean acquireNoWait() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireNoWait. Acquire the lock on the cache key object. But only if the object has no lock on it Added for CR 2317 Annotations @Override

acquireNoWait

back to summary

public boolean acquireNoWait()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireNoWait.

Acquire the lock on the cache key object. But only if the object has no lock on it Added for CR 2317

Annotations

@Override

acquireNoWait	back to summary
public boolean acquireNoWait(boolean forMerge) Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireNoWait. Acquire the lock on the cache key object. But only if the object has no lock on it Added for CR 2317 called with true from the merge process, if true then the refresh will not refresh the object Annotations @Override

acquireNoWait

back to summary

public boolean acquireNoWait(boolean forMerge)

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireNoWait.

Acquire the lock on the cache key object. But only if the object has no lock on it Added for CR 2317 called with true from the merge process, if true then the refresh will not refresh the object

Annotations

@Override

acquireReadLock	back to summary
public void acquireReadLock() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireReadLock. Acquire the read lock on the cache key object. Annotations @Override

acquireReadLock

back to summary

public void acquireReadLock()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireReadLock.

Acquire the read lock on the cache key object.

Annotations

@Override

acquireReadLockNoWait	back to summary
public boolean acquireReadLockNoWait() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireReadLockNoWait. Acquire the read lock on the cache key object. Return true if acquired. Annotations @Override

acquireReadLockNoWait

back to summary

public boolean acquireReadLockNoWait()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireReadLockNoWait.

Acquire the read lock on the cache key object. Return true if acquired.

Annotations

@Override

acquireWithWait	back to summary
public boolean acquireWithWait(boolean forMerge, int wait) Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireWithWait. Acquire the lock on the cache key object. But only if the object has no lock on it Added for CR 2317 called with true from the merge process, if true then the refresh will not refresh the object Annotations @Override

acquireWithWait

back to summary

public boolean acquireWithWait(boolean forMerge, int wait)

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.acquireWithWait.

Acquire the lock on the cache key object. But only if the object has no lock on it Added for CR 2317 called with true from the merge process, if true then the refresh will not refresh the object

Annotations

@Override

checkDeferredLock	back to summary
public void checkDeferredLock() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.checkDeferredLock. Check the deferred lock on the cache key object. This can be called to ensure the cache key has a valid built object. It does not hold a lock, so the object could be refreshed afterwards. Annotations @Override

checkDeferredLock

back to summary

public void checkDeferredLock()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.checkDeferredLock.

Check the deferred lock on the cache key object. This can be called to ensure the cache key has a valid built object. It does not hold a lock, so the object could be refreshed afterwards.

Annotations

@Override

checkReadLock	back to summary
public void checkReadLock() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.checkReadLock. Check the read lock on the cache key object. This can be called to ensure the cache key has a valid built object. It does not hold a lock, so the object could be refreshed afterwards. Annotations @Override

checkReadLock

back to summary

public void checkReadLock()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.checkReadLock.

Check the read lock on the cache key object. This can be called to ensure the cache key has a valid built object. It does not hold a lock, so the object could be refreshed afterwards.

Annotations

@Override

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. INTERNAL: Clones itself. Returns:Object Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

clone

back to summary

public Object clone()

Overrides java.lang.Object.clone.

INTERNAL: Clones itself.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Determine if the receiver is equal to anObject. If anObject is a CacheKey, do further comparison, otherwise, return false. Parameters object:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override See Also `CacheKey#equals(CacheKey)`

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Determine if the receiver is equal to anObject. If anObject is a CacheKey, do further comparison, otherwise, return false.

Parameters

object:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

See Also

CacheKey#equals(CacheKey)

equals	back to summary
public boolean equals(CacheKey key) Determine if the receiver is equal to key. Use an index compare, because it is much faster than enumerations.

getActiveThread	back to summary
public Thread getActiveThread() Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.getActiveThread. Return the active thread. Annotations @Override

getActiveThread

back to summary

public Thread getActiveThread()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.getActiveThread.

Return the active thread.

Annotations

@Override

getInvalidationState	back to summary
public int getInvalidationState() INTERNAL: Return the value of the invalidationState Variable The return value will be a constant CHECK_INVALIDATION_POLICY - The Invalidation policy is must be checked for this cache key's sate CACHE_KEY_INVALID - This cache key has been labeled invalid.

getKey	back to summary
public Object getKey()

getLastUpdatedQueryId	back to summary
public long getLastUpdatedQueryId() INTERNAL: This method returns the system time in millis seconds at which this object was last refreshed CR #4365 CR #2698903 ... instead of using millis we will now use id's instead. Method renamed appropriately.

getObject	back to summary
public Object getObject()

getOwningMap	back to summary
public IdentityMap getOwningMap()

getProtectedForeignKeys	back to summary
public AbstractRecord getProtectedForeignKeys() INTERNAL: Return the FK cache

getReadTime	back to summary
public long getReadTime() INTERNAL: Return the current value of the Read Time variable

getRecord	back to summary
public DataRecord getRecord()

getTransactionId	back to summary
public Object getTransactionId()

getWrappedCacheKey	back to summary
public CacheKey getWrappedCacheKey() If a Wrapper subclasses this CacheKey this method will be used to unwrap the cache key.

getWrapper	back to summary
public Object getWrapper()

getWriteLockValue	back to summary
public Object getWriteLockValue()

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Overrides hashCode() in Object to use the primaryKey's hashCode for storage in data structures.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations

@Override

hasProtectedForeignKeys	back to summary
public boolean hasProtectedForeignKeys() Returns true if the protectedForeignKeys record is non-null and non-empty, false otherwise.

isIsolated	back to summary
public boolean isIsolated() Returns true if this CacheKey is from an IsolatedClientSession

isWrapper	back to summary
public boolean isWrapper() Returns true if this Instance of CacheKey is a wrapper and should be unwrapped before passing to IdentityMap APIs. Wrapped CacheKeys may be used in the Cache Interceptors.

release

back to summary

public void release()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.release.

Release the lock on the cache key object.

Annotations

@Override

releaseDeferredLock

back to summary

public void releaseDeferredLock()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.releaseDeferredLock.

Release the deferred lock

Annotations

@Override

releaseReadLock

back to summary

public void releaseReadLock()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.releaseReadLock.

Release the read lock on the cache key object.

Annotations

@Override

removeFromOwningMap	back to summary
public Object removeFromOwningMap() Removes this cacheKey from the owning map

setInvalidationState	back to summary
public void setInvalidationState(int invalidationState) INTERNAL: Set the value of the invalidationState Variable The possible values are from an enumeration of constants CHECK_INVALIDATION_POLICY - The invalidation policy is must be checked for this cache key's sate CACHE_KEY_INVALID - This cache key has been labelled invalid.

setIsolated	back to summary
public void setIsolated(boolean isIsolated)

setIsWrapper	back to summary
public void setIsWrapper(boolean isWrapper)

setKey	back to summary
public void setKey(Object key)

setLastUpdatedQueryId	back to summary
public void setLastUpdatedQueryId(long id) INTERNAL: This method sets the system time in millis seconds at which this object was last refreshed CR #4365 CR #2698903 ... instead of using millis we will now use ids instead. Method renamed appropriately.

setObject	back to summary
public void setObject(Object object)

setOwningMap	back to summary
public void setOwningMap(IdentityMap map)

setProtectedForeignKeys	back to summary
public void setProtectedForeignKeys(AbstractRecord protectedForeignKeys)

setReadTime	back to summary
public void setReadTime(long readTime) INTERNAL: Set the read time of this cache key

setRecord	back to summary
public void setRecord(DataRecord newDataRecord)

setTransactionId	back to summary
public void setTransactionId(Object transactionId)

setWrapper	back to summary
public void setWrapper(Object wrapper)

setWriteLockValue	back to summary
public void setWriteLockValue(Object writeLockValue)

toString

back to summary

public String toString()

Overrides org.eclipse.persistence.internal.helper.ConcurrencyManager.toString.

Doc from org.eclipse.persistence.internal.helper.ConcurrencyManager.toString.

Print the nested depth.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

updateAccess	back to summary
public void updateAccess() Notifies that cache key that it has been accessed. Allows the LRU sub-cache to be maintained.

waitForObject	back to summary
public synchronized Object waitForObject()

public Class CacheKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail