Class CacheKeyInterceptor
- java.lang.Object
-
- org.eclipse.persistence.internal.helper.ConcurrencyManager
-
- org.eclipse.persistence.internal.identitymaps.CacheKey
-
- org.eclipse.persistence.sessions.interceptors.CacheKeyInterceptor
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class CacheKeyInterceptor extends CacheKey
The CacheKeyInterceptor allows a Cache Interceptor implementation to wrap the EclipseLink CacheKey. The CacheKey is an object that wraps the object and maintains cached based information about the object like primary key, write lock value and locking. The EclipseLink runtime will access the CacheKey and directly when releasing locks.- Author:
- Gordon Yorke
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected CacheKey
wrappedKey
-
Fields inherited from class org.eclipse.persistence.internal.identitymaps.CacheKey
CACHE_KEY_INVALID, CHECK_INVALIDATION_POLICY, CREATION_THREAD_HASHCODE, CREATION_THREAD_ID, CREATION_THREAD_NAME, invalidationState, isIsolated, isWrapper, key, lastUpdatedQueryId, mapOwner, MAX_WAIT_TRIES, object, protectedForeignKeys, readTime, record, transactionId, wrapper, writeLockValue
-
Fields inherited from class org.eclipse.persistence.internal.helper.ConcurrencyManager
activeThread, DEFERRED_LOCK_MANAGERS, depth, lockedByMergeManager, numberOfReaders, numberOfWritersWaiting, shouldTrackStack, stack
-
-
Constructor Summary
Constructors Constructor Description CacheKeyInterceptor(CacheKey cacheKey)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
acquire()
Acquire the lock on the cache key object.void
acquire(boolean forMerge)
Acquire the lock on the cache key object.void
acquireDeferredLock()
Acquire the deferred lock.boolean
acquireIfUnownedNoWait()
Acquire the lock on the cache key object.boolean
acquireNoWait()
Acquire the lock on the cache key object.boolean
acquireNoWait(boolean forMerge)
Acquire the lock on the cache key object.void
acquireReadLock()
Acquire the read lock on the cache key object.boolean
acquireReadLockNoWait()
Acquire the read lock on the cache key object.void
checkDeferredLock()
Check the deferred lock on the cache key object.void
checkReadLock()
Check the read lock on the cache key object.Object
clone()
INTERNAL: Clones itself.boolean
equals(CacheKey key)
Determine if the receiver is equal to key.Thread
getActiveThread()
Return the active thread.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.Object
getKey()
long
getLastUpdatedQueryId()
INTERNAL: This method returns the system time in millis seconds at which this object was last refreshed CR #4365 CR #2698903 ...Object
getObject()
IdentityMap
getOwningMap()
long
getReadTime()
INTERNAL: Return the current value of the Read Time variableRecord
getRecord()
CacheKey
getWrappedCacheKey()
If a Wrapper subclasses this CacheKey this method will be used to unwrap the cache key.Object
getWrapper()
Object
getWriteLockValue()
int
hashCode()
Overrides hashCode() in Object to use the primaryKey's hashCode for storage in data structures.boolean
isAcquired()
Return if a thread has acquire this manager.void
release()
Release the lock on the cache key object.void
releaseDeferredLock()
Release the deferred lockvoid
releaseReadLock()
Release the read lock on the cache key object.Object
removeFromOwningMap()
Removes this cacheKey from the owning mapvoid
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.void
setKey(Object key)
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 ...void
setObject(Object object)
void
setOwningMap(AbstractIdentityMap map)
void
setReadTime(long readTime)
INTERNAL: Set the read time of this cache keyvoid
setRecord(Record newRecord)
void
setWrapper(Object wrapper)
void
setWriteLockValue(Object writeLockValue)
String
toString()
Print the nested depth.void
updateAccess()
Notifies that cache key that it has been accessed.-
Methods inherited from class org.eclipse.persistence.internal.identitymaps.CacheKey
acquireLock, acquireWithWait, equals, getProtectedForeignKeys, getTransactionId, hasProtectedForeignKeys, isIsolated, isWrapper, setIsolated, setIsWrapper, setOwningMap, setProtectedForeignKeys, setTransactionId, waitForObject
-
Methods inherited from class 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, isBuildObjectOnThreadComplete, isLockedByMergeManager, isNested, putDeferredLock, putThreadAsWaitingToAcquireLockForReading, putThreadAsWaitingToAcquireLockForWriting, releaseAllLocksAcquiredByThread, removeDeferredLockManager, removeReadLockFromReadLockManager, removeReadLockManagerIfEmpty, removeThreadNoLongerWaitingToAcquireLockForReading, removeThreadNoLongerWaitingToAcquireLockForWriting, setActiveThread, setDepth, setIsLockedByMergeManager, setJustificationWhyMethodIsBuildingObjectCompleteReturnsFalse, setNumberOfReaders, setNumberOfWritersWaiting, setShouldTrackStack, setStack, shouldTrackStack, transitionToDeferredLock
-
-
-
-
Field Detail
-
wrappedKey
protected CacheKey wrappedKey
-
-
Constructor Detail
-
CacheKeyInterceptor
public CacheKeyInterceptor(CacheKey cacheKey)
-
-
Method Detail
-
acquire
public void acquire()
Acquire the lock on the cache key object.
-
acquire
public void acquire(boolean forMerge)
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
-
acquireNoWait
public boolean acquireNoWait()
Acquire the lock on the cache key object. But only if the object has no lock on it Added for CR 2317- Overrides:
acquireNoWait
in classCacheKey
-
acquireIfUnownedNoWait
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- Overrides:
acquireIfUnownedNoWait
in classCacheKey
-
acquireNoWait
public boolean acquireNoWait(boolean forMerge)
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- Overrides:
acquireNoWait
in classCacheKey
-
acquireDeferredLock
public void acquireDeferredLock()
Acquire the deferred lock.- Overrides:
acquireDeferredLock
in classCacheKey
-
checkReadLock
public void checkReadLock()
Description copied from class:CacheKey
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.- Overrides:
checkReadLock
in classCacheKey
-
checkDeferredLock
public void checkDeferredLock()
Description copied from class:CacheKey
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.- Overrides:
checkDeferredLock
in classCacheKey
-
acquireReadLock
public void acquireReadLock()
Acquire the read lock on the cache key object.- Overrides:
acquireReadLock
in classCacheKey
-
acquireReadLockNoWait
public boolean acquireReadLockNoWait()
Acquire the read lock on the cache key object.- Overrides:
acquireReadLockNoWait
in classCacheKey
-
getActiveThread
public Thread getActiveThread()
Return the active thread.- Overrides:
getActiveThread
in classCacheKey
-
equals
public boolean equals(CacheKey key)
Description copied from class:CacheKey
Determine if the receiver is equal to key. Use an index compare, because it is much faster than enumerations.
-
getLastUpdatedQueryId
public long getLastUpdatedQueryId()
Description copied from class:CacheKey
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.- Overrides:
getLastUpdatedQueryId
in classCacheKey
-
getOwningMap
public IdentityMap getOwningMap()
- Overrides:
getOwningMap
in classCacheKey
-
getReadTime
public long getReadTime()
INTERNAL: Return the current value of the Read Time variable- Overrides:
getReadTime
in classCacheKey
-
getWrappedCacheKey
public CacheKey getWrappedCacheKey()
If a Wrapper subclasses this CacheKey this method will be used to unwrap the cache key.- Overrides:
getWrappedCacheKey
in classCacheKey
- Returns:
-
getWrapper
public Object getWrapper()
- Overrides:
getWrapper
in classCacheKey
-
getWriteLockValue
public Object getWriteLockValue()
- Overrides:
getWriteLockValue
in classCacheKey
-
hashCode
public int hashCode()
Description copied from class:CacheKey
Overrides hashCode() in Object to use the primaryKey's hashCode for storage in data structures.
-
isAcquired
public boolean isAcquired()
Description copied from class:ConcurrencyManager
Return if a thread has acquire this manager.- Overrides:
isAcquired
in classConcurrencyManager
-
getInvalidationState
public int getInvalidationState()
Description copied from class:CacheKey
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.- Overrides:
getInvalidationState
in classCacheKey
-
release
public void release()
Release the lock on the cache key object.
-
releaseDeferredLock
public void releaseDeferredLock()
Release the deferred lock- Overrides:
releaseDeferredLock
in classCacheKey
-
releaseReadLock
public void releaseReadLock()
Release the read lock on the cache key object.- Overrides:
releaseReadLock
in classCacheKey
-
removeFromOwningMap
public Object removeFromOwningMap()
Removes this cacheKey from the owning map- Overrides:
removeFromOwningMap
in classCacheKey
-
setInvalidationState
public void setInvalidationState(int invalidationState)
Description copied from class:CacheKey
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.- Overrides:
setInvalidationState
in classCacheKey
-
setLastUpdatedQueryId
public void setLastUpdatedQueryId(long id)
Description copied from class:CacheKey
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.- Overrides:
setLastUpdatedQueryId
in classCacheKey
-
setOwningMap
public void setOwningMap(AbstractIdentityMap map)
-
setReadTime
public void setReadTime(long readTime)
Description copied from class:CacheKey
INTERNAL: Set the read time of this cache key- Overrides:
setReadTime
in classCacheKey
-
setWrapper
public void setWrapper(Object wrapper)
- Overrides:
setWrapper
in classCacheKey
-
setWriteLockValue
public void setWriteLockValue(Object writeLockValue)
- Overrides:
setWriteLockValue
in classCacheKey
-
toString
public String toString()
Description copied from class:ConcurrencyManager
Print the nested depth.
-
updateAccess
public void updateAccess()
Description copied from class:CacheKey
Notifies that cache key that it has been accessed. Allows the LRU sub-cache to be maintained.- Overrides:
updateAccess
in classCacheKey
-
-