AuxiliaryCache (Commons JCS 2.0.0-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jcs.auxiliary
Interface AuxiliaryCache<K extends Serializable,V extends Serializable>

All Superinterfaces:: ICache<K,V>, ICacheType

All Known Subinterfaces:: IRemoteCacheClient<K,V>

All Known Implementing Classes:: AbstractAuxiliaryCache, AbstractAuxiliaryCacheEventLogging, AbstractDiskCache, AbstractRemoteAuxiliaryCache, AbstractRemoteCacheNoWaitFacade, BlockDiskCache, FileDiskCache, IndexedDiskCache, JDBCDiskCache, LateralCache, LateralCacheNoWait, LateralCacheNoWaitFacade, MySQLDiskCache, RemoteCache, RemoteCacheNoWait, RemoteCacheNoWaitFacade, RemoteHttpCache

public interface AuxiliaryCache<K extends Serializable,V extends Serializable>
extends ICache<K,V>
extends ICache<K,V>

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jcs.engine.behavior.ICacheType
`ICacheType.CacheType`

Method Summary
`AuxiliaryCacheAttributes`	`getAuxiliaryCacheAttributes()` This returns the generic attributes for an auxiliary cache.
`Set<K>`	`getGroupKeys(String group)` Gets the set of keys of objects currently in the group
`Set<String>`	`getGroupNames()` Gets the set of group names currently in the cache
`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

Set<K> getGroupKeys(String group)
                                         throws IOException

Gets the set of keys of objects currently in the group

Parameters:: group -
Returns:: a set of group keys
Throws:: IOException

getGroupNames

Set<String> getGroupNames()
                          throws IOException

Gets the set of group names currently in the cache

Returns:: a set of group names
Throws:: 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 -