AbstractRemoteCacheListener (Apache Commons JCS

java.lang.Object
- org.apache.commons.jcs.auxiliary.remote.AbstractRemoteCacheListener<K,V>

All Implemented Interfaces:

Serializable, Remote, IRemoteCacheListener<K,V>, ICacheListener<K,V>

Direct Known Subclasses:

RemoteCacheListener, RemoteHttpClientListener
```
public abstract class AbstractRemoteCacheListener<K,V>
extends Object
implements IRemoteCacheListener<K,V>, Serializable
```
Shared listener base.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected int puts
Number of put requests received.

protected int removes
Number of remove requests received.

Fields
Modifier and Type	Field and Description
`protected int`	`puts` Number of put requests received.
`protected int`	`removes` Number of remove requests received.

Constructor Summary

Constructors
Constructor and Description
`AbstractRemoteCacheListener(IRemoteCacheAttributes irca, ICompositeCacheManager cacheMgr)` Only need one since it does work for all regions, just reference by multiple region names.

Method Summary

Methods
Modifier and Type	Method and Description
`protected ICompositeCacheManager`	`getCacheManager()` Gets the cacheManager attribute of the RemoteCacheListener object.
`long`	`getListenerId()` Gets the listenerId attribute of the RemoteCacheListener object.
`String`	`getLocalHostAddress()` This is for debugging.
`RemoteType`	`getRemoteType()` Gets the remoteType attribute of the RemoteCacheListener object
`void`	`handleDispose(String cacheName)` Notifies the subscribers for freeing up the named cache.
`void`	`handlePut(ICacheElement<K,V> cb)` If this is configured to remove on put, then remove the element since it has been updated elsewhere. cd should be incomplete for faster transmission.
`void`	`handleRemove(String cacheName, K key)` Calls localRemove on the CompositeCache.
`void`	`handleRemoveAll(String cacheName)` Calls localRemoveAll on the CompositeCache.
`void`	`setListenerId(long id)` Let the remote cache set a listener_id.
`String`	`toString()` For easier debugging.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.jcs.auxiliary.remote.behavior.IRemoteCacheListener
dispose

- Field Detail
  - puts
```
protected int puts
```
    Number of put requests received. For debugging only.
  - removes
```
protected int removes
```
    Number of remove requests received. For debugging only.
- Constructor Detail
  - AbstractRemoteCacheListener
```
public AbstractRemoteCacheListener(IRemoteCacheAttributes irca,
                           ICompositeCacheManager cacheMgr)
```
    Only need one since it does work for all regions, just reference by multiple region names.
    The constructor exports this object, making it available to receive incoming calls. The callback port is anonymous unless a local port value was specified in the configuration.
    
    Parameters:
    irca -
    cacheMgr -
- Method Detail
  - setListenerId
```
public void setListenerId(long id)
                   throws IOException
```
    Let the remote cache set a listener_id. Since there is only one listener for all the regions and every region gets registered? the id shouldn't be set if it isn't zero. If it is we assume that it is a reconnect.
    
    Specified by:
    
    setListenerId in interface IRemoteCacheListener<K,V>
    
    Specified by:
    
    setListenerId in interface ICacheListener<K,V>
    
    Parameters:
    id - The new listenerId value
    
    Throws:
    
    IOException
  - getListenerId
```
public long getListenerId()
                   throws IOException
```
    Gets the listenerId attribute of the RemoteCacheListener object. This is stored in the object. The RemoteCache object contains a reference to the listener and get the id this way.
    
    Specified by:
    
    getListenerId in interface IRemoteCacheListener<K,V>
    
    Specified by:
    
    getListenerId in interface ICacheListener<K,V>
    
    Returns:
    The listenerId value
    
    Throws:
    
    IOException
  - getRemoteType
```
public RemoteType getRemoteType()
                         throws IOException
```
    Gets the remoteType attribute of the RemoteCacheListener object
    
    Specified by:
    
    getRemoteType in interface IRemoteCacheListener<K,V>
    
    Returns:
    The remoteType value
    
    Throws:
    
    IOException
  - handlePut
```
public void handlePut(ICacheElement<K,V> cb)
               throws IOException
```
    If this is configured to remove on put, then remove the element since it has been updated elsewhere. cd should be incomplete for faster transmission. We don't want to pass data only invalidation. The next time it is used the local cache will get the new version from the remote store.
    If remove on put is not configured, then update the item.
    
    Specified by:
    
    handlePut in interface ICacheListener<K,V>
    
    Parameters:
    cb -
    
    Throws:
    
    IOException
  - handleRemove
```
public void handleRemove(String cacheName,
                K key)
                  throws IOException
```
    Calls localRemove on the CompositeCache.
    
    Specified by:
    
    handleRemove in interface ICacheListener<K,V>
    
    Parameters:
    cacheName -
    key -
    
    Throws:
    
    IOException
  - handleRemoveAll
```
public void handleRemoveAll(String cacheName)
                     throws IOException
```
    Calls localRemoveAll on the CompositeCache.
    
    Specified by:
    
    handleRemoveAll in interface ICacheListener<K,V>
    
    Parameters:
    cacheName -
    
    Throws:
    
    IOException
  - handleDispose
```
public void handleDispose(String cacheName)
                   throws IOException
```
    Description copied from interface: ICacheListener
    
    Notifies the subscribers for freeing up the named cache.
    
    Specified by:
    
    handleDispose in interface ICacheListener<K,V>
    
    Parameters:
    cacheName -
    
    Throws:
    
    IOException
  - getCacheManager
```
protected ICompositeCacheManager getCacheManager()
```
    Gets the cacheManager attribute of the RemoteCacheListener object. This is one of the few places that force the cache to be a singleton.
  - getLocalHostAddress
```
public String getLocalHostAddress()
                           throws IOException
```
    This is for debugging. It allows the remote server to log the address of clients.
    
    Specified by:
    
    getLocalHostAddress in interface IRemoteCacheListener<K,V>
    
    Returns:
    String
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    For easier debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    Basic info on this listener.

Class AbstractRemoteCacheListener<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.commons.jcs.auxiliary.remote.behavior.IRemoteCacheListener

Field Detail

puts

removes

Constructor Detail

AbstractRemoteCacheListener

Method Detail

setListenerId

getListenerId

getRemoteType

handlePut

handleRemove

handleRemoveAll

handleDispose

getCacheManager

getLocalHostAddress

toString