Class RemoteCacheAttributes
java.lang.Object
org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributes
org.apache.commons.jcs3.auxiliary.remote.CommonRemoteCacheAttributes
org.apache.commons.jcs3.auxiliary.remote.RemoteCacheAttributes
- All Implemented Interfaces:
- Serializable,- Cloneable,- AuxiliaryCacheAttributes,- ICommonRemoteCacheAttributes,- IRemoteCacheAttributes
- Direct Known Subclasses:
- RemoteHttpCacheAttributes
public class RemoteCacheAttributes
extends CommonRemoteCacheAttributes
implements IRemoteCacheAttributes
These objects are used to configure the remote cache client.
- See Also:
- 
Field SummaryFields inherited from interface org.apache.commons.jcs3.auxiliary.remote.behavior.ICommonRemoteCacheAttributesDEFAULT_RMI_SOCKET_FACTORY_TIMEOUT_MILLISFields inherited from interface org.apache.commons.jcs3.auxiliary.remote.behavior.IRemoteCacheAttributesDEFAULT_RECEIVE, DEFAULT_ZOMBIE_QUEUE_MAX_SIZE
- 
Constructor SummaryConstructorsConstructorDescriptionDefault constructor for the RemoteCacheAttributes object
- 
Method SummaryModifier and TypeMethodDescriptionintGets the failoverIndex attribute of the RemoteCacheAttributes object.Gets the failovers attribute of the RemoteCacheAttributes object.Gets the failoverServers attribute of the RemoteCacheAttributes object.int-1 and 0 mean no timeout, this is the default if the timeout is -1 or 0, no threadpool will be used.intGets the localPort attribute of the RemoteCacheAttributes object.The thread pool the remote cache should use.intThe number of elements the zombie queue will hold.booleanIf RECEIVE is false then the remote cache will not register a listener with the remote server.voidsetFailoverIndex(int p) Sets the failoverIndex attribute of the RemoteCacheAttributes object.voidsetFailovers(List<RemoteLocation> failovers) Sets the failovers attribute of the RemoteCacheAttributes object.voidSets the failoverServers attribute of the RemoteCacheAttributes object.voidsetGetTimeoutMillis(int millis) -1 means no timeout, this is the default if the timeout is -1 or 0, no threadpool will be used.voidsetLocalPort(int p) Sets the localPort attribute of the RemoteCacheAttributes objectvoidsetReceive(boolean receive) By default this option is true.voidsetThreadPoolName(String name) Set the name of the pool to use.voidsetZombieQueueMaxSize(int zombieQueueMaxSize) The number of elements the zombie queue will hold.toString()Methods inherited from class org.apache.commons.jcs3.auxiliary.remote.CommonRemoteCacheAttributesgetClusterServers, getGetOnly, getRemoteLocation, getRemoteServiceName, getRemoteType, getRemoteTypeName, getRemoveUponRemotePut, getRmiSocketFactoryTimeoutMillis, isLocalClusterConsistency, setClusterServers, setGetOnly, setLocalClusterConsistency, setRemoteLocation, setRemoteLocation, setRemoteServiceName, setRemoteType, setRemoteTypeName, setRemoveUponRemotePut, setRmiSocketFactoryTimeoutMillisMethods inherited from class org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributesclone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setNameMethods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.jcs3.auxiliary.AuxiliaryCacheAttributesclone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setNameMethods inherited from interface org.apache.commons.jcs3.auxiliary.remote.behavior.ICommonRemoteCacheAttributesgetClusterServers, getGetOnly, getRemoteLocation, getRemoteServiceName, getRemoteType, getRemoteTypeName, getRemoveUponRemotePut, getRmiSocketFactoryTimeoutMillis, isLocalClusterConsistency, setClusterServers, setGetOnly, setLocalClusterConsistency, setRemoteLocation, setRemoteLocation, setRemoteServiceName, setRemoteType, setRemoteTypeName, setRemoveUponRemotePut, setRmiSocketFactoryTimeoutMillis
- 
Constructor Details- 
RemoteCacheAttributespublic RemoteCacheAttributes()Default constructor for the RemoteCacheAttributes object
 
- 
- 
Method Details- 
getFailoverIndexGets the failoverIndex attribute of the RemoteCacheAttributes object.- Specified by:
- getFailoverIndexin interface- IRemoteCacheAttributes
- Returns:
- The failoverIndex value
 
- 
setFailoverIndexSets the failoverIndex attribute of the RemoteCacheAttributes object.- Specified by:
- setFailoverIndexin interface- IRemoteCacheAttributes
- Parameters:
- p- The new failoverIndex value
 
- 
getFailoversGets the failovers attribute of the RemoteCacheAttributes object.- Specified by:
- getFailoversin interface- IRemoteCacheAttributes
- Returns:
- The failovers value
 
- 
setFailoversSets the failovers attribute of the RemoteCacheAttributes object.- Specified by:
- setFailoversin interface- IRemoteCacheAttributes
- Parameters:
- failovers- The new failovers value
 
- 
getFailoverServersGets the failoverServers attribute of the RemoteCacheAttributes object.- Specified by:
- getFailoverServersin interface- IRemoteCacheAttributes
- Returns:
- The failoverServers value
 
- 
setFailoverServersSets the failoverServers attribute of the RemoteCacheAttributes object.- Specified by:
- setFailoverServersin interface- IRemoteCacheAttributes
- Parameters:
- s- The new failoverServers value
 
- 
getLocalPortGets the localPort attribute of the RemoteCacheAttributes object.- Specified by:
- getLocalPortin interface- IRemoteCacheAttributes
- Returns:
- The localPort value
 
- 
setLocalPortSets the localPort attribute of the RemoteCacheAttributes object- Specified by:
- setLocalPortin interface- IRemoteCacheAttributes
- Parameters:
- p- The new localPort value
 
- 
getThreadPoolNameDescription copied from interface:IRemoteCacheAttributesThe thread pool the remote cache should use. At first this will only be for gets.The default name is "remote_cache_client" - Specified by:
- getThreadPoolNamein interface- IRemoteCacheAttributes
- Returns:
- the name of the pool
 
- 
setThreadPoolNameDescription copied from interface:IRemoteCacheAttributesSet the name of the pool to use. Pools should be defined in the cache.ccf.- Specified by:
- setThreadPoolNamein interface- IRemoteCacheAttributes
- Parameters:
- name-
 
- 
getGetTimeoutMillisDescription copied from interface:IRemoteCacheAttributes-1 and 0 mean no timeout, this is the default if the timeout is -1 or 0, no threadpool will be used.- Specified by:
- getGetTimeoutMillisin interface- IRemoteCacheAttributes
- Returns:
- getTimeoutMillis
 
- 
setGetTimeoutMillisDescription copied from interface:IRemoteCacheAttributes-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.- Specified by:
- setGetTimeoutMillisin interface- IRemoteCacheAttributes
- Parameters:
- millis-
 
- 
setReceiveBy default this option is true. If you set it to false, you will not receive updates or removes from the remote server.- Specified by:
- setReceivein interface- IRemoteCacheAttributes
- Parameters:
- receive-
 
- 
isReceiveIf 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. - Specified by:
- isReceivein interface- IRemoteCacheAttributes
- Returns:
- the receive value.
 
- 
setZombieQueueMaxSizeThe number of elements the zombie queue will hold. This queue is used to store events if we loose our connection with the server.- Specified by:
- setZombieQueueMaxSizein interface- IRemoteCacheAttributes
- Parameters:
- zombieQueueMaxSize- The zombieQueueMaxSize to set.
 
- 
getZombieQueueMaxSizeThe number of elements the zombie queue will hold. This queue is used to store events if we loose our connection with the server.- Specified by:
- getZombieQueueMaxSizein interface- IRemoteCacheAttributes
- Returns:
- Returns the zombieQueueMaxSize.
 
- 
toString- Overrides:
- toStringin class- CommonRemoteCacheAttributes
- Returns:
- String, all the important values that can be configured
 
 
-