Interface IRemoteCacheAttributes
- All Superinterfaces:
AuxiliaryCacheAttributes
,Cloneable
,ICommonRemoteCacheAttributes
,Serializable
- All Known Implementing Classes:
RemoteCacheAttributes
,RemoteHttpCacheAttributes
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final boolean
If RECEIVE is false then the remote cache will not register a listener with the remote server.static final int
The number of elements the zombie queue will hold.Fields inherited from interface org.apache.commons.jcs3.auxiliary.remote.behavior.ICommonRemoteCacheAttributes
DEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MILLIS
-
Method Summary
Modifier and TypeMethodDescriptionint
Gets the failoverIndex attribute of the IRemoteCacheAttributes object.Gets the failovers attribute of the IRemoteCacheAttributes objectGets the failoverServers attribute of the IRemoteCacheAttributes objectint
-1 and 0 mean no timeout, this is the default if the timeout is -1 or 0, no threadpool will be used.int
Gets the localPort attribute of the IRemoteCacheAttributes objectThe thread pool the remote cache should use.int
The number of elements the zombie queue will hold.boolean
If RECEIVE is false then the remote cache will not register a listener with the remote server.void
setFailoverIndex
(int p) Sets the failoverIndex attribute of the IRemoteCacheAttributes objectvoid
setFailovers
(List<RemoteLocation> failovers) Sets the failovers attribute of the IRemoteCacheAttributes objectvoid
Sets the failoverServers attribute of the IRemoteCacheAttributes objectvoid
setGetTimeoutMillis
(int millis) -1 means no timeout, this is the default if the timeout is -1 or 0, no threadpool will be used.void
setLocalPort
(int p) Sets the localPort attribute of the IRemoteCacheAttributes objectvoid
setReceive
(boolean receive) By default this option is true.void
setThreadPoolName
(String name) Set the name of the pool to use.void
setZombieQueueMaxSize
(int zombieQueueMaxSize) The number of elements the zombie queue will hold.Methods inherited from interface org.apache.commons.jcs3.auxiliary.AuxiliaryCacheAttributes
clone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
Methods inherited from interface org.apache.commons.jcs3.auxiliary.remote.behavior.ICommonRemoteCacheAttributes
getClusterServers, getGetOnly, getRemoteLocation, getRemoteServiceName, getRemoteType, getRemoteTypeName, getRemoveUponRemotePut, getRmiSocketFactoryTimeoutMillis, isLocalClusterConsistency, setClusterServers, setGetOnly, setLocalClusterConsistency, setRemoteLocation, setRemoteLocation, setRemoteServiceName, setRemoteType, setRemoteTypeName, setRemoveUponRemotePut, setRmiSocketFactoryTimeoutMillis
-
Field Details
-
DEFAULT_RECEIVE
If RECEIVE is false then the remote cache will not register a listener with the remote server. This allows you to configure a remote server as a repository from which you can get and to which you put, but from which you do not receive any notifications. That is, you will not receive updates or removes.If you set this option to false, you should set your local memory size to 0.
- See Also:
-
DEFAULT_ZOMBIE_QUEUE_MAX_SIZE
The number of elements the zombie queue will hold. This queue is used to store events if we loose our connection with the server.- See Also:
-
-
Method Details
-
getFailoverIndex
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
Sets the failoverIndex attribute of the IRemoteCacheAttributes object- Parameters:
p
- The new failoverIndex value
-
getFailovers
Gets the failovers attribute of the IRemoteCacheAttributes object- Returns:
- The failovers value
-
setFailovers
Sets the failovers attribute of the IRemoteCacheAttributes object- Parameters:
failovers
- The new failovers value
-
getLocalPort
int getLocalPort()Gets the localPort attribute of the IRemoteCacheAttributes object- Returns:
- The localPort value
-
setLocalPort
Sets the localPort attribute of the IRemoteCacheAttributes object- Parameters:
p
- The new localPort value
-
getFailoverServers
Gets the failoverServers attribute of the IRemoteCacheAttributes object- Returns:
- The failoverServers value
-
setFailoverServers
Sets the failoverServers attribute of the IRemoteCacheAttributes object- Parameters:
s
- The new failoverServers value
-
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:
- the name of the pool
-
setThreadPoolName
Set the name of the pool to use. Pools should be defined in the cache.ccf.- Parameters:
name
-
-
getGetTimeoutMillis
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:
- the time in millis
-
setGetTimeoutMillis
-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
-
-
setReceive
By default this option is true. If you set it to false, you will not receive updates or removes from the remote server.- Parameters:
receive
-
-
isReceive
boolean isReceive()If RECEIVE is false then the remote cache will not register a listener with the remote server. This allows you to configure a remote server as a repository from which you can get and to which you put, but from which you do not receive any notifications. That is, you will not receive updates or removes.If you set this option to false, you should set your local 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.
- Returns:
- the receive value.
-
setZombieQueueMaxSize
The number of elements the zombie queue will hold. This queue is used to store events if we loose our connection with the server.- Parameters:
zombieQueueMaxSize
- The zombieQueueMaxSize to set.
-
getZombieQueueMaxSize
int getZombieQueueMaxSize()The number of elements the zombie queue will hold. This queue is used to store events if we loose our connection with the server.- Returns:
- Returns the zombieQueueMaxSize.
-