org.apache.jcs.engine.behavior
Interface ICacheService<K extends Serializable,V extends Serializable>

All Known Subinterfaces:

ICacheServiceNonLocal<K,V>, IRemoteHttpCacheClient<K,V>

All Known Implementing Classes:

AbstractRemoteCacheService, LateralTCPService, RemoteCacheServer, RemoteHttpCacheClient, RemoteHttpCacheService, ZombieCacheService, ZombieCacheServiceNonLocal

public interface ICacheService<K extends Serializable,V extends Serializable>

Used to retrieve and update the cache.

Note: server which implements this interface provides a local cache service, whereas server which implements IRmiCacheService provides a remote cache service.

update

void update(ICacheElement<K,V> item)
            throws ObjectExistsException,
                   IOException

Puts a cache item to the cache.

Parameters:

item -

Throws:

ObjectExistsException

IOException

get

ICacheElement<K,V> get(String cacheName,
                       K key)
                                                                 throws ObjectNotFoundException,
                                                                        IOException

Returns a cache bean from the specified cache; or null if the key does not exist.

Parameters:

cacheName -

key -

Returns:

the ICacheElement or null if not found

Throws:

ObjectNotFoundException

IOException

getMultiple

Map<K,ICacheElement<K,V>> getMultiple(String cacheName,
                                      Set<K> keys)
                                                                                                     throws ObjectNotFoundException,
                                                                                                            IOException

Gets multiple items from the cache based on the given set of keys.

Parameters:

cacheName -

keys -

Returns:

a map of K key to ICacheElement element, or an empty map if there is no data in cache for any of these keys

Throws:

ObjectNotFoundException

IOException

getMatching

Map<K,ICacheElement<K,V>> getMatching(String cacheName,
                                      String pattern)
                                                                                                     throws IOException

Gets multiple items from the cache matching the pattern.

Parameters:

cacheName -

pattern -

Returns:

a map of K key to ICacheElement element, or an empty map if there is no data in cache matching the pattern.

Throws:

IOException

remove

void remove(String cacheName,
            K key)
            throws IOException

Removes the given key from the specified cache.

Parameters:

cacheName -

key -

Throws:

IOException

removeAll

void removeAll(String cacheName)
               throws IOException

Remove all keys from the specified cache.

Parameters:

cacheName -

Throws:

IOException

dispose

void dispose(String cacheName)
             throws IOException

Frees the specified cache.

Parameters:

cacheName -

Throws:

IOException

release

void release()
             throws IOException

Frees all caches.

Throws:

IOException