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

All Superinterfaces:
AuxiliaryCacheAttributes, java.lang.Cloneable, java.io.Serializable
All Known Implementing Classes:
RemoteCacheAttributes

public interface IRemoteCacheAttributes
extends AuxiliaryCacheAttributes

This specifies what a remote cache configuration object should look like.


Field Summary
static int CLUSTER
          A remote cache is either a local cache or a cluster cache.
static int LOCAL
          A remote cache is either a local cache or a cluster cache.
 
Fields inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
POOLED_QUEUE_TYPE, SINGLE_QUEUE_TYPE
 
Method Summary
 java.lang.String getClusterServers()
          Gets the clusterServers attribute of the IRemoteCacheAttributes object
 int getFailoverIndex()
          Gets the failoverIndex attribute of the IRemoteCacheAttributes object.
 java.lang.String[] getFailovers()
          Gets the failovers attribute of the IRemoteCacheAttributes object
 java.lang.String getFailoverServers()
          Gets the failoverServers attribute of the IRemoteCacheAttributes object
 boolean getGetOnly()
          Gets the getOnly attribute of the IRemoteCacheAttributes object
 int getGetTimeoutMillis()
          -1 and 0 mean no timeout, this is the default if the timeout is -1 or 0, no threadpool will be used.
 boolean getLocalClusterConsistency()
          Should cluster updates be propogated to the locals
 int getLocalPort()
          Gets the localPort attribute of the IRemoteCacheAttributes object
 java.lang.String getRemoteHost()
          Gets the remoteHost attribute of the IRemoteCacheAttributes object
 int getRemotePort()
          Gets the remotePort attribute of the IRemoteCacheAttributes object
 java.lang.String getRemoteServiceName()
          Gets the remoteServiceName attribute of the IRemoteCacheAttributes object
 int getRemoteType()
          Gets the remoteType attribute of the IRemoteCacheAttributes object
 java.lang.String getRemoteTypeName()
          Gets the remoteTypeName attribute of the IRemoteCacheAttributes object
 boolean getRemoveUponRemotePut()
          Gets the removeUponRemotePut attribute of the IRemoteCacheAttributes object
 java.lang.String getThreadPoolName()
          The thread pool the remote cache should use.
 void setClusterServers(java.lang.String s)
          Sets the clusterServers attribute of the IRemoteCacheAttributes object
 void setFailoverIndex(int p)
          Sets the failoverIndex attribute of the IRemoteCacheAttributes object
 void setFailovers(java.lang.String[] f)
          Sets the failovers attribute of the IRemoteCacheAttributes object
 void setFailoverServers(java.lang.String s)
          Sets the failoverServers attribute of the IRemoteCacheAttributes object
 void setGetOnly(boolean r)
          Sets the getOnly attribute of the IRemoteCacheAttributes object
 void setGetTimeoutMillis(int millis)
          -1 means no timeout, this is the default if the timeout is -1 or 0, no threadpool will be used.
 void setLocalClusterConsistency(boolean r)
          Should cluster updates be propogated to the locals
 void setLocalPort(int p)
          Sets the localPort attribute of the IRemoteCacheAttributes object
 void setRemoteHost(java.lang.String s)
          Sets the remoteHost attribute of the IRemoteCacheAttributes object
 void setRemotePort(int p)
          Sets the remotePort attribute of the IRemoteCacheAttributes object
 void setRemoteServiceName(java.lang.String s)
          Sets the remoteServiceName attribute of the IRemoteCacheAttributes object
 void setRemoteType(int p)
          Sets the remoteType attribute of the IRemoteCacheAttributes object
 void setRemoteTypeName(java.lang.String s)
          Sets the remoteTypeName attribute of the IRemoteCacheAttributes object
 void setRemoveUponRemotePut(boolean r)
          Sets the removeUponRemotePut attribute of the IRemoteCacheAttributes object
 void setThreadPoolName(java.lang.String name)
          Set the anme of the pool to use.
 
Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
copy, getCacheName, getEventQueuePoolName, getEventQueueType, getEventQueueTypeFactoryCode, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
 

Field Detail

LOCAL

public static final int LOCAL
A remote cache is either a local cache or a cluster cache.

See Also:
Constant Field Values

CLUSTER

public static final int CLUSTER
A remote cache is either a local cache or a cluster cache.

See Also:
Constant Field Values
Method Detail

getRemoteTypeName

public java.lang.String getRemoteTypeName()
Gets the remoteTypeName attribute of the IRemoteCacheAttributes object

Returns:
The remoteTypeName value

setRemoteTypeName

public void setRemoteTypeName(java.lang.String s)
Sets the remoteTypeName attribute of the IRemoteCacheAttributes object

Parameters:
s - The new remoteTypeName value

getRemoteType

public int getRemoteType()
Gets the remoteType attribute of the IRemoteCacheAttributes object

Returns:
The remoteType value

setRemoteType

public void setRemoteType(int p)
Sets the remoteType attribute of the IRemoteCacheAttributes object

Parameters:
p - The new remoteType value

getFailoverIndex

public int getFailoverIndex()
Gets the failoverIndex attribute of the IRemoteCacheAttributes object.

This specifies which server in the list we are listening to if the number is greater than 0 we will try to move to 0 position the primary is added as position 1 if it is present

Returns:
The failoverIndex value

setFailoverIndex

public void setFailoverIndex(int p)
Sets the failoverIndex attribute of the IRemoteCacheAttributes object

Parameters:
p - The new failoverIndex value

getFailovers

public java.lang.String[] getFailovers()
Gets the failovers attribute of the IRemoteCacheAttributes object

Returns:
The failovers value

setFailovers

public void setFailovers(java.lang.String[] f)
Sets the failovers attribute of the IRemoteCacheAttributes object

Parameters:
f - The new failovers value

getRemoteServiceName

public java.lang.String getRemoteServiceName()
Gets the remoteServiceName attribute of the IRemoteCacheAttributes object

Returns:
The remoteServiceName value

setRemoteServiceName

public void setRemoteServiceName(java.lang.String s)
Sets the remoteServiceName attribute of the IRemoteCacheAttributes object

Parameters:
s - The new remoteServiceName value

getRemoteHost

public java.lang.String getRemoteHost()
Gets the remoteHost attribute of the IRemoteCacheAttributes object

Returns:
The remoteHost value

setRemoteHost

public void setRemoteHost(java.lang.String s)
Sets the remoteHost attribute of the IRemoteCacheAttributes object

Parameters:
s - The new remoteHost value

getRemotePort

public int getRemotePort()
Gets the remotePort attribute of the IRemoteCacheAttributes object

Returns:
The remotePort value

setRemotePort

public void setRemotePort(int p)
Sets the remotePort attribute of the IRemoteCacheAttributes object

Parameters:
p - The new remotePort value

getLocalPort

public int getLocalPort()
Gets the localPort attribute of the IRemoteCacheAttributes object

Returns:
The localPort value

setLocalPort

public void setLocalPort(int p)
Sets the localPort attribute of the IRemoteCacheAttributes object

Parameters:
p - The new localPort value

getClusterServers

public java.lang.String getClusterServers()
Gets the clusterServers attribute of the IRemoteCacheAttributes object

Returns:
The clusterServers value

setClusterServers

public void setClusterServers(java.lang.String s)
Sets the clusterServers attribute of the IRemoteCacheAttributes object

Parameters:
s - The new clusterServers value

getFailoverServers

public java.lang.String getFailoverServers()
Gets the failoverServers attribute of the IRemoteCacheAttributes object

Returns:
The failoverServers value

setFailoverServers

public void setFailoverServers(java.lang.String s)
Sets the failoverServers attribute of the IRemoteCacheAttributes object

Parameters:
s - The new failoverServers value

getRemoveUponRemotePut

public boolean getRemoveUponRemotePut()
Gets the removeUponRemotePut attribute of the IRemoteCacheAttributes object

Returns:
The removeUponRemotePut value

setRemoveUponRemotePut

public void setRemoveUponRemotePut(boolean r)
Sets the removeUponRemotePut attribute of the IRemoteCacheAttributes object

Parameters:
r - The new removeUponRemotePut value

getGetOnly

public boolean getGetOnly()
Gets the getOnly attribute of the IRemoteCacheAttributes object

Returns:
The getOnly value

setGetOnly

public void setGetOnly(boolean r)
Sets the getOnly attribute of the IRemoteCacheAttributes object

Parameters:
r - The new getOnly value

getLocalClusterConsistency

public boolean getLocalClusterConsistency()
Should cluster updates be propogated to the locals

Returns:
The localClusterConsistency value

setLocalClusterConsistency

public void setLocalClusterConsistency(boolean r)
Should cluster updates be propogated to the locals

Parameters:
r - The new localClusterConsistency value

getThreadPoolName

public java.lang.String getThreadPoolName()
The thread pool the remote cache should use. At first this will only be for gets.

The default name is "remote_cache_client"

Returns:

setThreadPoolName

public void setThreadPoolName(java.lang.String name)
Set the anme of the pool to use. Pools should be defined in the cache.ccf.

Parameters:
name -

getGetTimeoutMillis

public int getGetTimeoutMillis()
-1 and 0 mean no timeout, this is the default if the timeout is -1 or 0, no threadpool will be used.

Returns:

setGetTimeoutMillis

public void setGetTimeoutMillis(int millis)
-1 means no timeout, this is the default if the timeout is -1 or 0, no threadpool will be used. If the timeout is greater than 0 a threadpool will be used for get requests.

Parameters:
millis -


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