Cache (Red Hat JBoss Enterprise Application Platform 7.2.0.GA public API)

All Superinterfaces:

Cache

All Known Subinterfaces:

CacheImplementor, CacheImplementor

All Known Implementing Classes:

DisabledCaching, EnabledCaching
```
public interface Cache
extends Cache
```
Provides an API for querying/managing the second level cache regions.
CAUTION: None of these methods respect any isolation or transactional semantics associated with the underlying caches. Specifically, evictions perform an immediate "hard" removal outside any transactions and/or locking scheme(s).

Author:

Steve Ebersole

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsCollection(String role, Serializable ownerIdentifier)` Determine whether the cache contains data for the given collection.
`boolean`	`containsEntity(Class entityClass, Serializable identifier)` Determine whether the cache contains data for the given entity "instance".
`boolean`	`containsEntity(String entityName, Serializable identifier)` Determine whether the cache contains data for the given entity "instance".
`boolean`	`containsQuery(String regionName)` Determine whether the cache contains data for the given query.
`default void`	`evictAll()` Clear the cache.
`default void`	`evictAllRegions()` Evict data from all cache regions.
`default void`	`evictCollection(String role, Serializable ownerIdentifier)` Deprecated. Use `evictCollectionData(String, Serializable)` instead
`void`	`evictCollectionData()` Evict cache data for all collections
`void`	`evictCollectionData(String role)` Evicts cached data for the given collection role
`void`	`evictCollectionData(String role, Serializable ownerIdentifier)` Evicts the cache data for the given identified collection "instance"
`default void`	`evictCollectionRegion(String role)` Deprecated. Use `evictCollectionData(String)` instead
`default void`	`evictCollectionRegions()` Deprecated. Use `evictCollectionData()` instead
`void`	`evictDefaultQueryRegion()` Evicts all cached query results from the default region.
`default void`	`evictEntity(Class entityClass, Serializable identifier)` Deprecated. Use `evictEntityData(Class, Serializable)` instead
`default void`	`evictEntity(String entityName, Serializable identifier)` Deprecated. Use `evictEntityData(String, Serializable)` instead
`void`	`evictEntityData()` Evict data from all entity regions.
`void`	`evictEntityData(Class entityClass)` Evicts all entity data from the given region (i.e.
`void`	`evictEntityData(Class entityClass, Serializable identifier)` Evicts the entity data for a particular entity "instance".
`void`	`evictEntityData(String entityName)` Evicts all entity data from the given region (i.e.
`void`	`evictEntityData(String entityName, Serializable identifier)` Evicts the entity data for a particular entity "instance".
`default void`	`evictEntityRegion(Class entityClass)` Deprecated. Use `evictEntityData(Class)` instead
`default void`	`evictEntityRegion(String entityName)` Deprecated. Use `evictEntityData(String)` instead
`default void`	`evictEntityRegions()` Deprecated. Use `evictEntityData()` instead
`void`	`evictNaturalIdData()` Evict cached data for all natural-ids (for all entities)
`void`	`evictNaturalIdData(Class entityClass)` Evict cached data for the given entity's natural-id
`void`	`evictNaturalIdData(String entityName)` Evict cached data for the given entity's natural-id
`default void`	`evictNaturalIdRegion(Class entityClass)` Deprecated. Use `evictNaturalIdData(Class)` instead
`default void`	`evictNaturalIdRegion(String entityName)` Deprecated. Use `evictNaturalIdData(String)` instead
`default void`	`evictNaturalIdRegions()` Deprecated. Use `evictNaturalIdData()` instead
`void`	`evictQueryRegion(String regionName)` Evicts all cached query results under the given name.
`void`	`evictQueryRegions()` Evict data from all query regions.
`void`	`evictRegion(String regionName)` Evict all data from the named cache region
`SessionFactory`	`getSessionFactory()` Access to the SessionFactory this Cache is bound to.

Methods inherited from interface javax.persistence.Cache
contains, evict, evict, unwrap

- Method Detail
  - getSessionFactory
```
SessionFactory getSessionFactory()
```
    Access to the SessionFactory this Cache is bound to.
    
    Returns:
    
    The SessionFactory
  - containsEntity
```
boolean containsEntity(Class entityClass,
                       Serializable identifier)
```
    Determine whether the cache contains data for the given entity "instance".
    The semantic here is whether the cache contains data visible for the current call context.
    
    Parameters:
    
    entityClass - The entity class.
    
    identifier - The entity identifier
    
    Returns:
    
    True if the underlying cache contains corresponding data; false otherwise.
  - containsEntity
```
boolean containsEntity(String entityName,
                       Serializable identifier)
```
    Determine whether the cache contains data for the given entity "instance".
    The semantic here is whether the cache contains data visible for the current call context.
    
    Parameters:
    
    entityName - The entity name.
    
    identifier - The entity identifier
    
    Returns:
    
    True if the underlying cache contains corresponding data; false otherwise.
  - evictEntityData
```
void evictEntityData(Class entityClass,
                     Serializable identifier)
```
    Evicts the entity data for a particular entity "instance".
    
    Parameters:
    
    entityClass - The entity class.
    
    identifier - The entity identifier
    
    Since:
    
    5.3
  - evictEntityData
```
void evictEntityData(String entityName,
                     Serializable identifier)
```
    Evicts the entity data for a particular entity "instance".
    
    Parameters:
    
    entityName - The entity name.
    
    identifier - The entity identifier
    
    Since:
    
    5.3
  - evictEntityData
```
void evictEntityData(Class entityClass)
```
    Evicts all entity data from the given region (i.e. for all entities of type).
    
    Parameters:
    
    entityClass - The entity class.
    
    Since:
    
    5.3
  - evictEntityData
```
void evictEntityData(String entityName)
```
    Evicts all entity data from the given region (i.e. for all entities of type).
    
    Parameters:
    
    entityName - The entity name.
    
    Since:
    
    5.3
  - evictEntityData
```
void evictEntityData()
```
    Evict data from all entity regions.
    
    Since:
    
    5.3
  - evictNaturalIdData
```
void evictNaturalIdData(Class entityClass)
```
    Evict cached data for the given entity's natural-id
    
    Parameters:
    
    entityClass - The entity class.
    
    Since:
    
    5.3
  - evictNaturalIdData
```
void evictNaturalIdData(String entityName)
```
    Evict cached data for the given entity's natural-id
    
    Parameters:
    
    entityName - The entity name.
    
    Since:
    
    5.3
  - evictNaturalIdData
```
void evictNaturalIdData()
```
    Evict cached data for all natural-ids (for all entities)
    
    Since:
    
    5.3
  - containsCollection
```
boolean containsCollection(String role,
                           Serializable ownerIdentifier)
```
    Determine whether the cache contains data for the given collection.
    The semantic here is whether the cache contains data visible for the current call context.
    
    Parameters:
    
    role - The name of the collection role (in form [owner-entity-name].[collection-property-name]) whose regions should be evicted.
    
    ownerIdentifier - The identifier of the owning entity
    
    Returns:
    
    True if the underlying cache contains corresponding data; false otherwise.
  - evictCollectionData
```
void evictCollectionData(String role,
                         Serializable ownerIdentifier)
```
    Evicts the cache data for the given identified collection "instance"
    
    Parameters:
    
    role - The "collection role" (in form [owner-entity-name].[collection-property-name]).
    
    ownerIdentifier - The identifier of the owning entity
    
    Since:
    
    5.3
  - evictCollectionData
```
void evictCollectionData(String role)
```
    Evicts cached data for the given collection role
    
    Parameters:
    
    role - The "collection role" (in form [owner-entity-name].[collection-property-name]).
    
    Since:
    
    5.3
  - evictCollectionData
```
void evictCollectionData()
```
    Evict cache data for all collections
    
    Since:
    
    5.3
  - containsQuery
```
boolean containsQuery(String regionName)
```
    Determine whether the cache contains data for the given query.
    The semantic here is whether the cache contains any data for the given region name since query result caches are not transactionally isolated.
    
    Parameters:
    
    regionName - The cache name given to the query.
    
    Returns:
    
    True if the underlying cache contains corresponding data; false otherwise.
  - evictDefaultQueryRegion
```
void evictDefaultQueryRegion()
```
    Evicts all cached query results from the default region.
  - evictQueryRegion
```
void evictQueryRegion(String regionName)
```
    Evicts all cached query results under the given name.
    
    Parameters:
    
    regionName - The cache name associated to the queries being cached.
  - evictQueryRegions
```
void evictQueryRegions()
```
    Evict data from all query regions.
  - evictRegion
```
void evictRegion(String regionName)
```
    Evict all data from the named cache region
    
    Since:
    
    5.3
  - evictAll
```
default void evictAll()
```
    Clear the cache.
    
    Specified by:
    
    evictAll in interface Cache
  - evictAllRegions
```
default void evictAllRegions()
```
    Evict data from all cache regions.
  - evictEntity
```
@Deprecated
default void evictEntity(Class entityClass,
                                     Serializable identifier)
```
    Deprecated. Use evictEntityData(Class, Serializable) instead
    
    Evicts the entity data for a particular entity "instance".
    
    Parameters:
    
    entityClass - The entity class.
    
    identifier - The entity identifier
  - evictEntity
```
@Deprecated
default void evictEntity(String entityName,
                                     Serializable identifier)
```
    Deprecated. Use evictEntityData(String, Serializable) instead
    
    Evicts the entity data for a particular entity "instance".
    
    Parameters:
    
    entityName - The entity name.
    
    identifier - The entity identifier
  - evictEntityRegion
```
@Deprecated
default void evictEntityRegion(Class entityClass)
```
    Deprecated. Use evictEntityData(Class) instead
    
    Evicts all entity data from the given region (i.e. for all entities of type).
    
    Parameters:
    
    entityClass - The entity class.
  - evictEntityRegion
```
@Deprecated
default void evictEntityRegion(String entityName)
```
    Deprecated. Use evictEntityData(String) instead
    
    Evicts all entity data from the given region (i.e. for all entities of type).
    
    Parameters:
    
    entityName - The entity name.
  - evictEntityRegions
```
@Deprecated
default void evictEntityRegions()
```
    Deprecated. Use evictEntityData() instead
    
    Evict data from all entity regions.
  - evictNaturalIdRegion
```
@Deprecated
default void evictNaturalIdRegion(Class entityClass)
```
    Deprecated. Use evictNaturalIdData(Class) instead
    
    Evicts all naturalId data from the given region (i.e. for all entities of type).
    
    Parameters:
    
    entityClass - The entity class.
  - evictNaturalIdRegion
```
@Deprecated
default void evictNaturalIdRegion(String entityName)
```
    Deprecated. Use evictNaturalIdData(String) instead
    
    Evicts all naturalId data from the given region (i.e. for all entities of type).
    
    Parameters:
    
    entityName - The entity name.
  - evictNaturalIdRegions
```
@Deprecated
default void evictNaturalIdRegions()
```
    Deprecated. Use evictNaturalIdData() instead
    
    Evict data from all naturalId regions.
  - evictCollection
```
@Deprecated
default void evictCollection(String role,
                                         Serializable ownerIdentifier)
```
    Deprecated. Use evictCollectionData(String, Serializable) instead
    
    Evicts the cache data for the given identified collection instance.
    
    Parameters:
    
    role - The "collection role" (in form [owner-entity-name].[collection-property-name]).
    
    ownerIdentifier - The identifier of the owning entity
  - evictCollectionRegion
```
@Deprecated
default void evictCollectionRegion(String role)
```
    Deprecated. Use evictCollectionData(String) instead
    
    Evicts all entity data from the given region (i.e. evicts cached data for all of the specified collection role).
    
    Parameters:
    
    role - The "collection role" (in form [owner-entity-name].[collection-property-name]).
  - evictCollectionRegions
```
@Deprecated
default void evictCollectionRegions()
```
    Deprecated. Use evictCollectionData() instead
    
    Evict data from all collection regions.

Interface Cache

Method Summary

Methods inherited from interface javax.persistence.Cache

Method Detail

getSessionFactory

containsEntity

containsEntity

evictEntityData

evictEntityData

evictEntityData

evictEntityData

evictEntityData

evictNaturalIdData

evictNaturalIdData

evictNaturalIdData

containsCollection

evictCollectionData

evictCollectionData

evictCollectionData

containsQuery

evictDefaultQueryRegion

evictQueryRegion

evictQueryRegions

evictRegion

evictAll

evictAllRegions

evictEntity

evictEntity

evictEntityRegion

evictEntityRegion

evictEntityRegions

evictNaturalIdRegion

evictNaturalIdRegion

evictNaturalIdRegions

evictCollection

evictCollectionRegion

evictCollectionRegions