org.apache.jcs.engine.behavior

Interface ICacheService

All Known Subinterfaces:

ILateralCacheService, IRemoteCacheService, IRemoteHttpCacheClient

All Known Implementing Classes:

AbstractRemoteCacheService, LateralTCPService, RemoteHttpCacheClient, RemoteHttpCacheService, ZombieCacheService, ZombieLateralCacheService, ZombieRemoteCacheService

public interface ICacheService

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose(java.lang.String cacheName) Frees the specified cache.
ICacheElement	get(java.lang.String cacheName, java.io.Serializable key) Returns a cache bean from the specified cache; or null if the key does not exist.
java.util.Map	getMatching(java.lang.String cacheName, java.lang.String pattern) Gets multiple items from the cache matching the pattern.
java.util.Map	getMultiple(java.lang.String cacheName, java.util.Set keys) Gets multiple items from the cache based on the given set of keys.
void	release() Frees all caches.
void	remove(java.lang.String cacheName, java.io.Serializable key) Removes the given key from the specified cache.
void	removeAll(java.lang.String cacheName) Remove all keys from the sepcified cache.
void	update(ICacheElement item) Puts a cache item to the cache.

Method Detail

update

void update(ICacheElement item)
            throws ObjectExistsException,
                   java.io.IOException

Puts a cache item to the cache.

Parameters:

item -

Throws:

ObjectExistsException

java.io.IOException

get

ICacheElement get(java.lang.String cacheName,
                java.io.Serializable key)
                  throws ObjectNotFoundException,
                         java.io.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

java.io.IOException

getMultiple

java.util.Map getMultiple(java.lang.String cacheName,
                        java.util.Set keys)
                          throws ObjectNotFoundException,
                                 java.io.IOException

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

Parameters:

cacheName -

keys -

Returns:

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

Throws:

ObjectNotFoundException

java.io.IOException

getMatching

java.util.Map getMatching(java.lang.String cacheName,
                        java.lang.String pattern)
                          throws java.io.IOException

Gets multiple items from the cache matching the pattern.

Parameters:

cacheName -

pattern -

Returns:

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

Throws:

java.io.IOException

remove

void remove(java.lang.String cacheName,
          java.io.Serializable key)
            throws java.io.IOException

Removes the given key from the specified cache.

Parameters:

cacheName -

key -

Throws:

java.io.IOException

removeAll

void removeAll(java.lang.String cacheName)
               throws java.io.IOException

Remove all keys from the sepcified cache.

Parameters:

cacheName -

Throws:

java.io.IOException

dispose

void dispose(java.lang.String cacheName)
             throws java.io.IOException

Frees the specified cache.

Parameters:

cacheName -

Throws:

java.io.IOException

release

void release()
             throws java.io.IOException

Frees all caches.

Throws:

java.io.IOException