Interface ILateralCacheAttributes
- All Superinterfaces:
AuxiliaryCacheAttributes
,Cloneable
,Serializable
- All Known Subinterfaces:
ITCPLateralCacheAttributes
- All Known Implementing Classes:
LateralCacheAttributes
,TCPLateralCacheAttributes
This interface defines configuration options common to lateral cache plugins.
TODO it needs to be trimmed down. The old version had features for every lateral. Now, the individual laterals have their own specific attributes interfaces.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The number of elements the zombie queue will hold. -
Method Summary
Modifier and TypeMethodDescriptionint
Gets the httpListenerPort attribute of the ILateralCacheAttributes objectGets the httpServer attribute of the ILateralCacheAttributes objectGets the httpSrvers attribute of the LateralCacheAttributes objectboolean
Gets the transmissionType attribute of the ILateralCacheAttributes objectDeprecated.Use getTransmissionTypeGets the udpMulticastAddr attribute of the ILateralCacheAttributes objectint
Gets the udpMulticastPort attribute of the ILateralCacheAttributes 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 ILateralCacheAttributes objectvoid
setHttpServers
(String val) Sets the httpServers attribute of the LateralCacheAttributes objectvoid
setPutOnlyMode
(boolean val) Sets the putOnlyMode attribute of the ILateralCacheAttributes.void
setReceive
(boolean receive) void
Sets the transmissionType attribute of the ILateralCacheAttributes objectvoid
Deprecated.Use setTransmissionType()void
Sets the udpMulticastAddr attribute of the ILateralCacheAttributes objectvoid
setUdpMulticastPort
(int val) Sets the udpMulticastPort attribute of the ILateralCacheAttributes objectvoid
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
-
Field Details
-
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
-
setHttpServer
Sets the httpServer attribute of the ILateralCacheAttributes object- Parameters:
val
- The new httpServer value
-
getHttpServer
Gets the httpServer attribute of the ILateralCacheAttributes object- Returns:
- The httpServer value
-
setHttpListenerPort
Sets the httpListenerPort attribute of the ILateralCacheAttributes object- Parameters:
val
- The new tcpListenerPort value
-
getHttpListenerPort
int getHttpListenerPort()Gets the httpListenerPort attribute of the ILateralCacheAttributes object- Returns:
- The httpListenerPort value
-
setHttpServers
Sets the httpServers attribute of the LateralCacheAttributes object- Parameters:
val
- The new httpServers value
-
getHttpServers
Gets the httpSrvers attribute of the LateralCacheAttributes object- Returns:
- The httpServers value
-
setUdpMulticastAddr
Sets the udpMulticastAddr attribute of the ILateralCacheAttributes object- Parameters:
val
- The new udpMulticastAddr value
-
getUdpMulticastAddr
Gets the udpMulticastAddr attribute of the ILateralCacheAttributes object- Returns:
- The udpMulticastAddr value
-
setUdpMulticastPort
Sets the udpMulticastPort attribute of the ILateralCacheAttributes object- Parameters:
val
- The new udpMulticastPort value
-
getUdpMulticastPort
int getUdpMulticastPort()Gets the udpMulticastPort attribute of the ILateralCacheAttributes object- Returns:
- The udpMulticastPort value
-
setTransmissionType
Sets the transmissionType attribute of the ILateralCacheAttributes object- Parameters:
val
- The new transmissionType value
-
getTransmissionType
Gets the transmissionType attribute of the ILateralCacheAttributes object- Returns:
- The transmissionType value
-
setTransmissionTypeName
Deprecated.Use setTransmissionType()Sets the transmissionTypeName attribute of the ILateralCacheAttributes object- Parameters:
val
- The new transmissionTypeName value
-
getTransmissionTypeName
Deprecated.Use getTransmissionTypeGets the transmissionTypeName attribute of the ILateralCacheAttributes object- Returns:
- The transmissionTypeName value
-
setPutOnlyMode
Sets the putOnlyMode 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.- Parameters:
val
- The new transmissionTypeName value
-
getPutOnlyMode
boolean getPutOnlyMode()- Returns:
- The outgoingOnlyMode value. Stops gets from going remote.
-
setReceive
- Parameters:
receive
- The receive to set.
-
isReceive
boolean isReceive()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.
- Returns:
- true if we should have a listener connection
-
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.
-