| Modifier and Type | Field and Description |
|---|---|
| private EntityManagerFactoryDelegate | emf
The EntityManagerFactory associated with this Cache |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | clear()
Implements org. |
| public void | clear(Class<?> cls)
Implements org. |
| public void | clearQueryCache()
Implements org. |
| public void | clearQueryCache(String queryName)
Implements org. |
| public void | clearQueryCache(Class<?> entityClass)
Implements org. |
| public boolean | contains(Class<T>
entity class cls, Object primary key id)Implements jakarta. |
| public boolean | contains(Object object)
Implements org. |
| private Object | createPrimaryKeyFromId(Class<?> cls, Object id)
Return the EclipseLink cache key object from the JPA Id object. |
| public void | evict(Class<T>
- class to evict - usually representing an Entity or MappedSuperclass classToEvict, Object - Primary key of the Entity or MappedSuperclass Class
A null id means invalidate the class - possibly the entire tree or subtree id)Implements jakarta. |
| public void | evict(Class<?>
- class to evict - usually representing an Entity or MappedSuperclass classToEvict, Object - Primary key of the Entity or MappedSuperclass Class
A null id means invalidate the class - possibly the entire tree or subtree id, boolean - Invalidate the object id in the cluster, this only applies to a non-null id. invalidateInCluster)Implements org. |
| public void | evict(Class<T>
- Entity or MappedSuperclass Class entityOrMappedSuperclassToEvict)Implements jakarta. |
| public void | evict(Object object)
Implements org. |
| public void | evict(Object object, boolean invalidateInCluster)
Implements org. |
| public void | evictAll()
Implements jakarta. |
| private void | evictAssignableEntitySuperclass(Class<?> possibleSuperclass, Object id)
INTERNAL: This private method searches the map of descriptors for possible superclasses to the passed in class parameter and invalidates only entities found in the cache. |
| protected IdentityMapAccessor | getAccessor()
INTERNAL: Return the IdentityMapAccessor associated with the session on the EntityManagerFactory on this CacheImpl. |
| protected EntityManagerFactoryDelegate | |
| public Object | getId(Object object)
Implements org. |
| public Object | getObject(Class<?> cls, Object id)
Implements org. |
| protected Session | |
| public boolean | isValid(Object object)
Implements org. |
| public boolean | isValid(Class<?> cls, Object id)
Implements org. |
| public void | print()
Implements org. |
| public void | print(Class<?> cls)
Implements org. |
| public void | printLocks()
Implements org. |
| public Object | putObject(Object object)
Implements org. |
| public Object | removeObject(Object object)
Implements org. |
| public Object | removeObject(Class<?> cls, Object id)
Implements org. |
| public long | timeToLive(Object object)
Implements org. |
| public <T> T | unwrap(Class<T>
the class of the object to be returned. This is
normally either the underlying Cache implementation
class or an interface that it implements. cls)Implements jakarta. |
| public void | validate()
Implements org. |
| emf | back to summary |
|---|---|
| private EntityManagerFactoryDelegate emf The EntityManagerFactory associated with this Cache | |
| CacheImpl | back to summary |
|---|---|
| public CacheImpl(EntityManagerFactoryDelegate emf) | |
| clear | back to summary |
|---|---|
| public void clear() Implements org. ADVANCED: Resets the entire Object cache, and the Query cache. Note Be careful using this method. This method blows away both this session's and its parent's caches. This includes the server cache or any other cache. This throws away any Objects that have been read in. Extreme 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 Objects held in the cache.
| |
| clear | back to summary |
|---|---|
| public void clear(Class<?> cls) Implements org. ADVANCED: Resets the cache for only the instances of the given Class type. For inheritance the user must make sure that they only use the root class, clearing a subclass cache is not allowed (as they share their parents cache). Note Caution must be used in doing this to ensure that the Objects within the cache are not referenced from other Objects of other classes or from the application.
| |
| clearQueryCache | back to summary |
|---|---|
| public void clearQueryCache() Implements org. Clear all the query results caches.
| |
| clearQueryCache | back to summary |
|---|---|
| public void clearQueryCache(String queryName) Implements org. Clear the named query results cache associated with the query name.
| |
| clearQueryCache | back to summary |
|---|---|
| public void clearQueryCache(Class<?> entityClass) Implements org. Clear all named query results cache associated with entity class.
| |
| contains | back to summary |
|---|---|
| public boolean contains(Class<T> cls, Object id) Implements jakarta. Returns true if the cache contains an Object with the id and Class type, and is valid.
| |
| contains | back to summary |
|---|---|
| public boolean contains(Object object) Implements org. Returns true if the cache contains an Object with the same id and Class type of the given object.
| |
| createPrimaryKeyFromId | back to summary |
|---|---|
| private Object createPrimaryKeyFromId(Class<?> cls, Object id) Return the EclipseLink cache key object from the JPA Id object. | |
| evict | back to summary |
|---|---|
| public void evict(Class<T> classToEvict, Object id) Implements jakarta. Sets an Object with the id and Class type to be invalid in the cache. Remove the data for entities of the specified class (and its subclasses) from the cache. If the class is a MappedSuperclass then the first entity above in the inheritance hierarchy will be evicted along with all implementing subclasses If the class is not an Entity or MappedSuperclass but is the root of an entity inheritance tree then evict the subtree If the class is not an Entity or MappedSuperclass but inherits from one then evict up to root descriptor
| |
| evict | back to summary |
|---|---|
| public void evict(Class<?> classToEvict, Object id, boolean invalidateInCluster) Implements org. Sets an Object with the id and Class type to be invalid in the cache. Remove the data for entities of the specified class (and its subclasses) from the cache. If the class is a MappedSuperclass then the first entity above in the inheritance hierarchy will be evicted along with all implementing subclasses If the class is not an Entity or MappedSuperclass but is the root of an entity inheritance tree then evict the subtree If the class is not an Entity or MappedSuperclass but inherits from one then evict up to root descriptor
| |
| evict | back to summary |
|---|---|
| public void evict(Class<T> entityOrMappedSuperclassToEvict) Implements jakarta. Sets all instances of the class to be invalid. Remove the data for entities of the specified class (and its subclasses) from the cache. If the class is a MappedSuperclass then the first entity above in the inheritance hierarchy will be evicted along with all implementing subclasses If the class is not an Entity or MappedSuperclass (such as an Embeddable or plain java class) - nothing will be evicted
| |
| evict | back to summary |
|---|---|
| public void evict(Object object) Implements org. Sets the object to be invalid in the cache.
| |
| evict | back to summary |
|---|---|
| public void evict(Object object, boolean invalidateInCluster) Implements org. Sets an Object to be invalid in the cache. If true is passed, the object is also invalidated across cache coordination. Cache coordination must be enabled for this to have an affect.
| |
| evictAll | back to summary |
|---|---|
| public void evictAll() Implements jakarta. Sets all instances in the cache to be invalid.
| |
| evictAssignableEntitySuperclass | back to summary |
|---|---|
| private void evictAssignableEntitySuperclass(Class<?> possibleSuperclass, Object id) INTERNAL: This private method searches the map of descriptors for possible superclasses to the passed in class parameter and invalidates only entities found in the cache. If the class is not an Entity or MappedSuperclass (such as an Embeddable or plain java class) - nothing will be evicted | |
| getAccessor | back to summary |
|---|---|
| protected IdentityMapAccessor getAccessor() INTERNAL: Return the IdentityMapAccessor associated with the session on the EntityManagerFactory on this CacheImpl. | |
| getEntityManagerFactory | back to summary |
|---|---|
| protected EntityManagerFactoryDelegate getEntityManagerFactory() INTERNAL: Return the EntityManagerFactory associated with this CacheImpl. | |
| getId | back to summary |
|---|---|
| public Object getId(Object object) Implements org. This method will return the objects's Id. If the descriptor associated with the domain object is null - an IllegalArgumentException is thrown. If the CMPPolicy associated with the domain object's descriptor is null the Id will be determined using the ObjectBuilder on the descriptor - which may return the Id stored in the weaved _persistence_primaryKey field.
| |
| getObject | back to summary |
|---|---|
| public Object getObject(Class<?> cls, Object id) Implements org. Returns the Object from the cache map with the id and Class type.
| |
| getSession | back to summary |
|---|---|
| protected Session getSession() INTERNAL: Return the Session associated with the EntityManagerFactory. | |
| isValid | back to summary |
|---|---|
| public boolean isValid(Object object) Implements org. Returns true if the Object with the same id and Class type of the the given Object is valid in the cache.
| |
| isValid | back to summary |
|---|---|
| public boolean isValid(Class<?> cls, Object id) Implements org. Returns true if the Object with the id and Class type is valid in the cache.
| |
| back to summary | |
|---|---|
| public void print() Implements org. Used to print all the Objects in the cache. The output of this method will be logged to this persistence unit's SessionLog at SEVERE level.
| |
| back to summary | |
|---|---|
| public void print(Class<?> cls) Implements org. Used to print all the Objects in the cache of the Class type. The output of this method will be logged to this persistence unit's SessionLog at SEVERE level.
| |
| printLocks | back to summary |
|---|---|
| public void printLocks() Implements org. Used to print all the currently locked cache keys in the cache. The output of this method will be logged to this persistence unit's SessionLog at SEVERE level.
| |
| putObject | back to summary |
|---|---|
| public Object putObject(Object object) Implements org. ADVANCED: Puts the given Object into the cache. This is a very advanced method, and caution should be used in adding objects to the cache as other objects may have relationships to previous object, or this object may have relationships to other objects.
| |
| removeObject | back to summary |
|---|---|
| public Object removeObject(Object object) Implements org. ADVANCED: Removes the Object from the cache. Note Caution should be used when calling to avoid violating Object identity. The application should only call this if its known that no references to the Object exist.
| |
| removeObject | back to summary |
|---|---|
| public Object removeObject(Class<?> cls, Object id) Implements org. ADVANCED: Removes the Object with the id and Class type from the cache. Note Caution should be used when calling to avoid violating Object identity. The application should only call this if its known that no references to the Object exist.
| |
| timeToLive | back to summary |
|---|---|
| public long timeToLive(Object object) Implements org. Returns the remaining life of the given Object (in milliseconds). This method is associated with use of 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.
| |
| unwrap | back to summary |
|---|---|
| public <T> T unwrap(Class<T> cls) Implements jakarta. Doc from jakarta. Return an object of the specified type to allow access to the provider-specific API. If the provider's Cache implementation does not support the specified class, the PersistenceException is thrown. | |
| validate | back to summary |
|---|---|
| public void validate() Implements org. 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 that is not in the cache. This method will validate that all cached Objects are in a correct state.
| |