IRemoteCacheClient (Commons JCS 2.0.0-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jcs.auxiliary.remote.behavior
Interface IRemoteCacheClient<K extends Serializable,V extends Serializable>

All Superinterfaces:: AuxiliaryCache<K,V>, ICache<K,V>, ICacheType

All Known Implementing Classes:: AbstractRemoteAuxiliaryCache, RemoteCache, RemoteHttpCache

public interface IRemoteCacheClient<K extends Serializable,V extends Serializable>
extends AuxiliaryCache<K,V>
extends AuxiliaryCache<K,V>

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jcs.engine.behavior.ICacheType
`ICacheType.CacheType`

Method Summary
`void`	`fixCache(ICacheServiceNonLocal<?,?> remote)` Replaces the current remote cache service handle with the given handle.
`IRemoteCacheListener<K,V>`	`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, getGroupNames, 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(ICacheServiceNonLocal<?,?> 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 - ICacheServiceNonLocal -- 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<K,V> getListener()

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

Returns:: IRemoteCacheListener