Skip navigation links

com.bea.wlevs.cache.spi
Interface CachingSystem

All Known Subinterfaces:

CoherenceCachingSystem

public interface CachingSystem

Implementations of this interface represent a caching system that may be used by Event Server applications. A caching system provides a named set of caches to applications, as well as the ability to register listeners, loaders, and stores for those caches. The primary interface used by applications to access a cache is the java.util.Map interface. Applications may cast a cache object to a caching system specific interface if they require access to cache features that are specific to a particular caching implementation.

Method Summary

java.util.Map	getCache(java.lang.String name) Returns a named cache from the underlying caching system.
java.util.Set	getCacheNames() Return names of caches that are part of this caching system.
java.lang.String	getName() Return the name of this caching system.
java.lang.String	getProvider() Return the provider of this caching system.
void	setListeners(java.lang.String name, java.util.List listeners) sets listeners on a named cache in the underlying caching system.
void	setLoader(java.lang.String name, java.lang.Object loader) Sets a loader on the named cache in the underlying caching system.
void	setStore(java.lang.String name, java.lang.Object store) Sets a store on the named cache and the underlying caching system.

Method Detail

getName

public java.lang.String getName()

Return the name of this caching system.

Returns:

the name of this caching system

getCache

public java.util.Map getCache(java.lang.String name)

Returns a named cache from the underlying caching system.

Parameters:

name - the name associated with the cache

Returns:

the cache associated with the name

getCacheNames

public java.util.Set getCacheNames()

Return names of caches that are part of this caching system.

Returns:

the names of caches that are part of this caching system

getProvider

public java.lang.String getProvider()

Return the provider of this caching system.

Returns:

the provider of this caching system

setListeners

public void setListeners(java.lang.String name,
                         java.util.List listeners)

sets listeners on a named cache in the underlying caching system.

Parameters:

name - the name associated with the cache

listeners - the listeners to set

setLoader

public void setLoader(java.lang.String name,
                      java.lang.Object loader)

Sets a loader on the named cache in the underlying caching system.

Parameters:

name - the name associated with the cache

loader - the loader to set

setStore

public void setStore(java.lang.String name,
                     java.lang.Object store)

Sets a store on the named cache and the underlying caching system.

Parameters:

name - the name associated with the cache

store - the store to set