oracle.toplink.essentials.internal.sessions

Class IsolatedClientSessionIdentityMapAccessor

java.lang.Object

oracle.toplink.essentials.internal.sessions.IdentityMapAccessor

oracle.toplink.essentials.internal.sessions.IsolatedClientSessionIdentityMapAccessor

All Implemented Interfaces:

java.io.Serializable, IdentityMapAccessor

public class IsolatedClientSessionIdentityMapAccessor
extends IdentityMapAccessor

INTERNAL: Internal subclass that provides access to identity maps through the session. Implements the IdentityMapAccessor interface which provides all publicly available identity map functionality to users. This is the main class that should be used to access identity maps. In general, any function that accesses the identity map manager should go through this class Any session specific functionality appears in subclasses

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.toplink.essentials.internal.sessions.IdentityMapAccessor

identityMapManager, session

Constructor Summary

Constructors

Constructor and Description
IsolatedClientSessionIdentityMapAccessor(AbstractSession session, IdentityMapManager identityMapManager) INTERNAL: An IdentityMapAccessor sits between the session and the identityMapManager It needs references in both directions

Method Summary

Modifier and Type	Method and Description
CacheKey	acquireDeferredLock(java.util.Vector primaryKey, java.lang.Class javaClass, ClassDescriptor descriptor) INTERNAL: Deferred lock the identity map for the object, this is used for avoiding deadlock The return cacheKey should be used to release the deferred lock
CacheKey	acquireLock(java.util.Vector primaryKey, java.lang.Class domainClass, boolean forMerge, ClassDescriptor descriptor) INTERNAL: Provides access for setting a concurrency lock on an object in the IdentityMap.
CacheKey	acquireLockNoWait(java.util.Vector primaryKey, java.lang.Class domainClass, boolean forMerge, ClassDescriptor descriptor) INTERNAL: Provides access for setting a concurrency lock on an object in the IdentityMap.
CacheKey	acquireReadLockOnCacheKey(java.util.Vector primaryKey, java.lang.Class domainClass, ClassDescriptor descriptor) INTERNAL: Find the cachekey for the provided primary key and place a readlock on it.
CacheKey	acquireReadLockOnCacheKeyNoWait(java.util.Vector primaryKey, java.lang.Class domainClass, ClassDescriptor descriptor) INTERNAL: Find the cachekey for the provided primary key and place a readlock on it.
boolean	acquireWriteLock() INTERNAL: Lock the entire cache if the cache isolation requires.
boolean	containsKey(java.util.Vector key, java.lang.Class theClass, ClassDescriptor descriptor) INTERNAL: Return whether the identity maps contain an item of the given class and key
boolean	containsObjectInIdentityMap(java.util.Vector primaryKey, java.lang.Class theClass, ClassDescriptor descriptor) ADVANCED: Return if their is an object for the primary key.
java.util.Vector	getAllFromIdentityMap(Expression selectionCriteria, java.lang.Class theClass, Record translationRow, InMemoryQueryIndirectionPolicy valueHolderPolicy, boolean shouldReturnInvalidatedObjects) ADVANCED: Query the cache in-memory.
CacheKey	getCacheKeyForObject(java.util.Vector primaryKey, java.lang.Class myClass, ClassDescriptor descriptor) INTERNAL: Retrieve the cache key for the given identity information
java.util.Vector	getClassesRegistered() INTERNAL: This method is used to get a list of those classes with IdentityMaps in the Session.
java.lang.Object	getFromIdentityMap(Expression selectionCriteria, java.lang.Class theClass, Record translationRow, InMemoryQueryIndirectionPolicy valueHolderPolicy, boolean conforming, boolean shouldReturnInvalidatedObjects, ClassDescriptor descriptor) INTERNAL: Query the cache in-memory.
java.lang.Object	getFromIdentityMap(java.util.Vector primaryKey, java.lang.Class theClass, ClassDescriptor descriptor, JoinedAttributeManager joinedAttributeManager) ADVANCED: Return the object from the identity with the primary and class.
java.lang.Object	getFromIdentityMapWithDeferredLock(java.util.Vector primaryKey, java.lang.Class theClass, boolean shouldReturnInvalidatedObjects, ClassDescriptor descriptor) INTERNAL: Return the object from the identity with the primary and class.
IdentityMap	getIdentityMap(ClassDescriptor descriptor) INTERNAL: Get the identity map for the given class from the IdentityMapManager
IdentityMapManager	getIdentityMapManager() INTERNAL: Get the IdentityMapManager for this IdentityMapAccessor This method should be used for all IdentityMapManager access since it may be overridden in sub classes.
long	getRemainingValidTime(java.lang.Object object) ADVANCED: Return the remaining life of this object.
AbstractSession	getSession() INTERNAL: get the session associated with this IdentityMapAccessor
java.lang.Object	getWrapper(java.util.Vector primaryKey, java.lang.Class theClass) INTERNAL: Get the wrapper object from the cache key associated with the given primary key, this is used for EJB.
WriteLockManager	getWriteLockManager() INTERNAL: Returns the single write Lock manager for this session
java.lang.Object	getWriteLockValue(java.util.Vector primaryKey, java.lang.Class theClass, ClassDescriptor descriptor) ADVANCED: Extract the write lock value from the identity map.
void	initializeAllIdentityMaps() PUBLIC: Reset the entire object cache.
void	initializeIdentityMap(java.lang.Class theClass) PUBLIC: Reset the identity map for only the instances of the class.
void	initializeIdentityMaps() PUBLIC: Reset the entire local object cache.
CacheKey	internalPutInIdentityMap(java.lang.Object domainObject, java.util.Vector key, java.lang.Object writeLockValue, long readTime, ClassDescriptor descriptor) ADVANCED: Register the object with the identity map.
void	printIdentityMap(java.lang.Class businessClass) PUBLIC: Used to print all the objects in the identity map of the passed in class.
void	printIdentityMapLocks() PUBLIC: Used to print all the locks in every identity map in this session.
void	printIdentityMaps() PUBLIC: Used to print all the objects in every identity map in this session.
void	releaseWriteLock() INTERNAL: Lock the entire cache if the cache isolation requires.
java.lang.Object	removeFromIdentityMap(java.util.Vector key, java.lang.Class theClass, ClassDescriptor descriptor) ADVANCED: Remove the object from the object cache.
void	setIdentityMapManager(IdentityMapManager identityMapManager) INTERNAL: Set the IdentityMapManager for this IdentityMapAccessor
void	setWrapper(java.util.Vector primaryKey, java.lang.Class theClass, java.lang.Object wrapper) INTERNAL: Update the wrapper object the cache key associated with the given primary key, this is used for EJB.
void	updateWriteLockValue(java.util.Vector primaryKey, java.lang.Class theClass, java.lang.Object writeLockValue) ADVANCED: Update the write lock value in the identity map.

Methods inherited from class oracle.toplink.essentials.internal.sessions.IdentityMapAccessor

acquireLock, clearQueryCache, clearQueryCache, clearQueryCache, clearQueryCache, containsObjectInIdentityMap, containsObjectInIdentityMap, containsObjectInIdentityMap, extractPrimaryKeyFromRow, getAllFromIdentityMap, getAllFromIdentityMap, getCacheKeyForObject, getFromIdentityMap, getFromIdentityMap, getFromIdentityMap, getFromIdentityMap, getFromIdentityMap, getFromIdentityMap, getFromIdentityMap, getFromIdentityMap, getFromIdentityMap, getFromIdentityMap, getFromIdentityMapWithDeferredLock, getIdentityMap, getWriteLockValue, getWriteLockValue, invalidateAll, invalidateClass, invalidateClass, invalidateObject, invalidateObject, invalidateObject, invalidateObjects, invalidateObjects, isValid, isValid, isValid, putInIdentityMap, putInIdentityMap, putInIdentityMap, putInIdentityMap, putInIdentityMap, removeFromIdentityMap, removeFromIdentityMap, updateWriteLockValue, validateCache

Methods inherited from class java.lang.Object

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

Constructor Detail

IsolatedClientSessionIdentityMapAccessor

public IsolatedClientSessionIdentityMapAccessor(AbstractSession session,
                                                IdentityMapManager identityMapManager)

INTERNAL: An IdentityMapAccessor sits between the session and the identityMapManager It needs references in both directions

Method Detail

acquireDeferredLock

public CacheKey acquireDeferredLock(java.util.Vector primaryKey,
                                    java.lang.Class javaClass,
                                    ClassDescriptor descriptor)

INTERNAL: Deferred lock the identity map for the object, this is used for avoiding deadlock The return cacheKey should be used to release the deferred lock

Overrides:

acquireDeferredLock in class IdentityMapAccessor

acquireLock

public CacheKey acquireLock(java.util.Vector primaryKey,
                            java.lang.Class domainClass,
                            boolean forMerge,
                            ClassDescriptor descriptor)

INTERNAL: Provides access for setting a concurrency lock on an object in the IdentityMap. called with true from the merge process, if true then the refresh will not refresh the object

Overrides:

acquireLock in class IdentityMapAccessor

See Also:

IdentityMap#aquire

acquireLockNoWait

public CacheKey acquireLockNoWait(java.util.Vector primaryKey,
                                  java.lang.Class domainClass,
                                  boolean forMerge,
                                  ClassDescriptor descriptor)

INTERNAL: Provides access for setting a concurrency lock on an object in the IdentityMap. called with true from the merge process, if true then the refresh will not refresh the object

Overrides:

acquireLockNoWait in class IdentityMapAccessor

See Also:

IdentityMap#aquire

acquireReadLockOnCacheKey

public CacheKey acquireReadLockOnCacheKey(java.util.Vector primaryKey,
                                          java.lang.Class domainClass,
                                          ClassDescriptor descriptor)

INTERNAL: Find the cachekey for the provided primary key and place a readlock on it. This will allow multiple users to read the same object but prevent writes to the object while the read lock is held.

Overrides:

acquireReadLockOnCacheKey in class IdentityMapAccessor

acquireReadLockOnCacheKeyNoWait

public CacheKey acquireReadLockOnCacheKeyNoWait(java.util.Vector primaryKey,
                                                java.lang.Class domainClass,
                                                ClassDescriptor descriptor)

INTERNAL: Find the cachekey for the provided primary key and place a readlock on it. This will allow multiple users to read the same object but prevent writes to the object while the read lock is held. If no readlock can be acquired then do not wait but return null.

Overrides:

acquireReadLockOnCacheKeyNoWait in class IdentityMapAccessor

acquireWriteLock

public boolean acquireWriteLock()

INTERNAL: Lock the entire cache if the cache isolation requires. By default concurrent reads and writes are allowed. By write, unit of work merge is meant.

Overrides:

acquireWriteLock in class IdentityMapAccessor

containsKey

public boolean containsKey(java.util.Vector key,
                           java.lang.Class theClass,
                           ClassDescriptor descriptor)

INTERNAL: Return whether the identity maps contain an item of the given class and key

Overrides:

containsKey in class IdentityMapAccessor

containsObjectInIdentityMap

public boolean containsObjectInIdentityMap(java.util.Vector primaryKey,
                                           java.lang.Class theClass,
                                           ClassDescriptor descriptor)

ADVANCED: Return if their is an object for the primary key.

Overrides:

containsObjectInIdentityMap in class IdentityMapAccessor

getClassesRegistered

public java.util.Vector getClassesRegistered()

INTERNAL: This method is used to get a list of those classes with IdentityMaps in the Session.

Overrides:

getClassesRegistered in class IdentityMapAccessor

getAllFromIdentityMap

public java.util.Vector getAllFromIdentityMap(Expression selectionCriteria,
                                              java.lang.Class theClass,
                                              Record translationRow,
                                              InMemoryQueryIndirectionPolicy valueHolderPolicy,
                                              boolean shouldReturnInvalidatedObjects)
                                       throws QueryException

ADVANCED: Query the cache in-memory. If the expression is too complex an exception will be thrown. Only return objects that are invalid in the cache if specified.

Specified by:

getAllFromIdentityMap in interface IdentityMapAccessor

Overrides:

getAllFromIdentityMap in class IdentityMapAccessor

Parameters:

selectionCriteria - Expression selecting the Objects to be returned

theClass - Class to be considered

translationRow - Record

valueHolderPolicy - see InMemoryQueryIndirectionPolicy

shouldReturnInvalidatedObjects - boolean - true if only invalid Objects should be returned

Returns:

Vector of Objects

Throws:

QueryException

getCacheKeyForObject

public CacheKey getCacheKeyForObject(java.util.Vector primaryKey,
                                     java.lang.Class myClass,
                                     ClassDescriptor descriptor)

INTERNAL: Retrieve the cache key for the given identity information

Overrides:

getCacheKeyForObject in class IdentityMapAccessor

Parameters:

Vector - the primary key of the cache key to be retrieved

Class - the class of the cache key to be retrieved

Returns:

CacheKey

getFromIdentityMap

public java.lang.Object getFromIdentityMap(java.util.Vector primaryKey,
                                           java.lang.Class theClass,
                                           ClassDescriptor descriptor,
                                           JoinedAttributeManager joinedAttributeManager)

ADVANCED: Return the object from the identity with the primary and class.

Overrides:

getFromIdentityMap in class IdentityMapAccessor

getFromIdentityMap

public java.lang.Object getFromIdentityMap(Expression selectionCriteria,
                                           java.lang.Class theClass,
                                           Record translationRow,
                                           InMemoryQueryIndirectionPolicy valueHolderPolicy,
                                           boolean conforming,
                                           boolean shouldReturnInvalidatedObjects,
                                           ClassDescriptor descriptor)

INTERNAL: Query the cache in-memory. If the object is not found null is returned. If the expression is too complex an exception will be thrown.

Overrides:

getFromIdentityMap in class IdentityMapAccessor

getFromIdentityMapWithDeferredLock

public java.lang.Object getFromIdentityMapWithDeferredLock(java.util.Vector primaryKey,
                                                           java.lang.Class theClass,
                                                           boolean shouldReturnInvalidatedObjects,
                                                           ClassDescriptor descriptor)

INTERNAL: Return the object from the identity with the primary and class. Only return invalidated objects if requested

Overrides:

getFromIdentityMapWithDeferredLock in class IdentityMapAccessor

getIdentityMapManager

public IdentityMapManager getIdentityMapManager()

INTERNAL: Get the IdentityMapManager for this IdentityMapAccessor This method should be used for all IdentityMapManager access since it may be overridden in sub classes.

Overrides:

getIdentityMapManager in class IdentityMapAccessor

getIdentityMap

public IdentityMap getIdentityMap(ClassDescriptor descriptor)

INTERNAL: Get the identity map for the given class from the IdentityMapManager

Overrides:

getIdentityMap in class IdentityMapAccessor

getRemainingValidTime

public long getRemainingValidTime(java.lang.Object object)

ADVANCED: Return the remaining life of this object. This method is associated with use of TopLink's cache invalidation feature and returns the difference between the next expiry time of the object and its read time. The method will return 0 for invalidated objects.

Specified by:

getRemainingValidTime in interface IdentityMapAccessor

Overrides:

getRemainingValidTime in class IdentityMapAccessor

Parameters:

object - Object under consideration

Returns:

long time in milliseconds

getSession

public AbstractSession getSession()

INTERNAL: get the session associated with this IdentityMapAccessor

Overrides:

getSession in class IdentityMapAccessor

getWrapper

public java.lang.Object getWrapper(java.util.Vector primaryKey,
                                   java.lang.Class theClass)

INTERNAL: Get the wrapper object from the cache key associated with the given primary key, this is used for EJB.

Overrides:

getWrapper in class IdentityMapAccessor

getWriteLockManager

public WriteLockManager getWriteLockManager()

INTERNAL: Returns the single write Lock manager for this session

Overrides:

getWriteLockManager in class IdentityMapAccessor

getWriteLockValue

public java.lang.Object getWriteLockValue(java.util.Vector primaryKey,
                                          java.lang.Class theClass,
                                          ClassDescriptor descriptor)

ADVANCED: Extract the write lock value from the identity map.

Overrides:

getWriteLockValue in class IdentityMapAccessor

initializeAllIdentityMaps

public void initializeAllIdentityMaps()

PUBLIC: Reset the entire object cache.

NOTE: be careful using this method. This method blows away both this session's and its parents caches, this includes the server cache or any other cache. This throws away any objects that have been read in. Extream caution should be used before doing this because object identity will no longer be maintained for any objects currently read in. This should only be called if the application knows that it no longer has references to object held in the cache.

Specified by:

initializeAllIdentityMaps in interface IdentityMapAccessor

Overrides:

initializeAllIdentityMaps in class IdentityMapAccessor

initializeIdentityMap

public void initializeIdentityMap(java.lang.Class theClass)

PUBLIC: Reset the identity map for only the instances of the class. For inheritance the user must make sure that they only use the root class. Caution must be used in doing this to ensure that the objects within the identity map are not referenced from other objects of other classes or from the application.

Specified by:

initializeIdentityMap in interface IdentityMapAccessor

Overrides:

initializeIdentityMap in class IdentityMapAccessor

Parameters:

theClass - Class

initializeIdentityMaps

public void initializeIdentityMaps()

PUBLIC: Reset the entire local object cache. This throws away any objects that have been read in. Extream caution should be used before doing this because object identity will no longer be maintained for any objects currently read in. This should only be called if the application knows that it no longer has references to object held in the cache.

Specified by:

initializeIdentityMaps in interface IdentityMapAccessor

Overrides:

initializeIdentityMaps in class IdentityMapAccessor

printIdentityMap

public void printIdentityMap(java.lang.Class businessClass)

PUBLIC: Used to print all the objects in the identity map of the passed in class. The output of this method will be logged to this session's SessionLog at SEVERE level.

Specified by:

printIdentityMap in interface IdentityMapAccessor

Overrides:

printIdentityMap in class IdentityMapAccessor

Parameters:

businessClass - Class

printIdentityMaps

public void printIdentityMaps()

PUBLIC: Used to print all the objects in every identity map in this session. The output of this method will be logged to this session's SessionLog at SEVERE level.

Specified by:

printIdentityMaps in interface IdentityMapAccessor

Overrides:

printIdentityMaps in class IdentityMapAccessor

printIdentityMapLocks

public void printIdentityMapLocks()

PUBLIC: Used to print all the locks in every identity map in this session. The output of this method will be logged to this session's SessionLog at FINEST level.

Specified by:

printIdentityMapLocks in interface IdentityMapAccessor

Overrides:

printIdentityMapLocks in class IdentityMapAccessor

internalPutInIdentityMap

public CacheKey internalPutInIdentityMap(java.lang.Object domainObject,
                                         java.util.Vector key,
                                         java.lang.Object writeLockValue,
                                         long readTime,
                                         ClassDescriptor descriptor)

ADVANCED: Register the object with the identity map. The object must always be registered with its version number if optimistic locking is used. The readTime may also be included in the cache key as it is constructed.

Overrides:

internalPutInIdentityMap in class IdentityMapAccessor

releaseWriteLock

public void releaseWriteLock()

INTERNAL: Lock the entire cache if the cache isolation requires. By default concurrent reads and writes are allowed. By write, unit of work merge is meant.

Overrides:

releaseWriteLock in class IdentityMapAccessor

removeFromIdentityMap

public java.lang.Object removeFromIdentityMap(java.util.Vector key,
                                              java.lang.Class theClass,
                                              ClassDescriptor descriptor)

ADVANCED: Remove the object from the object cache.

Overrides:

removeFromIdentityMap in class IdentityMapAccessor

setIdentityMapManager

public void setIdentityMapManager(IdentityMapManager identityMapManager)

INTERNAL: Set the IdentityMapManager for this IdentityMapAccessor

Overrides:

setIdentityMapManager in class IdentityMapAccessor

setWrapper

public void setWrapper(java.util.Vector primaryKey,
                       java.lang.Class theClass,
                       java.lang.Object wrapper)

INTERNAL: Update the wrapper object the cache key associated with the given primary key, this is used for EJB.

Overrides:

setWrapper in class IdentityMapAccessor

updateWriteLockValue

public void updateWriteLockValue(java.util.Vector primaryKey,
                                 java.lang.Class theClass,
                                 java.lang.Object writeLockValue)

ADVANCED: Update the write lock value in the identity map.

Specified by:

updateWriteLockValue in interface IdentityMapAccessor

Overrides:

updateWriteLockValue in class IdentityMapAccessor

Parameters:

primaryKey - Vector

theClass - Class

writeLockValue - Object for versioning