org.apache.jcs.auxiliary.lateral.socket.tcp
Class LateralTCPDiscoveryListener

java.lang.Object
  extended by org.apache.jcs.auxiliary.lateral.socket.tcp.LateralTCPDiscoveryListener
All Implemented Interfaces:
IDiscoveryListener

public class LateralTCPDiscoveryListener
extends Object
implements IDiscoveryListener

This knows how to add and remove discovered services. It observers UDP discovery events.

We can have one listener per region, or one shared by all regions.


Field Summary
protected  ICacheEventLogger cacheEventLogger
          The event logger.
protected  IElementSerializer elementSerializer
          The serializer.
 
Constructor Summary
protected LateralTCPDiscoveryListener(ICompositeCacheManager cacheMgr, ICacheEventLogger cacheEventLogger, IElementSerializer elementSerializer)
          This plugs into the udp discovery system.
 
Method Summary
 void addDiscoveredService(DiscoveredService service)
          Creates the lateral cache if needed.
protected  boolean addNoWait(LateralCacheNoWait noWait)
          When a broadcast is received from the UDP Discovery receiver, for each cacheName in the message, the add no wait will be called here.
 boolean addNoWaitFacade(String cacheName, LateralCacheNoWaitFacade facade)
          Adds a nowait facade under this cachename.
 boolean containsNoWait(String cacheName, LateralCacheNoWait noWait)
          Allows us to see if the facade is present and if it has the no wait.
 boolean containsNoWaitFacade(String cacheName)
          Allows us to see if the facade is present.
 void removeDiscoveredService(DiscoveredService service)
          Removes the lateral cache.
protected  boolean removeNoWait(LateralCacheNoWait noWait)
          Look up the facade for the name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cacheEventLogger

protected ICacheEventLogger cacheEventLogger
The event logger.


elementSerializer

protected IElementSerializer elementSerializer
The serializer.

Constructor Detail

LateralTCPDiscoveryListener

protected LateralTCPDiscoveryListener(ICompositeCacheManager cacheMgr,
                                      ICacheEventLogger cacheEventLogger,
                                      IElementSerializer elementSerializer)
This plugs into the udp discovery system. It will receive add and remove events.

Parameters:
cacheMgr -
cacheEventLogger -
elementSerializer -
Method Detail

addNoWaitFacade

public boolean addNoWaitFacade(String cacheName,
                               LateralCacheNoWaitFacade facade)
Adds a nowait facade under this cachename. If one already existed, it will be overridden.

This adds nowaits to a facade for the region name. If the region has no facade, then it is not configured to use the lateral cache, and no facade will be created.

Parameters:
cacheName - - the region name
facade - - facade (for region) => multiple lateral clients.
Returns:
true if the facade was not already registered.

containsNoWaitFacade

public boolean containsNoWaitFacade(String cacheName)
Allows us to see if the facade is present.

Parameters:
cacheName - - facades are for a region
Returns:
do we contain the no wait. true if so

containsNoWait

public boolean containsNoWait(String cacheName,
                              LateralCacheNoWait noWait)
Allows us to see if the facade is present and if it has the no wait.

Parameters:
cacheName - - facades are for a region
noWait - - is this no wait in the facade
Returns:
do we contain the no wait. true if so

addNoWait

protected boolean addNoWait(LateralCacheNoWait noWait)
When a broadcast is received from the UDP Discovery receiver, for each cacheName in the message, the add no wait will be called here. To add a no wait, the facade is looked up for this cache name.

Each region has a facade. The facade contains a list of end points--the other tcp lateral services.

Parameters:
noWait -
Returns:
true if we found the no wait and added it. False if the no wait was not present or it we already had it.

removeNoWait

protected boolean removeNoWait(LateralCacheNoWait noWait)
Look up the facade for the name. If it doesn't exist, then the region is not configured for use with the lateral cache. If it is present, remove the item from the no wait list.

Parameters:
noWait -
Returns:
true if we found the no wait and removed it. False if the no wait was not present.

addDiscoveredService

public void addDiscoveredService(DiscoveredService service)
Creates the lateral cache if needed.

We could go to the composite cache manager and get the the cache for the region. This would force a full configuration of the region. One advantage of this would be that the creation of the later would go through the factory, which would add the item to the no wait list. But we don't want to do this. This would force this client to have all the regions as the other. This might not be desired. We don't want to send or receive for a region here that is either not used or not configured to use the lateral.

Right now, I'm afraid that the region will get puts if another instance has the region configured to use the lateral and our address is configured. This might be a bug, but it shouldn't happen with discovery.

Specified by:
addDiscoveredService in interface IDiscoveryListener
Parameters:
service -

removeDiscoveredService

public void removeDiscoveredService(DiscoveredService service)
Removes the lateral cache.

We need to tell the manager that this instance is bad, so it will reconnect the sender if it comes back.

Specified by:
removeDiscoveredService in interface IDiscoveryListener
Parameters:
service -


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