Class LateralCache<K,V> 
java.lang.Object
org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCache<K,V>
 
org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheEventLogging<K,V>
 
org.apache.commons.jcs3.auxiliary.lateral.LateralCache<K,V> 
- All Implemented Interfaces:
- AuxiliaryCache<K,,- V> - ICache<K,,- V> - ICacheType
Lateral distributor. Returns null on get by default. Net search not implemented.
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.apache.commons.jcs3.engine.behavior.ICacheTypeICacheType.CacheType
- 
Field SummaryFields inherited from interface org.apache.commons.jcs3.engine.behavior.ICacheNAME_COMPONENT_DELIMITER
- 
Constructor SummaryConstructorsConstructorDescriptionDeprecated.Causes NPELateralCache(ILateralCacheAttributes cattr, ICacheServiceNonLocal<K, V> lateral, LateralCacheMonitor monitor) Constructor for the LateralCache object
- 
Method SummaryModifier and TypeMethodDescriptionvoidfixCache(ICacheServiceNonLocal<K, V> restoredLateral) Replaces the current remote cache service handle with the given handle.This returns the generic attributes for an auxiliary cache.Gets the cacheName attribute of the LateralCache objectGets the cacheType attribute of the LateralCache objectGets the extra info for the event log.Return the keys in this cache.intgetSize()Returns the current cache size.The NoWait on top does not call out to here yet.getStats()getStatsReturns the cache status.protected voidSynchronously dispose the cache.protected ICacheElement<K,V> processGet(K key) The performance costs are too great.protected Map<K,ICacheElement<K, V>> processGetMatching(String pattern) Implementation of getMatching.protected booleanprocessRemove(K key) Synchronously remove from the remote cache; if failed, replace the remote handle with a zombie.protected voidSynchronously removeAll from the remote cache; if failed, replace the remote handle with a zombie.protected voidprocessUpdate(ICacheElement<K, V> ce) Update lateral.toString()Methods inherited from class org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheEventLoggingdispose, disposeWithEventLogging, get, getMatching, getMatchingWithEventLogging, getMultiple, getMultipleWithEventLogging, getWithEventLogging, remove, removeAll, removeAllWithEventLogging, removeWithEventLogging, update, updateWithEventLoggingMethods inherited from class org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCachecreateICacheEvent, createICacheEvent, getCacheEventLogger, getElementSerializer, getKeyMatcher, logApplicationEvent, logError, logICacheEvent, processGetMultiple, setCacheEventLogger, setElementSerializer, setKeyMatcher
- 
Constructor Details- 
LateralCachepublic LateralCache(ILateralCacheAttributes cattr, ICacheServiceNonLocal<K, V> lateral, LateralCacheMonitor monitor) Constructor for the LateralCache object- Parameters:
- cattr-
- lateral-
- monitor-
 
- 
LateralCacheDeprecated.Causes NPEConstructor for the LateralCache object- Parameters:
- cattr-
 
 
- 
- 
Method Details- 
processUpdateUpdate lateral.- Specified by:
- processUpdatein class- AbstractAuxiliaryCacheEventLogging<K,- V> 
- Parameters:
- ce-
- Throws:
- IOException
 
- 
processGetThe performance costs are too great. It is not recommended that you enable lateral gets.- Specified by:
- processGetin class- AbstractAuxiliaryCacheEventLogging<K,- V> 
- Parameters:
- key-
- Returns:
- ICacheElement<K, V> or null
- Throws:
- IOException
 
- 
processGetMatchingDescription copied from class:AbstractAuxiliaryCacheEventLoggingImplementation of getMatching.- Specified by:
- processGetMatchingin class- AbstractAuxiliaryCacheEventLogging<K,- V> 
- Parameters:
- pattern-
- Returns:
- A map of K key to ICacheElement<K, V> element, or an empty map if there is no data in cache for any of these keys
- Throws:
- IOException
 
- 
getKeySetReturn the keys in this cache.- Returns:
- a set of the key type TODO This should probably be done in chunks with a range passed in. This will be a problem if someone puts a 1,000,000 or so items in a region.
- Throws:
- IOException- if access to the auxiliary cache fails
- See Also:
 
- 
processRemoveSynchronously remove from the remote cache; if failed, replace the remote handle with a zombie.- Specified by:
- processRemovein class- AbstractAuxiliaryCacheEventLogging<K,- V> 
- Parameters:
- key-
- Returns:
- false always
- Throws:
- IOException
 
- 
processRemoveAllSynchronously removeAll from the remote cache; if failed, replace the remote handle with a zombie.- Specified by:
- processRemoveAllin class- AbstractAuxiliaryCacheEventLogging<K,- V> 
- Throws:
- IOException
 
- 
processDisposeSynchronously dispose the cache. Not sure we want this.- Specified by:
- processDisposein class- AbstractAuxiliaryCacheEventLogging<K,- V> 
- Throws:
- IOException
 
- 
getStatusReturns the cache status.- Returns:
- The status value
 
- 
getSizeReturns the current cache size.- Returns:
- The size value
 
- 
getCacheTypeGets the cacheType attribute of the LateralCache object- Returns:
- The cacheType value
 
- 
getCacheNameGets the cacheName attribute of the LateralCache object- Returns:
- The cacheName value
 
- 
fixCacheReplaces the current remote cache service handle with the given handle.- Parameters:
- restoredLateral-
 
- 
getStatsgetStats- Returns:
- String
 
- 
getAuxiliaryCacheAttributesDescription copied from interface:AuxiliaryCacheThis returns the generic attributes for an auxiliary cache. Most implementations will cast this to a more specific type.- Returns:
- Returns the AuxiliaryCacheAttributes.
 
- 
toString
- 
getEventLoggingExtraInfoDescription copied from class:AbstractAuxiliaryCacheGets the extra info for the event log.- Specified by:
- getEventLoggingExtraInfoin class- AbstractAuxiliaryCache<K,- V> 
- Returns:
- extra data.
 
- 
getStatisticsThe NoWait on top does not call out to here yet.- Returns:
- almost nothing
 
 
-