org.apache.jcs.auxiliary
Interface AuxiliaryCache

All Superinterfaces:
ICache, ICacheType, java.io.Serializable
All Known Implementing Classes:
AbstractDiskCache, LateralCacheNoWait, LateralCacheNoWaitFacade, RemoteCacheNoWait, RemoteCacheNoWaitFacade

public interface AuxiliaryCache
extends ICache

Tag interface for auxiliary caches. Currently this provides no additional methods over what is in ICache, but I anticipate that will change. For example, there will be a mechanism for determining the type (disk/lateral/remote) of the auxiliary here -- and the existing getCacheType will be removed from ICache.

Version:
$Id: AuxiliaryCache.java,v 1.6 2003/11/06 17:58:51 asmuts Exp $
Author:
Aaron Smuts, James Taylor

Field Summary
 
Fields inherited from interface org.apache.jcs.engine.behavior.ICacheType
CACHE_HUB, DISK_CACHE, LATERAL_CACHE, REMOTE_CACHE
 
Method Summary
 void dispose()
          Prepares for shutdown.
 ICacheElement get(java.io.Serializable key)
          Gets an item from the cache.
 java.lang.String getCacheName()
          Returns the cache name.
 java.util.Set getGroupKeys(java.lang.String group)
          Gets the set of keys of objects currently in the group
 int getSize()
          Returns the current cache size.
 int getStatus()
          Returns the cache status.
 boolean remove(java.io.Serializable key)
          Removes an item from the cache.
 void removeAll()
          Removes all cached items from the cache.
 void update(ICacheElement ce)
          Puts an item to the cache.
 
Methods inherited from interface org.apache.jcs.engine.behavior.ICacheType
getCacheType
 

Method Detail

update

public void update(ICacheElement ce)
            throws java.io.IOException
Puts an item to the cache.

Specified by:
update in interface ICache
Throws:
java.io.IOException

get

public ICacheElement get(java.io.Serializable key)
                  throws java.io.IOException
Gets an item from the cache.

Specified by:
get in interface ICache
Throws:
java.io.IOException

remove

public boolean remove(java.io.Serializable key)
               throws java.io.IOException
Removes an item from the cache.

Specified by:
remove in interface ICache
Throws:
java.io.IOException

removeAll

public void removeAll()
               throws java.io.IOException
Removes all cached items from the cache.

Specified by:
removeAll in interface ICache
Throws:
java.io.IOException

dispose

public void dispose()
             throws java.io.IOException
Prepares for shutdown.

Specified by:
dispose in interface ICache
Throws:
java.io.IOException

getSize

public int getSize()
Returns the current cache size.

Specified by:
getSize in interface ICache

getStatus

public int getStatus()
Returns the cache status.

Specified by:
getStatus in interface ICache

getCacheName

public java.lang.String getCacheName()
Returns the cache name.

Specified by:
getCacheName in interface ICache

getGroupKeys

public java.util.Set getGroupKeys(java.lang.String group)
                           throws java.io.IOException
Gets the set of keys of objects currently in the group

Throws:
java.io.IOException