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 SummaryNested Classes
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final intThe number of elements the zombie queue will hold.
- 
Method SummaryModifier and TypeMethodDescriptionintGets the httpListenerPort attribute of the ILateralCacheAttributes objectGets the httpServer attribute of the ILateralCacheAttributes objectGets the httpSrvers attribute of the LateralCacheAttributes objectbooleanGets the transmissionType attribute of the ILateralCacheAttributes objectDeprecated.Use getTransmissionTypeGets the udpMulticastAddr attribute of the ILateralCacheAttributes objectintGets the udpMulticastPort attribute of the ILateralCacheAttributes objectintThe number of elements the zombie queue will hold.booleanShould a listener be created.voidsetHttpListenerPort(int val) Sets the httpListenerPort attribute of the ILateralCacheAttributes objectvoidsetHttpServer(String val) Sets the httpServer attribute of the ILateralCacheAttributes objectvoidsetHttpServers(String val) Sets the httpServers attribute of the LateralCacheAttributes objectvoidsetPutOnlyMode(boolean val) Sets the putOnlyMode attribute of the ILateralCacheAttributes.voidsetReceive(boolean receive) voidSets the transmissionType attribute of the ILateralCacheAttributes objectvoidDeprecated.Use setTransmissionType()voidSets the udpMulticastAddr attribute of the ILateralCacheAttributes objectvoidsetUdpMulticastPort(int val) Sets the udpMulticastPort attribute of the ILateralCacheAttributes objectvoidsetZombieQueueMaxSize(int zombieQueueMaxSize) The number of elements the zombie queue will hold.Methods inherited from interface org.apache.commons.jcs3.auxiliary.AuxiliaryCacheAttributesclone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
- 
Field Details- 
DEFAULT_ZOMBIE_QUEUE_MAX_SIZEThe 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- 
setHttpServerSets the httpServer attribute of the ILateralCacheAttributes object- Parameters:
- val- The new httpServer value
 
- 
getHttpServerGets the httpServer attribute of the ILateralCacheAttributes object- Returns:
- The httpServer value
 
- 
setHttpListenerPortSets the httpListenerPort attribute of the ILateralCacheAttributes object- Parameters:
- val- The new tcpListenerPort value
 
- 
getHttpListenerPortint getHttpListenerPort()Gets the httpListenerPort attribute of the ILateralCacheAttributes object- Returns:
- The httpListenerPort value
 
- 
setHttpServersSets the httpServers attribute of the LateralCacheAttributes object- Parameters:
- val- The new httpServers value
 
- 
getHttpServersGets the httpSrvers attribute of the LateralCacheAttributes object- Returns:
- The httpServers value
 
- 
setUdpMulticastAddrSets the udpMulticastAddr attribute of the ILateralCacheAttributes object- Parameters:
- val- The new udpMulticastAddr value
 
- 
getUdpMulticastAddrGets the udpMulticastAddr attribute of the ILateralCacheAttributes object- Returns:
- The udpMulticastAddr value
 
- 
setUdpMulticastPortSets the udpMulticastPort attribute of the ILateralCacheAttributes object- Parameters:
- val- The new udpMulticastPort value
 
- 
getUdpMulticastPortint getUdpMulticastPort()Gets the udpMulticastPort attribute of the ILateralCacheAttributes object- Returns:
- The udpMulticastPort value
 
- 
setTransmissionTypeSets the transmissionType attribute of the ILateralCacheAttributes object- Parameters:
- val- The new transmissionType value
 
- 
getTransmissionTypeGets the transmissionType attribute of the ILateralCacheAttributes object- Returns:
- The transmissionType value
 
- 
setTransmissionTypeNameDeprecated.Use setTransmissionType()Sets the transmissionTypeName attribute of the ILateralCacheAttributes object- Parameters:
- val- The new transmissionTypeName value
 
- 
getTransmissionTypeNameDeprecated.Use getTransmissionTypeGets the transmissionTypeName attribute of the ILateralCacheAttributes object- Returns:
- The transmissionTypeName value
 
- 
setPutOnlyModeSets 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
 
- 
getPutOnlyModeboolean getPutOnlyMode()- Returns:
- The outgoingOnlyMode value. Stops gets from going remote.
 
- 
setReceive- Parameters:
- receive- The receive to set.
 
- 
isReceiveboolean 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
 
- 
setZombieQueueMaxSizeThe 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.
 
- 
getZombieQueueMaxSizeint 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.
 
 
-