package org.apache.stratum.jcs.auxiliary.remote;
import java.io.IOException;
import java.io.Serializable;
import java.rmi.Remote;
import java.rmi.RemoteException;
import java.rmi.server.UnicastRemoteObject;
import org.apache.stratum.jcs.auxiliary.remote.behavior.IRemoteCacheAttributes;
import org.apache.stratum.jcs.auxiliary.remote.behavior.IRemoteCacheConstants;
import org.apache.stratum.jcs.auxiliary.remote.behavior.IRemoteCacheListener;
import org.apache.stratum.jcs.engine.behavior.ICache;
import org.apache.stratum.jcs.engine.behavior.ICacheElement;
import org.apache.stratum.jcs.engine.behavior.ICacheManager;
import org.apache.stratum.jcs.engine.behavior.ICompositeCache;
import org.apache.stratum.jcs.engine.behavior.ICompositeCacheManager;
import org.apache.stratum.jcs.engine.control.Cache;
import org.apache.stratum.jcs.engine.control.CacheManagerFactory;
import org.apache.stratum.jcs.engine.control.CompositeCacheManager;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
// remove
/**
* Registered with RemoteCache server. The server updates the local caches via
* this class.
*
* @author asmuts
* @created January 15, 2002
*/
public class RemoteCacheListener
implements IRemoteCacheListener, IRemoteCacheConstants, Serializable
{
private final static Log log =
LogFactory.getLog( RemoteCacheListener.class );
/** Description of the Field */
protected static transient ICompositeCacheManager cacheMgr;
/** Description of the Field */
protected static IRemoteCacheListener instance;
/** Description of the Field */
protected IRemoteCacheAttributes irca;
/** Description of the Field */
protected int puts = 0;
/** Description of the Field */
protected int removes = 0;
/**
* Only need one since it does work for all regions, just reference by
* multiple region names.
*
* @param irca
*/
protected RemoteCacheListener( IRemoteCacheAttributes irca )
{
this.irca = irca;
// may need to add to ICacheManager interface to handle
// the source arument extended update and remove methods
// causes circular reference, unfortunate, becasue the
// the overhead is higer
// will need to pass a refernce thru
//cacheMgr = CacheManagerFactory.getInstance();
// Export this remote object to make it available to receive incoming calls,
// using an anonymous port.
try
{
if ( irca.getLocalPort() != 0 )
{
UnicastRemoteObject.exportObject( this, irca.getLocalPort() );
}
else
{
UnicastRemoteObject.exportObject( this );
}
}
catch ( RemoteException ex )
{
log.error( ex );
throw new IllegalStateException( ex.getMessage() );
}
}
/**
* let the remote cache set a listener_id. Since there is only one listerenr
* 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.
*
* @param id The new listenerId value
*/
public void setListenerId( byte id )
throws IOException
{
RemoteCacheInfo.listenerId = id;
if ( log.isDebugEnabled() )
{
log.debug( "set listenerId = " + id );
}
}
/**
* Gets the listenerId attribute of the RemoteCacheListener object
*
* @return The listenerId value
*/
public byte getListenerId()
throws IOException
{
// set the manager since we are in use
//getCacheManager();
//p( "get listenerId" );
if ( log.isDebugEnabled() )
{
log.debug( "get listenerId = " + RemoteCacheInfo.listenerId );
}
return RemoteCacheInfo.listenerId;
}
/**
* Gets the remoteType attribute of the RemoteCacheListener object
*
* @return The remoteType value
*/
public int getRemoteType()
throws IOException
{
if ( log.isDebugEnabled() )
{
log.debug( "getRemoteType = " + irca.getRemoteType() );
}
return irca.getRemoteType();
}
/**
* Gets the instance attribute of the RemoteCacheListener class
*
* @return The instance value
*/
public static IRemoteCacheListener getInstance( IRemoteCacheAttributes irca )
{
//throws IOException, NotBoundException
if ( instance == null )
{
synchronized ( RemoteCacheListener.class )
{
if ( instance == null )
{
instance = new RemoteCacheListener( irca );
}
}
}
//instance.incrementClients();
return instance;
}
//////////////////////////// implements the IRemoteCacheListener interface. //////////////
/**
* Just 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
*/
public void handlePut( ICacheElement cb )
throws IOException
{
if ( irca.getRemoveUponRemotePut() )
{
log.debug( "PUTTING ELEMENT FROM REMOTE, ( invalidating ) " );
handleRemove( cb.getCacheName(), cb.getKey() );
}
else
{
if ( log.isDebugEnabled() )
{
log.debug( "PUTTING ELEMENT FROM REMOTE, ( updating ) " );
log.debug( "cb = " + cb );
puts++;
if ( puts % 100 == 0 )
{
log.debug( "puts = " + puts );
}
}
getCacheManager();
ICompositeCache cache = ( ICompositeCache ) cacheMgr.getCache( cb.getCacheName() );
// if ( this.irca.getLocalClusterConsistency() && this.irca.getRemoteType() != irca.CLUSTER )
// {
cache.update( cb, ICache.EXCLUDE_REMOTE_CACHE );
// }
// else
// {
// cache.update( cb, ICache.INCLUDE_REMOTE_CACHE );
// }
}
return;
}
/** Description of the Method */
public void handleRemove( String cacheName, Serializable key )
throws IOException
{
if ( log.isDebugEnabled() )
{
removes++;
if ( removes % 100 == 0 )
{
log.debug( "removes = " + removes );
}
log.debug( "handleRemove> cacheName=" + cacheName + ", key=" + key );
}
getCacheManager();
Cache cache = ( Cache ) cacheMgr.getCache( cacheName );
// If cluster updates another cluster, then update listeners to that
// cluster.
// Do not communicate with cluster except via server.
// separates the remote from the local. Must run a server to
// cluster, else it can be run inside a local.
// if ( this.irca.getLocalClusterConsistency() && this.irca.getRemoteType() != irca.CLUSTER )
// {
cache.remove( key, cache.REMOTE_INVOKATION );
// }
// else
// {
// cache.remove( key, cache.LOCAL_INVOKATION );
// }
}
/** Description of the Method */
public void handleRemoveAll( String cacheName )
throws IOException
{
if ( log.isDebugEnabled() )
{
log.debug( "handleRemoveAll> cacheName=" + cacheName );
}
getCacheManager();
ICache cache = cacheMgr.getCache( cacheName );
cache.removeAll();
}
/** Description of the Method */
public void handleDispose( String cacheName )
throws IOException
{
if ( log.isDebugEnabled() )
{
log.debug( "handleDispose> cacheName=" + cacheName );
}
CompositeCacheManager cm = ( CompositeCacheManager ) cacheMgr;
cm.freeCache( cacheName, Cache.REMOTE_INVOKATION );
}
// override for new funcitonality
/**
* Gets the cacheManager attribute of the RemoteCacheListener object
*/
protected void getCacheManager()
{
if ( cacheMgr == null )
{
cacheMgr = ( ICompositeCacheManager ) CacheManagerFactory.getInstance();
log.debug( "had to get cacheMgr" );
if ( log.isDebugEnabled() )
{
log.debug( "cacheMgr = " + cacheMgr );
}
}
else
{
if ( log.isDebugEnabled() )
{
log.debug( "already got cacheMgr = " + cacheMgr );
}
}
}
}