Class AbstractAuxiliaryCacheEventLogging<K,V> 
java.lang.Object
org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCache<K,V>
 
org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheEventLogging<K,V> 
- All Implemented Interfaces:
- AuxiliaryCache<K,,- V> - ICache<K,,- V> - ICacheType
- Direct Known Subclasses:
- AbstractDiskCache,- AbstractRemoteAuxiliaryCache,- LateralCache
All ICacheEvents are defined as final. Children must implement process events. These are wrapped
 in event log parent calls.
 You can override the public method, but if you don't, the default will call getWithTiming.
- 
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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoiddispose()Synchronously dispose the remote cache; if failed, replace the remote handle with a zombie.protected final voidSynchronously dispose the remote cache; if failed, replace the remote handle with a zombie.Gets the item from the cache.Map<K,ICacheElement<K, V>> getMatching(String pattern) Gets items from the cache matching the given pattern.protected final Map<K,ICacheElement<K, V>> getMatchingWithEventLogging(String pattern) Gets matching items from the cache based on the given pattern.Map<K,ICacheElement<K, V>> getMultiple(Set<K> keys) Gets multiple items from the cache based on the given set of keys.protected final Map<K,ICacheElement<K, V>> getMultipleWithEventLogging(Set<K> keys) Gets multiple items from the cache based on the given set of keys.protected final ICacheElement<K,V> getWithEventLogging(K key) Gets the item from the cache.protected abstract voidSpecific implementation of dispose.protected abstract ICacheElement<K,V> processGet(K key) Implementation of get.protected abstract Map<K,ICacheElement<K, V>> processGetMatching(String pattern) Implementation of getMatching.protected abstract booleanprocessRemove(K key) Specific implementation of remove.protected abstract voidSpecific implementation of removeAll.protected abstract voidprocessUpdate(ICacheElement<K, V> cacheElement) Implementation of put.booleanRemoves the item from the cache.voidRemoves all from the region.protected final voidRemoves all from the region.protected final booleanremoveWithEventLogging(K key) Removes the item from the cache.voidupdate(ICacheElement<K, V> cacheElement) Puts an item into the cache.protected final voidupdateWithEventLogging(ICacheElement<K, V> cacheElement) Puts an item into the cache.Methods inherited from class org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCachecreateICacheEvent, createICacheEvent, getCacheEventLogger, getElementSerializer, getEventLoggingExtraInfo, getKeyMatcher, logApplicationEvent, logError, logICacheEvent, processGetMultiple, setCacheEventLogger, setElementSerializer, setKeyMatcherMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.commons.jcs3.auxiliary.AuxiliaryCachegetAuxiliaryCacheAttributes, getKeySet, getStatisticsMethods inherited from interface org.apache.commons.jcs3.engine.behavior.ICachegetCacheName, getSize, getStats, getStatusMethods inherited from interface org.apache.commons.jcs3.engine.behavior.ICacheTypegetCacheType
- 
Constructor Details- 
AbstractAuxiliaryCacheEventLoggingpublic AbstractAuxiliaryCacheEventLogging()
 
- 
- 
Method Details- 
updatePuts an item into the cache.- Parameters:
- cacheElement-
- Throws:
- IOException
 
- 
updateWithEventLoggingPuts an item into the cache. Wrapped in logging.- Parameters:
- cacheElement-
- Throws:
- IOException
 
- 
processUpdateImplementation of put.- Parameters:
- cacheElement-
- Throws:
- IOException
 
- 
getGets the item from the cache.- Specified by:
- getin interface- ICache<K,- V> 
- Specified by:
- getin class- AbstractAuxiliaryCache<K,- V> 
- Parameters:
- key-
- Returns:
- ICacheElement, a wrapper around the key, value, and attributes
- Throws:
- IOException
 
- 
getWithEventLoggingGets the item from the cache. Wrapped in logging.- Parameters:
- key-
- Returns:
- ICacheElement, a wrapper around the key, value, and attributes
- Throws:
- IOException
 
- 
processGetImplementation of get.- Parameters:
- key-
- Returns:
- ICacheElement, a wrapper around the key, value, and attributes
- Throws:
- IOException
 
- 
getMultipleGets multiple items from the cache based on the given set of keys.- Parameters:
- keys-
- 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
 
- 
getMultipleWithEventLoggingprotected final Map<K,ICacheElement<K, getMultipleWithEventLoggingV>> (Set<K> keys) throws IOException Gets multiple items from the cache based on the given set of keys.- Parameters:
- keys-
- 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
 
- 
getMatchingGets items from the cache matching the given pattern. Items from memory will replace those from remote sources. This only works with string keys. It's too expensive to do a toString on every key. Auxiliaries will do their best to handle simple expressions. For instance, the JDBC disk cache will convert * to % and . to _- Parameters:
- pattern-
- Returns:
- a map of K key to ICacheElement<K, V> element, or an empty map if there is no data matching the pattern.
- Throws:
- IOException
 
- 
getMatchingWithEventLoggingprotected final Map<K,ICacheElement<K, getMatchingWithEventLoggingV>> (String pattern) throws IOException Gets matching items from the cache based on the given pattern.- Parameters:
- pattern-
- Returns:
- a map of K key to ICacheElement<K, V> element, or an empty map if there is no data matching the pattern.
- Throws:
- IOException
 
- 
processGetMatchingImplementation of getMatching.- Parameters:
- pattern-
- Returns:
- a map of K key to ICacheElement<K, V> element, or an empty map if there is no data matching the pattern.
- Throws:
- IOException
 
- 
removeRemoves the item from the cache. Wraps the remove in event logs.- Parameters:
- key-
- Returns:
- boolean, whether or not the item was removed
- Throws:
- IOException
 
- 
removeWithEventLoggingRemoves the item from the cache. Wraps the remove in event logs.- Parameters:
- key-
- Returns:
- boolean, whether or not the item was removed
- Throws:
- IOException
 
- 
processRemoveSpecific implementation of remove.- Parameters:
- key-
- Returns:
- boolean, whether or not the item was removed
- Throws:
- IOException
 
- 
removeAllRemoves all from the region. Wraps the removeAll in event logs.- Throws:
- IOException
 
- 
removeAllWithEventLoggingRemoves all from the region. Wraps the removeAll in event logs.- Throws:
- IOException
 
- 
processRemoveAllSpecific implementation of removeAll.- Throws:
- IOException
 
- 
disposeSynchronously dispose the remote cache; if failed, replace the remote handle with a zombie.- Throws:
- IOException
 
- 
disposeWithEventLoggingSynchronously dispose the remote cache; if failed, replace the remote handle with a zombie. Wraps the removeAll in event logs.- Throws:
- IOException
 
- 
processDisposeSpecific implementation of dispose.- Throws:
- IOException
 
 
-