org.apache.jcs.auxiliary.lateral
Class LateralCacheNoWait

java.lang.Object
  extended by org.apache.jcs.auxiliary.AbstractAuxiliaryCache
      extended by org.apache.jcs.auxiliary.lateral.LateralCacheNoWait
All Implemented Interfaces:
java.io.Serializable, AuxiliaryCache, ICache, ICacheType

public class LateralCacheNoWait
extends AbstractAuxiliaryCache

Used to queue up update requests to the underlying cache. These requests will be processed in their order of arrival via the cache event queue processor.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.jcs.auxiliary.AbstractAuxiliaryCache
cacheEventLogger, elementSerializer, keyMatcher
 
Fields inherited from interface org.apache.jcs.engine.behavior.ICacheType
CACHE_HUB, DISK_CACHE, LATERAL_CACHE, REMOTE_CACHE
 
Constructor Summary
LateralCacheNoWait(LateralCache cache)
          Constructs with the given lateral cache, and fires up an event queue for aysnchronous processing.
 
Method Summary
 void dispose()
          Adds a dispose request to the lateral cache.
 void fixCache(ILateralCacheService lateral)
          Replaces the lateral cache service handle with the given handle and reset the queue by starting up a new instance.
 ICacheElement get(java.io.Serializable key)
          Synchronously reads from the lateral cache.
 AuxiliaryCacheAttributes getAuxiliaryCacheAttributes()
          This returns the generic attributes for an auxiliary cache.
 java.lang.String getCacheName()
          Gets the cacheName attribute of the LateralCacheNoWait object
 int getCacheType()
          No lateral invocation.
 java.lang.String getEventLoggingExtraInfo()
          this won't be called since we don't do ICache logging here.
 java.util.Set getGroupKeys(java.lang.String groupName)
          Gets the set of keys of objects currently in the group
 java.util.Map getMatching(java.lang.String pattern)
          Synchronously reads from the lateral cache.
 java.util.Map getMultiple(java.util.Set keys)
          Gets multiple items from the cache based on the given set of keys.
 int getSize()
          No lateral invocation.
 IStats getStatistics()
           
 java.lang.String getStats()
          getStats
 int getStatus()
          Returns the asyn cache status.
 boolean remove(java.io.Serializable key)
          Adds a remove request to the lateral cache.
 void removeAll()
          Adds a removeAll request to the lateral cache.
 void resetEventQ()
          Resets the event q by first destroying the existing one and starting up new one.
 java.lang.String toString()
           
 void update(ICacheElement ce)
          Puts an item to the cache.
 
Methods inherited from class org.apache.jcs.auxiliary.AbstractAuxiliaryCache
createICacheEvent, createICacheEvent, getCacheEventLogger, getElementSerializer, getKeyMatcher, logApplicationEvent, logError, logICacheEvent, setCacheEventLogger, setElementSerializer, setKeyMatcher
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LateralCacheNoWait

public LateralCacheNoWait(LateralCache cache)
Constructs with the given lateral cache, and fires up an event queue for aysnchronous processing.

Parameters:
cache -
Method Detail

update

public void update(ICacheElement ce)
            throws java.io.IOException
Description copied from interface: ICache
Puts an item to the cache.

Parameters:
ce -
Throws:
java.io.IOException

get

public ICacheElement get(java.io.Serializable key)
Synchronously reads from the lateral cache.

Parameters:
key -
Returns:
ICacheElement if found, else null

getMultiple

public java.util.Map getMultiple(java.util.Set keys)
Gets multiple items from the cache based on the given set of keys.

Parameters:
keys -
Returns:
a map of Serializable key to ICacheElement element, or an empty map if there is no data in cache for any of these keys

getMatching

public java.util.Map getMatching(java.lang.String pattern)
Synchronously reads from the lateral cache.

Parameters:
pattern -
Returns:
ICacheElement if found, else empty

getGroupKeys

public java.util.Set getGroupKeys(java.lang.String groupName)
Description copied from interface: AuxiliaryCache
Gets the set of keys of objects currently in the group

Parameters:
groupName -
Returns:
Set

remove

public boolean remove(java.io.Serializable key)
Adds a remove request to the lateral cache.

Parameters:
key -
Returns:
always false

removeAll

public void removeAll()
Adds a removeAll request to the lateral cache.


dispose

public void dispose()
Adds a dispose request to the lateral cache.


getSize

public int getSize()
No lateral invocation.

Returns:
The size value

getCacheType

public int getCacheType()
No lateral invocation.

Returns:
The cacheType value

getStatus

public int getStatus()
Returns the asyn cache status. An error status indicates either the lateral connection is not available, or the asyn queue has been unexpectedly destroyed. No lateral invokation.

Returns:
The status value

getCacheName

public java.lang.String getCacheName()
Gets the cacheName attribute of the LateralCacheNoWait object

Returns:
The cacheName value

fixCache

public void fixCache(ILateralCacheService lateral)
Replaces the lateral cache service handle with the given handle and reset the queue by starting up a new instance.

Parameters:
lateral -

resetEventQ

public void resetEventQ()
Resets the event q by first destroying the existing one and starting up new one.


getAuxiliaryCacheAttributes

public AuxiliaryCacheAttributes getAuxiliaryCacheAttributes()
Description copied from interface: AuxiliaryCache
This returns the generic attributes for an auxiliary cache. Most implementations will cast this to a more specific type.

Returns:
Returns the AuxiliaryCacheAttributes.

getStats

public java.lang.String getStats()
getStats

Returns:
String

getEventLoggingExtraInfo

public java.lang.String getEventLoggingExtraInfo()
this won't be called since we don't do ICache logging here.

Specified by:
getEventLoggingExtraInfo in class AbstractAuxiliaryCache
Returns:
String

getStatistics

public IStats getStatistics()
Returns:
statistics about this communication

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
debugging info.


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