|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jcs.auxiliary.AbstractAuxiliaryCache
public abstract class AbstractAuxiliaryCache
This holds convenience methods used by most auxiliary caches.
Field Summary | |
---|---|
protected ICacheEventLogger |
cacheEventLogger
An optional event logger |
protected IElementSerializer |
elementSerializer
The serializer. |
protected IKeyMatcher |
keyMatcher
Key matcher used by the getMatching API |
Fields inherited from interface org.apache.jcs.engine.behavior.ICacheType |
---|
CACHE_HUB, DISK_CACHE, LATERAL_CACHE, REMOTE_CACHE |
Constructor Summary | |
---|---|
AbstractAuxiliaryCache()
|
Method Summary | |
---|---|
protected ICacheEvent |
createICacheEvent(ICacheElement item,
java.lang.String eventName)
Logs an event if an event logger is configured. |
protected ICacheEvent |
createICacheEvent(java.lang.String regionName,
java.io.Serializable key,
java.lang.String eventName)
Logs an event if an event logger is configured. |
ICacheEventLogger |
getCacheEventLogger()
Allows it to be injected. |
IElementSerializer |
getElementSerializer()
Allows it to be injected. |
abstract java.lang.String |
getEventLoggingExtraInfo()
Gets the extra info for the event log. |
IKeyMatcher |
getKeyMatcher()
Rerturns the key matcher used by get matching. |
protected void |
logApplicationEvent(java.lang.String source,
java.lang.String eventName,
java.lang.String optionalDetails)
Logs an event if an event logger is configured. |
protected void |
logError(java.lang.String source,
java.lang.String eventName,
java.lang.String errorMessage)
Logs an event if an event logger is configured. |
protected void |
logICacheEvent(ICacheEvent cacheEvent)
Logs an event if an event logger is configured. |
void |
setCacheEventLogger(ICacheEventLogger cacheEventLogger)
Allows it to be injected. |
void |
setElementSerializer(IElementSerializer elementSerializer)
Allows you to inject a custom serializer. |
void |
setKeyMatcher(IKeyMatcher keyMatcher)
Sets the key matcher used by get matching. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCache |
---|
getAuxiliaryCacheAttributes, getGroupKeys, getStatistics |
Methods inherited from interface org.apache.jcs.engine.behavior.ICache |
---|
dispose, get, getCacheName, getMatching, getMultiple, getSize, getStats, getStatus, remove, removeAll, update |
Methods inherited from interface org.apache.jcs.engine.behavior.ICacheType |
---|
getCacheType |
Field Detail |
---|
protected ICacheEventLogger cacheEventLogger
protected IElementSerializer elementSerializer
protected IKeyMatcher keyMatcher
Constructor Detail |
---|
public AbstractAuxiliaryCache()
Method Detail |
---|
protected ICacheEvent createICacheEvent(ICacheElement item, java.lang.String eventName)
item
- eventName
-
protected ICacheEvent createICacheEvent(java.lang.String regionName, java.io.Serializable key, java.lang.String eventName)
regionName
- key
- eventName
-
protected void logICacheEvent(ICacheEvent cacheEvent)
cacheEvent
- protected void logApplicationEvent(java.lang.String source, java.lang.String eventName, java.lang.String optionalDetails)
source
- eventName
- optionalDetails
- protected void logError(java.lang.String source, java.lang.String eventName, java.lang.String errorMessage)
source
- eventName
- errorMessage
- public abstract java.lang.String getEventLoggingExtraInfo()
public void setCacheEventLogger(ICacheEventLogger cacheEventLogger)
setCacheEventLogger
in interface AuxiliaryCache
cacheEventLogger
- public ICacheEventLogger getCacheEventLogger()
public void setElementSerializer(IElementSerializer elementSerializer)
Does not allow you to set it to null.
setElementSerializer
in interface AuxiliaryCache
elementSerializer
- public IElementSerializer getElementSerializer()
public void setKeyMatcher(IKeyMatcher keyMatcher)
setKeyMatcher
in interface ICache
keyMatcher
- public IKeyMatcher getKeyMatcher()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |