Class LateralCacheAttributes
java.lang.Object
org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributes
org.apache.commons.jcs3.auxiliary.lateral.LateralCacheAttributes
- All Implemented Interfaces:
Serializable
,Cloneable
,AuxiliaryCacheAttributes
,ILateralCacheAttributes
- Direct Known Subclasses:
TCPLateralCacheAttributes
public class LateralCacheAttributes
extends AbstractAuxiliaryCacheAttributes
implements ILateralCacheAttributes
This class stores attributes for all of the available lateral cache auxiliaries.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.commons.jcs3.auxiliary.lateral.behavior.ILateralCacheAttributes
ILateralCacheAttributes.Type
-
Field Summary
Fields inherited from interface org.apache.commons.jcs3.auxiliary.lateral.behavior.ILateralCacheAttributes
DEFAULT_ZOMBIE_QUEUE_MAX_SIZE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the httpListenerPort attribute of the ILateralCacheAttributes objectGets the httpServer attribute of the LateralCacheAttributes objectGets the httpSrvers attribute of the LateralCacheAttributes objectboolean
Gets the transmissionType attribute of the LateralCacheAttributes objectDeprecated.Gets the udpMulticastAddr attribute of the LateralCacheAttributes objectint
Gets the udpMulticastPort attribute of the LateralCacheAttributes objectint
The number of elements the zombie queue will hold.boolean
Should a listener be created.void
setHttpListenerPort
(int val) Sets the httpListenerPort attribute of the ILateralCacheAttributes objectvoid
setHttpServer
(String val) Sets the httpServer attribute of the LateralCacheAttributes objectvoid
setHttpServers
(String val) Sets the httpServers attribute of the LateralCacheAttributes objectvoid
setPutOnlyMode
(boolean val) Sets the outgoingOnlyMode attribute of the ILateralCacheAttributes.void
setReceive
(boolean receive) void
Sets the transmissionType attribute of the LateralCacheAttributes objectvoid
Deprecated.void
Sets the udpMulticastAddr attribute of the LateralCacheAttributes objectvoid
setUdpMulticastPort
(int val) Sets the udpMulticastPort attribute of the LateralCacheAttributes objectvoid
setZombieQueueMaxSize
(int zombieQueueMaxSize) The number of elements the zombie queue will hold.toString()
Methods inherited from class org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributes
clone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.commons.jcs3.auxiliary.AuxiliaryCacheAttributes
clone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
-
Constructor Details
-
LateralCacheAttributes
public LateralCacheAttributes()
-
-
Method Details
-
setHttpServer
Sets the httpServer attribute of the LateralCacheAttributes object- Specified by:
setHttpServer
in interfaceILateralCacheAttributes
- Parameters:
val
- The new httpServer value
-
getHttpServer
Gets the httpServer attribute of the LateralCacheAttributes object- Specified by:
getHttpServer
in interfaceILateralCacheAttributes
- Returns:
- The httpServer value
-
setHttpServers
Sets the httpServers attribute of the LateralCacheAttributes object- Specified by:
setHttpServers
in interfaceILateralCacheAttributes
- Parameters:
val
- The new httpServers value
-
getHttpServers
Gets the httpSrvers attribute of the LateralCacheAttributes object- Specified by:
getHttpServers
in interfaceILateralCacheAttributes
- Returns:
- The httpServers value
-
setHttpListenerPort
Sets the httpListenerPort attribute of the ILateralCacheAttributes object- Specified by:
setHttpListenerPort
in interfaceILateralCacheAttributes
- Parameters:
val
- The new tcpListenerPort value
-
getHttpListenerPort
Gets the httpListenerPort attribute of the ILateralCacheAttributes object- Specified by:
getHttpListenerPort
in interfaceILateralCacheAttributes
- Returns:
- The httpListenerPort value
-
setUdpMulticastAddr
Sets the udpMulticastAddr attribute of the LateralCacheAttributes object- Specified by:
setUdpMulticastAddr
in interfaceILateralCacheAttributes
- Parameters:
val
- The new udpMulticastAddr value
-
getUdpMulticastAddr
Gets the udpMulticastAddr attribute of the LateralCacheAttributes object- Specified by:
getUdpMulticastAddr
in interfaceILateralCacheAttributes
- Returns:
- The udpMulticastAddr value
-
setUdpMulticastPort
Sets the udpMulticastPort attribute of the LateralCacheAttributes object- Specified by:
setUdpMulticastPort
in interfaceILateralCacheAttributes
- Parameters:
val
- The new udpMulticastPort value
-
getUdpMulticastPort
Gets the udpMulticastPort attribute of the LateralCacheAttributes object- Specified by:
getUdpMulticastPort
in interfaceILateralCacheAttributes
- Returns:
- The udpMulticastPort value
-
setTransmissionType
Sets the transmissionType attribute of the LateralCacheAttributes object- Specified by:
setTransmissionType
in interfaceILateralCacheAttributes
- Parameters:
val
- The new transmissionType value
-
getTransmissionType
Gets the transmissionType attribute of the LateralCacheAttributes object- Specified by:
getTransmissionType
in interfaceILateralCacheAttributes
- Returns:
- The transmissionType value
-
setTransmissionTypeName
Deprecated.Sets the transmissionTypeName attribute of the LateralCacheAttributes object- Specified by:
setTransmissionTypeName
in interfaceILateralCacheAttributes
- Parameters:
val
- The new transmissionTypeName value
-
getTransmissionTypeName
Deprecated.Gets the transmissionTypeName attribute of the LateralCacheAttributes object- Specified by:
getTransmissionTypeName
in interfaceILateralCacheAttributes
- Returns:
- The transmissionTypeName value
-
setPutOnlyMode
Sets the outgoingOnlyMode attribute of the ILateralCacheAttributes. When this is true the lateral cache will only issue put and remove order and will not try to retrieve elements from other lateral caches.- Specified by:
setPutOnlyMode
in interfaceILateralCacheAttributes
- Parameters:
val
- The new transmissionTypeName value
-
getPutOnlyMode
- Specified by:
getPutOnlyMode
in interfaceILateralCacheAttributes
- Returns:
- The outgoingOnlyMode value. Stops gets from going remote.
-
setReceive
- Specified by:
setReceive
in interfaceILateralCacheAttributes
- Parameters:
receive
- The receive to set.
-
isReceive
Description copied from interface:ILateralCacheAttributes
Should a listener be created. By default this is true.If this is false the lateral will connect to others but it will not create a listener to receive.
It is possible if two laterals are misconfigured that lateral A may have a region R1 that is not configured for the lateral but another is. And if cache B has region R1 configured for lateral distribution, A will get messages for R1 but not send them.
- Specified by:
isReceive
in interfaceILateralCacheAttributes
- Returns:
- Returns the receive.
-
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.- Specified by:
setZombieQueueMaxSize
in interfaceILateralCacheAttributes
- Parameters:
zombieQueueMaxSize
- The zombieQueueMaxSize to set.
-
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.- Specified by:
getZombieQueueMaxSize
in interfaceILateralCacheAttributes
- Returns:
- Returns the zombieQueueMaxSize.
-
toString
-