CacheKeyInterceptor (EclipseLink 2.4.2, "build v20130514-5956486" API Reference)

java.lang.Object
- org.eclipse.persistence.internal.identitymaps.CacheKey
- - org.eclipse.persistence.sessions.interceptors.CacheKeyInterceptor

All Implemented Interfaces:

java.io.Serializable, java.lang.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 inherited from class org.eclipse.persistence.internal.identitymaps.CacheKey
  CACHE_KEY_INVALID, CHECK_INVALIDATION_POLICY, MAX_WAIT_TRIES

Constructor Summary

Constructors
Constructor and Description

CacheKeyInterceptor(CacheKey cacheKey)

Constructors
Constructor and Description
`CacheKeyInterceptor(CacheKey cacheKey)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`java.lang.Object`	`clone()` INTERNAL: Clones itself.
`boolean`	`equals(CacheKey key)` Determine if the receiver is equal to key.
`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.
`java.lang.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 ...
`ConcurrencyManager`	`getMutex()` Return the concurrency manager.
`java.lang.Object`	`getObject()`
`IdentityMap`	`getOwningMap()`
`long`	`getReadTime()` INTERNAL: Return the current value of the Read Time variable
`Record`	`getRecord()`
`CacheKey`	`getWrappedCacheKey()` If a Wrapper subclasses this CacheKey this method will be used to unwrap the cache key.
`java.lang.Object`	`getWrapper()`
`java.lang.Object`	`getWriteLockValue()`
`int`	`hashCode()` Overrides hashCode() in Object to use the primaryKey's hashCode for storage in data structures.
`boolean`	`isAcquired()` Return if the lock is acquired
`void`	`release()` Release the lock on the cache key object.
`void`	`releaseDeferredLock()` Release the deferred lock
`void`	`releaseReadLock()` Release the read lock on the cache key object.
`java.lang.Object`	`removeFromOwningMap()` Removes this cacheKey from the owning map
`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.
`void`	`setKey(java.util.Vector 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`	`setMutex(ConcurrencyManager mutex)` Set the concurrency manager.
`void`	`setObject(java.lang.Object object)`
`void`	`setOwningMap(AbstractIdentityMap map)`
`void`	`setReadTime(long readTime)` INTERNAL: Set the read time of this cache key
`void`	`setRecord(Record newRecord)`
`void`	`setWrapper(java.lang.Object wrapper)`
`void`	`setWriteLockValue(java.lang.Object writeLockValue)`
`java.lang.String`	`toString()`
`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, isIsolated, isWrapper, setIsolated, setIsWrapper, setKey, setOwningMap, setProtectedForeignKeys, setTransactionId, transitionToDeferredLock, waitForObject

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CacheKeyInterceptor
```
public CacheKeyInterceptor(CacheKey cacheKey)
```
- Method Detail
  - acquire
```
public void acquire()
```
    Acquire the lock on the cache key object.
    
    Overrides:
    
    acquire in class CacheKey
  - 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
    
    Overrides:
    
    acquire in class CacheKey
  - 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 class CacheKey
  - 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 class CacheKey
  - 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 class CacheKey
  - acquireDeferredLock
```
public void acquireDeferredLock()
```
    Acquire the deferred lock.
    
    Overrides:
    
    acquireDeferredLock in class CacheKey
  - 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 class CacheKey
  - 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 class CacheKey
  - acquireReadLock
```
public void acquireReadLock()
```
    Acquire the read lock on the cache key object.
    
    Overrides:
    
    acquireReadLock in class CacheKey
  - acquireReadLockNoWait
```
public boolean acquireReadLockNoWait()
```
    Acquire the read lock on the cache key object.
    
    Overrides:
    
    acquireReadLockNoWait in class CacheKey
  - clone
```
public java.lang.Object clone()
```
    Description copied from class: CacheKey
    
    INTERNAL: Clones itself.
    
    Overrides:
    
    clone in class CacheKey
  - 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.
    
    Overrides:
    
    equals in class CacheKey
  - 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 class CacheKey
  - getKey
```
public java.lang.Object getKey()
```
    Overrides:
    
    getKey in class CacheKey
  - getMutex
```
public ConcurrencyManager getMutex()
```
    Description copied from class: CacheKey
    
    Return the concurrency manager.
    
    Overrides:
    
    getMutex in class CacheKey
  - getObject
```
public java.lang.Object getObject()
```
    Overrides:
    
    getObject in class CacheKey
  - getOwningMap
```
public IdentityMap getOwningMap()
```
    Overrides:
    
    getOwningMap in class CacheKey
  - getReadTime
```
public long getReadTime()
```
    INTERNAL: Return the current value of the Read Time variable
    
    Overrides:
    
    getReadTime in class CacheKey
  - getRecord
```
public Record getRecord()
```
    Overrides:
    
    getRecord in class CacheKey
  - getWrappedCacheKey
```
public CacheKey getWrappedCacheKey()
```
    If a Wrapper subclasses this CacheKey this method will be used to unwrap the cache key.
    
    Overrides:
    
    getWrappedCacheKey in class CacheKey
    
    Returns:
  - getWrapper
```
public java.lang.Object getWrapper()
```
    Overrides:
    
    getWrapper in class CacheKey
  - getWriteLockValue
```
public java.lang.Object getWriteLockValue()
```
    Overrides:
    
    getWriteLockValue in class CacheKey
  - hashCode
```
public int hashCode()
```
    Description copied from class: CacheKey
    
    Overrides hashCode() in Object to use the primaryKey's hashCode for storage in data structures.
    
    Overrides:
    
    hashCode in class CacheKey
  - isAcquired
```
public boolean isAcquired()
```
    Description copied from class: CacheKey
    
    Return if the lock is acquired
    
    Overrides:
    
    isAcquired in class CacheKey
  - 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 class CacheKey
  - release
```
public void release()
```
    Release the lock on the cache key object.
    
    Overrides:
    
    release in class CacheKey
  - releaseDeferredLock
```
public void releaseDeferredLock()
```
    Release the deferred lock
    
    Overrides:
    
    releaseDeferredLock in class CacheKey
  - releaseReadLock
```
public void releaseReadLock()
```
    Release the read lock on the cache key object.
    
    Overrides:
    
    releaseReadLock in class CacheKey
  - removeFromOwningMap
```
public java.lang.Object removeFromOwningMap()
```
    Removes this cacheKey from the owning map
    
    Overrides:
    
    removeFromOwningMap in class CacheKey
  - 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 class CacheKey
  - 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 class CacheKey
  - setKey
```
public void setKey(java.util.Vector key)
```
  - setMutex
```
public void setMutex(ConcurrencyManager mutex)
```
    Description copied from class: CacheKey
    
    Set the concurrency manager.
    
    Overrides:
    
    setMutex in class CacheKey
  - setObject
```
public void setObject(java.lang.Object object)
```
    Overrides:
    
    setObject in class CacheKey
  - 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 class CacheKey
  - setRecord
```
public void setRecord(Record newRecord)
```
    Overrides:
    
    setRecord in class CacheKey
  - setWrapper
```
public void setWrapper(java.lang.Object wrapper)
```
    Overrides:
    
    setWrapper in class CacheKey
  - setWriteLockValue
```
public void setWriteLockValue(java.lang.Object writeLockValue)
```
    Overrides:
    
    setWriteLockValue in class CacheKey
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class CacheKey
  - 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 class CacheKey

Class CacheKeyInterceptor

Field Summary

Fields inherited from class org.eclipse.persistence.internal.identitymaps.CacheKey

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.internal.identitymaps.CacheKey

Methods inherited from class java.lang.Object

Constructor Detail

CacheKeyInterceptor

Method Detail

acquire

acquire

acquireNoWait

acquireIfUnownedNoWait

acquireNoWait

acquireDeferredLock

checkReadLock

checkDeferredLock

acquireReadLock

acquireReadLockNoWait

clone

equals

getLastUpdatedQueryId

getKey

getMutex

getObject

getOwningMap

getReadTime

getRecord

getWrappedCacheKey

getWrapper

getWriteLockValue

hashCode

isAcquired

getInvalidationState

release

releaseDeferredLock

releaseReadLock

removeFromOwningMap

setInvalidationState

setLastUpdatedQueryId

setKey

setMutex

setObject

setOwningMap

setReadTime

setRecord

setWrapper

setWriteLockValue

toString

updateAccess