org.apache.jcs.auxiliary
Interface AuxiliaryCache

All Superinterfaces:
ICache, ICacheType, java.io.Serializable
All Known Subinterfaces:
IRemoteCacheClient
All Known Implementing Classes:
AbstractAuxiliaryCache, AbstractAuxiliaryCacheEventLogging, AbstractDiskCache, AbstractRemoteAuxiliaryCache, AbstractRemoteCacheNoWaitFacade, BlockDiskCache, IndexedDiskCache, JDBCDiskCache, LateralCache, LateralCacheNoWait, LateralCacheNoWaitFacade, MySQLDiskCache, RemoteCache, RemoteCacheNoWait, RemoteCacheNoWaitFacade, RemoteHttpCache

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.


Field Summary
 
Fields inherited from interface org.apache.jcs.engine.behavior.ICacheType
CACHE_HUB, DISK_CACHE, LATERAL_CACHE, REMOTE_CACHE
 
Method Summary
 AuxiliaryCacheAttributes getAuxiliaryCacheAttributes()
          This returns the generic attributes for an auxiliary cache.
 java.util.Set getGroupKeys(java.lang.String group)
          Gets the set of keys of objects currently in the group
 IStats getStatistics()
           
 void setCacheEventLogger(ICacheEventLogger cacheEventLogger)
          Every Auxiliary must allow for the use of an event logger.
 void setElementSerializer(IElementSerializer elementSerializer)
          Allows you to inject a custom serializer.
 
Methods inherited from interface org.apache.jcs.engine.behavior.ICache
dispose, get, getCacheName, getMatching, getMultiple, getSize, getStats, getStatus, remove, removeAll, setKeyMatcher, update
 
Methods inherited from interface org.apache.jcs.engine.behavior.ICacheType
getCacheType
 

Method Detail

getGroupKeys

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

Parameters:
group -
Returns:
a set of group keys
Throws:
java.io.IOException

getStatistics

IStats getStatistics()
Returns:
the historical and statistical data for a region's auxiliary cache.

getAuxiliaryCacheAttributes

AuxiliaryCacheAttributes getAuxiliaryCacheAttributes()
This returns the generic attributes for an auxiliary cache. Most implementations will cast this to a more specific type.

Returns:
the attributes for the auxiliary cache

setElementSerializer

void setElementSerializer(IElementSerializer elementSerializer)
Allows you to inject a custom serializer. A good example would be a compressing standard serializer.

Parameters:
elementSerializer -

setCacheEventLogger

void setCacheEventLogger(ICacheEventLogger cacheEventLogger)
Every Auxiliary must allow for the use of an event logger.

Parameters:
cacheEventLogger -


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.