oracle.toplink.essentials.internal.sessions

Class IdentityMapAccessor

java.lang.Object

oracle.toplink.essentials.internal.sessions.IdentityMapAccessor

All Implemented Interfaces:

Serializable, IdentityMapAccessor

Direct Known Subclasses:

ClientSessionIdentityMapAccessor, IsolatedClientSessionIdentityMapAccessor, UnitOfWorkIdentityMapAccessor

public class IdentityMapAccessor
extends Object
implements IdentityMapAccessor, Serializable

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

Modifier and Type	Field and Description
protected IdentityMapManager	identityMapManager This is the identity map manager for this accessor.
protected AbstractSession	session

Constructor Summary

Constructors

Constructor and Description
IdentityMapAccessor(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(Vector primarKey, 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(Vector primaryKey, Class domainClass, boolean forMerge, ClassDescriptor descriptor) INTERNAL: Provides access for setting a concurrency lock on an object in the IdentityMap.
CacheKey	acquireLock(Vector primarKey, Class javaClass, ClassDescriptor descriptor) INTERNAL: Lock the identity map for the object, this must be done when building objects.
CacheKey	acquireLockNoWait(Vector primaryKey, Class domainClass, boolean forMerge, ClassDescriptor descriptor) INTERNAL: Provides access for setting a concurrency lock on an object in the IdentityMap.
CacheKey	acquireReadLockOnCacheKey(Vector primaryKey, Class domainClass, ClassDescriptor descriptor) INTERNAL: Find the cachekey for the provided primary key and place a readlock on it.
CacheKey	acquireReadLockOnCacheKeyNoWait(Vector primaryKey, 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.
void	clearQueryCache() ADVANCED: Clear all the query caches
void	clearQueryCache(ReadQuery query) ADVANCED: Clear the query class associated with the passed-in read query
void	clearQueryCache(String sessionQueryName) ADVANCED: Clear the query cache associated with the named query on the session
void	clearQueryCache(String descriptorQueryName, Class queryClass) ADVANCED: Clear the query cache associated with the named query on the descriptor for the given class
boolean	containsKey(Vector key, Class theClass, ClassDescriptor descriptor) INTERNAL: Return whether the identity maps contain an item of the given class and key
boolean	containsObjectInIdentityMap(Object object) ADVANCED: Return if their is an object for the primary key.
boolean	containsObjectInIdentityMap(Record rowContainingPrimaryKey, Class theClass) ADVANCED: Return if their is an object for the row containing primary key and the class.
boolean	containsObjectInIdentityMap(Vector primaryKey, Class theClass) ADVANCED: Return if their is an object for the primary key.
boolean	containsObjectInIdentityMap(Vector primaryKey, Class theClass, ClassDescriptor descriptor) INTERNAL: Return if their is an object for the primary key.
protected Vector	extractPrimaryKeyFromRow(Record rowContainingPrimaryKey, Class theClass) INTERNAL: Extract primary key from a row
Vector	getAllFromIdentityMap(Expression selectionCriteria, Class theClass, Record translationRow) ADVANCED: Query the cache in-memory.
Vector	getAllFromIdentityMap(Expression selectionCriteria, Class theClass, Record translationRow, InMemoryQueryIndirectionPolicy valueHolderPolicy) ADVANCED: Query the cache in-memory.
Vector	getAllFromIdentityMap(Expression selectionCriteria, Class theClass, Record translationRow, InMemoryQueryIndirectionPolicy valueHolderPolicy, boolean shouldReturnInvalidatedObjects) ADVANCED: Query the cache in-memory.
CacheKey	getCacheKeyForObject(Object object, ClassDescriptor descriptor) INTERNAL: Retrieve the cache key for the given object from the identity maps
CacheKey	getCacheKeyForObject(Vector primaryKey, Class myClass, ClassDescriptor descriptor) INTERNAL: Retrieve the cache key for the given identity information
Vector	getClassesRegistered() INTERNAL: This method is used to get a list of those classes with IdentityMaps in the Session.
Object	getFromIdentityMap(Expression selectionCriteria, Class theClass, Record translationRow) ADVANCED: Query the cache in-memory.
Object	getFromIdentityMap(Expression selectionCriteria, Class theClass, Record translationRow, InMemoryQueryIndirectionPolicy valueHolderPolicy) ADVANCED: Query the cache in-memory.
Object	getFromIdentityMap(Expression selectionCriteria, Class theClass, Record translationRow, InMemoryQueryIndirectionPolicy valueHolderPolicy, boolean conforming) INTERNAL: Query the cache in-memory.
Object	getFromIdentityMap(Expression selectionCriteria, Class theClass, Record translationRow, InMemoryQueryIndirectionPolicy valueHolderPolicy, boolean conforming, boolean shouldReturnInvalidatedObjects) INTERNAL: Query the cache in-memory.
Object	getFromIdentityMap(Expression selectionCriteria, Class theClass, Record translationRow, InMemoryQueryIndirectionPolicy valueHolderPolicy, boolean conforming, boolean shouldReturnInvalidatedObjects, ClassDescriptor descriptor) INTERNAL: Query the cache in-memory.
Object	getFromIdentityMap(Object object) ADVANCED: Return the object from the identity with primary and class of the given object.
Object	getFromIdentityMap(Record rowContainingPrimaryKey, Class theClass) ADVANCED: Return the object from the identity with the primary and class.
Object	getFromIdentityMap(Record rowContainingPrimaryKey, Class theClass, boolean shouldReturnInvalidatedObjects) ADVANCED: Return the object from the identity with the primary and class.
Object	getFromIdentityMap(Vector primaryKey, Class theClass) ADVANCED: Return the object from the identity with the primary and class.
Object	getFromIdentityMap(Vector primaryKey, Class theClass, boolean shouldReturnInvalidatedObjects) ADVANCED: Return the object from the identity with the primary and class.
Object	getFromIdentityMap(Vector primaryKey, Class theClass, boolean shouldReturnInvalidatedObjects, ClassDescriptor descriptor, JoinedAttributeManager joinedAttributeManager) INTERNAL: Return the object from the identity with the primary and class.
Object	getFromIdentityMap(Vector primaryKey, Class theClass, ClassDescriptor descriptor, JoinedAttributeManager joinedAttributeManager) INTERNAL: Return the object from the identity with the primary and class.
Object	getFromIdentityMapWithDeferredLock(Vector primaryKey, Class theClass, boolean shouldReturnInvalidatedObjects, ClassDescriptor descriptor) INTERNAL: Return the object from the identity with the primary and class.
Object	getFromIdentityMapWithDeferredLock(Vector primaryKey, Class theClass, ClassDescriptor descriptor) INTERNAL: Return the object from the identity with the primary and class.
IdentityMap	getIdentityMap(Class theClass) INTERNAL: Get the identity map for the given class from the IdentityMapManager
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(Object object) ADVANCED: Return the remaining life of this object.
AbstractSession	getSession() INTERNAL: get the session associated with this IdentityMapAccessor
Object	getWrapper(Vector primaryKey, 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
Object	getWriteLockValue(Object object) ADVANCED: Extract the write lock value from the identity map.
Object	getWriteLockValue(Vector primaryKey, Class theClass) ADVANCED: Extract the write lock value from the identity map.
Object	getWriteLockValue(Vector primaryKey, Class theClass, ClassDescriptor descriptor) ADVANCED: Extract the write lock value from the identity map.
void	initializeAllIdentityMaps() PUBLIC: Reset the entire object cache.
void	initializeIdentityMap(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(Object object, Vector key, Object writeLockValue, long readTime, ClassDescriptor descriptor) INTERNAL: Register the object with the identity map.
void	invalidateAll() ADVANCED: Set all of the objects from all identity maps to be invalid in TopLink's identity maps.
void	invalidateClass(Class myClass) ADVANCED: Set all of the objects of a specific class to be invalid in TopLink's identity maps Will set the recurse on inheritance to true.
void	invalidateClass(Class myClass, boolean recurse) ADVANCED: Set all of the objects of a specific class to be invalid in TopLink's identity maps.
void	invalidateObject(Object object) ADVANCED: Set an object to be invalid in the TopLink identity maps.
void	invalidateObject(Record rowContainingPrimaryKey, Class theClass) ADVANCED: Set an object to be invalid in the TopLink identity maps.
void	invalidateObject(Vector primaryKey, Class theClass) ADVANCED: Set an object to be invalid in the TopLink identity maps.
void	invalidateObjects(Expression selectionCriteria) ADVANCED: Set all of the objects from the given Expression to be invalid in the TopLink Identity Maps
void	invalidateObjects(Vector collection) ADVANCED: Set all of the objects in the given collection to be invalid in the TopLink Identity Maps This method will take no action for any objects in the collection that do not exist in the cache.
boolean	isValid(AbstractRecord rowContainingPrimaryKey, Class theClass) ADVANCED: Return true if this object is valid in TopLink's identity maps return false otherwise
boolean	isValid(Object object) ADVANCED: Return true if this object is valid in TopLink's identity maps return false otherwise
boolean	isValid(Vector primaryKey, Class theClass) ADVANCED: Return true if this object is valid in TopLink's identity maps return false otherwise
void	printIdentityMap(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.
Object	putInIdentityMap(Object object) ADVANCED: Register the object with the identity map.
Object	putInIdentityMap(Object object, Vector key) ADVANCED: Register the object with the identity map.
Object	putInIdentityMap(Object object, Vector key, Object writeLockValue) ADVANCED: Register the object with the identity map.
Object	putInIdentityMap(Object object, Vector key, Object writeLockValue, long readTime) ADVANCED: Register the object with the identity map.
Object	putInIdentityMap(Object object, Vector key, Object writeLockValue, long readTime, ClassDescriptor descriptor) ADVANCED: Register the object with the identity map.
void	releaseWriteLock() INTERNAL: Lock the entire cache if the cache isolation requires.
Object	removeFromIdentityMap(Object object) ADVANCED: Remove the object from the object cache.
Object	removeFromIdentityMap(Vector key, Class theClass) ADVANCED: Remove the object from the object cache.
Object	removeFromIdentityMap(Vector key, Class theClass, ClassDescriptor descriptor) INTERNAL: Remove the object from the object cache.
void	setIdentityMapManager(IdentityMapManager identityMapManager) INTERNAL: Set the IdentityMapManager for this IdentityMapAccessor
void	setWrapper(Vector primaryKey, Class theClass, Object wrapper) INTERNAL: Update the wrapper object the cache key associated with the given primary key, this is used for EJB.
void	updateWriteLockValue(Object object, Object writeLockValue) ADVANCED: Update the write lock value in the identity map.
void	updateWriteLockValue(Vector primaryKey, Class theClass, Object writeLockValue) ADVANCED: Update the write lock value in the identity map.
void	validateCache() INTERNAL: This can be used to help debugging an object identity problem.

Methods inherited from class java.lang.Object

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

Field Detail

identityMapManager

protected IdentityMapManager identityMapManager

This is the identity map manager for this accessor. It should only be accessed through the getter

session

protected AbstractSession session

Constructor Detail

IdentityMapAccessor

public IdentityMapAccessor(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(Vector primarKey,
                                    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

acquireLock

public CacheKey acquireLock(Vector primarKey,
                            Class javaClass,
                            ClassDescriptor descriptor)

INTERNAL: Lock the identity map for the object, this must be done when building objects. The return cacheKey should be used to release the lock

acquireLock

public CacheKey acquireLock(Vector primaryKey,
                            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

See Also:

IdentityMap#aquire

acquireLockNoWait

public CacheKey acquireLockNoWait(Vector primaryKey,
                                  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

See Also:

IdentityMap#aquire

acquireReadLockOnCacheKey

public CacheKey acquireReadLockOnCacheKey(Vector primaryKey,
                                          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.

acquireReadLockOnCacheKeyNoWait

public CacheKey acquireReadLockOnCacheKeyNoWait(Vector primaryKey,
                                                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.

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.

clearQueryCache

public void clearQueryCache()

ADVANCED: Clear all the query caches

clearQueryCache

public void clearQueryCache(ReadQuery query)

ADVANCED: Clear the query class associated with the passed-in read query

clearQueryCache

public void clearQueryCache(String sessionQueryName)

ADVANCED: Clear the query cache associated with the named query on the session

clearQueryCache

public void clearQueryCache(String descriptorQueryName,
                            Class queryClass)

ADVANCED: Clear the query cache associated with the named query on the descriptor for the given class

containsKey

public boolean containsKey(Vector key,
                           Class theClass,
                           ClassDescriptor descriptor)

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

containsObjectInIdentityMap

public boolean containsObjectInIdentityMap(Object object)

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

Specified by:

containsObjectInIdentityMap in interface IdentityMapAccessor

Parameters:

object - Object

Returns:

boolean

containsObjectInIdentityMap

public boolean containsObjectInIdentityMap(Vector primaryKey,
                                           Class theClass)

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

Specified by:

containsObjectInIdentityMap in interface IdentityMapAccessor

Parameters:

primaryKey - Vector

theClass - Class

Returns:

boolean

containsObjectInIdentityMap

public boolean containsObjectInIdentityMap(Vector primaryKey,
                                           Class theClass,
                                           ClassDescriptor descriptor)

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

containsObjectInIdentityMap

public boolean containsObjectInIdentityMap(Record rowContainingPrimaryKey,
                                           Class theClass)

ADVANCED: Return if their is an object for the row containing primary key and the class.

Specified by:

containsObjectInIdentityMap in interface IdentityMapAccessor

Parameters:

rowContainingPrimaryKey - Record

theClass - Class type to be found

Returns:

boolean - true if Object in indentity map

extractPrimaryKeyFromRow

protected Vector extractPrimaryKeyFromRow(Record rowContainingPrimaryKey,
                                          Class theClass)

INTERNAL: Extract primary key from a row

Parameters:

DatabaseRow - to extract primary key from

Class -

Returns:

Vector primary key

getCacheKeyForObject

public CacheKey getCacheKeyForObject(Object object,
                                     ClassDescriptor descriptor)

INTERNAL: Retrieve the cache key for the given object from the identity maps

Parameters:

Object - object the object to get the cache key for

Returns:

CacheKey

getClassesRegistered

public Vector getClassesRegistered()

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

getAllFromIdentityMap

public Vector getAllFromIdentityMap(Expression selectionCriteria,
                                    Class theClass,
                                    Record translationRow)
                             throws QueryException

ADVANCED: Query the cache in-memory. If the expression is too complex an exception will be thrown.

Throws:

QueryException

getAllFromIdentityMap

public Vector getAllFromIdentityMap(Expression selectionCriteria,
                                    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

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

getAllFromIdentityMap

public Vector getAllFromIdentityMap(Expression selectionCriteria,
                                    Class theClass,
                                    Record translationRow,
                                    InMemoryQueryIndirectionPolicy valueHolderPolicy)
                             throws QueryException

ADVANCED: Query the cache in-memory. If the expression is too complex an exception will be thrown.

Specified by:

getAllFromIdentityMap in interface IdentityMapAccessor

Parameters:

selectionCriteria - Expression selecting the Objects to be returned

theClass - Class to be considered

translationRow - Record

valueHolderPolicy - see InMemoryQueryIndirectionPolicy

Returns:

Vector of Objects with type theClass and matching the selectionCriteria

Throws:

QueryException

getFromIdentityMap

public Object getFromIdentityMap(Object object)

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

Specified by:

getFromIdentityMap in interface IdentityMapAccessor

Parameters:

object - Object

Returns:

Object from identity map, may be null.

getCacheKeyForObject

public CacheKey getCacheKeyForObject(Vector primaryKey,
                                     Class myClass,
                                     ClassDescriptor descriptor)

INTERNAL: Retrieve the cache key for the given identity information

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 Object getFromIdentityMap(Vector primaryKey,
                                 Class theClass)

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

Specified by:

getFromIdentityMap in interface IdentityMapAccessor

Parameters:

primaryKey - Vector

theClass - Class

Returns:

Object from identity map, may be null.

getFromIdentityMap

public Object getFromIdentityMap(Vector primaryKey,
                                 Class theClass,
                                 ClassDescriptor descriptor,
                                 JoinedAttributeManager joinedAttributeManager)

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

getFromIdentityMap

public Object getFromIdentityMap(Vector primaryKey,
                                 Class theClass,
                                 boolean shouldReturnInvalidatedObjects)

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

Specified by:

getFromIdentityMap in interface IdentityMapAccessor

Parameters:

primaryKey - Vector

theClass - Class

shouldReturnInvalidatedObjects - InMemoryQueryIndirectionPolicy

Returns:

Object from identity map, may be null.

getFromIdentityMap

public Object getFromIdentityMap(Vector primaryKey,
                                 Class theClass,
                                 boolean shouldReturnInvalidatedObjects,
                                 ClassDescriptor descriptor,
                                 JoinedAttributeManager joinedAttributeManager)

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

getFromIdentityMap

public Object getFromIdentityMap(Record rowContainingPrimaryKey,
                                 Class theClass)

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

Specified by:

getFromIdentityMap in interface IdentityMapAccessor

Parameters:

rowContainingPrimaryKey - Record

theClass - Class

Returns:

Object from identity map, may be null.

getFromIdentityMap

public Object getFromIdentityMap(Record rowContainingPrimaryKey,
                                 Class theClass,
                                 boolean shouldReturnInvalidatedObjects)

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

Specified by:

getFromIdentityMap in interface IdentityMapAccessor

Parameters:

rowContainingPrimaryKey - Record

theClass - Class

shouldReturnInvalidatedObjects - boolean

Returns:

Object from identity map, may be null.

getFromIdentityMap

public Object getFromIdentityMap(Expression selectionCriteria,
                                 Class theClass,
                                 Record translationRow)
                          throws QueryException

ADVANCED: 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.

Specified by:

getFromIdentityMap in interface IdentityMapAccessor

Parameters:

selectionCriteria - Expression

theClass - Class

translationRow - Record

Returns:

Object from identity map, may be null

Throws:

QueryException

getFromIdentityMap

public Object getFromIdentityMap(Expression selectionCriteria,
                                 Class theClass,
                                 Record translationRow,
                                 InMemoryQueryIndirectionPolicy valueHolderPolicy)
                          throws QueryException

ADVANCED: 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.

Specified by:

getFromIdentityMap in interface IdentityMapAccessor

Parameters:

selectionCriteria - Expression

theClass - Class

translationRow - Record

valueHolderPolicy - see InMemoryQueryIndirectionPolicy

Returns:

Object from identity map, may be null

Throws:

QueryException

getFromIdentityMap

public Object getFromIdentityMap(Expression selectionCriteria,
                                 Class theClass,
                                 Record translationRow,
                                 InMemoryQueryIndirectionPolicy valueHolderPolicy,
                                 boolean conforming)

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.

getFromIdentityMap

public Object getFromIdentityMap(Expression selectionCriteria,
                                 Class theClass,
                                 Record translationRow,
                                 InMemoryQueryIndirectionPolicy valueHolderPolicy,
                                 boolean conforming,
                                 boolean shouldReturnInvalidatedObjects)

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.

getFromIdentityMap

public Object getFromIdentityMap(Expression selectionCriteria,
                                 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.

getFromIdentityMapWithDeferredLock

public Object getFromIdentityMapWithDeferredLock(Vector primaryKey,
                                                 Class theClass,
                                                 ClassDescriptor descriptor)

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

getFromIdentityMapWithDeferredLock

public Object getFromIdentityMapWithDeferredLock(Vector primaryKey,
                                                 Class theClass,
                                                 boolean shouldReturnInvalidatedObjects,
                                                 ClassDescriptor descriptor)

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

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.

getIdentityMap

public IdentityMap getIdentityMap(Class theClass)

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

getIdentityMap

public IdentityMap getIdentityMap(ClassDescriptor descriptor)

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

getRemainingValidTime

public long getRemainingValidTime(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

Parameters:

object - Object under consideration

Returns:

long time in milliseconds

getSession

public AbstractSession getSession()

INTERNAL: get the session associated with this IdentityMapAccessor

getWrapper

public Object getWrapper(Vector primaryKey,
                         Class theClass)

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

getWriteLockManager

public WriteLockManager getWriteLockManager()

INTERNAL: Returns the single write Lock manager for this session

getWriteLockValue

public Object getWriteLockValue(Object object)

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

Specified by:

getWriteLockValue in interface IdentityMapAccessor

Parameters:

object - Object

Returns:

Object for versioning

getWriteLockValue

public Object getWriteLockValue(Vector primaryKey,
                                Class theClass)

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

Specified by:

getWriteLockValue in interface IdentityMapAccessor

Parameters:

primaryKey - Vector

theClass - Class

Returns:

Object for versioning

getWriteLockValue

public Object getWriteLockValue(Vector primaryKey,
                                Class theClass,
                                ClassDescriptor descriptor)

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

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

initializeIdentityMap

public void initializeIdentityMap(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

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

invalidateObject

public void invalidateObject(Object object)

ADVANCED: Set an object to be invalid in the TopLink identity maps. If the object does not exist in the cache, thiss method will return without any action

Specified by:

invalidateObject in interface IdentityMapAccessor

Parameters:

object - Object

invalidateObject

public void invalidateObject(Vector primaryKey,
                             Class theClass)

ADVANCED: Set an object to be invalid in the TopLink identity maps. If the object does not exist in the cache, this method will return without any action

Specified by:

invalidateObject in interface IdentityMapAccessor

Parameters:

primaryKey - Vector

theClass - Class

invalidateObject

public void invalidateObject(Record rowContainingPrimaryKey,
                             Class theClass)

ADVANCED: Set an object to be invalid in the TopLink identity maps. If the object does not exist in the cache, this method will return without any action

Specified by:

invalidateObject in interface IdentityMapAccessor

Parameters:

rowContainingPrimaryKey - Record

theClass - Class

invalidateObjects

public void invalidateObjects(Expression selectionCriteria)

ADVANCED: Set all of the objects from the given Expression to be invalid in the TopLink Identity Maps

Specified by:

invalidateObjects in interface IdentityMapAccessor

Parameters:

selectionCriteria - Expression

invalidateObjects

public void invalidateObjects(Vector collection)

ADVANCED: Set all of the objects in the given collection to be invalid in the TopLink Identity Maps This method will take no action for any objects in the collection that do not exist in the cache.

Specified by:

invalidateObjects in interface IdentityMapAccessor

Parameters:

collection - Vector of Objects to be invalidated

invalidateClass

public void invalidateClass(Class myClass)

ADVANCED: Set all of the objects of a specific class to be invalid in TopLink's identity maps Will set the recurse on inheritance to true.

Specified by:

invalidateClass in interface IdentityMapAccessor

Parameters:

myClass - Class

invalidateClass

public void invalidateClass(Class myClass,
                            boolean recurse)

ADVANCED: Set all of the objects of a specific class to be invalid in TopLink's identity maps. User can set the recurse flag to false if they do not want to invalidate all the classes within an inheritance tree.

Specified by:

invalidateClass in interface IdentityMapAccessor

Parameters:

myClass - Class

recurse - boolean

invalidateAll

public void invalidateAll()

ADVANCED: Set all of the objects from all identity maps to be invalid in TopLink's identity maps.

Specified by:

invalidateAll in interface IdentityMapAccessor

isValid

public boolean isValid(Object object)

ADVANCED: Return true if this object is valid in TopLink's identity maps return false otherwise

Specified by:

isValid in interface IdentityMapAccessor

Parameters:

object - Object

Returns:

boolean

isValid

public boolean isValid(Vector primaryKey,
                       Class theClass)

ADVANCED: Return true if this object is valid in TopLink's identity maps return false otherwise

Specified by:

isValid in interface IdentityMapAccessor

Parameters:

primaryKey - Vector

theClass - Class

Returns:

boolean

isValid

public boolean isValid(AbstractRecord rowContainingPrimaryKey,
                       Class theClass)

ADVANCED: Return true if this object is valid in TopLink's identity maps return false otherwise

Specified by:

isValid in interface IdentityMapAccessor

Parameters:

rowContainingPrimaryKey - AbstractRecord

theClass - Class

Returns:

boolean

printIdentityMap

public void printIdentityMap(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

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

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

putInIdentityMap

public Object putInIdentityMap(Object object)

ADVANCED: Register the object with the identity map. The object must always be registered with its version number if optimistic locking is used.

Specified by:

putInIdentityMap in interface IdentityMapAccessor

Parameters:

object - Object

Returns:

Object

putInIdentityMap

public Object putInIdentityMap(Object object,
                               Vector key)

ADVANCED: Register the object with the identity map. The object must always be registered with its version number if optimistic locking is used.

Specified by:

putInIdentityMap in interface IdentityMapAccessor

Parameters:

object - Object

key - Vector

Returns:

Object

putInIdentityMap

public Object putInIdentityMap(Object object,
                               Vector key,
                               Object writeLockValue)

ADVANCED: Register the object with the identity map. The object must always be registered with its version number if optimistic locking is used.

Specified by:

putInIdentityMap in interface IdentityMapAccessor

Parameters:

object - Object

key - Vector

writeLockValue - Object for versioning

Returns:

Object

putInIdentityMap

public Object putInIdentityMap(Object object,
                               Vector key,
                               Object writeLockValue,
                               long readTime)

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

Specified by:

putInIdentityMap in interface IdentityMapAccessor

Parameters:

object - Object

key - Vector

writeLockValue - Object for versioning

readTime - long, time in milliseconds

Returns:

Object the Object put into the identity map

putInIdentityMap

public Object putInIdentityMap(Object object,
                               Vector key,
                               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

internalPutInIdentityMap

public CacheKey internalPutInIdentityMap(Object object,
                                         Vector key,
                                         Object writeLockValue,
                                         long readTime,
                                         ClassDescriptor descriptor)

INTERNAL: 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. Return the cache-key.

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.

removeFromIdentityMap

public Object removeFromIdentityMap(Object object)

ADVANCED: Remove the object from the object cache. Caution should be used when calling to avoid violating object identity. The application should only call this is it knows that no references to the object exist.

Specified by:

removeFromIdentityMap in interface IdentityMapAccessor

Parameters:

object - Object

Returns:

Object the Object removed from the identity map

removeFromIdentityMap

public Object removeFromIdentityMap(Vector key,
                                    Class theClass)

ADVANCED: Remove the object from the object cache.

Specified by:

removeFromIdentityMap in interface IdentityMapAccessor

Parameters:

key - Vector

theClass - Class

Returns:

Object the Object removed from the identity map

removeFromIdentityMap

public Object removeFromIdentityMap(Vector key,
                                    Class theClass,
                                    ClassDescriptor descriptor)

INTERNAL: Remove the object from the object cache.

setIdentityMapManager

public void setIdentityMapManager(IdentityMapManager identityMapManager)

INTERNAL: Set the IdentityMapManager for this IdentityMapAccessor

setWrapper

public void setWrapper(Vector primaryKey,
                       Class theClass,
                       Object wrapper)

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

updateWriteLockValue

public void updateWriteLockValue(Object object,
                                 Object writeLockValue)

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

Specified by:

updateWriteLockValue in interface IdentityMapAccessor

Parameters:

object - Object

writeLockValue - Object for versioning

updateWriteLockValue

public void updateWriteLockValue(Vector primaryKey,
                                 Class theClass,
                                 Object writeLockValue)

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

Specified by:

updateWriteLockValue in interface IdentityMapAccessor

Parameters:

primaryKey - Vector

theClass - Class

writeLockValue - Object for versioning

validateCache

public void validateCache()

INTERNAL: This can be used to help debugging an object identity problem. An object identity problem is when an object in the cache references an object not in the cache. This method will validate that all cached objects are in a correct state.

Specified by:

validateCache in interface IdentityMapAccessor