|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRemoteCacheAttributes
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 boolean |
DEFAULT_RECEIVE
If RECEIVE is false then the remote cache will not register a listener with the remote server. |
static int |
DEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MILLIS
The default timeout for the custom RMI socket facfory |
static int |
DEFAULT_ZOMBIE_QUEUE_MAX_SIZE
The number of elements the zombie queue will hold. |
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 | |
---|---|
String |
getClusterServers()
Gets the clusterServers attribute of the IRemoteCacheAttributes object |
int |
getFailoverIndex()
Gets the failoverIndex attribute of the IRemoteCacheAttributes object. |
String[] |
getFailovers()
Gets the failovers attribute of the IRemoteCacheAttributes object |
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 |
String |
getRemoteHost()
Gets the remoteHost attribute of the IRemoteCacheAttributes object |
int |
getRemotePort()
Gets the remotePort attribute of the IRemoteCacheAttributes object |
String |
getRemoteServiceName()
Gets the remoteServiceName attribute of the IRemoteCacheAttributes object |
int |
getRemoteType()
Gets the remoteType attribute of the IRemoteCacheAttributes object |
String |
getRemoteTypeName()
Gets the remoteTypeName attribute of the IRemoteCacheAttributes object |
boolean |
getRemoveUponRemotePut()
Gets the removeUponRemotePut attribute of the IRemoteCacheAttributes object |
int |
getRmiSocketFactoryTimeoutMillis()
This sets a general timeout on the rmi socket factory. |
String |
getThreadPoolName()
The thread pool the remote cache should use. |
int |
getZombieQueueMaxSize()
The number of elements the zombie queue will hold. |
boolean |
isReceive()
If RECEIVE is false then the remote cache will not register a listener with the remote server. |
void |
setClusterServers(String s)
Sets the clusterServers attribute of the IRemoteCacheAttributes object |
void |
setFailoverIndex(int p)
Sets the failoverIndex attribute of the IRemoteCacheAttributes object |
void |
setFailovers(String[] f)
Sets the failovers attribute of the IRemoteCacheAttributes object |
void |
setFailoverServers(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 |
setReceive(boolean receive)
By default this option is true. |
void |
setRemoteHost(String s)
Sets the remoteHost attribute of the IRemoteCacheAttributes object |
void |
setRemotePort(int p)
Sets the remotePort attribute of the IRemoteCacheAttributes object |
void |
setRemoteServiceName(String s)
Sets the remoteServiceName attribute of the IRemoteCacheAttributes object |
void |
setRemoteType(int p)
Sets the remoteType attribute of the IRemoteCacheAttributes object |
void |
setRemoteTypeName(String s)
Sets the remoteTypeName attribute of the IRemoteCacheAttributes object |
void |
setRemoveUponRemotePut(boolean r)
Sets the removeUponRemotePut attribute of the IRemoteCacheAttributes object |
void |
setRmiSocketFactoryTimeoutMillis(int rmiSocketFactoryTimeoutMillis)
This sets a general timeout on the RMI socket factory. |
void |
setThreadPoolName(String name)
Set the anme of the pool to use. |
void |
setZombieQueueMaxSize(int zombieQueueMaxSize)
The number of elements the zombie queue will hold. |
Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes |
---|
copy, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName |
Field Detail |
---|
static final int LOCAL
static final int CLUSTER
static final int DEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MILLIS
static final boolean DEFAULT_RECEIVE
If you set this option to false, you should set your locl memory size to 0.
static final int DEFAULT_ZOMBIE_QUEUE_MAX_SIZE
Method Detail |
---|
String getRemoteTypeName()
void setRemoteTypeName(String s)
s
- The new remoteTypeName valueint getRemoteType()
void setRemoteType(int p)
p
- The new remoteType valueint getFailoverIndex()
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
void setFailoverIndex(int p)
p
- The new failoverIndex valueString[] getFailovers()
void setFailovers(String[] f)
f
- The new failovers valueString getRemoteServiceName()
void setRemoteServiceName(String s)
s
- The new remoteServiceName valueString getRemoteHost()
void setRemoteHost(String s)
s
- The new remoteHost valueint getRemotePort()
void setRemotePort(int p)
p
- The new remotePort valueint getLocalPort()
void setLocalPort(int p)
p
- The new localPort valueString getClusterServers()
void setClusterServers(String s)
s
- The new clusterServers valueString getFailoverServers()
void setFailoverServers(String s)
s
- The new failoverServers valueboolean getRemoveUponRemotePut()
void setRemoveUponRemotePut(boolean r)
r
- The new removeUponRemotePut valueboolean getGetOnly()
void setGetOnly(boolean r)
r
- The new getOnly valueboolean getLocalClusterConsistency()
void setLocalClusterConsistency(boolean r)
r
- The new localClusterConsistency valueString getThreadPoolName()
The default name is "remote_cache_client"
void setThreadPoolName(String name)
name
- int getGetTimeoutMillis()
void setGetTimeoutMillis(int millis)
millis
- int getRmiSocketFactoryTimeoutMillis()
We have a default setting. The default rmi behavior should never be used.
void setRmiSocketFactoryTimeoutMillis(int rmiSocketFactoryTimeoutMillis)
rmiSocketFactoryTimeoutMillis
- void setReceive(boolean receive)
receive
- boolean isReceive()
If you set this option to false, you should set your locl memory size to 0.
The remote cache manager uses this value to decide whether or not to register a listener.
It makes no sense to configure a cluster remote cache to no receive.
Since a non-receiving remote cache client will not register a listener, it will not have a listener id assigned from the server. As such the remote server cannot determine if it is a cluster or a normal client. It will assume that it is a normal client.
void setZombieQueueMaxSize(int zombieQueueMaxSize)
zombieQueueMaxSize
- The zombieQueueMaxSize to set.int getZombieQueueMaxSize()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |