oracle.hsgbu.hdr.base.fwk

Interface CTBCacheService

public interface CTBCacheService

Provides methods to create and interact with a CTB cache. A CTB cache allows frequently accessed or expensive-to-retrieve data to be cached in the middle-tier, for better performance. The CTB cache is a JVM-level cache. The CTB cache provides the following features:

• Separates the caches depending on the type of object being cached.
• Independent configuration: Each cache is configured independently.
• Total-time based invalidation
• Idle-time based invalidation
• CacheLoader: Automatically called by the caching framework to populate cache.
• Cache bulkload or pre-load

Method Summary

Modifier and Type	Method and Description
void	bulkload(String cacheName) Bulkload the cache identified by a name.
void	bulkload(String cacheName, CTBCacheContext cacheContext) Bulkload the cache identified by a name.
void	createCache(CTBCacheConfig cacheConfig) Creates a new cache.
Object	get(String cacheName, Object key) Retrieves an object from the cache.
Object	get(String cacheName, Object key, CTBCacheContext cacheContext) Retrieves an object from the cache.
void	invalidate(String cacheName) Invalidates the entire cache.
void	invalidate(String cacheName, Object key) Invalidates an object in the cache.
boolean	isPresent(String cacheName, Object key) Determines if a key is present in the named cache.
Object[]	keys(String cacheName) Returns all keys in the named cache.
boolean	update(String cacheName, Object key, Object newValue) Updates an object in the cache.
Object[]	values(String cacheName) Returns all values in the named cache.

Method Detail

createCache

void createCache(CTBCacheConfig cacheConfig)
          throws CommonException

Creates a new cache.

Parameters:

cacheConfig - CTBCacheConfig object containing configuration information for this cache.

Throws:

CommonException

bulkload

void bulkload(String cacheName)
       throws CommonException

Bulkload the cache identified by a name.

NOTE: The cache must be preload-enabled in order to bulkload the cache. Calling this method causes the bulkload method of this cache's cache loader to be called.

Parameters:

cacheName - Unique name of the cache.

Throws:

CommonException

bulkload

void bulkload(String cacheName,
              CTBCacheContext cacheContext)
       throws CommonException

Bulkload the cache identified by a name. NOTE: The cache must be preload-enabled in order to bulkload the cache. Calling this method causes the oracle.hsgbu.hdr.base.fwk.server.CTBCacheLoader#bulkload(CacheContext) method of this cache's cache loader to be called.

Parameters:

cacheName - Unique name of the cache.

cacheContext - CTBCacheContext object containing user-provided information used by the bulkload method in the cache loader in order to bulkload the cache.

Throws:

CommonException

get

Object get(String cacheName,
           Object key)
    throws CommonException

Retrieves an object from the cache. This method causes the oracle.hsgbu.hdr.base.fwk.server.CTBCacheLoader#load(Object) method of the cache loader to be called if the key does not exist in the cache in order to load the cache.

Parameters:

cacheName - Unique name of the cache.

key - Key to retrieve from the cache.

Returns:

the value of the key in the named cache.

Throws:

CommonException

get

Object get(String cacheName,
           Object key,
           CTBCacheContext cacheContext)
    throws CommonException

Retrieves an object from the cache.

Parameters:

cacheName - Unique name of the cache.

key - Key to retrieve from the cache.

cacheContext - CTBCacheContext object containing user-provided information used by the load method in the cache loader in order to load an object into the cache if the key is not already in the cache.

Returns:

object from cache

Throws:

CommonException

update

boolean update(String cacheName,
               Object key,
               Object newValue)
        throws CommonException

Updates an object in the cache. If the key does not exist in the cache, this method does nothing. If the named cache is distributed, the cache entry represented by this key in other JVMs will be invalidated.

Parameters:

cacheName - Unique name of the cache.

key - Key to update in the cache.

newValue - New value to update in the cache.

Returns:

true if the key did exist in the cache and the object was updated. false if the object did not exist in the cache and nothing was done.

Throws:

CommonException

See Also:

CTBCacheConfig.setDistributed(boolean)

invalidate

void invalidate(String cacheName)
         throws CommonException

Invalidates the entire cache. This method invalidates all objects in the named cache. If the named cache is distributed, this cache is invalidated in other JVMs as well.

Parameters:

cacheName - Unique name of the cache.

Throws:

CommonException

See Also:

CTBCacheConfig.setDistributed(boolean)

invalidate

void invalidate(String cacheName,
                Object key)
         throws CommonException

Invalidates an object in the cache. This method invalidates an object in the named cache. If the named cache is distributed, this key is invalidated in other JVMs as well.

Parameters:

cacheName - Unique name of the cache.

key - Key of the object to invalidate.

Throws:

CommonException

See Also:

CTBCacheConfig.setDistributed(boolean)

isPresent

boolean isPresent(String cacheName,
                  Object key)
           throws CommonException

Determines if a key is present in the named cache.

Parameters:

cacheName - Unique name of the cache.

key - Key of the object to check if exists in the cache.

Returns:

boolean indicating if the key exists in the cache.

Throws:

CommonException

keys

Object[] keys(String cacheName)
       throws CommonException

Returns all keys in the named cache.

Parameters:

cacheName - Unique name of the cache.

Returns:

An array of keys from the named cache.

Throws:

CommonException

values

Object[] values(String cacheName)
         throws CommonException

Returns all values in the named cache.

Parameters:

cacheName - Unique name of the cache.

Returns:

An array of values from the named cache.

Throws:

CommonException