org.apache.jcs.auxiliary.remote.behavior
Interface IRemoteCacheClient

All Superinterfaces:
AuxiliaryCache, ICache, ICacheType, java.io.Serializable
All Known Implementing Classes:
AbstractRemoteAuxiliaryCache, RemoteCache, RemoteHttpCache

public interface IRemoteCacheClient
extends AuxiliaryCache

This defines the behavior expected of a remote cache client. This extends Auxiliary cache which in turn extends ICache.

I'd like generalize this a bit.

Author:
Aaron Smuts

Field Summary
 
Fields inherited from interface org.apache.jcs.engine.behavior.ICacheType
CACHE_HUB, DISK_CACHE, LATERAL_CACHE, REMOTE_CACHE
 
Method Summary
 void fixCache(IRemoteCacheService remote)
          Replaces the current remote cache service handle with the given handle.
 IRemoteCacheListener getListener()
          This returns the listener associated with this remote cache.
 long getListenerId()
          Gets the listenerId attribute of the RemoteCacheListener object.
 
Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCache
getAuxiliaryCacheAttributes, getGroupKeys, getStatistics, setCacheEventLogger, setElementSerializer
 
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

fixCache

void fixCache(IRemoteCacheService remote)
Replaces the current remote cache service handle with the given handle. If the current remote is a Zombie, the propagate the events that may be queued to the restored service.

Parameters:
remote - IRemoteCacheService -- the remote server or proxy to the remote server

getListenerId

long getListenerId()
Gets the listenerId attribute of the RemoteCacheListener object.

All requests to the remote cache must include a listener id. This allows the server to avoid sending updates the the listener associated with this client.

Returns:
The listenerId value

getListener

IRemoteCacheListener getListener()
This returns the listener associated with this remote cache. TODO we should try to get this out of the interface.

Returns:
IRemoteCacheListener


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